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.
schema	Print the transcript database schema.
validate	Validate a transcript database schema.

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

scout db schema

Print the transcript database schema.

Outputs the schema in various formats for use when creating transcript databases outside of the Python API.

Examples: scout db schema # Avro schema to stdout

scout db schema --format pyarrow    # PyArrow schema

scout db schema -o transcript.avsc  # Save to file

Usage

scout db schema [OPTIONS]

Options

Name	Type	Description	Default
--format	choice (avro | pyarrow | json | pandas)	Output format (default: avro).	avro
--output, -o	path	Write to file instead of stdout.
--help	boolean	Show this message and exit.

Subcommands

scout db validate

Validate a transcript database schema.

Checks that the database has the required fields and correct types.

Examples: scout db validate ./my_transcript_db

scout db validate ./encrypted_db --key $KEY

Usage

scout db validate [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