Databricks SDK for JavaScript
    Preparing search index...

    Interface Stream

    A Stream is a governed UC entity representing an external streaming data source. The source_config oneof determines the streaming platform source (e.g. Kafka, Kinesis, etc.).

    interface Stream {
        browseOnly?: boolean;
        connectionConfig?: StreamConnectionConfig;
        createdBy?: string;
        createTime?: Instant;
        description?: string;
        excludedColumns?: string[];
        ingestionConfig?: IngestionConfig;
        name?: string;
        recordTypeFilter?: string;
        schemaConfig?: StreamSchemaConfig;
        sourceConfig?: StreamSourceConfig;
        updatedBy?: string;
        updateTime?: Instant;
    }
    Index

    Properties

    browseOnly? connectionConfig? createdBy? createTime? description? excludedColumns? ingestionConfig? name? recordTypeFilter? schemaConfig? sourceConfig? updatedBy? updateTime?

    Properties

    browseOnly?: boolean

    Indicates whether the principal is limited to retrieving metadata for the associated object through the BROWSE privilege when include_browse is enabled in the request.

    connectionConfig?: StreamConnectionConfig

    Specifies how to connect and authenticate to the stream platform.

    createdBy?: string

    Username of the Stream creator.

    createTime?: Instant

    Time at which this Stream was created.

    description?: string

    User-provided description.

    excludedColumns?: string[]

    Column paths (dot notation, e.g. "value.email" for Kafka) to drop. A path may reference a struct, in which case all of its nested fields are dropped (e.g. "value.address" drops "value.address.city" and "value.address.zip"). These columns are not written to the ingestion table and cannot be referenced by any feature. They are dropped from ingestion, backfill, and materialization. For direct schemas, each column must exist in the relevant key or payload schema. With a schema registry, a column can be excluded before it exists. A column cannot also be a deduplication column in the ingestion_config.

    ingestionConfig?: IngestionConfig

    Configuration for streaming data ingestion: the managed table storing an offline copy of forward fill data and optional historical backfill.

    name?: string

    Full three-part (catalog.schema.stream) name of the stream.

    recordTypeFilter?: string

    Optional SQL predicate to filter which record types from a streaming channel (e.g. a topic for Kafka) belong to this Stream. Events that do not match are not written to the ingestion table and are not used in materialization. Example: "value.event_type = 'transaction'".

    schemaConfig?: StreamSchemaConfig

    Schema definitions for the stream, provided either directly on the Stream or resolved from an external schema registry through a UC Connection.

    sourceConfig?: StreamSourceConfig

    Source-specific configuration. Determines the streaming platform source.

    updatedBy?: string

    Username of user who last modified the Stream.

    updateTime?: Instant

    Time at which this Stream was last modified.

    Settings

    Member Visibility

    On This Page

    Properties