// Copyright 2016 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. // DO NOT EDIT. THIS IS AUTOMATICALLY GENERATED. // Run "go generate" to regenerate. //go:generate go run cbt.go gcpolicy.go -o cbtdoc.go doc /* 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/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 " 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. Note: cbt does not support specifying arbitrary bytes on the command line for any value that Bigtable otherwise supports (e.g., row key, column qualifier, etc.). 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 Create an instance with an initial cluster Usage: cbt createinstance 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 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
Create a table Usage: cbt createtable
[families=family[:gcpolicy],...] [splits=split,...] families: Column families and their associated GC policies. For gcpolicy, 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 [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 Delete a cluster from the configured instance Usage: cbt deletecluster Delete all cells in a column Usage: cbt deletecolumn
[app-profile=] app-profile= The app profile id to use for the request Delete a column family Usage: cbt deletefamily
Delete a row Usage: cbt deleterow
[app-profile=] app-profile= The app profile id to use for the request Delete a table Usage: cbt deletetable
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
[columns=[family]:[qualifier],...] [cells-per-column=] [app-profile=] columns=[family]:[qualifier],... Read only these columns, comma-separated cells-per-column= Read only this many cells per column app-profile= The app profile id to use for the request List tables and column families Usage: cbt ls List tables cbt ls
List column families in
Print documentation for cbt in Markdown format Usage: cbt mddoc Read rows Usage: cbt read
[start=] [end=] [prefix=] [regex=] [columns=[family]:[qualifier],...] [count=] [cells-per-column=] [app-profile=] start= Start reading at this row end= Stop reading before this row prefix= Read rows with this prefix regex= Read rows with keys matching this regex columns=[family]:[qualifier],... Read only these columns, comma-separated count= Read only this many rows cells-per-column= Read only this many cells per column app-profile= The app profile id to use for the request Set value of a cell Usage: cbt set
[app-profile=] family:column=val[@ts] ... app-profile= 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
((maxage= | maxversions=) [(and|or) (maxage= | maxversions=),...] | never) maxage= Maximum timestamp age to preserve (e.g. "1h", "4d") maxversions= Maximum number of versions to preserve Block until all the completed writes have been replicated to all the clusters Usage: cbt waitforreplication
Create a table from a snapshot (snapshots alpha) Usage: cbt createtablefromsnapshot
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
[ttl=] [ttl=] Lifespan of the snapshot (e.g. "1h", "4d") List snapshots in a cluster (snapshots alpha) Usage: cbt listsnapshots [] Get snapshot info (snapshots alpha) Usage: cbt getsnapshot Delete snapshot in a cluster (snapshots alpha) Usage: cbt deletesnapshot Print the current cbt version Usage: cbt version Creates app profile for an instance Usage: usage: cbt createappprofile (route-any | [ route-to= : transactional-writes]) [optional flag] optional flags may be `force` Reads app profile for an instance Usage: cbt getappprofile Lists app profile for an instance Usage: cbt listappprofile Updates app profile for an instance Usage: usage: cbt updateappprofile (route-any | [ route-to= : transactional-writes]) [optional flag] optional flags may be `force` Deletes app profile for an instance Usage: cbt deleteappprofile */ package main