.\" Man page generated from reStructuredText.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "CEPH-KVSTORE-TOOL" "8" "Mar 10, 2024" "dev" "Ceph"
.SH NAME
ceph-kvstore-tool \- ceph kvstore manipulation tool
.SH SYNOPSIS
.nf
\fBceph\-kvstore\-tool\fP <leveldb|rocksdb|bluestore\-kv> <store path> \fIcommand\fP [args...]
.fi
.sp
.SH DESCRIPTION
.sp
\fBceph\-kvstore\-tool\fP is a kvstore manipulation tool. It allows users to manipulate
leveldb/rocksdb\(aqs data (like OSD\(aqs omap) offline.
.SH COMMANDS
.sp
\fBceph\-kvstore\-tool\fP utility uses many commands for debugging purpose
which are as follows:
.INDENT 0.0
.TP
\fBlist [prefix]\fP
Print key of all KV pairs stored with the URL encoded prefix.
.TP
\fBlist\-crc [prefix]\fP
Print CRC of all KV pairs stored with the URL encoded prefix.
.TP
\fBdump [prefix]\fP
Print key and value of all KV pairs stored with the URL encoded prefix.
.TP
\fBexists <prefix> [key]\fP
Check if there is any KV pair stored with the URL encoded prefix. If key
is also specified, check for the key with the prefix instead.
.TP
\fBget <prefix> <key> [out <file>]\fP
Get the value of the KV pair stored with the URL encoded prefix and key.
If file is also specified, write the value to the file.
.TP
\fBcrc <prefix> <key>\fP
Get the CRC of the KV pair stored with the URL encoded prefix and key.
.TP
\fBget\-size [<prefix> <key>]\fP
Get estimated store size or size of value specified by prefix and key.
.TP
\fBset <prefix> <key> [ver <N>|in <file>]\fP
Set the value of the KV pair stored with the URL encoded prefix and key.
The value could be \fIversion_t\fP or text.
.TP
\fBrm <prefix> <key>\fP
Remove the KV pair stored with the URL encoded prefix and key.
.TP
\fBrm\-prefix <prefix>\fP
Remove all KV pairs stored with the URL encoded prefix.
.TP
\fBstore\-copy <path> [num\-keys\-per\-tx]\fP
Copy all KV pairs to another directory specified by \fBpath\fP\&.
[num\-keys\-per\-tx] is the number of KV pairs copied for a transaction.
.TP
\fBstore\-crc <path>\fP
Store CRC of all KV pairs to a file specified by \fBpath\fP\&.
.TP
\fBcompact\fP
Subcommand \fBcompact\fP is used to compact all data of kvstore. It will open
the database, and trigger a database\(aqs compaction. After compaction, some
disk space may be released.
.TP
\fBcompact\-prefix <prefix>\fP
Compact all entries specified by the URL encoded prefix.
.TP
\fBcompact\-range <prefix> <start> <end>\fP
Compact some entries specified by the URL encoded prefix and range.
.TP
\fBdestructive\-repair\fP
Make a (potentially destructive) effort to recover a corrupted database.
Note that in the case of rocksdb this may corrupt an otherwise uncorrupted
database\-\-use this only as a last resort!
.TP
\fBstats\fP
Prints statistics from underlying key\-value database. This is only for informative purposes.
Format and information content may vary between releases. For RocksDB information includes
compactions stats, performance counters, memory usage and internal RocksDB stats.
.TP
\fBhistogram\fP
Presents key\-value sizes distribution statistics from the underlying KV database.
.UNINDENT
.SH AVAILABILITY
.sp
\fBceph\-kvstore\-tool\fP is part of Ceph, a massively scalable, open\-source, distributed storage system. Please refer to
the Ceph documentation at \fI\%https://docs.ceph.com\fP for more information.
.SH SEE ALSO
.sp
\fI\%ceph\fP(8)
.SH COPYRIGHT
2010-2024, Inktank Storage, Inc. and contributors. Licensed under Creative Commons Attribution Share Alike 3.0 (CC-BY-SA-3.0)
.\" Generated by docutils manpage writer.
.