Skip to content

docs: Add metadata info for feature_store.yaml #5455

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
franciscojavierarceo merged 1 commit into from
Jun 15, 2025
Merged

docs: Add metadata info for feature_store.yaml #5455

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/reference/registries/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

Please see [Registry](../../getting-started/components/registry.md) for a conceptual explanation of registries.

{% content-ref url="metadata.md" %}
[metadata.md](metadata.md)
{% endcontent-ref %}

{% content-ref url="local.md" %}
[local.md](local.md)
{% endcontent-ref %}
Expand Down
29 changes: 29 additions & 0 deletions docs/reference/registries/metadata.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Metadata info of feature_store.yaml

## Description

The metadata info of Feast `feature_store.yaml` is:

| Key | Required | Value Type |Definition |
| ------------------------|---------------------|------------------------|------------------------|
| project | Y | string | name of the project |
| provider | N | string | |
| registry | Y | NA | definition of registry |
| registry.path | Y | string | URI of storing registry data |
| registry.cache_ttl_seconds | N | integer | |
| registry.registry_type | N | string | type of registry server |
| registry.sqlalchemy_config_kwargs | N | NA | kwargs configuration for sql registry server|
| registry.account | N | string | cloud account type |
| registry.user | N | string | cloud login account |
| registry.password | N | string | cloud login password |
| registry.role | N | string | cloud login account role |
| registry.warehouse | N | string | snowflake warehouse name |
| registry.database | N | string | snowflake db name |
| registry.schema | N | string | snowflake schema name |
| online_store | Y | | |
| offline_store | Y | NA | | |
| offline_store.type | Y | string | storage type |
| entity_key_serialization_version | N | string | |
| feature_server | N | NA | config of feature server |
| feature_server.transformation_service_endpoint | N | string | python transformation server endpoint for Go feature server |