materialized_features

Creates, updates, deletes, gets or lists a materialized_features resource.

Overview

Name	materialized_features
Type	Resource
Id	databricks_workspace.ml.materialized_features

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
key	string
value	string

list

Name	Datatype	Description
key	string
value	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	table_name, feature_name, key, deployment_name		Gets a FeatureTag.
list	select	table_name, feature_name, deployment_name	page_size, page_token	Lists FeatureTags.
create	insert	table_name, feature_name, deployment_name, feature_tag		Creates a FeatureTag.
update	update	table_name, feature_name, key, deployment_name, feature_tag	update_mask	Updates a FeatureTag.
delete	delete	table_name, feature_name, key, deployment_name		Deletes a FeatureTag.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
deployment_name	string	The Databricks Workspace Deployment Name (default: dbc-abcd0123-a1bc)
feature_name	string	The name of the feature within the feature table.
key	string	The key of the tag to delete.
table_name	string	The name of the feature table.
page_size	integer	The maximum number of results to return.
page_token	string	Pagination token to go to the next page based on a previous query.
update_mask	string	The list of fields to update.

SELECT examples

get

Gets a FeatureTag.

SELECT
key,
value
FROM databricks_workspace.ml.materialized_features
WHERE table_name = '{{ table_name }}' -- required
AND feature_name = '{{ feature_name }}' -- required
AND key = '{{ key }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
;

list

Lists FeatureTags.

SELECT
key,
value
FROM databricks_workspace.ml.materialized_features
WHERE table_name = '{{ table_name }}' -- required
AND feature_name = '{{ feature_name }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
AND page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;

INSERT examples

create

Creates a FeatureTag.

INSERT INTO databricks_workspace.ml.materialized_features (
feature_tag,
table_name,
feature_name,
deployment_name
)
SELECT 
'{{ feature_tag }}' /* required */,
'{{ table_name }}',
'{{ feature_name }}',
'{{ deployment_name }}'
RETURNING
key,
value
;

Manifest

# Description fields are for documentation purposes
- name: materialized_features
props:
  - name: table_name
    value: "{{ table_name }}"
    description: Required parameter for the materialized_features resource.
  - name: feature_name
    value: "{{ feature_name }}"
    description: Required parameter for the materialized_features resource.
  - name: deployment_name
    value: "{{ deployment_name }}"
    description: Required parameter for the materialized_features resource.
  - name: feature_tag
    description: |
      :returns: :class:`FeatureTag`
    value:
      key: "{{ key }}"
      value: "{{ value }}"

UPDATE examples

update

Updates a FeatureTag.

UPDATE databricks_workspace.ml.materialized_features
SET 
feature_tag = '{{ feature_tag }}'
WHERE 
table_name = '{{ table_name }}' --required
AND feature_name = '{{ feature_name }}' --required
AND key = '{{ key }}' --required
AND deployment_name = '{{ deployment_name }}' --required
AND feature_tag = '{{ feature_tag }}' --required
AND update_mask = '{{ update_mask}}'
RETURNING
key,
value;

DELETE examples

delete

Deletes a FeatureTag.

DELETE FROM databricks_workspace.ml.materialized_features
WHERE table_name = '{{ table_name }}' --required
AND feature_name = '{{ feature_name }}' --required
AND key = '{{ key }}' --required
AND deployment_name = '{{ deployment_name }}' --required
;