Skip to content

Commit a912bc1

Browse files
committed
Update docs for Store.proto
1 parent 143360b commit a912bc1

File tree

1 file changed

+20
-4
lines changed

1 file changed

+20
-4
lines changed

protos/feast/core/Store.proto

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -48,15 +48,31 @@ message Store {
4848

4949
// BigQuery stores a FeatureRow element as a row in a BigQuery table.
5050
//
51-
// Table name is derived from the feature set name and version. For example
52-
// a feature row for feature set "driver" and version "1" will be written
53-
// to table "driver_1".
51+
// Table name is derived from the feature set name and version as:
52+
// [feature_set_name]_v[feature_set_version]
53+
//
54+
// For example:
55+
// A feature row for feature set "driver" and version "1" will be written
56+
// to table "driver_v1".
5457
//
5558
// The entities and features in a FeatureSetSpec corresponds to the
5659
// fields in the BigQuery table (these make up the BigQuery schema).
5760
// The name of the entity spec and feature spec corresponds to the column
5861
// names, and the value_type of entity spec and feature spec corresponds
59-
// to BigQuery standard SQL data type of the column.
62+
// to BigQuery standard SQL data type of the column.
63+
//
64+
// The following BigQuery fields are reserved for Feast internal use.
65+
// Ingestion of entity or feature spec with names identical
66+
// to the following field names will raise an exception during ingestion.
67+
//
68+
// column_name | column_data_type | description
69+
// ====================|==================|================================
70+
// - event_timestamp | TIMESTAMP | event time of the FeatureRow
71+
// - created_timestamp | TIMESTAMP | processing time of the ingestion of the FeatureRow
72+
// - job_id | STRING | identifier for the job that writes the FeatureRow to the corresponding BigQuery table
73+
//
74+
// BigQuery table created will be partitioned by the event_timestamp field
75+
// of the FeatureRow (https://cloud.google.com/bigquery/docs/partitioned-tables).
6076
//
6177
// Since newer version of feature set can introduce breaking, non backward-
6278
// compatible BigQuery schema updates, incrementing the version of a

0 commit comments

Comments
 (0)