agentleFS
Google CloudKnown publisherGoogleCloudPlatform/data-agent-kit-plugin/skills/bigtable-basics/SKILL.md

bigtable-basics

Skill240 starsChanged 5 months agoApache-2.0View on GitHub

Provisions instances and tables, designs performant schemas, and queries 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.

3 other projects use a version of this, 3 of them edited.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

9 rules. 6 are common, 0 are distinctive, and 3 are very specific to this project.

  • 6

    Common

    Most of the 3 edited versions we read keep these.

  • 0

    Distinctive

    This author's own choices. Worth a look.

  • 3

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Use gcloud for Control Plane & DDL operations: Manage Instances, Clusters, App Profiles, Backups, and IAM.

    line 20
  2. Very specific:

    Use cbt for Data Plane operations: Reading, writing, and inspecting data.

    line 24
  3. Common:

    Observability: When diagnosing performance or hotspotting, always mention Key Visualizer (via Cloud Console) as the primary diagnostic tool …

    line 31
  4. Very specific:

    Use SQL for complex transforms or aggregations and key-value APIs for simpler query patterns.

    line 47
  5. Common:

    If expensive scans (either unbounded or prefix or range queries scanning a large range) are unavoidable due to multiple access patterns …

    line 53
  6. Common:

    If the query will be used in user facing and/or latency sensitive applications, use continuous materialized views with keys optimized for …

    line 57
  7. Common:

    If secondary access patterns are infrequent, batch patterns like ETL, ML model training or analytical read-only tasks, use Bigtable Data …

    line 60
  8. Common:

    Use key-value APIs for insert, update, increment and delete operations.

    line 66
  9. Common:

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

    line 105

“Common” is measured: kept by at least 6 in 10 of the 3 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

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: 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)

  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:

    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"
  3. Reference infrastructure_management.md for full syntax.

External Resources

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

Reviews can't be read right now.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.