bigtable-basics

---
name: bigtable-basics
description: >-
  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.
metadata:
  version: v1
  publisher: google
  category: Databases
license: Apache-2.0
---

# 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 & DDL operations: Manage Instances,
        Clusters, App Profiles, Backups, and IAM. Manage schemas: Create,
        update, and delete Tables, Column Families, Logical Views,
        Materialized Views, and Authorized Views.
    -   Use **`cbt`** for Data Plane operations: Reading, writing, and
        inspecting 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](references/infrastructure_management.md):
        Provisioning instances, clusters, and table schemas.
    -   [cli_data_access.md](references/cli_data_access.md): Reading and writing
        data via the `cbt` CLI.
-   **Design & Discovery**:
    -   [schema_design.md](references/schema_design.md): Best practices for row
        keys and performance with tables and continuous materialized views.
    -   [dataplex.md](references/dataplex.md): Data catalog search for Bigtable
        assets.
-   **Querying & Code**:
    -   [sql_guide.md](references/sql_guide.md): Querying structured row keys
        via SQL and CLI.
    -   [client_libraries.md](references/client_libraries.md): Patterns for
        high-performance Go/Java/Python code.

## Common Workflows

### Schema Evolution (DevOps)

1.  **Prefer Terraform** for production schema changes to prevent accidental
    data loss.
2.  For manual `cbt` changes, first check the existing state by listing the table's column families and GC policies before proposing any modifications:

    ```bash
    cbt ls {table}
    ```

    If modifications are needed, create the family or update the GC policy:

    ```bash
    cbt createfamily {table} {family}
    cbt setgcpolicy {table} {family} "maxversions=5 AND maxage=30d"
    ```

3.  Reference
    [infrastructure_management.md](references/infrastructure_management.md) for
    full syntax.

## External Resources

*   [Cloud Bigtable Documentation](https://cloud.google.com/bigtable/docs)
*   [Bigtable SQL Reference](https://cloud.google.com/bigtable/docs/reference/sql)
*   [cbt CLI Reference](https://cloud.google.com/bigtable/docs/cbt-reference)
*   [gcloud bigtable Reference](https://cloud.google.com/sdk/gcloud/reference/bigtable)

From googlecloudplatform/data-agent-kit-plugin at 0dd8034, shown as plain text under its license: Apache-2.0 (permissive). The license text is in skills/bigtable-basics/SKILL.md.

• SKILL.md5.2 KB · 0a67c6d4d16f
• assets/
• row_key_schema.yaml781 B · 89cde1a37789
• references/
• cli_data_access.md1.6 KB · 99824f9a6850
• client_libraries.md2.3 KB · 74243c6400a0
• dataplex.md911 B · a7fe80e70dac
• infrastructure_management.md3.5 KB · 035aa015d127
• schema_design.md8.0 KB · b46bedbe0bb9
• sql_guide.md7.5 KB · 621cb233486a

8 files, 30 KB in total. Each file has a sha256 in the pin's manifest; the first 12 characters are shown.