Link Search Menu Expand Document

Soda SQL CLI commands

Command Description
soda analyze Analyzes the contents of your warehouse and automatically prepares a scan YAML file for each table. Soda SQL puts the YAML files in the /tables directory inside the warehouse directory. See Create a scan YAML file for details.
soda create yourdatawarehouse Creates a new warehouse.yml file and prepares credentials in your ~/.soda/env_vars.yml. Soda SQL does not overwrite or remove and existing environment variables, it only adds new. See Create a warehouse YAML file for details.
soda scan Uses the configurations in your scan YAML file to prepare, then run SQL queries against the data in your warehouse. See Run a scan for details.

List of commands

To see a list of Soda SQL command-line interface (CLI) commands, use the soda command.

Command:

$ soda

Output:

Usage: soda [OPTIONS] COMMAND [ARGS]...

  Soda CLI version 2.x.xxx

Options:
  --help  Show this message and exit.

Commands:
  analyze  Analyzes tables in the warehouse and creates scan YAML files...
  create   Creates a new warehouse.yml file and prepares credentials in
           your...

  scan     Computes all measurements and runs all tests on one table.

List of parameters

To see a list of configurable parameters for each command, use the command-line help.

$ soda create --help
$ soda analyze --help
$ soda scan --help

Go further