|
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425 |
- // 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 <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.
-
- 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 <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[: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 <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>) [(and|or) (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:
- usage: cbt createappprofile <instance-id> <profile-id> <description> (route-any | [ route-to=<cluster-id> : transactional-writes]) [optional flag]
- optional flags may be `force`
-
-
-
-
- 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:
- usage: cbt updateappprofile <instance-id> <profile-id> <description>(route-any | [ route-to=<cluster-id> : transactional-writes]) [optional flag]
- optional flags may be `force`
-
-
-
-
- Deletes app profile for an instance
-
- Usage:
- cbt deleteappprofile <instance-id> <profile-id>
-
-
-
-
- */
- package main
|