Databricks SDK for JavaScript
    Preparing search index...

    Interface MaterializedFeature

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

    interface MaterializedFeature {
        cronSchedule?: string;
        destination?:
            | {
                $case: "offlineStoreConfig";
                offlineStoreConfig: OfflineStoreConfig;
            }
            | { $case: "onlineStoreConfig"; onlineStoreConfig: OnlineStoreConfig };
        featureName?: string;
        isOnline?: boolean;
        lastMaterializationTime?: Instant;
        materializedFeatureId?: string;
        pipelineScheduleState?: MaterializedFeature_PipelineScheduleState;
        tableName?: string;
        trigger?:
            | { $case: "cronScheduleTrigger"; cronScheduleTrigger: CronSchedule }
            | { $case: "tableTrigger"; tableTrigger: TableTrigger }
            | { $case: "streamingMode"; streamingMode: StreamingMode };
    }
    Index

    Properties

    cronSchedule? destination? featureName? isOnline? lastMaterializationTime? materializedFeatureId? pipelineScheduleState? tableName? trigger?

    Properties

    cronSchedule?: string

    The quartz cron expression that defines the schedule of the materialization pipeline. The schedule is evaluated in the UTC timezone. Hidden from GraphQL: superseded by the trigger oneof (cron_schedule_trigger), so not exposed to Catalog Explorer.

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

    Type Declaration

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

        Destination for writing feature values to an offline Delta table.

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

        Destination for writing feature values to an online Lakebase table.

    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.

    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.

    materializedFeatureId?: string

    Server-assigned unique identifier for the materialized feature.

    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.

    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