Databricks SDK for JavaScript
    Preparing search index...

    Interface MaterializedFeature

    A materialized feature represents a feature that is continuously computed and stored.

    interface MaterializedFeature {
        budgetPolicyId?: string;
        cronSchedule?: string;
        destination?:
            | {
                $case: "offlineStoreConfig";
                offlineStoreConfig: OfflineStoreConfig;
            }
            | { $case: "onlineStoreConfig"; onlineStoreConfig: OnlineStoreConfig };
        featureName?: string;
        isOnline?: boolean;
        jobId?: bigint;
        lastMaterializationTime?: Instant;
        latestBackfillOperation?: string;
        materializedFeatureId?: string;
        notifications?: MaterializationNotifications;
        pipelineId?: string;
        pipelineScheduleState?: MaterializedFeature_PipelineScheduleState;
        tableName?: string;
        tags?: Record<string, string>;
        trigger?:
            | { $case: "cronScheduleTrigger"; cronScheduleTrigger: CronSchedule }
            | { $case: "tableTrigger"; tableTrigger: TableTrigger }
            | { $case: "streamingMode"; streamingMode: StreamingMode };
    }
    Index

    Properties

    budgetPolicyId? cronSchedule? destination? featureName? isOnline? jobId? lastMaterializationTime? latestBackfillOperation? materializedFeatureId? notifications? pipelineId? pipelineScheduleState? tableName? tags? trigger?

    Properties

    budgetPolicyId?: string

    The ID of the budget policy used to attribute the serverless compute cost of this materialization. If not specified, a default budget policy may be applied.

    cronSchedule?: string
    destination?:
        | {
            $case: "offlineStoreConfig";
            offlineStoreConfig: OfflineStoreConfig;
        }
        | { $case: "onlineStoreConfig"; onlineStoreConfig: OnlineStoreConfig }

    (-- The destination configs are deliberately IMMUTABLE: an API review settled that a materialization cannot be retargeted in place, so a destination change recreates it. --)

    Type Declaration

    • { $case: "offlineStoreConfig"; offlineStoreConfig: OfflineStoreConfig }
      • $case: "offlineStoreConfig"
      • offlineStoreConfig: OfflineStoreConfig

        Destination for writing feature values to an offline Delta table. The resulting table is returned as table_name.

    • { $case: "onlineStoreConfig"; onlineStoreConfig: OnlineStoreConfig }
      • $case: "onlineStoreConfig"
      • onlineStoreConfig: OnlineStoreConfig

        Destination for writing feature values to an online Lakebase table. The resulting table is returned as table_name.

    featureName?: string

    The full name of the feature in Unity Catalog.

    isOnline?: boolean

    True if this is an online materialized feature. False if it is an offline materialized feature.

    jobId?: bigint

    The ID of the job that materializes the feature. This is present for both batch and streaming features.

    lastMaterializationTime?: Instant

    The timestamp when the pipeline last ran and updated the materialized feature values. If the pipeline has not run yet, this field will be null.

    latestBackfillOperation?: string

    Name of the latest backfill operation on this materialized feature. Format: operations/{operation_id}.

    materializedFeatureId?: string

    Server-assigned unique identifier for the materialized feature.

    notifications?: MaterializationNotifications

    Notification configuration around the materialization job or pipeline lifecycle. They are applied to every job and pipeline that materializes this feature. Features which are materialized in the same pipeline will share the same notification.

    pipelineId?: string

    The ID of the pipeline that materializes this feature. This is only present for streaming features.

    pipelineScheduleState?: MaterializedFeature_PipelineScheduleState

    The schedule state of the materialization pipeline. Hidden from GraphQL: being deprecated, so not exposed to Catalog Explorer.

    tableName?: string

    The fully qualified Unity Catalog path to the table containing the materialized feature (Delta table or Lakebase table). Output only.

    tags?: Record<string, string>

    Custom tags to associate with this materialization. They are applied to the materialization job (for batch features) or pipeline (for streaming features) and forwarded to the underlying compute as cluster tags, so materialization cost can be attributed in the billing system tables. These tags apply only to the materialization compute; they are not applied to the Unity Catalog Feature resource itself, whose tags are managed separately through the Unity Catalog tagging API. A maximum of 25 tags is supported; keys and values are subject to the same limitations as cluster tags.

    trigger?:
        | { $case: "cronScheduleTrigger"; cronScheduleTrigger: CronSchedule }
        | { $case: "tableTrigger"; tableTrigger: TableTrigger }
        | { $case: "streamingMode"; streamingMode: StreamingMode }

    The trigger configuration for the materialization pipeline.

    Type Declaration

    • { $case: "cronScheduleTrigger"; cronScheduleTrigger: CronSchedule }
      • $case: "cronScheduleTrigger"
      • cronScheduleTrigger: CronSchedule

        A cron-based schedule trigger for the materialization pipeline.

    • { $case: "tableTrigger"; tableTrigger: TableTrigger }
      • $case: "tableTrigger"
      • tableTrigger: TableTrigger

        A trigger that fires when the upstream source table changes.

    • { $case: "streamingMode"; streamingMode: StreamingMode }
      • $case: "streamingMode"
      • streamingMode: StreamingMode

        The Structured Streaming trigger mode used for materialization. Real-time mode (RTM) targets sub-second latency for operational workloads; micro-batch mode (MBM) favors cost efficiency for ETL and analytics workloads.

    Settings

    Member Visibility

    On This Page

    Properties