OS Manuals

/usr/bin/sst_dump

Percona Server for MySQL is a free, fully compatible, enhanced, and open source drop-in replacement for any MySQL database. It provides superior performance, scalability, and instrumentation.

From percona-server-8.4 8.4.2.2-r0 (os), captured 2026-11-05 by running sst_dump --help (exit 0). permalink

sst_dump --file=<data_dir_OR_sst_file> [--command=check|scan|raw|recompress|identify]
    --file=<data_dir_OR_sst_file>
      Path to SST file or directory containing SST files

    --env_uri=<uri of underlying Env>
      URI of underlying Env, mutually exclusive with fs_uri

    --fs_uri=<uri of underlying FileSystem>
      URI of underlying FileSystem, mutually exclusive with env_uri

    --command=check|scan|raw|verify|identify
        check: Iterate over entries in files but don't print anything except if an error is encountered (default command)
        scan: Iterate over entries in files and print them to screen
        raw: Dump all the table contents to <file_name>_dump.txt
        verify: Iterate all the blocks in files verifying checksum to detect possible corruption but don't print anything except if a corruption is encountered
        recompress: reports the SST file size if recompressed with different
                    compression types
        identify: Reports a file is a valid SST file or lists all valid SST files under a directory

    --output_hex
      Can be combined with scan command to print the keys and values in Hex

    --decode_blob_index
      Decode blob indexes and print them in a human-readable format during scans.

    --from=<user_key>
      Key to start reading from when executing check|scan

    --to=<user_key>
      Key to stop reading at when executing check|scan

    --prefix=<user_key>
      Returns all keys with this prefix when executing check|scan
      Cannot be used in conjunction with --from

    --read_num=<num>
      Maximum number of entries to read when executing check|scan

    --verify_checksum
      Verify file checksum when executing check|scan

    --input_key_hex
      Can be combined with --from and --to to indicate that these values are encoded in Hex

    --show_properties
      Print table properties after iterating over the file when executing
      check|scan|raw|identify

    --set_block_size=<block_size>
      Can be combined with --command=recompress to set the block size that will
      be used when trying different compression algorithms

    --compression_types=<comma-separated list of CompressionType members, e.g.,
      kSnappyCompression>
      Can be combined with --command=recompress to run recompression for this
      list of compression types
      Supported compression types: kNoCompression, kZlibCompression, kLZ4Compression, kLZ4HCCompression, kZSTD, kZSTDNotFinalCompression

    --parse_internal_key=<0xKEY>
      Convenience option to parse an internal key on the command line. Dumps the
      internal key in hex format {'key' @ SN: type}

    --compression_level_from=<compression_level>
      Compression level to start compressing when executing recompress. One compression type
      and compression_level_to must also be specified

    --compression_level_to=<compression_level>
      Compression level to stop compressing when executing recompress. One compression type
      and compression_level_from must also be specified

    --compression_max_dict_bytes=<uint32_t>
      Maximum size of dictionary used to prime the compression library

    --compression_zstd_max_train_bytes=<uint32_t>
      Maximum size of training data passed to zstd's dictionary trainer

    --compression_max_dict_buffer_bytes=<int64_t>
      Limit on buffer size from which we collect samples for dictionary generation.

    --compression_use_zstd_finalize_dict
      Use zstd's finalizeDictionary() API instead of zstd's dictionary trainer to generate dictionary.
Options (19)
OptionDescriptionSource
--file data_dir_OR_sst_filePath to SST file or directory containing SST fileshelp
--command check|scan|raw|verify|identifycheck: Iterate over entries in files but don't print anything except if an error is encountered (default command) scan: Iterate over entries in files and print them to screen raw: Dump all the table…help
--output_hexCan be combined with scan command to print the keys and values in Hexhelp
--decode_blob_indexDecode blob indexes and print them in a human-readable format during scans.help
--from user_keyKey to start reading from when executing check|scanhelp
--to user_keyKey to stop reading at when executing check|scanhelp
--prefix user_keyReturns all keys with this prefix when executing check|scan Cannot be used in conjunction with --fromhelp
--read_num numMaximum number of entries to read when executing check|scanhelp
--verify_checksumVerify file checksum when executing check|scanhelp
--input_key_hexCan be combined with --from and --to to indicate that these values are encoded in Hexhelp
--show_propertiesPrint table properties after iterating over the file when executing check|scan|raw|identifyhelp
--set_block_size block_sizeCan be combined with --command=recompress to set the block size that will be used when trying different compression algorithmshelp
--parse_internal_key 0xKEYConvenience option to parse an internal key on the command line.help
--compression_level_from compression_levelCompression level to start compressing when executing recompress.help
--compression_level_to compression_levelCompression level to stop compressing when executing recompress.help
--compression_max_dict_bytes uint32_tMaximum size of dictionary used to prime the compression libraryhelp
--compression_zstd_max_train_bytes uint32_tMaximum size of training data passed to zstd's dictionary trainerhelp
--compression_max_dict_buffer_bytes int64_tLimit on buffer size from which we collect samples for dictionary generation.help
--compression_use_zstd_finalize_dictUse zstd's finalizeDictionary() API instead of zstd's dictionary trainer to generate dictionary.help

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.