Soda Core CLI commands

Last modified on 31-May-23

Command	Description
`soda ingest`	Ingests dbt test results to display in Soda Cloud. See Integrate with dbt.
`soda scan`	Uses the configurations in your checks YAML file to prepare, then run SQL queries against the data in your data source. See Run a Soda Core scan for details.
`soda test-connection`	Tests the connection to the data sources for which you configured a connection in your configuration YAML file.
`soda update-dro`	Updates a distribution reference file that a distribution check uses.

List of commands

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

Command:

soda

Output:

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

  Soda Core CLI version 3.0.0xx

Options:
  --help  Show this message and exit.

Commands:
  scan    runs a scan
  update-dro  updates a distribution reference file

List of command options

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

soda scan --help
soda ingest --help
soda update-dro --help

Refer to Add scan options for more information.

Go further

Learn How Soda Core works.
Need help? Join the Soda community on Slack.

Was this documentation helpful?

What could we do to improve this page?

Suggest a docs change in GitHub.
Share feedback in the Soda community on Slack.

Last modified on 31-May-23