feast-dev · feast-ci-bot · Oct 5, 2022 · Aug 25, 2022 · Sep 5, 2022 · Sep 5, 2022
diff --git a/README.md b/README.md
@@ -173,12 +173,12 @@ The list below contains the functionality that contributors are planning to deve
   * [x] [DynamoDB](https://docs.feast.dev/reference/online-stores/dynamodb)
   * [x] [Redis](https://docs.feast.dev/reference/online-stores/redis)
   * [x] [Datastore](https://docs.feast.dev/reference/online-stores/datastore)
+  * [x] [Bigtable](https://docs.feast.dev/reference/online-stores/bigtable)
   * [x] [SQLite](https://docs.feast.dev/reference/online-stores/sqlite)
   * [x] [Azure Cache for Redis (community plugin)](https://github.com/Azure/feast-azure)
   * [x] [Postgres (contrib plugin)](https://docs.feast.dev/reference/online-stores/postgres)
+  * [x] [Cassandra / AstraDB (contrib plugin)](https://docs.feast.dev/reference/online-stores/cassandra)
   * [x] [Custom online store support](https://docs.feast.dev/how-to-guides/adding-support-for-a-new-online-store)
-  * [x] [Cassandra / AstraDB](https://docs.feast.dev/reference/online-stores/cassandra)
-  * [ ] Bigtable (in progress)
 * **Feature Engineering**
   * [x] On-demand Transformations (Alpha release. See [RFC](https://docs.google.com/document/d/1lgfIw0Drc65LpaxbUu49RCeJgMew547meSJttnUqz7c/edit#))
   * [x] Streaming Transformations (Alpha release. See [RFC](https://docs.google.com/document/d/1UzEyETHUaGpn0ap4G82DHluiCj7zEbrQLkJJkKSv4e8/edit))

@@ -92,6 +92,7 @@
   * [Redis](reference/online-stores/redis.md)
   * [Datastore](reference/online-stores/datastore.md)
   * [DynamoDB](reference/online-stores/dynamodb.md)
+  * [Bigtable](reference/online-stores/bigtable.md)
   * [PostgreSQL (contrib)](reference/online-stores/postgres.md)
   * [Cassandra + Astra DB (contrib)](reference/online-stores/cassandra.md) 
   * [MySQL (contrib)](reference/online-stores/mysql.md)

@@ -11,7 +11,7 @@ Don't see your offline store or online store of choice here? Check out our guide
 
 ## Integrations
 
-See [Functionality and Roadmap](../../#-functionality-and-roadmap)
+See [Functionality and Roadmap](../roadmap.md)
 
 ## Standards
 

@@ -26,6 +26,10 @@ Please see [Online Store](../../getting-started/architecture-and-components/onli
 [dynamodb.md](dynamodb.md)
 {% endcontent-ref %}
 
+{% content-ref url="bigtable.md" %}
+[bigtable.md](mysql.md)
+{% endcontent-ref %}
+
 {% content-ref url="postgres.md" %}
 [postgres.md](postgres.md)
 {% endcontent-ref %}

@@ -0,0 +1,56 @@
+# Bigtable online store
+
+## Description
+
+The [Bigtable](https://cloud.google.com/bigtable) online store provides support for
+materializing feature values into Cloud Bigtable. The data model used to store feature
+values in Bigtable is described in more detail
+[here](../../specs/online_store_format.md#google-bigtable-online-store-format).
+
+## Getting started
+
+In order to use this online store, you'll need to run `pip install 'feast[gcp]'`. You
+can then get started with the command `feast init REPO_NAME -t gcp`.
+
+## Example
+
+{% code title="feature_store.yaml" %}
+```yaml
+project: my_feature_repo
+registry: data/registry.db
+provider: gcp
+online_store:
+  type: bigtable
+  project_id: my_gcp_project
+  instance: my_bigtable_instance
+```
+{% endcode %}
+
+The full set of configuration options is available in
+[BigtableOnlineStoreConfig](https://rtd.feast.dev/en/latest/#feast.infra.online_stores.bigtable.BigtableOnlineStoreConfig).
+
+## Functionality Matrix
+
+The set of functionality supported by online stores is described in detail [here](overview.md#functionality).
+Below is a matrix indicating which functionality is supported by the Bigtable online store.
+
+|                                                           | Bigtable |
+|-----------------------------------------------------------|----------|
+| write feature values to the online store                  | yes      |
+| read feature values from the online store                 | yes      |
+| update infrastructure (e.g. tables) in the online store   | yes      |
+| teardown infrastructure (e.g. tables) in the online store | yes      |
+| generate a plan of infrastructure changes                 | no       |
+| support for on-demand transforms                          | yes      |
+| readable by Python SDK                                    | yes      |
+| readable by Java                                          | no       |
+| readable by Go                                            | no       |
+| support for entityless feature views                      | yes      |
+| support for concurrent writing to the same key            | yes      |
+| support for ttl (time to live) at retrieval               | no       |
+| support for deleting expired data                         | no       |
+| collocated by feature view                                | yes      |
+| collocated by feature service                             | no       |
+| collocated by entity key                                  | yes      |
+
+To compare this set of functionality against other online stores, please see the full [functionality matrix](overview.md#functionality-matrix).
@@ -31,12 +31,12 @@ The list below contains the functionality that contributors are planning to deve
   * [x] [DynamoDB](https://docs.feast.dev/reference/online-stores/dynamodb)
   * [x] [Redis](https://docs.feast.dev/reference/online-stores/redis)
   * [x] [Datastore](https://docs.feast.dev/reference/online-stores/datastore)
+  * [x] [Bigtable](https://docs.feast.dev/reference/online-stores/bigtable)
   * [x] [SQLite](https://docs.feast.dev/reference/online-stores/sqlite)
   * [x] [Azure Cache for Redis (community plugin)](https://github.com/Azure/feast-azure)
   * [x] [Postgres (contrib plugin)](https://docs.feast.dev/reference/online-stores/postgres)
+  * [x] [Cassandra / AstraDB (contrib plugin)](https://docs.feast.dev/reference/online-stores/cassandra)
   * [x] [Custom online store support](https://docs.feast.dev/how-to-guides/adding-support-for-a-new-online-store)
-  * [x] [Cassandra / AstraDB](https://docs.feast.dev/reference/online-stores/cassandra)
-  * [ ] Bigtable (in progress)
 * **Feature Engineering**
   * [x] On-demand Transformations (Alpha release. See [RFC](https://docs.google.com/document/d/1lgfIw0Drc65LpaxbUu49RCeJgMew547meSJttnUqz7c/edit#))
   * [x] Streaming Transformations (Alpha release. See [RFC](https://docs.google.com/document/d/1UzEyETHUaGpn0ap4G82DHluiCj7zEbrQLkJJkKSv4e8/edit))

@@ -92,6 +92,29 @@ Other types of entity keys are not supported in this version of the specificatio
 
 ![Datastore Online Example](datastore_online_example.png)
 
+## Google Bigtable Online Store Format
+
+[Bigtable storage model](https://cloud.google.com/bigtable/docs/overview#storage-model)
+consists of massively scalable tables, with each row keyed by a "row key". The rows in a
+table are stored lexicographically sorted by this row key.
+
+We use the following structure to store feature data in Bigtable:
+
+* All feature data for an entity or a specific group of entities is stored in the same
+  table. The table name is derived by concatenating the lexicographically sorted names
+  of entities.
+* This implementation only uses one column family per table, named `features`.
+* Each row key is created by concatenating a hash derived from the specific entity keys
+  and the name of the feature view. Each row only stores feature values for a specific
+  feature view. This arrangement also means that feature values for a given group of
+  entities are colocated.
+* The columns used in each row are named after the features in the feature view.
+  Bigtable is perfectly content being sparsely populated.
+* By default, we store 1 historical value of each feature value. This can be configured
+  using the `max_versions` setting in `BigtableOnlineStoreConfig`. This implementation
+  of the online store does not have the ability to revert any given value to its old
+  self. To use the historical version, you'll have to use custom code.
+
 ## Cassandra/Astra DB Online Store Format
 
 ### Overview
@@ -250,4 +273,4 @@ message BoolList {
   repeated bool val = 1;
 }
 
-```
+```