Command Line Interface

The OLake CLI consist of the following:

Offers commands like spec, check, discover, and sync for seamless pipeline orchestration. Configurable flags (such as --batch_size and --thread_count) allow you to optimize performance.

Command	Description
discover	Scans the database (e.g., MongoDB) to generate catalog.json.
sync	Runs initial snapshot and/or CDC-based replication.
spec	Returns render-able JSON Schema that can be consumed by rjsf libraries in frontend
check	performs all necessary checks on the Config, Catalog, State and Writer config

Common Flags

Flag	Example	Description
--config	--config /mnt/config/config.json	Path to the MongoDB (or other DB) connection config.
--catalog	--catalog /mnt/config/catalog.json	Path to the catalog file (list of tables/collections to replicate).
--destination	--destination /mnt/config/writer.json	Path to the writer configuration (local or S3).
--state	--state /mnt/config/state.json	Path to a file with saved offsets or resume tokens.

Remember: The -v (volume) flag is crucial for mounting your local olake_folder into /mnt/config within the container.