great_expectations.cli.suite
¶
Module Contents¶
Functions¶
|
Expectation Suite operations |
|
Create a new Expectation Suite. |
|
|
|
Process various optional suite new flags and prompt if there is not enough information from the flags. |
|
|
|
|
|
|
|
|
|
|
|
|
|
Edit an existing Expectation Suite. |
|
Process various optional suite edit flags and prompt if there is not enough information from the flags. |
|
|
|
This command is not supported in the v3 (Batch Request) API. |
|
Delete an Expectation Suite from the Expectation Store. |
|
List existing Expectation Suites. |
|
-
great_expectations.cli.suite.
SQLAlchemyError
¶
-
great_expectations.cli.suite.
MESSAGE_USER_CONFIGURABLE_PROFILER
:str = Since you did not supply a profiler name, defaulting to the UserConfigurableProfiler¶
-
great_expectations.cli.suite.
MESSAGE_ONBOARDING_DATA_ASSISTANT
:str = Since you did not supply a profiler name, defaulting to the OnboardingDataAssistant¶
-
great_expectations.cli.suite.
MESSAGE_RULE_BASED_PROFILER
:str = Since you supplied a profiler name, utilizing the RuleBasedProfiler¶
-
great_expectations.cli.suite.
suite
(ctx: click.Context) → None¶ Expectation Suite operations
-
great_expectations.cli.suite.
suite_new
(ctx: click.Context, expectation_suite: Optional[str], interactive_flag: bool, manual_flag: bool, profiler_name: Optional[str], batch_request: Optional[str], no_jupyter: bool) → None¶ Create a new Expectation Suite. Edit in jupyter notebooks, or skip with the –no-jupyter flag.
-
great_expectations.cli.suite.
_determine_profile
(profiler_name: Optional[str]) → bool¶
-
great_expectations.cli.suite.
_process_suite_new_flags_and_prompt
(context: DataContext, usage_event_end: str, interactive_flag: bool, manual_flag: bool, profile: bool, batch_request: Optional[str] = None) → Tuple[CLISuiteInteractiveFlagCombinations, bool]¶ Process various optional suite new flags and prompt if there is not enough information from the flags. :param context: Data Context for use in sending error messages if any :param usage_event_end: event name for ending usage stats message :param interactive_flag: –interactive from the suite new CLI command :param manual_flag: –manual from the suite new CLI command :param profile: –profile from the suite new CLI command :param batch_request: –batch-request from the suite new CLI command
- Returns
Tuple with keys of processed parameters and boolean values
-
great_expectations.cli.suite.
_suite_new_workflow
(context: DataContext, expectation_suite_name: Optional[str], interactive_mode: CLISuiteInteractiveFlagCombinations, profile: bool, profiler_name: Optional[str], no_jupyter: bool, usage_event: str, batch_request: Optional[Union[str, Dict[str, Union[str, int, Dict[str, Any]]]]] = None) → None¶
-
great_expectations.cli.suite.
_suite_convert_flags_to_interactive_mode
(interactive_flag: bool, manual_flag: bool) → CLISuiteInteractiveFlagCombinations¶
-
great_expectations.cli.suite.
_suite_new_process_profile_and_batch_request_flags
(interactive_mode: CLISuiteInteractiveFlagCombinations, profile: bool, batch_request: Optional[str]) → CLISuiteInteractiveFlagCombinations¶
-
great_expectations.cli.suite.
_exit_early_if_error
(error_message: Optional[str], context: DataContext, usage_event_end: str, interactive_mode: CLISuiteInteractiveFlagCombinations) → None¶
-
great_expectations.cli.suite.
_suite_new_user_provided_any_flag
(interactive_mode: CLISuiteInteractiveFlagCombinations, profile: bool, batch_request: Optional[str]) → bool¶
-
great_expectations.cli.suite.
_suite_new_mode_from_prompt
(profile: bool) → Tuple[CLISuiteInteractiveFlagCombinations, bool]¶
-
great_expectations.cli.suite.
suite_edit
(ctx: click.Context, expectation_suite: str, interactive_flag: bool, manual_flag: bool, datasource_name: Optional[str], batch_request: Optional[str], no_jupyter: bool) → None¶ Edit an existing Expectation Suite.
The SUITE argument is required. This is the name you gave to the suite when you created it.
The edit command will help you specify a batch interactively. Or you can specify them manually by providing –batch-request in valid JSON format.
Read more about specifying batches of data in the documentation: https://docs.greatexpectations.io/
-
great_expectations.cli.suite.
_process_suite_edit_flags_and_prompt
(context: DataContext, usage_event_end: str, interactive_flag: bool, manual_flag: bool, datasource_name: Optional[str] = None, batch_request: Optional[str] = None) → CLISuiteInteractiveFlagCombinations¶ Process various optional suite edit flags and prompt if there is not enough information from the flags. :param context: Data Context for use in sending error messages if any :param usage_event_end: event name for ending usage stats message :param interactive_flag: –interactive from the suite new CLI command :param manual_flag: –manual from the suite new CLI command :param datasource_name: –datasource-name from the suite new CLI command :param batch_request: –batch-request from the suite new CLI command
- Returns
boolean of whether to enter interactive mode
-
great_expectations.cli.suite.
_suite_edit_workflow
(context: DataContext, expectation_suite_name: str, profile: bool, profiler_name: Optional[str], usage_event: str, interactive_mode: CLISuiteInteractiveFlagCombinations, no_jupyter: bool, create_if_not_exist: bool = False, datasource_name: Optional[str] = None, batch_request: Optional[Union[str, Dict[str, Union[str, int, Dict[str, Any]]]]] = None, additional_batch_request_args: Optional[Dict[str, Union[str, int, Dict[str, Any]]]] = None, suppress_usage_message: bool = False, assume_yes: bool = False) → None¶
-
great_expectations.cli.suite.
suite_demo
(ctx: click.Context) → None¶ This command is not supported in the v3 (Batch Request) API.
-
great_expectations.cli.suite.
suite_delete
(ctx: click.Context, suite: str) → None¶ Delete an Expectation Suite from the Expectation Store.
-
great_expectations.cli.suite.
suite_list
(ctx: click.Context) → None¶ List existing Expectation Suites.
-
great_expectations.cli.suite.
_get_notebook_path
(context: DataContext, notebook_name: str) → str¶