great_expectations.cli.suite

Module Contents

Functions

suite()

Expectation Suite operations

suite_edit(suite, datasource, directory, jupyter, batch_kwargs)

Generate a Jupyter notebook for editing an existing Expectation Suite.

_suite_edit(suite, datasource, directory, jupyter, batch_kwargs, usage_event)

suite_demo(suite, directory, view)

Create a new demo Expectation Suite.

suite_new(suite, directory, empty, jupyter, view, batch_kwargs)

Create a new Expectation Suite.

_suite_new(suite: str, directory: str, empty: bool, jupyter: bool, view: bool, batch_kwargs, usage_event: str)

suite_delete(suite, directory)

Delete an expectation suite from the expectation store.

suite_scaffold(suite, directory, jupyter)

Scaffold a new Expectation Suite.

_suite_scaffold(suite: str, directory: str, jupyter: bool)

suite_list(directory)

Lists available Expectation Suites.

_get_notebook_path(context, notebook_name)

great_expectations.cli.suite.json_parse_exception
great_expectations.cli.suite.SQLAlchemyError
great_expectations.cli.suite.suite()

Expectation Suite operations

great_expectations.cli.suite.suite_edit(suite, datasource, directory, jupyter, batch_kwargs)

Generate a Jupyter notebook for editing an existing Expectation Suite.

The SUITE argument is required. This is the name you gave to the suite when you created it.

A batch of data is required to edit the suite, which is used as a sample.

The edit command will help you specify a batch interactively. Or you can specify them manually by providing –batch-kwargs in valid JSON format.

Read more about specifying batches of data in the documentation: https://docs.greatexpectations.io/

great_expectations.cli.suite._suite_edit(suite, datasource, directory, jupyter, batch_kwargs, usage_event)
great_expectations.cli.suite.suite_demo(suite, directory, view)

Create a new demo Expectation Suite.

Great Expectations will choose a couple of columns and generate expectations about them to demonstrate some examples of assertions you can make about your data.

great_expectations.cli.suite.suite_new(suite, directory, empty, jupyter, view, batch_kwargs)

Create a new Expectation Suite.

Great Expectations will choose a couple of columns and generate expectations about them to demonstrate some examples of assertions you can make about your data.

If you wish to skip the examples, add the –empty flag.

great_expectations.cli.suite._suite_new(suite: str, directory: str, empty: bool, jupyter: bool, view: bool, batch_kwargs, usage_event: str) → None
great_expectations.cli.suite.suite_delete(suite, directory)

Delete an expectation suite from the expectation store.

great_expectations.cli.suite.suite_scaffold(suite, directory, jupyter)

Scaffold a new Expectation Suite.

great_expectations.cli.suite._suite_scaffold(suite: str, directory: str, jupyter: bool) → None
great_expectations.cli.suite.suite_list(directory)

Lists available Expectation Suites.

great_expectations.cli.suite._get_notebook_path(context, notebook_name)