Materialized Feature

View as Markdown

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

MaterializedFeature object

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

materialized_feature_idstringPublic PreviewIDImmutable: Server-assigned unique identifier for the materialized feature.

feature_namestringPublic Preview: The full name of the feature in Unity Catalog.

offline_store_configobjectPublic PreviewInput onlyImmutable

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

Show child attributesHide child attributes

catalog_namestringPublic Preview: The Unity Catalog catalog name.

schema_namestringPublic Preview: The Unity Catalog schema name.

table_name_prefixstringPublic Preview: Prefix for Unity Catalog table name. The materialized feature will be stored in a table with this prefix and a generated postfix.

online_store_configobjectPublic PreviewImmutable

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

Show child attributesHide child attributes

catalog_namestringPublic PreviewInput only: The Unity Catalog catalog name. This name is also used as the Lakebase logical database name. Quoting is handled by the backend where needed, do not pre-quote it.

schema_namestringPublic PreviewInput only: The Unity Catalog schema name. This name is also used as the Lakebase schema name under the database. Quoting is handled by the backend where needed, do not pre-quote it.

table_name_prefixstringPublic PreviewInput only: Prefix for Unity Catalog table name. The materialized feature will be stored in a Lakebase table with this prefix and a generated postfix.

online_store_namestringPublic Preview: The name of the target online store.

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

last_materialization_timestringPublic PreviewOutput only: 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.

is_onlinebooleanPublic PreviewOutput only: True if this is an online materialized feature. False if it is an offline materialized feature.

cron_schedule_triggerobjectPublic Preview

A cron-based schedule trigger for the materialization pipeline.

Show child attributesHide child attributes

cron_expressionstringPublic Preview: The cron expression defining the schedule (e.g., "0 0 * * *" for daily at midnight). The schedule is interpreted in timezone_id (defaults to UTC). Required when mode is MANUAL (or unset). Left empty when mode is DERIVED, where the service computes it (aligned to UTC) from the features' window timing and fills it in on the response.

table_triggerobjectPublic Preview: A trigger that fires when the upstream source table changes.

streaming_modeobjectPublic Preview

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.

Show child attributesHide child attributes

modestringPublic Preview

The type of streaming mode used by the materialization pipeline.

Values:

STREAMING_MODE_TYPE_UNSPECIFIED
STREAMING_MODE_TYPE_RTM
STREAMING_MODE_TYPE_MBM

View as Markdown

The MaterializedFeature object

{
  "materialized_feature_id": "string",
  "feature_name": "string",
  "offline_store_config": {
    "catalog_name": "string",
    "schema_name": "string",
    "table_name_prefix": "string"
  },
  "online_store_config": {
    "catalog_name": "string",
    "schema_name": "string",
    "table_name_prefix": "string",
    "online_store_name": "string"
  },
  "table_name": "string",
  "last_materialization_time": "string",
  "is_online": true,
  "cron_schedule_trigger": {
    "cron_expression": "string"
  },
  "table_trigger": {},
  "streaming_mode": {
    "mode": "STREAMING_MODE_TYPE_RTM"
  }
}

Get a materialized feature Public Preview

GET /api/2.0/feature-engineering/materialized-features/{materialized_feature_id}

Get a materialized feature.

API scopes: mlflow

Parameters

materialized_feature_idstringRequiredpath: The ID of the materialized feature.

Response

Returns the MaterializedFeature object.

View as Markdown

Response

{
  "materialized_feature_id": "string",
  "feature_name": "string",
  "online_store_config": {
    "online_store_name": "string"
  },
  "table_name": "string",
  "last_materialization_time": "string",
  "is_online": true,
  "cron_schedule_trigger": {
    "cron_expression": "string"
  },
  "table_trigger": {},
  "streaming_mode": {
    "mode": "STREAMING_MODE_TYPE_RTM"
  }
}

List materialized features Public Preview

GET /api/2.0/feature-engineering/materialized-features

List materialized features.

API scopes: mlflow

Parameters

feature_namestringquery: Filter by feature name. If specified, only materialized features materialized from this feature will be returned.

page_tokenstringquery: Pagination token to go to the next page based on a previous query.

page_sizeint32<= 1000query: The maximum number of results to return. Defaults to 100 if not specified. Cannot be greater than 1000.
Default: 100

Response

Returns a list of MaterializedFeature objects.

View as Markdown

Response

{
  "materialized_features": [
    {
      "materialized_feature_id": "string",
      "feature_name": "string",
      "online_store_config": {},
      "table_name": "string",
      "last_materialization_time": "string",
      "is_online": true,
      "cron_schedule_trigger": {},
      "table_trigger": {},
      "streaming_mode": {}
    }
  ],
  "next_page_token": "string"
}

Create a materialized feature Public Preview

POST /api/2.0/feature-engineering/materialized-features

Create a materialized feature.

API scopes: mlflow

Request body

The materialized feature to create.

materialized_feature_idstringIDImmutable: Server-assigned unique identifier for the materialized feature.

feature_namestringRequired: The full name of the feature in Unity Catalog.

offline_store_configobjectInput onlyImmutable

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

Show child attributesHide child attributes

catalog_namestringRequired: The Unity Catalog catalog name.

schema_namestringRequired: The Unity Catalog schema name.

table_name_prefixstringRequired: Prefix for Unity Catalog table name. The materialized feature will be stored in a table with this prefix and a generated postfix.

online_store_configobjectImmutable

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

Show child attributesHide child attributes

catalog_namestringRequiredInput only: The Unity Catalog catalog name. This name is also used as the Lakebase logical database name. Quoting is handled by the backend where needed, do not pre-quote it.

schema_namestringRequiredInput only: The Unity Catalog schema name. This name is also used as the Lakebase schema name under the database. Quoting is handled by the backend where needed, do not pre-quote it.

table_name_prefixstringRequiredInput only: Prefix for Unity Catalog table name. The materialized feature will be stored in a Lakebase table with this prefix and a generated postfix.

online_store_namestringRequired: The name of the target online store.

cron_schedule_triggerobject

A cron-based schedule trigger for the materialization pipeline.

Show child attributesHide child attributes

cron_expressionstring: The cron expression defining the schedule (e.g., "0 0 * * *" for daily at midnight). The schedule is interpreted in timezone_id (defaults to UTC). Required when mode is MANUAL (or unset). Left empty when mode is DERIVED, where the service computes it (aligned to UTC) from the features' window timing and fills it in on the response.

table_triggerobject: A trigger that fires when the upstream source table changes.

streaming_modeobject

Show child attributesHide child attributes

modestring

The type of streaming mode used by the materialization pipeline.

Values:

STREAMING_MODE_TYPE_UNSPECIFIED
STREAMING_MODE_TYPE_RTM
STREAMING_MODE_TYPE_MBM

Response

Returns the MaterializedFeature object.

View as Markdown

Request

{
  "materialized_feature_id": "string",
  "feature_name": "string",
  "offline_store_config": {
    "catalog_name": "string",
    "schema_name": "string",
    "table_name_prefix": "string"
  },
  "online_store_config": {
    "catalog_name": "string",
    "schema_name": "string",
    "table_name_prefix": "string",
    "online_store_name": "string"
  },
  "cron_schedule_trigger": {
    "cron_expression": "string"
  },
  "table_trigger": {},
  "streaming_mode": {
    "mode": "STREAMING_MODE_TYPE_RTM"
  }
}

Response

{
  "materialized_feature_id": "string",
  "feature_name": "string",
  "online_store_config": {
    "online_store_name": "string"
  },
  "table_name": "string",
  "last_materialization_time": "string",
  "is_online": true,
  "cron_schedule_trigger": {
    "cron_expression": "string"
  },
  "table_trigger": {},
  "streaming_mode": {
    "mode": "STREAMING_MODE_TYPE_RTM"
  }
}

Update a materialized feature Public Preview

PATCH /api/2.0/feature-engineering/materialized-features/{materialized_feature_id}

Update a materialized feature (pause/resume).

API scopes: mlflow

Parameters

materialized_feature_idstringRequiredIDImmutablepath: Server-assigned unique identifier for the materialized feature.

update_maskstringRequiredquery: Provide the materialization feature fields which should be updated. Currently, only the pipeline_state field can be updated.

Request body

The materialized feature to update.

feature_namestringRequired: The full name of the feature in Unity Catalog.

offline_store_configobjectInput onlyImmutable

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

Show child attributesHide child attributes

catalog_namestringRequired: The Unity Catalog catalog name.

schema_namestringRequired: The Unity Catalog schema name.

table_name_prefixstringRequired: Prefix for Unity Catalog table name. The materialized feature will be stored in a table with this prefix and a generated postfix.

online_store_configobjectImmutable

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

Show child attributesHide child attributes

catalog_namestringRequiredInput only: The Unity Catalog catalog name. This name is also used as the Lakebase logical database name. Quoting is handled by the backend where needed, do not pre-quote it.

schema_namestringRequiredInput only: The Unity Catalog schema name. This name is also used as the Lakebase schema name under the database. Quoting is handled by the backend where needed, do not pre-quote it.

table_name_prefixstringRequiredInput only: Prefix for Unity Catalog table name. The materialized feature will be stored in a Lakebase table with this prefix and a generated postfix.

online_store_namestringRequired: The name of the target online store.

cron_schedule_triggerobject

A cron-based schedule trigger for the materialization pipeline.

Show child attributesHide child attributes

cron_expressionstring: The cron expression defining the schedule (e.g., "0 0 * * *" for daily at midnight). The schedule is interpreted in timezone_id (defaults to UTC). Required when mode is MANUAL (or unset). Left empty when mode is DERIVED, where the service computes it (aligned to UTC) from the features' window timing and fills it in on the response.

table_triggerobject: A trigger that fires when the upstream source table changes.

streaming_modeobject

Show child attributesHide child attributes

modestring

The type of streaming mode used by the materialization pipeline.

Values:

STREAMING_MODE_TYPE_UNSPECIFIED
STREAMING_MODE_TYPE_RTM
STREAMING_MODE_TYPE_MBM

Response

Returns the MaterializedFeature object.

View as Markdown

Request

{
  "feature_name": "string",
  "offline_store_config": {
    "catalog_name": "string",
    "schema_name": "string",
    "table_name_prefix": "string"
  },
  "online_store_config": {
    "catalog_name": "string",
    "schema_name": "string",
    "table_name_prefix": "string",
    "online_store_name": "string"
  },
  "cron_schedule_trigger": {
    "cron_expression": "string"
  },
  "table_trigger": {},
  "streaming_mode": {
    "mode": "STREAMING_MODE_TYPE_RTM"
  }
}

Response

{
  "materialized_feature_id": "string",
  "feature_name": "string",
  "online_store_config": {
    "online_store_name": "string"
  },
  "table_name": "string",
  "last_materialization_time": "string",
  "is_online": true,
  "cron_schedule_trigger": {
    "cron_expression": "string"
  },
  "table_trigger": {},
  "streaming_mode": {
    "mode": "STREAMING_MODE_TYPE_RTM"
  }
}

Delete a materialized feature Public Preview

DELETE /api/2.0/feature-engineering/materialized-features/{materialized_feature_id}

Delete a materialized feature.

API scopes: mlflow

Parameters

materialized_feature_idstringRequiredpath: The ID of the materialized feature to delete.

Batch create materialized features Public Preview

POST /api/2.0/feature-engineering/materialized-features:batchCreate

Batch create materialized features.

API scopes: mlflow

Request body

requestsarray of objectRequired

The requests to create materialized features.

Show child attributesHide child attributes

materialized_featureobjectRequired

The materialized feature to create.

Show child attributesHide child attributes

materialized_feature_idstringIDImmutable: Server-assigned unique identifier for the materialized feature.

feature_namestringRequired: The full name of the feature in Unity Catalog.

offline_store_configobjectInput onlyImmutable

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

Show child attributesHide child attributes

catalog_namestringRequired: The Unity Catalog catalog name.

schema_namestringRequired: The Unity Catalog schema name.

table_name_prefixstringRequired: Prefix for Unity Catalog table name. The materialized feature will be stored in a table with this prefix and a generated postfix.

online_store_configobjectImmutable

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

Show child attributesHide child attributes

catalog_namestringRequiredInput only: The Unity Catalog catalog name. This name is also used as the Lakebase logical database name. Quoting is handled by the backend where needed, do not pre-quote it.

schema_namestringRequiredInput only: The Unity Catalog schema name. This name is also used as the Lakebase schema name under the database. Quoting is handled by the backend where needed, do not pre-quote it.

table_name_prefixstringRequiredInput only: Prefix for Unity Catalog table name. The materialized feature will be stored in a Lakebase table with this prefix and a generated postfix.

online_store_namestringRequired: The name of the target online store.

cron_schedule_triggerobject

A cron-based schedule trigger for the materialization pipeline.

Show child attributesHide child attributes

cron_expressionstring: The cron expression defining the schedule (e.g., "0 0 * * *" for daily at midnight). The schedule is interpreted in timezone_id (defaults to UTC). Required when mode is MANUAL (or unset). Left empty when mode is DERIVED, where the service computes it (aligned to UTC) from the features' window timing and fills it in on the response.

table_triggerobject: A trigger that fires when the upstream source table changes.

streaming_modeobject

Show child attributesHide child attributes

modestring

The type of streaming mode used by the materialization pipeline.

Values:

STREAMING_MODE_TYPE_UNSPECIFIED
STREAMING_MODE_TYPE_RTM
STREAMING_MODE_TYPE_MBM

Response

Returns a list of MaterializedFeature objects.

View as Markdown

Request

{
  "requests": [
    {
      "materialized_feature": {}
    }
  ]
}

Response

{
  "materialized_features": [
    {
      "materialized_feature_id": "string",
      "feature_name": "string",
      "online_store_config": {},
      "table_name": "string",
      "last_materialization_time": "string",
      "is_online": true,
      "cron_schedule_trigger": {},
      "table_trigger": {},
      "streaming_mode": {}
    }
  ]
}