From ffd50fd04b93f631091f433bb2c6f86c37534e21 Mon Sep 17 00:00:00 2001 From: Miles Adkins <82121043+sfc-gh-madkins@users.noreply.github.com> Date: Fri, 21 Apr 2023 09:35:22 -0700 Subject: [PATCH] docs: Add Snowflake registry bolierplate (#3583) Signed-off-by: Miles Adkins --- docs/reference/offline-stores/snowflake.md | 7 ++--- docs/reference/registry/snowflake.md | 30 ++++++++++++++++++++++ 2 files changed, 34 insertions(+), 3 deletions(-) create mode 100644 docs/reference/registry/snowflake.md diff --git a/docs/reference/offline-stores/snowflake.md b/docs/reference/offline-stores/snowflake.md index 4ac7f16436..77a144c5c4 100644 --- a/docs/reference/offline-stores/snowflake.md +++ b/docs/reference/offline-stores/snowflake.md @@ -7,7 +7,7 @@ The [Snowflake](https://trial.snowflake.com) offline store provides support for * Entity dataframes can be provided as a SQL query or can be provided as a Pandas dataframe. A Pandas dataframes will be uploaded to Snowflake as a temporary table in order to complete join operations. ## Getting started -In order to use this offline store, you'll need to run `pip install 'feast[snowflake]'`. +In order to use this offline store, you'll need to run `pip install 'feast[snowflake]'`. If you're using a file based registry, then you'll also need to install the relevant cloud extra (`pip install 'feast[snowflake, CLOUD]'` where `CLOUD` is one of `aws`, `gcp`, `azure`) @@ -25,9 +25,10 @@ offline_store: account: snowflake_deployment.us-east-1 user: user_login password: user_password - role: sysadmin - warehouse: demo_wh + role: SYSADMIN + warehouse: COMPUTE_WH database: FEAST + schema: PUBLIC ``` {% endcode %} diff --git a/docs/reference/registry/snowflake.md b/docs/reference/registry/snowflake.md new file mode 100644 index 0000000000..31b0db9582 --- /dev/null +++ b/docs/reference/registry/snowflake.md @@ -0,0 +1,30 @@ +# Snowflake registry + +## Description + +The [Snowflake](https://trial.snowflake.com) registry provides support for storing the protobuf representation of your feature store objects (data sources, feature views, feature services, etc.) Because Snowflake is an ACID compliant database, this allows for changes to individual objects atomically. + +An example of how to configure this would be: + +## Example + +{% code title="feature_store.yaml" %} +```yaml +project: my_feature_repo +provider: local +registry: + registry_type: snowflake.registry + account: snowflake_deployment.us-east-1 + user: user_login + password: user_password + role: SYSADMIN + warehouse: COMPUTE_WH + database: FEAST + schema: PUBLIC + cache_ttl_seconds: 60 +offline_store: + ... +``` +{% endcode %} + +The full set of configuration options is available in [SnowflakeRegistryConfig](https://rtd.feast.dev/en/latest/#feast.infra.registry.snowflake.SnowflakeRegistryConfig).