scout db

Scout transcript database management.

Usage

scout db [OPTIONS] COMMAND [ARGS]...

Options

Name Type Description Default
--help boolean Show this message and exit.

Subcommands

encrypt Encrypt a transcript database.
decrypt Decrypt a transcript database.
index Create or rebuild the index for a transcript database.

scout db encrypt

Encrypt a transcript database.

Usage

scout db encrypt [OPTIONS] DATABASE_LOCATION

Options

Name Type Description Default
--output-dir text Directory to write encrypted database files to. _required
--key text Encryption key (use ‘-’ for stdin, or set SCOUT_DB_ENCRYPTION_KEY).
--overwrite boolean Overwrite files in the output directory.
--help boolean Show this message and exit.

Subcommands

scout db decrypt

Decrypt a transcript database.

Usage

scout db decrypt [OPTIONS] DATABASE_LOCATION

Options

Name Type Description Default
--output-dir text Directory to write decrypted database files to. _required
--key text Encryption key (use ‘-’ for stdin, or set SCOUT_DB_ENCRYPTION_KEY).
--overwrite boolean Overwrite files in the output directory.
--help boolean Show this message and exit.

Subcommands

scout db index

Create or rebuild the index for a transcript database.

This scans all parquet data files and creates a manifest index containing metadata for fast queries. Any existing index files are replaced.

For encrypted databases, provide –key or set SCOUT_DB_ENCRYPTION_KEY.

Usage

scout db index [OPTIONS] DATABASE_LOCATION

Options

Name Type Description Default
--key text Encryption key for encrypted databases (use ‘-’ for stdin, or set SCOUT_DB_ENCRYPTION_KEY).
--help boolean Show this message and exit.

Subcommands