Azure CosmosDB Online Store Spec

class databricks.feature_store.online_store_spec.azure_cosmosdb_online_store_spec.AzureCosmosDBSpec(*, account_uri: str, database_name: Optional[str] = None, container_name: Optional[str] = None, read_secret_prefix: Optional[str] = None, write_secret_prefix: str)

Bases: databricks.feature_store.online_store_spec.online_store_spec.OnlineStoreSpec

This OnlineStoreSpec implementation is intended for publishing features to Azure Cosmos DB.

If database_name and container_name are not provided, FeatureStoreClient.publish_table will use the offline store’s database and table name as the Cosmos DB database and container name.

The expected read or write secret for Cosmos DB for a given {prefix} string is ${prefix}-authorization-key.

The authorization key can be either the Cosmos DB account primary or secondary key.

Note

Available starting with Databricks Runtime 11.1 for ML.

Parameters

  • account_uri – URI of the Cosmos DB account.

  • database_name – Database name.

  • container_name – Container name.

  • read_secret_prefix – Prefix for read secret.

  • write_secret_prefix – Prefix for write secret.

Methods

auth_type()

Publish Auth type.

Properties

account_uri

Account URI of the online store.

database_name

Database name.

container_name

Container name.

cloud

Define the cloud property for the data store.

store_type

Define the data store type.

auth_type()

Publish Auth type.

clone(**kwargs)

Clone a feature spec.

non_secret_properties()

TODO (ML-21692): Determine if this function is required and update for use if necessary.

Dictionary of non-secret properties.

property account_uri

Account URI of the online store.

property container_name

Container name.

property database_name

Database name.

property driver

Name of the custom JDBC driver to access the online store.

property password

Password to access the online store.

Property will be empty if write_scret_prefix argument was used.

property read_secret_prefix

Prefix for read access to online store.

Name of the secret scope and prefix that contains the username and password to access the online store with read-only credentials.

See the read_secret_prefix parameter description for details.

property table_name

Table name.

property type

Type of the online store.

property user

Username that has access to the online store.

Property will be empty if write_scret_prefix argument was used.

property write_secret_prefix

Secret prefix that contains online store login info.

Name of the secret scope and prefix that contains the username and password to access the online store with read/write credentials. See the write_secret_prefix parameter description for details.