[NoSQL] 【TcaplusDB知识库】表格相关操作命令

• 表创建: 支持Cloud, Docker
  
• 表删除：支持Cloud, Docker
  
• 表查询: 支持Cloud, Docker
  
• 表清理: 支持Cloud, Docker
  
• 表恢复: 支持Cloud
  
• 表扩容：支持Cloud
  
• 批量创建表: 支持Cloud
  
• 批量清理表: 支持Cloud
  
• 批量扩容表: 支持Cloud
  

Provide basic commands to operate TcaplusDB table. The basic commands includes: create, delete, recover and describe

Usage:

tcapluscli table [commands] [flags]

tcapluscli table [command]

Examples:

./tcapluscli table [create | delete | recover | describe] [flags]

Available Commands:

batchclear  Batch clear specified table data. [Cloud Env]

batchcreate Create multiple TcaplusDB tables. [Cloud Env]

batchexpand Expand multiple tables' quotas. [Cloud Env]

clear     Clear specified table data. [Cloud | Docker]

create    Create a TcaplusDB table [Cloud | Docker]

delete    Delete a TcaplusDB table. [Cloud | Docker]

describe  Get table description information. [Cloud | Docker]

expand    Expand table quotas. [Cloud Env]

recover   Recover a TcaplusDB table from Recycle. [ Cloud Env]

Flags:

-h, --help   help for table

Use "tcapluscli table [command] --help" for more information about a command.

Create a TcaplusDB table. Support  creating table in local docker env with '--endpoint-url' flag

Note: The TcaplusDB cluster and table group should be created first.  See cluster and table group command

Usage:

tcapluscli table create [flags]

Examples:

Cloud Env: ./tcapluscli table create --region=ap-shanghai --cluster-id=1234 --group-id=1 --schema-type=PROTO --schema-file=game_players.proto

Docker Env: ./tcapluscli table create --endpoint-url=http://localhost --access-id=[2|3] --group-id=1 --schema-type=TDR --schema-file=table_test.xml

Flags:

-a, --access-id string    required in docker env: available value [2|3], 2: default cluster of TDR, 3: default cluster of PROTO.

-c, --cluster-id string   required in cloud env: table cluster id

-u, --endpoint-url string   required in local docker env: local env endpoint

-g, --group-id string     required: table group id

-h, --help          help for create

-R, --rcu int         optional: table reserved Read Capacity  Units (default 80)

-r, --region string     required in cloud env:region name of table (default "ap-shanghai")

-f, --schema-file string  required: table schema file with relative path, e.g:./cfg/test.proto

-t, --schema-type string  required: table schema protocol : PROTO | TDR (default "PROTO")

-v, --volume int      optional: table reserved volume (GB) (default 1)

-W, --wcu int         optional: table reserved Write Capacity Units (default 26)

• 支持创建腾讯云＆Docker环境的单表
  
• 支持创建PROTO和TDR的单表
  
• 支持一个schema文件放多个表定义
  

Create multiple TcaplusDB tables.

Note: The TcaplusDB cluster and table group should be created first.  See cluster and table group command

Usage:

tcapluscli table batchcreate [flags]

Examples:

./tcapluscli table batchcreate --region=ap-shanghai --cluster-id=1234 --group-id=1 --schema-type=PROTO --schema-filepath=./cfg/schema

Flags:

-c, --cluster-id string    required: table cluster id

-g, --group-id string      required: table group id

-h, --help           help for batchcreate

-R, --rcu int          optional: table reserved Read Capacity  Units (default 80)

-r, --region string      required:region name of table (default "ap-shanghai")

-d, --schema-filepath string   required: file path of table schema file e.g:./cfg/schema

-t, --schema-type string     required: table schema protocol : PROTO | TDR (default "PROTO")

-v, --volume int         optional: table reserved volume (GB) (default 1)

-W, --wcu int          optional: table reserved Write Capacity Units (default 26)

Clear specfied table data.  Support clearing table data of local docker env with --endpoint-url flag.

Note: This operation is high dangerous, please be careful to execute this api to clear table data. Please double-check before operation

Usage:

tcapluscli table clear [flags]

Examples:

Cloud Env: ./tcapluscli table clear --region=ap-shanghai --cluster-id=1234 --group-id=1 --table-instance-id=tcpalus-123df12 --table-name=test

Docker Env: ./tcapluscli table clear --endpoint-url=http://localhost --access-id=[2|3] --group-id=1 --table-name=test

Flags:

-a, --access-id string       required in docker env: available value [2|3], 2: default cluster of TDR, 3: default cluster of PROTO.

-c, --cluster-id string      required in cloud env: table cluster id

-u, --endpoint-url string    required in docker env: access endpoint url of docker env

-g, --group-id string      required: table group id

-h, --help             help for clear

-r, --region string        required in cloud env: region name of table (default "ap-shanghai")

-i, --table-instance-id string   required in cloud env: tcaplusdb table instance id

-n, --table-name string      required: tcaplusdb table name

Batch clear specfied table data. If you want to clear multiple tables, the table infos should be saved in a text file, the file content should contain three fields: TableInstanceId, TableGroupId, and TableName and use comma to separate them.

Note: This operation is high dangerous, please be careful to execute this api to clear table data. Please double-check before operation

Usage:

tcapluscli table batchclear [flags]

Examples:

Cloud Env: ./tcapluscli table clear --region=ap-shanghai --cluster-id=1234 --clear-file=./data/target_table.clear

Flags:

-f, --clear-file string   required in cloud env: the clear file that contains target table infos need to be cleared.

-c, --cluster-id string   required in cloud env: table cluster id

-h, --help        help for batchclear

-r, --region string     required in cloud env: region name of table (default "ap-shanghai")

• 支持将要清理的表元数据信息放一个文件中进行批量删除，文件内容格式： TableInstanceId, TableGroupId, and TableName, 用逗号隔开这三个属性。
  

Get table description information. If table instance id and table name are empty, the 'list' flag must be indispensable  and list all table infos of table group. Support get table descriptions of local docker env with --endpoint-url flag.

Usage:

tcapluscli table describe [flags]

Examples:

Cloud Env: ./tcapluscli table describe --region=ap-shanghai --cluster-id=123 --group-id=1  --table-instance-id=tcaplus-12f397 --table-name=test

Cloud Env: ./tcapluscli  table describe --region=ap-shanghai --cluster-id=123 --group-id=1 --list

Docker Env: ./tcapluscli  table describe --endpoint-url=http://localhost --access-id=[2|3] --group-id=1 --list

Flags:

-a, --access-id string       required in docker env: available value [2|3], 2: default cluster of TDR, 3: default cluster of PROTO.

-c, --cluster-id string      required in cloud env: table cluster id

-u, --endpoint-url string    required in docker env: endpoint url of docker env

-g, --group-id string      required: table group id

-h, --help             help for describe

-l, --list             list all table infos

-r, --region string        required in cloud env : region name of table (default "ap-shanghai")

-i, --table-instance-id string   required in cloud env: tcaplusdb table instance id

-n, --table-name string      required in cloud env: tcaplusdb table name

• 支持获取指定表的描述信息，通过在命令行参数指定表实例id,表名来获取
  
• 支持获取指定group表格组下的所有表描述信息
  

Delete a TcaplusDB table. The deleted table will be removed into Recycle of TcaplusDB Console. If you want to delete the table thoroughly, you can manually delete in the Recycle of TcaplusDB Console . Support deleting table of docker env with --endpoint-url flag

Usage:

tcapluscli table delete [flags]

Examples:

Cloud Env: ./tcapluscli table delete --cluster-id=123 --group-id=1 --region=ap-shanghai --table-instance-id=tcaplus-12f397 --table-name=test

Docker Env: ./tcapluscli table delete --endpoint-url=http://localhost --access-id=[2|3] --group-id=1 --table-name=test

Flags:

-a, --access-id string       required in docker env: available value [2|3], 2: default cluster of TDR, 3: default cluster of PROTO.

-c, --cluster-id string      required in cloud env: table cluster id

-u, --endpoint-url string    required in docker env: access endpoint url of docker env

-g, --group-id string      required: table group id

-h, --help             help for delete

-r, --region string        required in cloud env:region name of table (default "ap-shanghai")

-i, --table-instance-id string   required in cloud env: tcaplusdb table instance id

-n, --table-name string      required: tcaplusdb table name

Expand the specified table quotas, including volume, rcu and wcu. Expand as default value if volume, rcu and wcu are not presented.

Usage:

tcapluscli table expand [flags]

Examples:

./tcapluscli  table expand --region=ap-shanghai --cluster-id=123 --group-id=1 --table-instance-id=tcaplus-12df --table-name=test --volume=2 --rcu=100 --wcu=100

./tcapluscli  table expand --region=ap-shanghai --cluster-id=123 --group-id=1 --table-instance-id=tcaplus-12df --table-name=test

Flags:

-c, --cluster-id string      required: table cluster id

-g, --group-id string      required: table group id

-h, --help             help for expand

-R, --rcu int          optional: table reserved Read Capacity  Units (default 80)

-r, --region string        required:region name of table (default "ap-shanghai")

-i, --table-instance-id string   required: table instance id

-n, --table-name string      required: table name

-v, --volume int         optional: table reserved volume (GB) (default 1)

-W, --wcu int          optional: table reserved Write Capacity Units (default 26)

• 支持扩容表至指定容量，如命令行参数传入volume, rcu, wcu新值即可
  
• 支持扩容表至默认容量，此时命令行不用带volume, rcu,wcu参数，默认值：volume: 1GB, rcu: 80, wcu: 26
  

Expand multiple tables' quotas. Save the target table infos into a file. The file format is as below:

[table group id], [table instance id], [table name], [volume], [rcu], [wcu].

Usage:

tcapluscli table batchexpand [flags]

Examples:

./tcapluscli table batchexpand --region=ap-shanghai --cluster-id=123 --expand-file=expand_table.txt

Flags:

-c, --cluster-id string  required: table cluster id

-f, --expand-file string   required: expand file, save the target table quotas that need to be expanded

-h, --help         help for batchexpand

-r, --region string    required:region name of table (default "ap-shanghai")

• 支持将扩容的多表信息放到一个文件中，文件内容格式如：[table group id], [table instance id], [table name], [volume], [rcu], [wcu]
  

Recover a TcaplusDB table. The deleted table  was in Recycle, call RecoverRecycleTables api to recover the deleted tables to online.

Note: This command does't support docker env

Usage:

tcapluscli table recover [flags]

Examples:

./tcapluscli  table recover --cluster-id=123 --group-id=1 --region=ap-shanghai --table-instance-id=tcaplus-12f397 --table-name=test

Flags:

-c, --cluster-id string      required: table cluster id

-g, --group-id string      required: table group id

-h, --help             help for recover

-r, --region string        required:region name of table (default "ap-shanghai")

-i, --table-instance-id string   required: tcaplusdb table instance id

-n, --table-name string      required: tcaplusdb table name

• 支持从回收站中恢复表，指定表实例id, 表名