Home

Launch flags

flag	default	description
mode	txn	TiKV API mode; choose between Raw and Transactional API with raw and txn
pd	127.0.0.1:2379	TiKV placement driver node address
log-file	/dev/null	TiKV client log file
log-level	info	TiKV client log level

Commands

command	arguments	description
.stores		list tikv stores in cluster
backup	[prefix] [outfile] opts	back up tikv data to a specified file
bench	[type]	benchmark client performance with test of type y/c/s/b
clear		clear output
count	[*|prefix]	count all keys, or those with the specified prefix
del delete rm remove	[key]	delete a single kv pair
delall		remove all key-value pairs (DANGEROUS)
delp deletep rmp	opts	delete key-value pairs with specific prefix
echo	$[varname]	print environment variable
env	$[varname]	print all environment variables
exit		exit program
get	[key]	get a key-value pair
head	[limit]	scan entries in lexicographic order, up to limit entries
help		displays help
hexdump	[string]	print hex dump of string
loadcsv	[filename] [key_prefix] opts	loads CSV file; if key prefix is set, automatically adds prefix to original key. opts:batch-size specifies max number of entries per transaction
put	[key] [value]	puts a key-value pair
scan	[start key] opts	scan key-value pairs. opts: limit: integer, default:100 key-only: true(1)
scanp	[prefix]	scan keys with prefix; equivalent to scan key_prefix strict-prefix=True
sysenv		print system environment variables
var	[name]=[value]	set an envrionment variable. Value must be formatted as a string