chcli man page

chcli — Issue command to data storage service (chunkd)

Synopsis

chcli [options] command [command-args]

chcli -?|--help

Description

chcli is used as a command line interface to the chunkd data storage service.

command is the name of the command corresponding to the operation chunkd should perform: get put del ping checkstatus checkstart

Options

-? --help
Shows a short help message.
-c --config
Load key=value text configuration file. This permits easy reuse and scripting of frequently used options. See Config File section for more details.
--create
When opening a table, create the specified table, if it does not already exist.
-D --debug
Set debug verbosity level. 0 == none, 2 == max verbosity.
-h --host
Set host and TCP port to which chcli should connect, for the chunkd data object service.
-i --input
Obtain value portion of a key/value pair from the specified file, rather than the command line.
-k --key
Obtain key portion of a key/value pair from the specified file, rather than the command line. Keys provided on the command line (as opposed to via -k) are stored with a C-style nul terminating character appended, adding 1 byte to each key. If the command is copy (CP), this represents the destination key.
-s --src
Obtain source-key portion of a source-key/source-value pair from the specified file, rather than the command line. Keys provided on the command line (as opposed to via -s) are stored with a C-style nul terminating character appended, adding 1 byte to each key.
--list-cmds
List all supported commands, and a short command usage synopsis.
-o --output
Send any GET output to the specified file, rather than stdout.
-S --ssl
Enable TLS/SSL channel security (default disabled).
-t --table
Retrieve and store data in the specified table's dataspace.
-u --user
Set username to USER.
-v --verbose
Enable verbose libhail output.
-V --version
Print program version, and exit.

Commands

The following commands are available:

GET key
Retrieve the data object associated with the specified key.
PUT key val
Store data object associated with the specified key.
DEL key
Delete data object associated with the specified key.
PING
Ping server
CHECKSTATUS
Fetch status of server self-check
CHECKSTART
Begin server self-check
CP dest-key src-key
Copy object represented by 'src-key' into new object referenced by 'dest-key'
Keys provided on the command line (as opposed to via -k) are stored
with a C-style nul terminating character appended, adding 1 byte to each key.

Config File

To avoid repeating commonly specified command line options such as --host or --table a key=value text configuration file facility is available.

The format of the config file is similar to .INI files, a simple
key=value text file divided into sections by [ section names surrounded by brackets ]
Our configuration file is headed by a single section, [global],
followed by zero or more of the following key=value pairs:
host=HOST:PORT
Mimics --host
table=my_table_name
Mimics --table
username=guest
Mimics --user
password=hello
Specifies password for authentication.
verbose=1
Mimics --verbose.
ssl=1
Mimics --ssl.
debug=1
Mimics --debug.

Availability

chcli is available over the Web at http://www.kernel.org/pub/software/netw…

Info

July 2010 Project Hail