The ultimate CLI tool for TiKV, for human being :).
(Only support Transaction KV API now)
>>> help
Commands:
.stores list tikv stores in cluster
backup backup <prefix> <outfile> <opts>, opts: type=csv batch-size=1000(default) concurrent=1, example: backup * outfile
bench bench [type] config1=value1 config2=value2 ...
type: ycsb
clear clear the screen
count count [*|key prefix], count all keys or keys with specific prefix
del delete a single kv pair, usage: del(delete/rm/remove) [key]
delall remove all key-value pairs, DANGEROUS
delp delete kv pairs with specific prefix, usage: delp(deletep/rmp) keyPrefix [opts]
echo echo $<varname>
env print env variables
exit exit the program
get get [key]
head scan keys from $head, equals to "scan $head limit=N", usage: head <limit>
help display help
hexdump hexdump <string>
loadcsv loadfile [filename] [key prefix] [opts], only supports CSV now, when "key prefix" is set, will automatically add prefix to the original key,
opts:
batch-size: int, how many records in one tikv transaction, default: 1000
put put [key] [value]
scan Scan key-value pairs in range, usage: scan [start key] [opts]
opt format: key1=value1,key2=value2,key3=value3,
scan options:
limit: integer, default:100
key-only: true(1)|false(0)
strict-prefix: true(1)|false(0)
count-only: true(1)|false(0)
scanp scan keys with prefix, equals to "scan [key prefix] strict-prefix=true"
sysenv print system env variables
var set variables, usage:
var <varname>=<string value>, variable name and value are both string
example: scan $varname or get $varname
Have a try:
- Install
tiup
curl --proto '=https' --tlsv1.2 -sSf https://tiup-mirrors.pingcap.com/install.sh | sh
- Deploy TiKV using
tiup
tiup playground --mode tikv-slim
- Launch
tcli
$ tcli -pd localhost:2379
/
%#######%
.#################
##########################*
############# *############%
(########### ###############
(######( ################### Welcome, TiKV Cluster ID: 7022523378280680532
(###### (######### ######
(###### #% (###### ######
(###### %####% (###### ###### https://tikv.org
(############% (###### ###### https://pingcap.com
(############% (###### ######
(############% (###### ######
(############% (###### .#########
#############, (##################(
/############# (##############.
####################%
%###########(
/###,
2021/10/24 14:57:19 main.go:98: I | pd instance info: name:"pd-0" member_id:3474484975246189105 peer_urls:"http://127.0.0.1:2380" client_urls:"http://127.0.0.1:2379"
2021/10/24 14:57:19 main.go:105: I | tikv instance info: store_id:"1" version:"5.2.1" addr:"127.0.0.1:20160" state:"Up" status_addr:"127.0.0.1:20180"
>>>
- Have a try:
>>> put hello world
Input: put hello world
Success, Elapse: 33 ms
>>> get hello
Input: get hello
|-------|-------|
| KEY | VALUE |
|-------|-------|
| hello | world |
|-------|-------|
1 Record Found
Success, Elapse: 8 ms
>>> put hello_world world
Input: put hello_world world
Success, Elapse: 7 ms
>>> scanp hello
Input: scanp hello
|-------------|-------|
| KEY | VALUE |
|-------------|-------|
| hello | world |
| hello_world | world |
|-------------|-------|
2 Records Found
Success, Elapse: 5 ms