1CEPH-KVSTORE-TOOL(8)                 Ceph                 CEPH-KVSTORE-TOOL(8)
2
3
4

NAME

6       ceph-kvstore-tool - ceph kvstore manipulation tool
7

SYNOPSIS

9       ceph-kvstore-tool <leveldb|rocksdb|bluestore-kv> <store path> command [args...]
10
11

DESCRIPTION

13       ceph-kvstore-tool  is  a  kvstore manipulation tool. It allows users to
14       manipule leveldb/rocksdb's data (like OSD's omap) offline.
15

COMMANDS

17       ceph-kvstore-tool utility uses  many  commands  for  debugging  purpose
18       which are as follows:
19
20       list [prefix]
21              Print key of all KV pairs stored with the URL encoded prefix.
22
23       list-crc [prefix]
24              Print CRC of all KV pairs stored with the URL encoded prefix.
25
26       exists <prefix> [key]
27              Check  if  there is any KV pair stored with the URL encoded pre‐
28              fix. If key is also specified, check for the key with the prefix
29              instead.
30
31       get <prefix> <key> [out <file>]
32              Get  the value of the KV pair stored with the URL encoded prefix
33              and key.  If file is also specified,  write  the  value  to  the
34              file.
35
36       crc <prefix> <key>
37              Get  the  CRC  of the KV pair stored with the URL encoded prefix
38              and key.
39
40       get-size [<prefix> <key>]
41              Get estimated store size or size of value  specified  by  prefix
42              and key.
43
44       set <prefix> <key> [ver <N>|in <file>]
45              Set  the value of the KV pair stored with the URL encoded prefix
46              and key.  The value could be version_t or text.
47
48       rm <prefix> <key>
49              Remove the KV pair stored with the URL encoded prefix and key.
50
51       rm-prefix <prefix>
52              Remove all KV pairs stored with the URL encoded prefix.
53
54       store-copy <path> [num-keys-per-tx]
55              Copy all KV  pairs  to  another  directory  specified  by  path.
56              [num-keys-per-tx]  is the number of KV pairs copied for a trans‐
57              action.
58
59       store-crc <path>
60              Store CRC of all KV pairs to a file specified by path.
61
62       compact
63              Subcommand compact is used to compact all data  of  kvstore.  It
64              will  open  the  database,  and trigger a database's compaction.
65              After compaction, some disk space may be released.
66
67       compact-prefix <prefix>
68              Compact all entries specified by the URL encoded prefix.
69
70       compact-range <prefix> <start> <end>
71              Compact some entries specified by the  URL  encoded  prefix  and
72              range.
73

AVAILABILITY

75       ceph-kvstore-tool  is  part of Ceph, a massively scalable, open-source,
76       distributed storage system. Please refer to the Ceph  documentation  at
77       http://ceph.com/docs for more information.
78

SEE ALSO

80       ceph(8)
81

83       2010-2014,  Inktank Storage, Inc. and contributors. Licensed under Cre‐
84       ative Commons Attribution Share Alike 3.0 (CC-BY-SA-3.0)
85
86
87
88
89dev                              Apr 14, 2019             CEPH-KVSTORE-TOOL(8)
Impressum