Get desktop application:
View/edit binary Protocol Buffers messages
Used in:
Defines a Data Source that can be used source Feature data Next available id: 28
Used as response type in: registry.RegistryServer.GetDataSource
Used as field type in:
, , , , , , , ,Unique name of data source within the project
Name of Feast project that this data source belongs to.
Defines mapping between fields in the sourced data and fields in parent FeatureTable.
Must specify event timestamp column name
(Optional) Specify partition column useful for file sources
Must specify creation timestamp column name
This is an internal field that is represents the python class for the data source object a proto object represents. This should be set by feast, and not by users. The field is used primarily by custom data sources and is mandatory for them to set. Feast may set it for first party sources as well.
Optional batch source for streaming sources for historical features and materialization.
DataSource options.
Defines options for DataSource that sources features from a Athena Query
Used in:
,Athena table name
SQL query that returns a table containing feature data. Must contain an event_timestamp column, and respective entity columns
Athena database name
Athena schema name
Defines options for DataSource that sources features from a BigQuery Query
Used in:
,Full table reference in the form of [project:dataset.table]
SQL query that returns a table containing feature data. Must contain an event_timestamp column, and respective entity columns
Defines configuration for custom third-party data sources.
Used in:
,Serialized configuration information for the data source. The implementer of the custom data source is responsible for serializing and deserializing data from bytes
Defines options for DataSource that sources features from a file
Used in:
,Target URL of file to retrieve and source features from. s3://path/to/file for AWS S3 storage gs://path/to/file for GCP GCS storage file:///path/to/file for local storage
override AWS S3 storage endpoint with custom S3 endpoint
Defines options for DataSource that sources features from Kafka messages. Each message should be a Protobuf that can be decoded with the generated Java Protobuf class at the given class path
Used in:
Comma separated list of Kafka bootstrap servers. Used for feature tables without a defined source host[:port]]
Kafka topic to collect feature data from.
Defines the stream data format encoding feature/entity data in Kafka messages.
Watermark delay threshold for stream data
Defines options for DataSource that sources features from Kinesis records. Each record should be a Protobuf that can be decoded with the generated Java Protobuf class at the given class path
Used in:
AWS region of the Kinesis stream
Name of the Kinesis stream to obtain feature data from.
Defines the data format encoding the feature/entity data in Kinesis records. Kinesis Data Sources support Avro and Proto as data formats.
Defines options for DataSource that supports pushing data to it. This allows data to be pushed to the online store on-demand, such as by stream consumers.
Used in:
(message has no fields)
Defines options for DataSource that sources features from a Redshift Query
Used in:
,Redshift table name
SQL query that returns a table containing feature data. Must contain an event_timestamp column, and respective entity columns
Redshift schema name
Redshift database name
Defines options for DataSource that sources features from request data
Used in:
Mapping of feature name to type
Defines options for DataSource that sources features from a Snowflake Query
Used in:
,Snowflake table name
SQL query that returns a table containing feature data. Must contain an event_timestamp column, and respective entity columns
Snowflake schema name
Snowflake schema name
Used in:
Type of Data Source. Next available id: 12
Used in:
Defines options for DataSource that sources features from a spark table/query
Used in:
,Table name
Spark SQl query that returns the table, this is an alternative to `table`
Path from which spark can read the table, this is an alternative to `table`
Format of files at `path` (e.g. parquet, avro, etc)
Date Format of date partition column (e.g. %Y-%m-%d)
Defines options for DataSource that sources features from a Trino Query
Used in:
,Full table reference in the form of [project:dataset.table]
SQL query that returns a table containing feature data. Must contain an event_timestamp column, and respective entity columns
Represents a Datastore table
Used in:
Feast project of the table
Name of the table
GCP project id
Datastore namespace
Firestore database
Represents a DynamoDB table
Used in:
Name of the table
Region of the table
Used as response type in: registry.RegistryServer.GetEntity
Used as field type in:
, , ,User-specified specifications of this entity.
System-populated metadata for this entity.
Used in:
Used in:
Name of the entity.
Name of Feast project that this feature table belongs to.
Type of the entity.
Description of the entity.
Join key for the entity (i.e. name of the column the entity maps to).
User defined metadata
Owner of the entity.
Used as response type in: registry.RegistryServer.GetFeatureService
Used as field type in:
, , ,User-specified specifications of this feature service.
System-populated metadata for this feature service.
Used in:
Time where this Feature Service is created
Time where this Feature Service is last updated
Used in:
Name of the Feature Service. Must be unique. Not updated.
Name of Feast project that this Feature Service belongs to.
Represents a projection that's to be applied on top of the FeatureView. Contains data such as the features to use from a FeatureView.
User defined metadata
Description of the feature service.
Owner of the feature service.
(optional) if provided logging will be enabled for this feature service.
Used in:
, , , , ,Name of the feature. Not updatable.
Value type of the feature. Not updatable.
Tags for user defined metadata on a feature
Description of the feature.
Field indicating the vector will be indexed for vector similarity search
Metric used for vector similarity search.
Field indicating the vector length
Used in:
User-specified specifications of this feature table.
System-populated metadata for this feature table.
Used in:
Time where this Feature Table is created
Time where this Feature Table is last updated
Auto incrementing revision no. of this Feature Table
Hash entities, features, batch_source and stream_source to inform JobService if jobs should be restarted should hash change
Used in:
Name of the feature table. Must be unique. Not updated.
Name of Feast project that this feature table belongs to.
List names of entities to associate with the Features defined in this Feature Table. Not updatable.
List of features specifications for each feature defined with this feature table.
User defined metadata
Features in this feature table can only be retrieved from online serving younger than max age. Age is measured as the duration of time between the feature's event timestamp and when the feature is retrieved Feature values outside max age will be returned as unset values and indicated to end user
Batch/Offline DataSource to source batch/offline feature data. Only batch DataSource can be specified (ie source type should start with 'BATCH_')
Stream/Online DataSource to source stream/online feature data. Only stream DataSource can be specified (ie source type should start with 'STREAM_')
A feature transformation executed as a user-defined function
Used in:
,Used as response type in: registry.RegistryServer.GetFeatureView
Used as field type in:
, , , , , ,User-specified specifications of this feature view.
System-populated metadata for this feature view.
Used in:
,Time where this Feature View is created
Time where this Feature View is last updated
List of pairs (start_time, end_time) for which this feature view has been materialized.
A projection to be applied on top of a FeatureView. Contains the modifications to a FeatureView such as the features subset to use.
Used in:
,The feature view name
Alias for feature view name
The features of the feature view that are a part of the feature reference.
Map for entity join_key overrides of feature data entity join_key to entity data join_key
Batch/Offline DataSource where this view can retrieve offline feature data.
Streaming DataSource from where this view can consume "online" feature data.
Next available id: 13 TODO(adchia): refactor common fields from this and ODFV into separate metadata proto
Used in:
Name of the feature view. Must be unique. Not updated.
Name of Feast project that this feature view belongs to.
List of names of entities associated with this feature view.
List of specifications for each feature defined as part of this feature view.
List of specifications for each entity defined as part of this feature view.
Description of the feature view.
User defined metadata
Owner of the feature view.
Features in this feature view can only be retrieved from online serving younger than ttl. Ttl is measured as the duration of time between the feature's event timestamp and when the feature is retrieved Feature values outside ttl will be returned as unset values and indicated to end user
Batch/Offline DataSource where this view can retrieve offline feature data.
Streaming DataSource from where this view can consume "online" feature data.
Whether these features should be served online or not This is also used to determine whether the features should be written to the online store
Whether these features should be written to the offline store
Defines the file format encoding the features/entity data in files
Used in:
Defines options for delta data format
Used in:
(message has no fields)
Defines options for the Parquet data format
Used in:
(message has no fields)
Used in:
JSON-serialized ExpectationSuite object
Used in:
Used in:
The python-syntax function body (serialized by dill)
Represents a set of infrastructure objects managed by Feast
Used as response type in: registry.RegistryServer.GetInfra
Used as field type in:
,List of infrastructure objects managed by Feast
Represents a single infrastructure object managed by Feast
Used in:
Represents the Python class for the infrastructure object
The infrastructure object
Allows for custom infra objects to be added
Used in:
Used in:
Used in:
Destination table name. data_source and database will be taken from an offline store config
Used in:
Full table reference in the form of [project:dataset.table]
Used in:
Destination database name
Destination scope name
Destination collection name
Used in:
Used in:
column names to use for partitioning
Used in:
Destination table name. ClusterId and database will be taken from an offline store config
Used in:
Destination table name. Schema and database will be taken from an offline store config
Used in:
Used as response type in: registry.RegistryServer.GetOnDemandFeatureView
Used as field type in:
, , , ,User-specified specifications of this feature view.
Used in:
Time where this Feature View is created
Time where this Feature View is last updated
Next available id: 9
Used in:
Name of the feature view. Must be unique. Not updated.
Name of Feast project that this feature view belongs to.
List of features specifications for each feature defined with this feature view.
Map of sources for this feature view.
Oneof with {user_defined_function, on_demand_substrait_transformation}
Description of the on demand feature view.
User defined metadata.
Owner of the on demand feature view.
List of names of entities associated with this feature view.
List of specifications for each entity defined as part of this feature view.
Used in:
Used as response type in: registry.RegistryServer.GetPermission
Used as field type in:
, ,User-specified specifications of this permission.
System-populated metadata for this permission.
Used in:
Used in:
Name of the permission. Must be unique. Not updated.
Name of Feast project.
List of actions.
the policy.
User defined metadata
Used in:
Used in:
Used in:
Name of the policy.
Name of Feast project.
Used as response type in: registry.RegistryServer.GetProject
Used as field type in:
, ,User-specified specifications of this entity.
System-populated metadata for this entity.
Used in:
Time when the Project is created
Time when the Project is last updated with registry changes (Apply stage)
Used in:
,Used in:
Name of the Project
Description of the Project
User defined metadata
Owner of the Project
Next id: 18
Used as response type in: registry.RegistryServer.Proto
Tracking metadata of Feast by project
to support migrations; incremented when schema is changed
version id, random string generated on each update of the data; now used only for debugging purposes
Used in:
List of roles in this policy.
Used as response type in: registry.RegistryServer.GetSavedDataset
Used as field type in:
, ,Used in:
Time when this saved dataset is created
Time when this saved dataset is last updated
Min timestamp in the dataset (needed for retrieval)
Max timestamp in the dataset (needed for retrieval)
Used in:
Name of the dataset. Must be unique since it's possible to overwrite dataset by name
Name of Feast project that this Dataset belongs to.
list of feature references with format "<view name>:<feature name>"
entity columns + request columns from all feature views used during retrieval
Whether full feature names are used in stored data
Optional and only populated if generated from a feature service fetch
User defined metadata
Used in:
Represents a Sqlite table
Used in:
Absolute path of the table
Name of the table
Store provides a location where Feast reads and writes feature values. Feature values will be written to the Store in the form of FeatureRow elements. The way FeatureRow is encoded and decoded when it is written to and read from the Store depends on the type of the Store.
Name of the store.
Type of store.
Feature sets to subscribe to.
Configuration to connect to the store. Required.
Used in:
List of Redis Uri for all the nodes in Redis Cluster, comma separated. Eg. host1:6379, host2:6379
Optional. How often flush data to redis
Optional. Append a prefix to the Redis Key
Optional. Enable fallback to another key prefix if the original key is not present. Useful for migrating key prefix without re-ingestion. Disabled by default.
Optional. This would be the fallback prefix to use if enable_fallback is true.
Optional. Priority of nodes when reading from cluster
Used in:
Used in:
Optional. The number of milliseconds to wait before retrying failed Redis connection. By default, Feast uses exponential backoff policy and "initial_backoff_ms" sets the initial wait duration.
Optional. Maximum total number of retries for connecting to Redis. Default to zero retries.
Optional. How often flush data to redis
Optional. Connect over SSL.
Used in:
Redis stores a FeatureRow element as a key, value pair. The Redis data types used (https://redis.io/topics/data-types): - key: STRING - value: STRING Encodings: - key: byte array of RedisKey (refer to feast.storage.RedisKeyV2) - value: Redis hashmap
Used in:
Name of project that the feature sets belongs to. This can be one of - [project_name] - * If an asterisk is provided, filtering on projects will be disabled. All projects will be matched. It is NOT possible to provide an asterisk with a string in order to do pattern matching.
Name of the desired feature set. Asterisks can be used as wildcards in the name. Matching on names is only permitted if a specific project is defined. It is disallowed If the project name is set to "*" e.g. - * can be used to match all feature sets - my-feature-set* can be used to match all features prefixed by "my-feature-set" - my-feature-set-6 can be used to select a single feature set
All matches with exclude enabled will be filtered out instead of added
Used as response type in: registry.RegistryServer.GetStreamFeatureView
Used as field type in:
, , ,User-specified specifications of this feature view.
Next available id: 17
Used in:
Name of the feature view. Must be unique. Not updated.
Name of Feast project that this feature view belongs to.
List of names of entities associated with this feature view.
List of specifications for each feature defined as part of this feature view.
List of specifications for each entity defined as part of this feature view.
Description of the feature view.
User defined metadata
Owner of the feature view.
Features in this feature view can only be retrieved from online serving younger than ttl. Ttl is measured as the duration of time between the feature's event timestamp and when the feature is retrieved Feature values outside ttl will be returned as unset values and indicated to end user
Batch/Offline DataSource where this view can retrieve offline feature data.
Streaming DataSource from where this view can consume "online" feature data.
Whether these features should be served online or not
Serialized function that is encoded in the streamfeatureview
Mode of execution
Aggregation definitions
Timestamp field for aggregation
Oneof with {user_defined_function, on_demand_substrait_transformation}
Defines the data format encoding features/entity data in data streams
Used in:
,Specifies the data format and format specific options
Defines options for the avro data format
Used in:
Optional if used in a File DataSource as schema is embedded in avro file. Specifies the schema of the Avro message as JSON string.
Used in:
Defines options for the protobuf data format
Used in:
Classpath to the generated Java Protobuf class that can be used to decode Feature data from the obtained stream message
Used in:
Serialized representation of python function.
Used in:
,The function name
The python-syntax function body (serialized by dill)
The string representation of the udf
Serialized representation of python function.
Used in:
The function name
The python-syntax function body (serialized by dill)
The string representation of the udf
Used as response type in: registry.RegistryServer.GetValidationReference
Used as field type in:
, ,Unique name of validation reference within the project
Name of saved dataset used as reference dataset
Name of Feast project that this object source belongs to
Description of the validation reference
User defined metadata
validation profiler
(optional) cached validation profile (to avoid constant recalculation)