docs: Add Snowflake registry bolierplate (feast-dev#3583)

Signed-off-by: Miles Adkins <miles.adkins@snowflake.com>
zerafachris · Apr 21, 2023 · ffd50fd · ffd50fd
1 parent e2b03fd
commit ffd50fd
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 3 deletions.
diff --git 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
@@ -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).