Bigtable Basics
This skill provides core workflows and guidance for administering and developing
with Google Bigtable.
Core Principles
- Control Plane vs. Data Plane:
- Use
gcloud for Control Plane operations: Manage Instances,
Clusters, App Profiles, Backups and IAM. Create Tables, Logical Views,
Materialized Views and Authorized Views.
- Use
cbt for Data Plane operations: Update Tables, Column Families,
and reading/writing data.
- Performance First: Bigtable is a NoSQL database. Efficiency is tied to
Row Key design. Always warn about Full Table Scans.
- Client Selection: For production use cases, prefer Java or Go
for their superior performance and feature coverage compared to other
languages.
- Observability: When diagnosing performance or hotspotting, always
mention Key Visualizer (via Cloud Console) as the primary diagnostic
tool because it provides the most granular view of access patterns across
row keys. This should be followed by the hot-tablets tool and table stats
in gcloud CLI and
include-stats=full option under cbt read to diagnose
slow queries.
[!IMPORTANT] Safety Rule: You MUST obtain explicit user confirmation before
making non-emulator database changes. You MUST mention this safety requirement
when providing commands or instructions that modify the database structure or
data.
Quick Recipes
1. Querying Data
Use SQL for complex transforms or aggregations and key-value APIs for simpler
query patterns. Note: Use exact match, prefix (_key LIKE 'myprefix%'), or
range predicates on _key to avoid expensive unbounded scans. Recommend
explicit row ranges (_key BETWEEN 'start' AND 'end') as a more performant
alternative to prefix matches where possible.
If expensive scans (either unbounded or prefix or range queries scanning a large
range) are unavoidable due to multiple access patterns that can’t all be
accommodated in a single schema, consider one of these two options:
- If the query will be used in user facing and/or latency sensitive
applications, use continuous materialized views with keys optimized for the
additional access patterns.
- If secondary access patterns are infrequent, batch patterns like ETL, ML
model training or analytical read-only tasks, use Bigtable Data Boost
instead.
2. Manipulating Data
Use key-value APIs for insert, update, increment and delete operations. SQL API
is read-only.
3. Data Model Definition (DDL)
SQL API doesn't support DDL operations. Table creation, deletion, updates should
be made using gcloud CLI. Logical Views and Continuous Materialized Views are
defined as SQL queries but they must be created using gcloud CLI.
Reference Guides
- CLI Operations:
- infrastructure_management.md:
Provisioning instances, clusters, and table schemas.
- cli_data_access.md: Reading and writing
data via the
cbt CLI.
- Design & Discovery:
- schema_design.md: Best practices for row
keys and performance with tables and continuous materialized views.
- dataplex.md: Data catalog search for Bigtable
assets.
- Querying & Code:
- sql_guide.md: Querying structured row keys
via SQL and CLI.
- client_libraries.md: Patterns for
high-performance Go/Java/Python code.
Common Workflows
Schema Evolution (DevOps)
Prefer Terraform for production schema changes to prevent accidental
data loss.
For manual cbt changes, first check the existing state by listing the table's column families and GC policies before proposing any modifications:
cbt ls {table}
If modifications are needed, create the family or update the GC policy:
cbt createfamily {table} {family}
cbt setgcpolicy {table} {family} "maxversions=5 AND maxage=30d"
Reference
infrastructure_management.md for
full syntax.
External Resources
1---2name: bigtable-basics3description: Assists in provisioning instances/tables, designing performant schemas, and querying data in Bigtable. Use when designing Bigtable row keys, configuring column families, writing SQL queries or client library code (Java, Go, Python) for Bigtable, or diagnosing performance/hotspotting issues. Also use when provisioning Bigtable clusters using gcloud or cbt CLIs. Don't use for generic Cloud SQL administration.4---56# Bigtable Basics78This skill provides core workflows and guidance for administering and developing9with Google Bigtable.1011## Core Principles1213- **Control Plane vs. Data Plane:**14 - Use **`gcloud`** for Control Plane operations: Manage Instances,15 Clusters, App Profiles, Backups and IAM. Create Tables, Logical Views,16 Materialized Views and Authorized Views.17 - Use **`cbt`** for Data Plane operations: Update Tables, Column Families,18 and reading/writing data.19- **Performance First:** Bigtable is a NoSQL database. Efficiency is tied to20 Row Key design. Always warn about Full Table Scans.21- **Client Selection:** For production use cases, prefer **Java** or **Go**22 for their superior performance and feature coverage compared to other23 languages.24- **Observability:** When diagnosing performance or hotspotting, **always**25 mention **Key Visualizer** (via Cloud Console) as the primary diagnostic26 tool because it provides the most granular view of access patterns across27 row keys. This should be followed by the hot-tablets tool and table stats28 in gcloud CLI and `include-stats=full` option under `cbt read` to diagnose29 slow queries.3031> [!IMPORTANT] **Safety Rule:** You MUST obtain explicit user confirmation before32> making non-emulator database changes. You MUST mention this safety requirement33> when providing commands or instructions that modify the database structure or34> data.3536## Quick Recipes3738### 1. Querying Data3940Use SQL for complex transforms or aggregations and key-value APIs for simpler41query patterns. *Note: Use exact match, prefix (`_key LIKE 'myprefix%'`), or42range predicates on `_key` to avoid expensive unbounded scans. Recommend43explicit row ranges (`_key BETWEEN 'start' AND 'end'`) as a more performant44alternative to prefix matches where possible.*4546If expensive scans (either unbounded or prefix or range queries scanning a large47range) are unavoidable due to multiple access patterns that can’t all be48accommodated in a single schema, consider one of these two options:4950- If the query will be used in user facing and/or latency sensitive51 applications, use continuous materialized views with keys optimized for the52 additional access patterns.53- If secondary access patterns are infrequent, batch patterns like ETL, ML54 model training or analytical read-only tasks, use Bigtable Data Boost55 instead.5657### 2. Manipulating Data5859Use key-value APIs for insert, update, increment and delete operations. SQL API60is read-only.6162### 3. Data Model Definition (DDL)6364SQL API doesn't support DDL operations. Table creation, deletion, updates should65be made using gcloud CLI. Logical Views and Continuous Materialized Views are66defined as SQL queries but they must be created using gcloud CLI.6768## Reference Guides6970- **CLI Operations**:71 - [infrastructure_management.md](references/infrastructure_management.md):72 Provisioning instances, clusters, and table schemas.73 - [cli_data_access.md](references/cli_data_access.md): Reading and writing74 data via the `cbt` CLI.75- **Design & Discovery**:76 - [schema_design.md](references/schema_design.md): Best practices for row77 keys and performance with tables and continuous materialized views.78 - [dataplex.md](references/dataplex.md): Data catalog search for Bigtable79 assets.80- **Querying & Code**:81 - [sql_guide.md](references/sql_guide.md): Querying structured row keys82 via SQL and CLI.83 - [client_libraries.md](references/client_libraries.md): Patterns for84 high-performance Go/Java/Python code.8586## Common Workflows8788### Schema Evolution (DevOps)89901. **Prefer Terraform** for production schema changes to prevent accidental91 data loss.922. For manual `cbt` changes, first check the existing state by listing the table's column families and GC policies before proposing any modifications:9394 ```bash95 cbt ls {table}96 ```9798 If modifications are needed, create the family or update the GC policy:99100 ```bash101 cbt createfamily {table} {family}102 cbt setgcpolicy {table} {family} "maxversions=5 AND maxage=30d"103 ```1041053. Reference106 [infrastructure_management.md](references/infrastructure_management.md) for107 full syntax.108109## External Resources110111* [Cloud Bigtable Documentation](https://cloud.google.com/bigtable/docs)112* [Bigtable SQL Reference](https://cloud.google.com/bigtable/docs/reference/sql)113* [cbt CLI Reference](https://cloud.google.com/bigtable/docs/cbt-reference)114* [gcloud bigtable Reference](https://cloud.google.com/sdk/gcloud/reference/bigtable)