cbt

Documentation

Overview

Cbt is a tool for doing basic interactions with Cloud Bigtable. To learn how to install the cbt tool, see the [cbt overview](https://cloud.google.com/bigtable/docs/go/cbt-overview).

Usage:

cbt [options] command [arguments]

The commands are:

count                     Count rows in a table
createinstance            Create an instance with an initial cluster
createcluster             Create a cluster in the configured instance
createfamily              Create a column family
createtable               Create a table
updatecluster             Update a cluster in the configured instance
deleteinstance            Delete an instance
deletecluster             Delete a cluster from the configured instance
deletecolumn              Delete all cells in a column
deletefamily              Delete a column family
deleterow                 Delete a row
deletetable               Delete a table
doc                       Print godoc-suitable documentation for cbt
help                      Print help text
listinstances             List instances in a project
listclusters              List clusters in an instance
lookup                    Read from a single row
ls                        List tables and column families
mddoc                     Print documentation for cbt in Markdown format
read                      Read rows
set                       Set value of a cell
setgcpolicy               Set the GC policy for a column family
waitforreplication        Block until all the completed writes have been replicated to all the clusters
createtablefromsnapshot   Create a table from a snapshot (snapshots alpha)
createsnapshot            Create a snapshot from a source table (snapshots alpha)
listsnapshots             List snapshots in a cluster (snapshots alpha)
getsnapshot               Get snapshot info (snapshots alpha)
deletesnapshot            Delete snapshot in a cluster (snapshots alpha)
version                   Print the current cbt version
createappprofile          Creates app profile for an instance
getappprofile             Reads app profile for an instance
listappprofile            Lists app profile for an instance
updateappprofile          Updates app profile for an instance
deleteappprofile          Deletes app profile for an instance

Use "cbt help <command>" for more information about a command.

The options are:

-project string
	project ID, if unset uses gcloud configured project
-instance string
	Cloud Bigtable instance
-creds string
	if set, use application credentials in this file

Alpha features are not currently available to most Cloud Bigtable customers. The features might be changed in backward-incompatible ways and are not recommended for production use. They are not subject to any SLA or deprecation policy.

For convenience, values of the -project, -instance, -creds, -admin-endpoint and -data-endpoint flags may be specified in ~/.cbtrc in this format:

project = my-project-123
instance = my-instance
creds = path-to-account-key.json
admin-endpoint = hostname:port
data-endpoint = hostname:port

All values are optional, and all will be overridden by flags.

Count rows in a table

Usage:

cbt count <table>

Create an instance with an initial cluster

Usage:

cbt createinstance <instance-id> <display-name> <cluster-id> <zone> <num-nodes> <storage type>
  instance-id					Permanent, unique id for the instance
  display-name	  			Description of the instance
  cluster-id						Permanent, unique id for the cluster in the instance
  zone				  				The zone in which to create the cluster
  num-nodes	  				The number of nodes to create
  storage-type					SSD or HDD

Create a cluster in the configured instance

Usage:

cbt createcluster <cluster-id> <zone> <num-nodes> <storage type>
  cluster-id		Permanent, unique id for the cluster in the instance
  zone				  The zone in which to create the cluster
  num-nodes	  The number of nodes to create
  storage-type	SSD or HDD

Create a column family

Usage:

cbt createfamily <table> <family>

Create a table

Usage:

cbt createtable <table> [families=family[:(maxage=<d> | maxversions=<n>)],...] [splits=split,...]
  families: Column families and their associated GC policies. See "setgcpolicy".
  					 Example: families=family1:maxage=1w,family2:maxversions=1
  splits:   Row key to be used to initially split the table

Update a cluster in the configured instance

Usage:

cbt updatecluster <cluster-id> [num-nodes=num-nodes]
  cluster-id		Permanent, unique id for the cluster in the instance
  num-nodes		The number of nodes to update to

Delete an instance

Usage:

cbt deleteinstance <instance>

Delete a cluster from the configured instance

Usage:

cbt deletecluster <cluster>

Delete all cells in a column

Usage:

cbt deletecolumn <table> <row> <family> <column> [app-profile=<app profile id>]
  app-profile=<app profile id>		The app profile id to use for the request

Delete a column family

Usage:

cbt deletefamily <table> <family>

Delete a row

Usage:

cbt deleterow <table> <row> [app-profile=<app profile id>]
  app-profile=<app profile id>		The app profile id to use for the request

Delete a table

Usage:

cbt deletetable <table>

Print godoc-suitable documentation for cbt

Usage:

cbt doc

Print help text

Usage:

cbt help [command]

List instances in a project

Usage:

cbt listinstances

List clusters in an instance

Usage:

cbt listclusters

Read from a single row

Usage:

cbt lookup <table> <row> [columns=[family]:[qualifier],...] [cells-per-column=<n>] [app-profile=<app profile id>]
  columns=[family]:[qualifier],...	Read only these columns, comma-separated
  cells-per-column=<n> 			Read only this many cells per column
  app-profile=<app profile id>		The app profile id to use for the request

List tables and column families

Usage:

cbt ls			List tables
cbt ls <table>		List column families in <table>

Print documentation for cbt in Markdown format

Usage:

cbt mddoc

Read rows

Usage:

cbt read <table> [start=<row>] [end=<row>] [prefix=<prefix>] [regex=<regex>] [columns=[family]:[qualifier],...] [count=<n>] [cells-per-column=<n>] [app-profile=<app profile id>]
  start=<row>				Start reading at this row
  end=<row>				Stop reading before this row
  prefix=<prefix>			Read rows with this prefix
  regex=<regex> 			Read rows with keys matching this regex
  columns=[family]:[qualifier],...	Read only these columns, comma-separated
  count=<n>				Read only this many rows
  cells-per-column=<n>			Read only this many cells per column
  app-profile=<app profile id>		The app profile id to use for the request

Set value of a cell

Usage:

cbt set <table> <row> [app-profile=<app profile id>] family:column=val[@ts] ...
  app-profile=<app profile id>		The app profile id to use for the request
  family:column=val[@ts] may be repeated to set multiple cells.

  ts is an optional integer timestamp.
  If it cannot be parsed, the `@ts` part will be
  interpreted as part of the value.

Set the GC policy for a column family

Usage:

cbt setgcpolicy <table> <family> ( maxage=<d> | maxversions=<n> | never)

  maxage=<d>		Maximum timestamp age to preserve (e.g. "1h", "4d")
  maxversions=<n>	Maximum number of versions to preserve

Block until all the completed writes have been replicated to all the clusters

Usage:

cbt waitforreplication <table>

Create a table from a snapshot (snapshots alpha)

Usage:

cbt createtablefromsnapshot <table> <cluster> <snapshot>
  table	The name of the table to create
  cluster	The cluster where the snapshot is located
  snapshot	The snapshot to restore

Create a snapshot from a source table (snapshots alpha)

Usage:

cbt createsnapshot <cluster> <snapshot> <table> [ttl=<d>]

  [ttl=<d>]		Lifespan of the snapshot (e.g. "1h", "4d")

List snapshots in a cluster (snapshots alpha)

Usage:

cbt listsnapshots [<cluster>]

Get snapshot info (snapshots alpha)

Usage:

cbt getsnapshot <cluster> <snapshot>

Delete snapshot in a cluster (snapshots alpha)

Usage:

cbt deletesnapshot <cluster> <snapshot>

Print the current cbt version

Usage:

cbt version

Creates app profile for an instance

Usage:

cbt createappprofile <instance-id> <profile-id> <description> <etag> <routing-policy>
[cluster-id=<cluster-id>] [allow-transactional-writes=<allow-transactional-writes>]
set multi_cluster_routing_use_any or single_cluster_routing as possible values for routing policy
provide cluster-id=clusterID and allow-transactional-writes=true or false in case of single_cluster_routing

Reads app profile for an instance

Usage:

cbt getappprofile <instance-id> <profile-id>

Lists app profile for an instance

Usage:

cbt listappprofile <instance-id>

Updates app profile for an instance

Usage:

cbt updateappprofile  <instance-id> <profile-id> <description> <routing-policy>[cluster-id=<cluster-id>] [allow-transactional-writes=<allow-transactional-writes>]
set multi_cluster_routing_use_any or single_cluster_routing as possible values for routing policy
provide cluster-id=clusterID and allow-transactional-writes=true or false in case of single_cluster_routing

Deletes app profile for an instance

Usage:

cbt deleteappprofile <instance-id> <profile-id>