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       manipulate 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       dump [prefix]
27              Print  key and value of all KV pairs stored with the URL encoded
28              prefix.
29
30       exists <prefix> [key]
31              Check if there is any KV pair stored with the URL  encoded  pre‐
32              fix. If key is also specified, check for the key with the prefix
33              instead.
34
35       get <prefix> <key> [out <file>]
36              Get the value of the KV pair stored with the URL encoded  prefix
37              and  key.   If  file  is  also specified, write the value to the
38              file.
39
40       crc <prefix> <key>
41              Get the CRC of the KV pair stored with the  URL  encoded  prefix
42              and key.
43
44       get-size [<prefix> <key>]
45              Get  estimated  store  size or size of value specified by prefix
46              and key.
47
48       set <prefix> <key> [ver <N>|in <file>]
49              Set the value of the KV pair stored with the URL encoded  prefix
50              and key.  The value could be version_t or text.
51
52       rm <prefix> <key>
53              Remove the KV pair stored with the URL encoded prefix and key.
54
55       rm-prefix <prefix>
56              Remove all KV pairs stored with the URL encoded prefix.
57
58       store-copy <path> [num-keys-per-tx]
59              Copy  all  KV  pairs  to  another  directory  specified by path.
60              [num-keys-per-tx] is the number of KV pairs copied for a  trans‐
61              action.
62
63       store-crc <path>
64              Store CRC of all KV pairs to a file specified by path.
65
66       compact
67              Subcommand  compact  is  used to compact all data of kvstore. It
68              will open the database, and trigger a database's compaction. Af‐
69              ter compaction, some disk space may be released.
70
71       compact-prefix <prefix>
72              Compact all entries specified by the URL encoded prefix.
73
74       compact-range <prefix> <start> <end>
75              Compact  some  entries  specified  by the URL encoded prefix and
76              range.
77
78       destructive-repair
79              Make a (potentially destructive) effort to recover  a  corrupted
80              database.   Note that in the case of rocksdb this may corrupt an
81              otherwise uncorrupted database--use this only as a last resort!
82
83       stats  Prints statistics from underlying key-value  database.  This  is
84              only  for  informative purposes.  Format and information content
85              may vary between releases. For RocksDB information includes com‐
86              pactions  stats, performance counters, memory usage and internal
87              RocksDB stats.
88
89       histogram
90              Presents key-value sizes distribution statistics from the under‐
91              lying KV database.
92

AVAILABILITY

94       ceph-kvstore-tool  is  part of Ceph, a massively scalable, open-source,
95       distributed storage system. Please refer to the Ceph  documentation  at
96       https://docs.ceph.com for more information.
97

SEE ALSO

99       ceph(8)
100

102       2010-2023,  Inktank Storage, Inc. and contributors. Licensed under Cre‐
103       ative Commons Attribution Share Alike 3.0 (CC-BY-SA-3.0)
104
105
106
107
108dev                              Nov 15, 2023             CEPH-KVSTORE-TOOL(8)
Impressum