Skip to content

Storage Connector#

Storage connectors encapsulate all information needed for the execution engine to read and write to specific storage. This storage can be S3, a JDBC compliant database or the distributed filesystem HOPSFS.

Retrieval#

[source]

get_storage_connector#

FeatureStore.get_storage_connector(name)

Get a previously created storage connector from the feature store.

Storage connectors encapsulate all information needed for the execution engine to read and write to specific storage. This storage can be S3, a JDBC compliant database or the distributed filesystem HOPSFS.

If you want to connect to the online feature store, see the get_online_storage_connector method to get the JDBC connector for the Online Feature Store.

Getting a Storage Connector

sc = fs.get_storage_connector("demo_fs_meb10000_Training_Datasets")

td = fs.create_training_dataset(..., storage_connector=sc, ...)

Arguments

  • name str: Name of the storage connector to retrieve.

Returns

StorageConnector. Storage connector object.


[source]

get_online_storage_connector#

FeatureStore.get_online_storage_connector()

Get the storage connector for the Online Feature Store of the respective project's feature store.

The returned storage connector depends on the project that you are connected to.

Returns

StorageConnector. JDBC storage connector to the Online Feature Store.


Properties#

[source]

access_key#

Access key.


[source]

account#

Account of the Snowflake storage connector


[source]

account_name#

Account name of the ADLS storage connector


[source]

application_id#

Application ID of the ADLS storage connector


[source]

arguments#

Additional JDBC, REDSHIFT, or Snowflake arguments.


[source]

auto_create#

Database username for redshift cluster.


[source]

bucket#

Return the bucket for S3 connectors.


[source]

cluster_identifier#

Cluster identifier for redshift cluster.


[source]

connection_string#

JDBC connection string.


[source]

connector_type#

Type of the connector. S3, JDBC, REDSHIFT or HOPSFS.


[source]

container_name#

Container name of the ADLS storage connector


[source]

database#

Database of the Snowflake storage connector


[source]

database_driver#

Database endpoint for redshift cluster.


[source]

database_endpoint#

Database endpoint for redshift cluster.


[source]

database_group#

Database username for redshift cluster.


[source]

database_name#

Database name for redshift cluster.


[source]

database_password#

Database password for redshift cluster.


[source]

database_port#

Database port for redshift cluster.


[source]

database_user_name#

Database username for redshift cluster.


[source]

directory_id#

Directory ID of the ADLS storage connector


[source]

expiration#

Cluster temporary credential expiration time.


[source]

generation#

Generation of the ADLS storage connector


[source]

iam_role#

IAM role.


[source]

id#

Id of the storage connector uniquely identifying it in the Feature store.


[source]

password#

Password of the Snowflake storage connector


[source]

path#

If the connector refers to a path (e.g. S3) - return the path of the connector


[source]

role#

Role of the Snowflake storage connector


[source]

schema#

Schema of the Snowflake storage connector


[source]

secret_key#

Secret key.


[source]

server_encryption_algorithm#

Encryption algorithm if server-side S3 bucket encryption is enabled.


[source]

server_encryption_key#

Encryption key if server-side S3 bucket encryption is enabled.


[source]

service_credential#

Service credential of the ADLS storage connector


[source]

session_token#

Session token.


[source]

sf_options#

Additional options for the Snowflake storage connector


[source]

table#

Table of the Snowflake storage connector


[source]

table_name#

Table name for redshift cluster.


[source]

token#

OAuth token of the Snowflake storage connector


[source]

url#

URL of the Snowflake storage connector


[source]

user#

User of the Snowflake storage connector


[source]

warehouse#

Warehouse of the Snowflake storage connector


Methods#

[source]

snowflake_connector_options#

StorageConnector.snowflake_connector_options()

[source]

spark_options#

StorageConnector.spark_options()

Return prepared options to be passed to Spark, based on the additional arguments.


[source]

to_dict#

StorageConnector.to_dict()