aidentity / index

google/skills · Apache-2.0

bigtable-basics

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.

cloud stable

Contents

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](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.

  1. 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"
    

  1. Reference

[infrastructure_management.md](references/infrastructure_management.md) for

full syntax.

External Resources

Provenance

Authored by Google LLC in google/skills. The content is mirrored here under its upstream license.

Related

agent-platform-alert-configuration Configures best-practice alerting policies for AI agents using OpenTelemetry (OTel) metrics, generating output as Terraform (.tf) configuration files. Use when analyzing, writing, or deploying alerting policies to monitor agent latency, error rates, token usage, and quality metrics. Don't use for standard infrastructure monitoring unrelated to AI agents, or when the agent is not instrumented with OpenTelemetry (for Reliability, Cost, Safety, Security alerts). NOTE: Reliability, Cost, Safety, and Security alerts use generic OTel metrics and work across runtimes (such as Cloud Run, Vertex AI). Quality alerts rely on Vertex AI Online Monitors and are strictly bound to Vertex AI deployments. google/skills Apache-2.0 agent-platform-deploy Deploy open models or custom weights from Model Garden to Agent Platform endpoints, check the status of an in-progress deployment operation, or clean up resources by undeploying models and deleting endpoints. Use when asked to actively deploy a model, list the Model Garden CATALOG of available models, check if a specific model is deployable (`gcloud ai model-garden models list-deployment-config`), query deployment cost, troubleshoot deployment errors (like quota limits), or undeploy/clean up endpoints. Also use when copying and deploying a 1P Tuned Model. Don't use for pure listing/discovery questions of the form "is X deployed?", "list my endpoints", or "which regions have models running?" — for those use `agent-platform-endpoint-management`. Don't use for public Vertex AI deployments (use the `vertex-deploy` skill) or for running model evaluations (use the `agent-platform-eval-flywheel` skill). google/skills Apache-2.0 agent-platform-endpoint-management Manages Agent Platform serving endpoints. Use when you need to create, list, describe, update, or delete serving endpoints for model deployment on Agent Platform. Also use when troubleshooting endpoint permission, quota, or resource busy errors. Don't use for deploying models to endpoints or for running model evaluations. google/skills Apache-2.0 agent-platform-eval-flywheel Measures and improves the quality of AI models and agents on Google Cloud using the Eval Quality Flywheel methodology. Use when evaluating an agent or model, building an eval dataset, picking or writing evaluation metrics, analyzing failures, comparing results before and after a fix, or when guidance is needed on Agent Platform eval methodology — including dataset schema, LLM-as-judge scoring, and common failure causes. For fine-tuning, use agent-platform-tuning. For general production deployment, use agent-platform-deploy. google/skills Apache-2.0 agent-platform-inference Connects to and performs inference with Google Cloud Agent Platform GenAI models, including First-Party Gemini models and Third-Party OpenMaaS models (Llama, DeepSeek, Qwen, etc.). Use when asked to perform inference, ask a model a question, run a test prompt, execute chat completions, or generate code for calling Gemini or OpenMaaS models, authenticate with GenAI SDK, OpenAI SDK, or legacy Agent Platform SDK, configure base URLs and global/regional endpoints, or troubleshoot 429 Resource Exhausted (DSQ), 400 User Validation, or 404 Not Found errors. Don't use for deploying models to endpoints or for running model evaluations. google/skills Apache-2.0