A newer version of this documentation is available.

View Latest

cbsqlitedump

    A utility for dumping SQLite files generated by cbbackupmgr

    SYNOPSIS

    cbsqlitedump [--version] [--help] [--file <path>] [--directory <path>]
                 [--info-only] [--bykey] [--byseq] [--no-body] [--no-meta] [--json]

    DESCRIPTION

    cbsqlitedump is used to dump SQLite files generated by cbbackupmgr.

    OPTIONS

    --version

    Prints the cbsqlitedump suite version that the cbsqlitedump program came from.

    -h,--help

    Prints the synopsis and usage instructions for the command.

    -f,--file <path>

    Specify the file to be dumped.

    -d,--directory <path>

    Specify the path to the directory to be dumped.

    --info-only

    Displays only information of the specified file, no documents will be dumped.

    --bykey

    Sorts per table output by key. If a whole directory is dumped the output of each table will be sorted by key.

    --byseq

    Sorts per table output by sequence number. If a whole directory is dumped the output of each table will be sorted by sequence number.

    --no-meta

    Do not return any of the documents metadata.

    --no-xattrs

    Do not return any of the documents extended attributes.

    --no-value

    Do not return the documents value.

    --hex-meta

    Return the metadata encoded in hex.

    --hex-xattrs

    Return the extended attributes encoded in hex.

    --hex-value

    Return the value encoded in hex.

    -j,--json

    The output will be in JSON format.

    FORMATS

    The default format resembles the output of the forestdb_dump tool. A dumped file will look like:

    Key: pymc0
      Deleted: false
      Size: 5B (key), 29B (meta), 10B (value)
      Meta: {"flags":0,"expiry":0,"locktime":0,"cas":1564654245015781376,"revseqno":1,"datatype":0}
      Value:
        00000000  30 30 30 30 30 30 30 30  30 30                    |0000000000|

    If the json format is chosen it will look like:

    {"key":"pymc0","value":"0000000000","meta":{"flags":0,"expiry":0,"locktime":0,"cas":1564654245015781376,"revseqno":1,"datatype":0},"deleted":false}