Rate This Document
Findability
Accuracy
Completeness
Readability

Administrator Commands

Table 1 Administrator commands

Command

Description

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

Dumps WAL files.

compact [--from] [--to]

Specifies the compact operation range. The values of from and to are existing keys in a database.

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

Restores a specified level.

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>

Converts the compaction style of the corresponding level. Values 0 and 1 indicate level-based compaction and universal compaction respectively.

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>]

Queries the existing data of the key/value type in the database, converts the data in the special storage format to the data that can be directly read and identified, and displays the data with various control parameters.

  • The from and to parameters control the query scope. The values are existing keys.
  • The ttl parameter queries valid data in the lifecycle.
  • The count_only parameter specifies that only the number of key/value data records in the database is displayed.
  • The count_delim parameter has a specified value of the char type. The data that contains the character in the key is not queried.
  • If no parameter is added to dump, the default column family default is queried. You can use the --column_family parameter to query other column families.

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

Loads a database.

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

Dumps manifest files.

file_checksum_dump [--path=<path_to_manifest_file>]

Verifies the SST files in a database and prints the verification information of each SST file.

list_column_families

Lists all column families in a specified database.

create_column_family --db=<db_path> <new_column_family_name>

Adds a new column family to a specified database.

drop_column_family --db=<db_path> <column_family_name_to_drop>

Deletes a column family from a specified database.

dump_live_files

Dumps files within the lifecycle.

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

Similar to the dump command, this command also queries data in the database. However, the key/value data in the command output is more detailed. For example, the actual sequence of writing data into the database is included in the command output.

repair

Restores recently deleted log files, such as manifest and log files, and saves the restored log files to the newly generated lost directory in the database.

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

Backs up a database.

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

Restores a database.

checkpoint [--checkpoint_dir]

Sets a checkpoint.

write_extern_sst <output_sst_path>

Writes data to the SST file in a specified path.

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

Imports an external SST file.