RocksDB Tool

Install rocksdb first.

brew install rocksdb

1
2

brew install rocksdb
Add alias in zshrc

alias ldb = 'rocksdb_ldb --db=. '

1
2

alias ldb = 'rocksdb_ldb --db=. '
List all column families

# ldb list_column_families Column families in .: {default, S1, User, C1, C2, U1, C3}

1
2
3
4

# ldb list_column_families
Column families in .:
{default, S1, User, C1, C2, U1, C3}
Scan command:

# ldb --column_family=User scan User_U_name : cowman User_U_status : 0 User_U_type : 0 User_U_updatedTimestamp : User_U_userId : U

1
2
3
4
5
6
7

# ldb --column_family=User scan
User_U_name : cowman
User_U_status : 0
User_U_type : 0
User_U_updatedTimestamp :
User_U_userId : U

Show result with hex value

ldb --column_family=User scan --value_hex
User_U_name : 0x636F776D616E
User_U_status : 0x30
User_U_type : 0x30
User_U_updatedTimestamp : 0x0000000000000000
User_U_userId : 0x55

ldb --column_family=User scan --value_hex

User_U_name : 0x636F776D616E

User_U_status : 0x30

User_U_type : 0x30

User_U_updatedTimestamp : 0x0000000000000000

User_U_userId : 0x55

Command description (Some commands are inconsistent with how they are used on linux servers)

ldb - RocksDB Tool

commands MUST specify --db=&lt;full_path_to_db_directory&gt; when necessary

commands can optionally specify
  --env_uri=&lt;uri_of_environment&gt; or --fs_uri=&lt;uri_of_filesystem&gt; if necessary
  --secondary_path=&lt;secondary_path&gt; to open DB as secondary instance. Operations not supported in secondary instance will fail.

The following optional parameters control if keys/values are input/output as hex or as plain strings:
  --key_hex : Keys are input/output as hex
  --value_hex : Values are input/output as hex
  --hex : Both keys and values are input/output as hex

The following optional parameters control the database internals:
  --column_family=&lt;string&gt; : name of the column family to operate on. default: default column family
  --ttl with 'put','get','scan','dump','query','batchput' : DB supports ttl and value is internally timestamp-suffixed
  --try_load_options : Try to load option file from DB. Default to true if db is specified and not creating a new DB and not open as TTL DB. Can be set to false explicitly.
  --disable_consistency_checks : Set options.force_consistency_checks = false.
  --ignore_unknown_options : Ignore unknown options when loading option file.
  --bloom_bits=&lt;int,e.g.:14&gt;
  --fix_prefix_len=&lt;int,e.g.:14&gt;
  --compression_type=&lt;no|snappy|zlib|bzip2|lz4|lz4hc|xpress|zstd&gt;
  --compression_max_dict_bytes=&lt;int,e.g.:16384&gt;
  --block_size=&lt;block_size_in_bytes&gt;
  --auto_compaction=&lt;true|false&gt;
  --db_write_buffer_size=&lt;int,e.g.:16777216&gt;
  --write_buffer_size=&lt;int,e.g.:4194304&gt;
  --file_size=&lt;int,e.g.:2097152&gt;
  --enable_blob_files : Enable key-value separation using BlobDB
  --min_blob_size=&lt;int,e.g.:2097152&gt;
  --blob_file_size=&lt;int,e.g.:2097152&gt;
  --blob_compression_type=&lt;no|snappy|zlib|bzip2|lz4|lz4hc|xpress|zstd&gt;
  --enable_blob_garbage_collection : Enable blob garbage collection
  --blob_garbage_collection_age_cutoff=&lt;double,e.g.:0.25&gt;
  --blob_garbage_collection_force_threshold=&lt;double,e.g.:0.25&gt;
  --blob_compaction_readahead_size=&lt;int,e.g.:2097152&gt;


Data Access Commands:
  put &lt;key&gt; &lt;value&gt; [--create_if_missing] [--ttl]
  get &lt;key&gt; [--ttl]
  batchput &lt;key&gt; &lt;value&gt; [&lt;key&gt; &lt;value&gt;] [..] [--create_if_missing] [--ttl]
  scan [--from] [--to]  [--ttl] [--timestamp] [--max_keys=&lt;N&gt;q]  [--start_time=&lt;N&gt;:- is inclusive] [--end_time=&lt;N&gt;:- is exclusive] [--no_value]
  delete &lt;key&gt;
  deleterange &lt;begin key&gt; &lt;end key&gt;
  query [--ttl]
    Starts a REPL shell.  Type help for list of available commands.
  approxsize [--from] [--to]
  checkconsistency
  list_file_range_deletes [--max_keys=&lt;N&gt;] : print tombstones in SST files.


Admin Commands:
  dump_wal --walfile=&lt;write_ahead_log_file_path&gt; [--header]  [--print_value]  [--write_committed=true|false]
  compact [--from] [--to]
  reduce_levels --new_levels=&lt;New number of levels&gt; [--print_old_levels]
  change_compaction_style --old_compaction_style=&lt;Old compaction style: 0 for level compaction, 1 for universal compaction&gt; --new_compaction_style=&lt;New compaction style: 0 for level compaction, 1 for universal compaction&gt;
  dump [--from] [--to]  [--ttl] [--max_keys=&lt;N&gt;] [--timestamp] [--count_only] [--count_delim=&lt;char&gt;] [--stats] [--bucket=&lt;N&gt;] [--start_time=&lt;N&gt;:- is inclusive] [--end_time=&lt;N&gt;:- is exclusive] [--path=&lt;path_to_a_file&gt;] [--decode_blob_index] [--dump_uncompressed_blobs]
  load [--create_if_missing] [--disable_wal] [--bulk_load] [--compact]
  manifest_dump [--verbose] [--json] [--path=&lt;path_to_manifest_file&gt;]
  update_manifest [--update_temperatures]      MUST NOT be used on a live DB.
  file_checksum_dump [--path=&lt;path_to_manifest_file&gt;]
  get_property &lt;property_name&gt;
  list_column_families
  create_column_family --db=&lt;db_path&gt; &lt;new_column_family_name&gt;
  drop_column_family --db=&lt;db_path&gt; &lt;column_family_name_to_drop&gt;
  dump_live_files [--decode_blob_index]  [--dump_uncompressed_blobs]
  idump [--from] [--to]  [--input_key_hex] [--max_keys=&lt;N&gt;] [--count_only] [--count_delim=&lt;char&gt;] [--stats] [--decode_blob_index]
  list_live_files_metadata [--sort_by_filename]
  repair [--verbose]
  backup [--backup_env_uri | --backup_fs_uri]  [--backup_dir]  [--num_threads]  [--stderr_log_level=&lt;int (InfoLogLevel)&gt;]
  restore [--backup_env_uri | --backup_fs_uri]  [--backup_dir]  [--num_threads]  [--stderr_log_level=&lt;int (InfoLogLevel)&gt;]
  checkpoint [--checkpoint_dir]
  write_extern_sst &lt;output_sst_path&gt;
  ingest_extern_sst &lt;input_sst_path&gt; [--move_files]  [--snapshot_consistency]  [--allow_global_seqno]  [--allow_blocking_flush]  [--ingest_behind]  [--write_global_seqno]
  unsafe_remove_sst_file &lt;SST file number        MUST NOT be used on a live DB.

ldb - RocksDB Tool

commands MUST specify --db=<full_path_to_db_directory> when necessary

commands can optionally specify

--env_uri=<uri_of_environment> or --fs_uri=<uri_of_filesystem> if necessary

--secondary_path=<secondary_path> to open DB as secondary instance. Operations not supported in secondary instance will fail.

The following optional parameters control if keys/values are input/output as hex or as plain strings:

--key_hex : Keys are input/output as hex

--value_hex : Values are input/output as hex

--hex : Both keys and values are input/output as hex

The following optional parameters control the database internals:

--column_family=<string> : name of the column family to operate on. default: default column family

--ttl with 'put','get','scan','dump','query','batchput' : DB supports ttl and value is internally timestamp-suffixed

--try_load_options : Try to load option file from DB. Default to true if db is specified and not creating a new DB and not open as TTL DB. Can be set to false explicitly.

--disable_consistency_checks : Set options.force_consistency_checks = false.

--ignore_unknown_options : Ignore unknown options when loading option file.

--bloom_bits=<int,e.g.:14>

--fix_prefix_len=<int,e.g.:14>

--compression_max_dict_bytes=<int,e.g.:16384>

--block_size=<block_size_in_bytes>

--auto_compaction=<true|false>

--db_write_buffer_size=<int,e.g.:16777216>

--write_buffer_size=<int,e.g.:4194304>

--file_size=<int,e.g.:2097152>

--enable_blob_files : Enable key-value separation using BlobDB

--min_blob_size=<int,e.g.:2097152>

--blob_file_size=<int,e.g.:2097152>

--enable_blob_garbage_collection : Enable blob garbage collection

--blob_garbage_collection_age_cutoff=<double,e.g.:0.25>

--blob_garbage_collection_force_threshold=<double,e.g.:0.25>

--blob_compaction_readahead_size=<int,e.g.:2097152>

Data Access Commands:

put <key> <value> [--create_if_missing] [--ttl]

get <key> [--ttl]

batchput <key> <value> [<key> <value>] [..] [--create_if_missing] [--ttl]

scan [--from] [--to] [--ttl] [--timestamp] [--max_keys=<N>q] [--start_time=<N>:- is inclusive] [--end_time=<N>:- is exclusive] [--no_value]

delete <key>

deleterange <begin key> <end key>

query [--ttl]

Starts a REPL shell. Type help for list of available commands.

approxsize [--from] [--to]

checkconsistency

list_file_range_deletes [--max_keys=<N>] : print tombstones in SST files.

Admin Commands:

dump_wal --walfile=<write_ahead_log_file_path> [--header] [--print_value] [--write_committed=true|false]

compact [--from] [--to]

reduce_levels --new_levels=<New number of levels> [--print_old_levels]

change_compaction_style --old_compaction_style=<Old compaction style: 0 for level compaction, 1 for universal compaction> --new_compaction_style=<New compaction style: 0 for level compaction, 1 for universal compaction>

dump [--from] [--to] [--ttl] [--max_keys=<N>] [--timestamp] [--count_only] [--count_delim=<char>] [--stats] [--bucket=<N>] [--start_time=<N>:- is inclusive] [--end_time=<N>:- is exclusive] [--path=<path_to_a_file>] [--decode_blob_index] [--dump_uncompressed_blobs]

load [--create_if_missing] [--disable_wal] [--bulk_load] [--compact]

manifest_dump [--verbose] [--json] [--path=<path_to_manifest_file>]

update_manifest [--update_temperatures] MUST NOT be used on a live DB.

file_checksum_dump [--path=<path_to_manifest_file>]

get_property <property_name>

list_column_families

create_column_family --db=<db_path> <new_column_family_name>

drop_column_family --db=<db_path> <column_family_name_to_drop>

dump_live_files [--decode_blob_index] [--dump_uncompressed_blobs]

idump [--from] [--to] [--input_key_hex] [--max_keys=<N>] [--count_only] [--count_delim=<char>] [--stats] [--decode_blob_index]

list_live_files_metadata [--sort_by_filename]

repair [--verbose]

backup [--backup_env_uri | --backup_fs_uri] [--backup_dir] [--num_threads] [--stderr_log_level=<int (InfoLogLevel)>]

restore [--backup_env_uri | --backup_fs_uri] [--backup_dir] [--num_threads] [--stderr_log_level=<int (InfoLogLevel)>]

checkpoint [--checkpoint_dir]

write_extern_sst <output_sst_path>

ingest_extern_sst <input_sst_path> [--move_files] [--snapshot_consistency] [--allow_global_seqno] [--allow_blocking_flush] [--ingest_behind] [--write_global_seqno]

unsafe_remove_sst_file <SST file number MUST NOT be used on a live DB.

Categories