1CHCLI(8)                    System Manager's Manual                   CHCLI(8)
2
3
4

NAME

6       chcli - Issue command to data storage service (chunkd)
7

SYNOPSIS

9       chcli [options] command [command-args]
10
11       chcli -?|--help
12

DESCRIPTION

14       chcli  is  used  as a command line interface to the chunkd data storage
15       service.
16
17       command is the name of  the  command  corresponding  to  the  operation
18       chunkd should perform: get put del ping checkstatus checkstart
19
20

OPTIONS

22       -? --help
23              Shows a short help message.
24
25       -c --config
26              Load key=value text configuration file.  This permits easy reuse
27              and scripting of frequently used options.  See CONFIG FILE  sec‐
28              tion for more details.
29
30       --create
31              When opening a table, create the specified table, if it does not
32              already exist.
33
34       -D --debug
35              Set debug verbosity level.  0 == none, 2 == max verbosity.
36
37       -h --host
38              Set host and TCP port to which chcli  should  connect,  for  the
39              chunkd data object service.
40
41       -i --input
42              Obtain  value  portion  of  a  key/value pair from the specified
43              file, rather than the command line.
44
45       -k --key
46              Obtain key portion of a key/value pair from the specified  file,
47              rather than the command line.  Keys provided on the command line
48              (as opposed to via -k) are stored with a C-style nul terminating
49              character  appended,  adding 1 byte to each key.  If the command
50              is copy (CP), this represents the destination key.
51
52       -s --src
53              Obtain source-key portion of a source-key/source-value pair from
54              the specified file, rather than the command line.  Keys provided
55              on the command line (as opposed to via -s) are stored with a  C-
56              style  nul terminating character appended, adding 1 byte to each
57              key.
58
59       --list-cmds
60              List all supported commands, and a short command usage synopsis.
61
62       -o --output
63              Send any GET output to the specified file, rather than stdout.
64
65       -S --ssl
66              Enable TLS/SSL channel security (default disabled).
67
68       -t --table
69              Retrieve and store data in the specified table's dataspace.
70
71       -u --user
72              Set username to USER.
73
74       -v --verbose
75              Enable verbose libhail output.
76
77       -V --version
78              Print program version, and exit.
79

COMMANDS

81       The following commands are available:
82
83       GET key
84              Retrieve the data object associated with the specified key.
85
86       PUT key val
87              Store data object associated with the specified key.
88
89       DEL key
90              Delete data object associated with the specified key.
91
92       PING   Ping server
93
94       CHECKSTATUS
95              Fetch status of server self-check
96
97       CHECKSTART
98              Begin server self-check
99
100       CP dest-key src-key
101              Copy object represented by 'src-key' into new object  referenced
102              by 'dest-key'
103
104       Keys provided on the command line (as opposed to via -k) are stored
105              with a C-style nul terminating character appended, adding 1 byte
106              to each key.
107

CONFIG FILE

109       To avoid repeating commonly specified  command  line  options  such  as
110       --host  or  --table  a  key=value  text  configuration file facility is
111       available.
112
113       The format of the config file is similar to .INI files, a simple
114              key=value text file divided into sections  by  [  section  names
115              surrounded by brackets ]
116
117       Our configuration file is headed by a single section, [global],
118              followed by zero or more of the following key=value pairs:
119
120       host=HOST:PORT
121              Mimics --host
122
123       table=my_table_name
124              Mimics --table
125
126       username=guest
127              Mimics --user
128
129       password=hello
130              Specifies password for authentication.
131
132       verbose=1
133              Mimics --verbose.
134
135       ssl=1  Mimics --ssl.
136
137       debug=1
138              Mimics --debug.
139

AVAILABILITY

141       chcli  is  available  over  the  Web at http://www.kernel.org/pub/soft‐
142       ware/network/distsrv/hail/
143
144
145
146
147Project Hail                       July 2010                          CHCLI(8)