From 2551f137063a403cbed3ecc75bc936c61552d7b1 Mon Sep 17 00:00:00 2001 From: Deborah <38264052+deborahniesz@users.noreply.github.com> Date: Mon, 21 Oct 2024 17:23:44 -0300 Subject: [PATCH] [DOCS] Change href from relative path to root in API docs (version 0.18) (#10507) --- .../api/checkpoint/Checkpoint_class.mdx | 4 +- .../api/checkpoint/EmailAction_class.mdx | 4 +- ...MicrosoftTeamsNotificationAction_class.mdx | 4 +- .../checkpoint/OpsgenieAlertAction_class.mdx | 4 +- .../checkpoint/PagerdutyAlertAction_class.mdx | 4 +- .../SNSNotificationAction_class.mdx | 4 +- .../SlackNotificationAction_class.mdx | 4 +- .../StoreEvaluationParametersAction_class.mdx | 4 +- .../checkpoint/StoreMetricsAction_class.mdx | 4 +- .../StoreValidationResultAction_class.mdx | 4 +- .../checkpoint/UpdateDataDocsAction_class.mdx | 4 +- .../api/checkpoint/ValidationAction_class.mdx | 6 +- .../CheckpointResult_class.mdx | 6 +- .../core/ExpectationConfiguration_class.mdx | 4 +- ...ExpectationSuiteValidationResult_class.mdx | 2 +- .../api/core/ExpectationSuite_class.mdx | 8 +- .../ExpectationValidationResult_class.mdx | 2 +- .../api/core/batch/BatchDefinition_class.mdx | 2 +- .../api/core/batch/BatchRequest_class.mdx | 3 +- .../reference/api/core/batch/Batch_class.mdx | 4 +- .../core/batch/RuntimeBatchRequest_class.mdx | 4 +- .../core/yaml_handler/YAMLHandler_class.mdx | 2 +- .../AbstractDataContext_class.mdx | 58 +++++----- .../data_context/CloudDataContext_class.mdx | 44 ++++---- .../EphemeralDataContext_class.mdx | 50 ++++----- .../data_context/FileDataContext_class.mdx | 50 ++++----- .../data_context/context_factory.mdx | 10 +- .../types/base/DataContextConfig_class.mdx | 7 -- .../api/datasource/DataConnector_class.mdx | 2 +- ...tAWSGlueDataCatalogDataConnector_class.mdx | 2 +- ...onfiguredAssetAzureDataConnector_class.mdx | 4 +- ...ConfiguredAssetDBFSDataConnector_class.mdx | 4 +- ...iguredAssetFilePathDataConnector_class.mdx | 4 +- ...uredAssetFilesystemDataConnector_class.mdx | 4 +- .../ConfiguredAssetGCSDataConnector_class.mdx | 4 +- .../ConfiguredAssetS3DataConnector_class.mdx | 4 +- .../ConfiguredAssetSqlDataConnector_class.mdx | 4 +- .../FilePathDataConnector_class.mdx | 2 +- ...tAWSGlueDataCatalogDataConnector_class.mdx | 2 +- .../InferredAssetAzureDataConnector_class.mdx | 2 +- .../InferredAssetDBFSDataConnector_class.mdx | 2 +- ...ferredAssetFilePathDataConnector_class.mdx | 2 +- ...rredAssetFilesystemDataConnector_class.mdx | 2 +- .../InferredAssetGCSDataConnector_class.mdx | 2 +- .../InferredAssetS3DataConnector_class.mdx | 2 +- .../InferredAssetSqlDataConnector_class.mdx | 2 +- .../RuntimeDataConnector_class.mdx | 2 +- .../fluent/DatabricksSQLDatasource_class.mdx | 6 +- .../fluent/PostgresDatasource_class.mdx | 6 +- .../fluent/SnowflakeDatasource_class.mdx | 6 +- .../fluent/SqliteDatasource_class.mdx | 2 +- .../sql_datasource/QueryAsset_class.mdx | 2 +- .../sql_datasource/TableAsset_class.mdx | 2 +- .../ExecutionEngine_class.mdx | 6 +- .../PandasExecutionEngine_class.mdx | 4 +- .../SparkDFExecutionEngine_class.mdx | 4 +- .../SqlAlchemyExecutionEngine_class.mdx | 4 +- .../api/expectations/expectation.mdx | 102 +++++++++--------- .../expectation/BatchExpectation_class.mdx | 12 +-- .../ColumnAggregateExpectation_class.mdx | 12 +-- .../expectation/ColumnExpectation_class.mdx | 12 +-- .../ColumnMapExpectation_class.mdx | 10 +- .../ColumnPairMapExpectation_class.mdx | 10 +- .../expectation/Expectation_class.mdx | 12 +-- .../MulticolumnMapExpectation_class.mdx | 10 +- .../expectation/QueryExpectation_class.mdx | 12 +-- .../expectation/TableExpectation_class.mdx | 12 +-- .../ColumnAggregateMetricProvider_class.mdx | 2 +- .../metrics/ColumnMapMetricProvider_class.mdx | 2 +- .../column_aggregate_metric_provider.mdx | 2 +- .../column_condition_partial.mdx | 2 +- .../column_pair_function_partial.mdx | 2 +- .../expectations/metrics/metric_provider.mdx | 10 +- .../QueryMetricProvider_class.mdx | 2 +- .../TableMetricProvider_class.mdx | 2 +- .../RegexBasedColumnMapExpectation_class.mdx | 12 +-- .../RegexColumnMapMetricProvider_class.mdx | 2 +- .../reference/api/expectations/registry.mdx | 2 +- .../SetBasedColumnMapExpectation_class.mdx | 12 +-- .../FabricPowerBIDatasource_class.mdx | 8 +- .../UserConfigurableProfiler_class.mdx | 4 +- .../RuleBasedProfilerResult_class.mdx | 6 +- .../DataAssistantResult_class.mdx | 4 +- .../validator/validator/Validator_class.mdx | 10 +- 84 files changed, 340 insertions(+), 348 deletions(-) diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/checkpoint/Checkpoint_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/checkpoint/Checkpoint_class.mdx index 7d1f26a70a51..2fc64438cca0 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/checkpoint/Checkpoint_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/checkpoint/Checkpoint_class.mdx @@ -8,7 +8,7 @@ sidebar_label: Checkpoint
-class great_expectations.checkpoint.Checkpoint(name: str, data_context: AbstractDataContext, config_version: int | float = 1.0, template_name: str | None = None, run_name_template: str | None = None, expectation_suite_name: str | None = None, batch_request: BatchRequestBase | FluentBatchRequest | dict | None = None, validator: Validator | None = None, action_list: Sequence[ActionDict] | None = None, evaluation_parameters: dict | None = None, runtime_configuration: dict | None = None, validations: list[dict] | list[CheckpointValidationConfig] | None = None, profilers: list[dict] | None = None, ge_cloud_id: str | None = None, expectation_suite_ge_cloud_id: str | None = None, default_validation_id: str | None = None)# +class great_expectations.checkpoint.Checkpoint(name: str, data_context: AbstractDataContext, config_version: int | float = 1.0, template_name: str | None = None, run_name_template: str | None = None, expectation_suite_name: str | None = None, batch_request: BatchRequestBase | FluentBatchRequest | dict | None = None, validator: Validator | None = None, action_list: Sequence[ActionDict] | None = None, evaluation_parameters: dict | None = None, runtime_configuration: dict | None = None, validations: list[dict] | list[CheckpointValidationConfig] | None = None, profilers: list[dict] | None = None, ge_cloud_id: str | None = None, expectation_suite_ge_cloud_id: str | None = None, default_validation_id: str | None = None)#

A checkpoint is the primary means for validating data in a production deployment of Great Expectations.

@@ -62,7 +62,7 @@ variables and datetime-template syntax (e.g. “%Y-%M-staging-$MY_ENV_VAR”).
-run(template_name: str | None = None, run_name_template: str | None = None, expectation_suite_name: str | None = None, batch_request: BatchRequestBase | FluentBatchRequest | dict | None = None, validator: Validator | None = None, action_list: Sequence[ActionDict] | None = None, evaluation_parameters: dict | None = None, runtime_configuration: dict | None = None, validations: list[dict] | list[CheckpointValidationConfig] | None = None, profilers: list[dict] | None = None, run_id: str | RunIdentifier | None = None, run_name: str | None = None, run_time: datetime.datetime | None = None, result_format: str | dict | None = None, expectation_suite_ge_cloud_id: str | None = None) → CheckpointResult# +run(template_name: str | None = None, run_name_template: str | None = None, expectation_suite_name: str | None = None, batch_request: BatchRequestBase | FluentBatchRequest | dict | None = None, validator: Validator | None = None, action_list: Sequence[ActionDict] | None = None, evaluation_parameters: dict | None = None, runtime_configuration: dict | None = None, validations: list[dict] | list[CheckpointValidationConfig] | None = None, profilers: list[dict] | None = None, run_id: str | RunIdentifier | None = None, run_name: str | None = None, run_time: datetime.datetime | None = None, result_format: str | dict | None = None, expectation_suite_ge_cloud_id: str | None = None) → CheckpointResult#

Validate against current Checkpoint.

diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/checkpoint/EmailAction_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/checkpoint/EmailAction_class.mdx index d6bf8e1eb408..ea6584b5b2be 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/checkpoint/EmailAction_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/checkpoint/EmailAction_class.mdx @@ -8,7 +8,7 @@ import CodeBlock from '@theme/CodeBlock';
-class great_expectations.checkpoint.EmailAction(data_context: AbstractDataContext, renderer: dict, smtp_address: str, smtp_port: str, sender_login: str, sender_password: str, receiver_emails: str, sender_alias: Optional[str] = None, use_tls: Optional[bool] = None, use_ssl: Optional[bool] = None, notify_on: str = 'all', notify_with: Optional[list[str]] = None)# +class great_expectations.checkpoint.EmailAction(data_context: AbstractDataContext, renderer: dict, smtp_address: str, smtp_port: str, sender_login: str, sender_password: str, receiver_emails: str, sender_alias: Optional[str] = None, use_tls: Optional[bool] = None, use_ssl: Optional[bool] = None, notify_on: str = 'all', notify_with: Optional[list[str]] = None)#

Sends an email to a given list of email addresses.

@@ -57,7 +57,7 @@ action: :param notify_with: Optional list of DataDocs site names to display in Slack messages. Defaults to all.

-run(validation_result_suite: ExpectationSuiteValidationResult, validation_result_suite_identifier: Union[ValidationResultIdentifier, GXCloudIdentifier], data_asset, expectation_suite_identifier: Optional[ExpectationSuiteIdentifier] = None, checkpoint_identifier=None, **kwargs)# +run(validation_result_suite: ExpectationSuiteValidationResult, validation_result_suite_identifier: Union[ValidationResultIdentifier, GXCloudIdentifier], data_asset, expectation_suite_identifier: Optional[ExpectationSuiteIdentifier] = None, checkpoint_identifier=None, **kwargs)#

Public entrypoint GX uses to trigger a ValidationAction.

diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/checkpoint/MicrosoftTeamsNotificationAction_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/checkpoint/MicrosoftTeamsNotificationAction_class.mdx index 4c884f3016b7..57609d53630e 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/checkpoint/MicrosoftTeamsNotificationAction_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/checkpoint/MicrosoftTeamsNotificationAction_class.mdx @@ -8,7 +8,7 @@ import CodeBlock from '@theme/CodeBlock';
-class great_expectations.checkpoint.MicrosoftTeamsNotificationAction(data_context: AbstractDataContext, renderer: dict, microsoft_teams_webhook: str, notify_on: str = 'all')# +class great_expectations.checkpoint.MicrosoftTeamsNotificationAction(data_context: AbstractDataContext, renderer: dict, microsoft_teams_webhook: str, notify_on: str = 'all')#

Sends a Microsoft Teams notification to a given webhook.

@@ -41,7 +41,7 @@ action: :param notify_on: Specifies validation status that triggers notification. One of "all", "failure", "success".
-run(validation_result_suite: ExpectationSuiteValidationResult, validation_result_suite_identifier: Union[ValidationResultIdentifier, GXCloudIdentifier], data_asset, expectation_suite_identifier: Optional[ExpectationSuiteIdentifier] = None, checkpoint_identifier=None, **kwargs)# +run(validation_result_suite: ExpectationSuiteValidationResult, validation_result_suite_identifier: Union[ValidationResultIdentifier, GXCloudIdentifier], data_asset, expectation_suite_identifier: Optional[ExpectationSuiteIdentifier] = None, checkpoint_identifier=None, **kwargs)#

Public entrypoint GX uses to trigger a ValidationAction.

diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/checkpoint/OpsgenieAlertAction_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/checkpoint/OpsgenieAlertAction_class.mdx index 21180fc6c287..23e6bfc32476 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/checkpoint/OpsgenieAlertAction_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/checkpoint/OpsgenieAlertAction_class.mdx @@ -8,7 +8,7 @@ import CodeBlock from '@theme/CodeBlock';
-class great_expectations.checkpoint.OpsgenieAlertAction(data_context: AbstractDataContext, renderer: dict, api_key: str, region: Optional[str] = None, priority: str = 'P3', notify_on: str = 'failure', tags: Optional[list[str]] = None)# +class great_expectations.checkpoint.OpsgenieAlertAction(data_context: AbstractDataContext, renderer: dict, api_key: str, region: Optional[str] = None, priority: str = 'P3', notify_on: str = 'failure', tags: Optional[list[str]] = None)#

Sends an Opsgenie alert.

@@ -35,7 +35,7 @@ action:
-run(validation_result_suite: ExpectationSuiteValidationResult, validation_result_suite_identifier: Union[ValidationResultIdentifier, GXCloudIdentifier], data_asset, expectation_suite_identifier: Optional[ExpectationSuiteIdentifier] = None, checkpoint_identifier=None, **kwargs)# +run(validation_result_suite: ExpectationSuiteValidationResult, validation_result_suite_identifier: Union[ValidationResultIdentifier, GXCloudIdentifier], data_asset, expectation_suite_identifier: Optional[ExpectationSuiteIdentifier] = None, checkpoint_identifier=None, **kwargs)#

Public entrypoint GX uses to trigger a ValidationAction.

diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/checkpoint/PagerdutyAlertAction_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/checkpoint/PagerdutyAlertAction_class.mdx index 8c394da857bc..8e61efbb8388 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/checkpoint/PagerdutyAlertAction_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/checkpoint/PagerdutyAlertAction_class.mdx @@ -8,7 +8,7 @@ import CodeBlock from '@theme/CodeBlock';
-class great_expectations.checkpoint.PagerdutyAlertAction(data_context: AbstractDataContext, api_key: str, routing_key: str, notify_on: str = 'failure', severity: str = 'critical')# +class great_expectations.checkpoint.PagerdutyAlertAction(data_context: AbstractDataContext, api_key: str, routing_key: str, notify_on: str = 'failure', severity: str = 'critical')#

Sends a PagerDuty event.

@@ -32,7 +32,7 @@ action:
-run(validation_result_suite: ExpectationSuiteValidationResult, validation_result_suite_identifier: Union[ValidationResultIdentifier, GXCloudIdentifier], data_asset, expectation_suite_identifier: Optional[ExpectationSuiteIdentifier] = None, checkpoint_identifier=None, **kwargs)# +run(validation_result_suite: ExpectationSuiteValidationResult, validation_result_suite_identifier: Union[ValidationResultIdentifier, GXCloudIdentifier], data_asset, expectation_suite_identifier: Optional[ExpectationSuiteIdentifier] = None, checkpoint_identifier=None, **kwargs)#

Public entrypoint GX uses to trigger a ValidationAction.

diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/checkpoint/SNSNotificationAction_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/checkpoint/SNSNotificationAction_class.mdx index 664fea2b8d42..9a549d77e8f6 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/checkpoint/SNSNotificationAction_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/checkpoint/SNSNotificationAction_class.mdx @@ -8,7 +8,7 @@ import CodeBlock from '@theme/CodeBlock';
-class great_expectations.checkpoint.SNSNotificationAction(data_context: AbstractDataContext, sns_topic_arn: str, sns_message_subject: Optional[str])# +class great_expectations.checkpoint.SNSNotificationAction(data_context: AbstractDataContext, sns_topic_arn: str, sns_message_subject: Optional[str])#

Action that pushes validations results to an SNS topic with a subject of passed or failed.

@@ -32,7 +32,7 @@ import CodeBlock from '@theme/CodeBlock';
-run(validation_result_suite: ExpectationSuiteValidationResult, validation_result_suite_identifier: Union[ValidationResultIdentifier, GXCloudIdentifier], data_asset, expectation_suite_identifier: Optional[ExpectationSuiteIdentifier] = None, checkpoint_identifier=None, **kwargs)# +run(validation_result_suite: ExpectationSuiteValidationResult, validation_result_suite_identifier: Union[ValidationResultIdentifier, GXCloudIdentifier], data_asset, expectation_suite_identifier: Optional[ExpectationSuiteIdentifier] = None, checkpoint_identifier=None, **kwargs)#

Public entrypoint GX uses to trigger a ValidationAction.

diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/checkpoint/SlackNotificationAction_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/checkpoint/SlackNotificationAction_class.mdx index 64fb7d52e93e..6cee2a7ddbad 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/checkpoint/SlackNotificationAction_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/checkpoint/SlackNotificationAction_class.mdx @@ -8,7 +8,7 @@ import CodeBlock from '@theme/CodeBlock';
-class great_expectations.checkpoint.SlackNotificationAction(data_context: AbstractDataContext, renderer: dict, slack_webhook: Optional[str] = None, slack_token: Optional[str] = None, slack_channel: Optional[str] = None, notify_on: str = 'all', notify_with: Optional[list[str]] = None, show_failed_expectations: bool = False)# +class great_expectations.checkpoint.SlackNotificationAction(data_context: AbstractDataContext, renderer: dict, slack_webhook: Optional[str] = None, slack_token: Optional[str] = None, slack_channel: Optional[str] = None, notify_on: str = 'all', notify_with: Optional[list[str]] = None, show_failed_expectations: bool = False)#

Sends a Slack notification to a given webhook.

@@ -50,7 +50,7 @@ action: :param show_failed_expectations: Shows a list of failed expectation types.

-run(validation_result_suite: ExpectationSuiteValidationResult, validation_result_suite_identifier: Union[ValidationResultIdentifier, GXCloudIdentifier], data_asset, expectation_suite_identifier: Optional[ExpectationSuiteIdentifier] = None, checkpoint_identifier=None, **kwargs)# +run(validation_result_suite: ExpectationSuiteValidationResult, validation_result_suite_identifier: Union[ValidationResultIdentifier, GXCloudIdentifier], data_asset, expectation_suite_identifier: Optional[ExpectationSuiteIdentifier] = None, checkpoint_identifier=None, **kwargs)#

Public entrypoint GX uses to trigger a ValidationAction.

diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/checkpoint/StoreEvaluationParametersAction_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/checkpoint/StoreEvaluationParametersAction_class.mdx index 04ccf4cf1a6c..99b808e0a6e8 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/checkpoint/StoreEvaluationParametersAction_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/checkpoint/StoreEvaluationParametersAction_class.mdx @@ -8,7 +8,7 @@ import CodeBlock from '@theme/CodeBlock';
-class great_expectations.checkpoint.StoreEvaluationParametersAction(data_context: AbstractDataContext, target_store_name: Optional[str] = None)# +class great_expectations.checkpoint.StoreEvaluationParametersAction(data_context: AbstractDataContext, target_store_name: Optional[str] = None)#

Store evaluation parameters from a validation result.

@@ -34,7 +34,7 @@ in the process of validating other prior expectations.

-run(validation_result_suite: ExpectationSuiteValidationResult, validation_result_suite_identifier: Union[ValidationResultIdentifier, GXCloudIdentifier], data_asset, expectation_suite_identifier: Optional[ExpectationSuiteIdentifier] = None, checkpoint_identifier=None, **kwargs)# +run(validation_result_suite: ExpectationSuiteValidationResult, validation_result_suite_identifier: Union[ValidationResultIdentifier, GXCloudIdentifier], data_asset, expectation_suite_identifier: Optional[ExpectationSuiteIdentifier] = None, checkpoint_identifier=None, **kwargs)#

Public entrypoint GX uses to trigger a ValidationAction.

diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/checkpoint/StoreMetricsAction_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/checkpoint/StoreMetricsAction_class.mdx index 07cfb1be8238..1b7f48362549 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/checkpoint/StoreMetricsAction_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/checkpoint/StoreMetricsAction_class.mdx @@ -8,7 +8,7 @@ import CodeBlock from '@theme/CodeBlock';
-class great_expectations.checkpoint.StoreMetricsAction(data_context: AbstractDataContext, requested_metrics: dict, target_store_name: Optional[str] = 'metrics_store')# +class great_expectations.checkpoint.StoreMetricsAction(data_context: AbstractDataContext, requested_metrics: dict, target_store_name: Optional[str] = 'metrics_store')#

Extract metrics from a Validation Result and store them in a metrics store.

@@ -50,7 +50,7 @@ import CodeBlock from '@theme/CodeBlock';
-run(validation_result_suite: ExpectationSuiteValidationResult, validation_result_suite_identifier: Union[ValidationResultIdentifier, GXCloudIdentifier], data_asset, expectation_suite_identifier: Optional[ExpectationSuiteIdentifier] = None, checkpoint_identifier=None, **kwargs)# +run(validation_result_suite: ExpectationSuiteValidationResult, validation_result_suite_identifier: Union[ValidationResultIdentifier, GXCloudIdentifier], data_asset, expectation_suite_identifier: Optional[ExpectationSuiteIdentifier] = None, checkpoint_identifier=None, **kwargs)#

Public entrypoint GX uses to trigger a ValidationAction.

diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/checkpoint/StoreValidationResultAction_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/checkpoint/StoreValidationResultAction_class.mdx index 2d6f3c00e90d..96b982fe7ac3 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/checkpoint/StoreValidationResultAction_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/checkpoint/StoreValidationResultAction_class.mdx @@ -8,7 +8,7 @@ import CodeBlock from '@theme/CodeBlock';
-class great_expectations.checkpoint.StoreValidationResultAction(data_context: AbstractDataContext, target_store_name: Optional[str] = None)# +class great_expectations.checkpoint.StoreValidationResultAction(data_context: AbstractDataContext, target_store_name: Optional[str] = None)#

Store a validation result in the ValidationsStore.

@@ -33,7 +33,7 @@ import CodeBlock from '@theme/CodeBlock';
-run(validation_result_suite: ExpectationSuiteValidationResult, validation_result_suite_identifier: Union[ValidationResultIdentifier, GXCloudIdentifier], data_asset, expectation_suite_identifier: Optional[ExpectationSuiteIdentifier] = None, checkpoint_identifier=None, **kwargs)# +run(validation_result_suite: ExpectationSuiteValidationResult, validation_result_suite_identifier: Union[ValidationResultIdentifier, GXCloudIdentifier], data_asset, expectation_suite_identifier: Optional[ExpectationSuiteIdentifier] = None, checkpoint_identifier=None, **kwargs)#

Public entrypoint GX uses to trigger a ValidationAction.

diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/checkpoint/UpdateDataDocsAction_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/checkpoint/UpdateDataDocsAction_class.mdx index dd67a4ab0fa3..7d52b3ac49ca 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/checkpoint/UpdateDataDocsAction_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/checkpoint/UpdateDataDocsAction_class.mdx @@ -8,7 +8,7 @@ import CodeBlock from '@theme/CodeBlock';
-class great_expectations.checkpoint.UpdateDataDocsAction(data_context: AbstractDataContext, site_names: list[str] | str | None = None)# +class great_expectations.checkpoint.UpdateDataDocsAction(data_context: AbstractDataContext, site_names: list[str] | str | None = None)#

Notify the site builders of all data docs sites of a Data Context that a validation result should be added to the data docs.

@@ -33,7 +33,7 @@ action:
-run(validation_result_suite: ExpectationSuiteValidationResult, validation_result_suite_identifier: Union[ValidationResultIdentifier, GXCloudIdentifier], data_asset, expectation_suite_identifier: Optional[ExpectationSuiteIdentifier] = None, checkpoint_identifier=None, **kwargs)# +run(validation_result_suite: ExpectationSuiteValidationResult, validation_result_suite_identifier: Union[ValidationResultIdentifier, GXCloudIdentifier], data_asset, expectation_suite_identifier: Optional[ExpectationSuiteIdentifier] = None, checkpoint_identifier=None, **kwargs)#

Public entrypoint GX uses to trigger a ValidationAction.

diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/checkpoint/ValidationAction_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/checkpoint/ValidationAction_class.mdx index 7076f933e56f..e388de317adc 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/checkpoint/ValidationAction_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/checkpoint/ValidationAction_class.mdx @@ -8,7 +8,7 @@ sidebar_label: ValidationAction
-class great_expectations.checkpoint.ValidationAction(data_context: AbstractDataContext)# +class great_expectations.checkpoint.ValidationAction(data_context: AbstractDataContext)#

Base class for all Actions that act on Validation Results and are aware of a Data Context namespace structure.

@@ -20,7 +20,7 @@ sidebar_label: ValidationAction
-_run(validation_result_suite: ExpectationSuiteValidationResult, validation_result_suite_identifier: Union[ValidationResultIdentifier, GXCloudIdentifier], data_asset, expectation_suite_identifier=None, checkpoint_identifier=None)# +_run(validation_result_suite: ExpectationSuiteValidationResult, validation_result_suite_identifier: Union[ValidationResultIdentifier, GXCloudIdentifier], data_asset, expectation_suite_identifier=None, checkpoint_identifier=None)#

Private method containing the logic specific to a ValidationAction’s implementation.

@@ -47,7 +47,7 @@ class (for open source Great Expectations) or the GeCloudIdentifier (from Great
-run(validation_result_suite: ExpectationSuiteValidationResult, validation_result_suite_identifier: Union[ValidationResultIdentifier, GXCloudIdentifier], data_asset, expectation_suite_identifier: Optional[ExpectationSuiteIdentifier] = None, checkpoint_identifier=None, **kwargs)# +run(validation_result_suite: ExpectationSuiteValidationResult, validation_result_suite_identifier: Union[ValidationResultIdentifier, GXCloudIdentifier], data_asset, expectation_suite_identifier: Optional[ExpectationSuiteIdentifier] = None, checkpoint_identifier=None, **kwargs)#

Public entrypoint GX uses to trigger a ValidationAction.

diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/checkpoint/types/checkpoint_result/CheckpointResult_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/checkpoint/types/checkpoint_result/CheckpointResult_class.mdx index 86e64c509fd1..c0b1cbe75ca9 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/checkpoint/types/checkpoint_result/CheckpointResult_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/checkpoint/types/checkpoint_result/CheckpointResult_class.mdx @@ -8,7 +8,7 @@ import CodeBlock from '@theme/CodeBlock';
-class great_expectations.checkpoint.types.checkpoint_result.CheckpointResult(run_id: RunIdentifier, run_results: dict[ValidationResultIdentifier, dict[str, ExpectationSuiteValidationResult | dict | str]], checkpoint_config: CheckpointConfig, validation_result_url: Optional[str] = None, success: Optional[bool] = None)# +class great_expectations.checkpoint.types.checkpoint_result.CheckpointResult(run_id: RunIdentifier, run_results: dict[ValidationResultIdentifier, dict[str, ExpectationSuiteValidationResult | dict | str]], checkpoint_config: CheckpointConfig, validation_result_url: Optional[str] = None, success: Optional[bool] = None)#

Object returned by Checkpoint.run.

@@ -67,7 +67,7 @@ might have an extra key named "expectation_suite_severity_level" to indicate if
-list_validation_result_identifiers() → List[ValidationResultIdentifier]# +list_validation_result_identifiers() → List[ValidationResultIdentifier]#

Obtain a list of all the ValidationResultIdentifiers used in this CheckpointResult.

@@ -81,7 +81,7 @@ might have an extra key named "expectation_suite_severity_level" to indicate if
-list_validation_results(group_by: Literal['validation_result_identifier', 'expectation_suite_name', 'data_asset_name'] | None = None) → list[ExpectationSuiteValidationResult] | dict# +list_validation_results(group_by: Literal['validation_result_identifier', 'expectation_suite_name', 'data_asset_name'] | None = None) → list[ExpectationSuiteValidationResult] | dict#

Obtain the ExpectationValidationResults belonging to this CheckpointResult.

diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/core/ExpectationConfiguration_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/core/ExpectationConfiguration_class.mdx index fcabd99decfe..6aba421f06c6 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/core/ExpectationConfiguration_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/core/ExpectationConfiguration_class.mdx @@ -74,7 +74,7 @@ sidebar_label: ExpectationConfiguration
-validate(validator: Validator, runtime_configuration: Optional[dict] = None) → ExpectationValidationResult# +validate(validator: Validator, runtime_configuration: Optional[dict] = None) → ExpectationValidationResult#

Runs the expectation against a Validator.

@@ -95,7 +95,7 @@ sidebar_label: ExpectationConfiguration
Return type
-

ExpectationValidationResult

+

ExpectationValidationResult

diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/core/ExpectationSuiteValidationResult_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/core/ExpectationSuiteValidationResult_class.mdx index 46724f3679aa..4f5eaebf2abd 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/core/ExpectationSuiteValidationResult_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/core/ExpectationSuiteValidationResult_class.mdx @@ -8,7 +8,7 @@ import CodeBlock from '@theme/CodeBlock';
-class great_expectations.core.ExpectationSuiteValidationResult(success: Optional[bool] = None, results: Optional[list] = None, evaluation_parameters: Optional[dict] = None, statistics: Optional[dict] = None, meta: Optional[Union[great_expectations.core.expectation_validation_result.ExpectationSuiteValidationResult, dict]] = None, ge_cloud_id: Optional[str] = None)# +class great_expectations.core.ExpectationSuiteValidationResult(success: Optional[bool] = None, results: Optional[list] = None, evaluation_parameters: Optional[dict] = None, statistics: Optional[dict] = None, meta: Optional[Union[great_expectations.core.expectation_validation_result.ExpectationSuiteValidationResult, dict]] = None, ge_cloud_id: Optional[str] = None)#

The result of a batch of data validated against an Expectation Suite.

diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/core/ExpectationSuite_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/core/ExpectationSuite_class.mdx index 25325cf84abb..d2031db8c2cc 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/core/ExpectationSuite_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/core/ExpectationSuite_class.mdx @@ -8,7 +8,7 @@ sidebar_label: ExpectationSuite
-class great_expectations.core.ExpectationSuite(expectation_suite_name: str, data_context: Optional[AbstractDataContext] = None, expectations: Optional[Sequence[Union[dict, ExpectationConfiguration]]] = None, evaluation_parameters: Optional[dict] = None, data_asset_type: Optional[str] = None, execution_engine_type: Optional[Type[ExecutionEngine]] = None, meta: Optional[dict] = None, ge_cloud_id: Optional[str] = None)# +class great_expectations.core.ExpectationSuite(expectation_suite_name: str, data_context: Optional[AbstractDataContext] = None, expectations: Optional[Sequence[Union[dict, ExpectationConfiguration]]] = None, evaluation_parameters: Optional[dict] = None, data_asset_type: Optional[str] = None, execution_engine_type: Optional[Type[ExecutionEngine]] = None, meta: Optional[dict] = None, ge_cloud_id: Optional[str] = None)#

Suite of expectations plus create, read, update, and delete functionality.

@@ -40,7 +40,7 @@ sidebar_label: ExpectationSuite
-add_expectation(expectation_configuration: great_expectations.core.expectation_configuration.ExpectationConfiguration, send_usage_event: bool = True, match_type: str = 'domain', overwrite_existing: bool = True) → great_expectations.core.expectation_configuration.ExpectationConfiguration# +add_expectation(expectation_configuration: great_expectations.core.expectation_configuration.ExpectationConfiguration, send_usage_event: bool = True, match_type: str = 'domain', overwrite_existing: bool = True) → great_expectations.core.expectation_configuration.ExpectationConfiguration#

Upsert specified ExpectationConfiguration into this ExpectationSuite.

@@ -71,7 +71,7 @@ False.

-find_expectations(expectation_configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None, match_type: str = 'domain', ge_cloud_id: Optional[str] = None) → List[great_expectations.core.expectation_configuration.ExpectationConfiguration]# +find_expectations(expectation_configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None, match_type: str = 'domain', ge_cloud_id: Optional[str] = None) → List[great_expectations.core.expectation_configuration.ExpectationConfiguration]#

Find Expectations matching the given ExpectationConfiguration on the given match_type. @@ -96,7 +96,7 @@ based on all configuration parameters

-remove_expectation(expectation_configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None, match_type: str = 'domain', remove_multiple_matches: bool = False, ge_cloud_id: Optional[Union[str, uuid.UUID]] = None) → List[great_expectations.core.expectation_configuration.ExpectationConfiguration]# +remove_expectation(expectation_configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None, match_type: str = 'domain', remove_multiple_matches: bool = False, ge_cloud_id: Optional[Union[str, uuid.UUID]] = None) → List[great_expectations.core.expectation_configuration.ExpectationConfiguration]#

Remove an ExpectationConfiguration from the ExpectationSuite.

diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/core/ExpectationValidationResult_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/core/ExpectationValidationResult_class.mdx index 205a0704bf42..c921f3cd5da0 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/core/ExpectationValidationResult_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/core/ExpectationValidationResult_class.mdx @@ -8,7 +8,7 @@ sidebar_label: ExpectationValidationResult
-class great_expectations.core.ExpectationValidationResult(success: Optional[bool] = None, expectation_config: Optional[ExpectationConfiguration] = None, result: Optional[dict] = None, meta: Optional[dict] = None, exception_info: Optional[dict] = None, rendered_content: Optional[RenderedAtomicContent] = None, **kwargs: dict)# +class great_expectations.core.ExpectationValidationResult(success: Optional[bool] = None, expectation_config: Optional[ExpectationConfiguration] = None, result: Optional[dict] = None, meta: Optional[dict] = None, exception_info: Optional[dict] = None, rendered_content: Optional[RenderedAtomicContent] = None, **kwargs: dict)#

An Expectation validation result.

diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/core/batch/BatchDefinition_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/core/batch/BatchDefinition_class.mdx index 9a3999dfba50..1532cd1cd3b5 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/core/batch/BatchDefinition_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/core/batch/BatchDefinition_class.mdx @@ -20,7 +20,7 @@ translated into a Batch. One or more BatchDefinitions should always be
-Relevant Documentation Links -
diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/core/batch/BatchRequest_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/core/batch/BatchRequest_class.mdx index ed202734062f..e64d1fabe29c 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/core/batch/BatchRequest_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/core/batch/BatchRequest_class.mdx @@ -17,8 +17,7 @@ import CodeBlock from '@theme/CodeBlock';
-Relevant Documentation Links -
diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/core/batch/Batch_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/core/batch/Batch_class.mdx index 2bf7954c879a..b95c1b402162 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/core/batch/Batch_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/core/batch/Batch_class.mdx @@ -8,7 +8,7 @@ sidebar_label: Batch
-class great_expectations.core.batch.Batch(data: Optional[Union[Type[great_expectations.core.batch.BatchData], Type[pandas.core.frame.DataFrame], Type[pyspark.sql.dataframe.DataFrame]]] = None, batch_request: Optional[Union[great_expectations.core.batch.BatchRequestBase, dict]] = None, batch_definition: Optional[great_expectations.core.batch.BatchDefinition] = None, batch_spec: Optional[great_expectations.core.id_dict.BatchSpec] = None, batch_markers: Optional[great_expectations.core.batch.BatchMarkers] = None, data_context=None, datasource_name=None, batch_parameters=None, batch_kwargs=None)# +class great_expectations.core.batch.Batch(data: Optional[Union[Type[great_expectations.core.batch.BatchData], Type[pandas.core.frame.DataFrame], Type[pyspark.sql.dataframe.DataFrame]]] = None, batch_request: Optional[Union[great_expectations.core.batch.BatchRequestBase, dict]] = None, batch_definition: Optional[great_expectations.core.batch.BatchDefinition] = None, batch_spec: Optional[great_expectations.core.id_dict.BatchSpec] = None, batch_markers: Optional[great_expectations.core.batch.BatchMarkers] = None, data_context=None, datasource_name=None, batch_parameters=None, batch_kwargs=None)#

A Batch is a selection of records from a Data Asset.

@@ -19,7 +19,7 @@ data and maintains metadata.

-Relevant Documentation Links -
diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/core/batch/RuntimeBatchRequest_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/core/batch/RuntimeBatchRequest_class.mdx index e480e965d77a..fe4e8ef31ee8 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/core/batch/RuntimeBatchRequest_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/core/batch/RuntimeBatchRequest_class.mdx @@ -20,8 +20,8 @@ user-provided identifiers for uniquely identifying the data.

-Relevant Documentation Links -
diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/core/yaml_handler/YAMLHandler_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/core/yaml_handler/YAMLHandler_class.mdx index c7a103c7d2a0..534751039d50 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/core/yaml_handler/YAMLHandler_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/core/yaml_handler/YAMLHandler_class.mdx @@ -36,7 +36,7 @@ yaml_handler.dump(example_dict)`}

Converts a Python dictionary into a YAML string.

Dump code has been adopted from: -Example.Html

+Example.Html

{`>>> data = {'foo': 'bar'} >>> yaml_str = yaml_handler.dump(data) >>> print(yaml_str) diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/data_context/AbstractDataContext_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/data_context/AbstractDataContext_class.mdx index 6f34ca7ce507..70a4c65909ac 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/data_context/AbstractDataContext_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/data_context/AbstractDataContext_class.mdx @@ -79,17 +79,17 @@ majority of Data Context functionality lives here.

-add_checkpoint(name: str = None, config_version: float = 1.0, template_name: str | None = None, module_name: str = 'great_expectations.checkpoint', class_name: str = 'Checkpoint', run_name_template: str | None = None, expectation_suite_name: str | None = None, batch_request: dict | None = None, action_list: Sequence[ActionDict] | None = None, evaluation_parameters: dict | None = None, runtime_configuration: dict | None = None, validations: list[great_expectations.data_context.types.base.CheckpointValidationConfig] | list[dict] | None = None, profilers: list[dict] | None = None, site_names: str | list[str] | None = None, slack_webhook: str | None = None, notify_on: str | None = None, notify_with: str | list[str] | None = None, ge_cloud_id: str | None = None, expectation_suite_ge_cloud_id: str | None = None, default_validation_id: str | None = None, id: str | None = None, expectation_suite_id: str | None = None, validator: great_expectations.validator.validator.Validator | None = None, checkpoint: None = None) → great_expectations.checkpoint.checkpoint.Checkpoint# +add_checkpoint(name: str = None, config_version: float = 1.0, template_name: str | None = None, module_name: str = 'great_expectations.checkpoint', class_name: str = 'Checkpoint', run_name_template: str | None = None, expectation_suite_name: str | None = None, batch_request: dict | None = None, action_list: Sequence[ActionDict] | None = None, evaluation_parameters: dict | None = None, runtime_configuration: dict | None = None, validations: list[great_expectations.data_context.types.base.CheckpointValidationConfig] | list[dict] | None = None, profilers: list[dict] | None = None, site_names: str | list[str] | None = None, slack_webhook: str | None = None, notify_on: str | None = None, notify_with: str | list[str] | None = None, ge_cloud_id: str | None = None, expectation_suite_ge_cloud_id: str | None = None, default_validation_id: str | None = None, id: str | None = None, expectation_suite_id: str | None = None, validator: great_expectations.validator.validator.Validator | None = None, checkpoint: None = None) → great_expectations.checkpoint.checkpoint.Checkpoint#
-add_checkpoint(name: None = None, config_version: float = 1.0, template_name: None = None, module_name: str = 'great_expectations.checkpoint', class_name: str = 'Checkpoint', run_name_template: None = None, expectation_suite_name: None = None, batch_request: None = None, action_list: Sequence[ActionDict] | None = None, evaluation_parameters: None = None, runtime_configuration: None = None, validations: None = None, profilers: None = None, site_names: None = None, slack_webhook: None = None, notify_on: None = None, notify_with: None = None, ge_cloud_id: None = None, expectation_suite_ge_cloud_id: None = None, default_validation_id: None = None, id: None = None, expectation_suite_id: None = None, validator: great_expectations.validator.validator.Validator | None = None, checkpoint: great_expectations.checkpoint.checkpoint.Checkpoint = None) → great_expectations.checkpoint.checkpoint.Checkpoint +add_checkpoint(name: None = None, config_version: float = 1.0, template_name: None = None, module_name: str = 'great_expectations.checkpoint', class_name: str = 'Checkpoint', run_name_template: None = None, expectation_suite_name: None = None, batch_request: None = None, action_list: Sequence[ActionDict] | None = None, evaluation_parameters: None = None, runtime_configuration: None = None, validations: None = None, profilers: None = None, site_names: None = None, slack_webhook: None = None, notify_on: None = None, notify_with: None = None, ge_cloud_id: None = None, expectation_suite_ge_cloud_id: None = None, default_validation_id: None = None, id: None = None, expectation_suite_id: None = None, validator: great_expectations.validator.validator.Validator | None = None, checkpoint: great_expectations.checkpoint.checkpoint.Checkpoint = None) → great_expectations.checkpoint.checkpoint.Checkpoint

Add a Checkpoint to the DataContext.

-Relevant Documentation Links-
@@ -162,17 +162,17 @@ majority of Data Context functionality lives here.

-add_datasource(name: str = None, initialize: bool = True, datasource: None = None, **kwargs) → BaseDatasource | FluentDatasource | LegacyDatasource | None# +add_datasource(name: str = None, initialize: bool = True, datasource: None = None, **kwargs) → BaseDatasource | FluentDatasource | LegacyDatasource | None#
-add_datasource(name: None = None, initialize: bool = True, datasource: BaseDatasource | FluentDatasource | LegacyDatasource = None, **kwargs) → BaseDatasource | FluentDatasource | LegacyDatasource | None +add_datasource(name: None = None, initialize: bool = True, datasource: BaseDatasource | FluentDatasource | LegacyDatasource = None, **kwargs) → BaseDatasource | FluentDatasource | LegacyDatasource | None

Add a new Datasource to the data context, with configuration provided as kwargs.

Relevant Documentation Links
@@ -197,10 +197,10 @@ initialize it, for example if a user needs to debug database connectivity.

-add_expectation_suite(expectation_suite_name: str, id: str | None = None, expectations: list[dict | ExpectationConfiguration] | None = None, evaluation_parameters: dict | None = None, data_asset_type: str | None = None, execution_engine_type: Type[ExecutionEngine] | None = None, meta: dict | None = None, expectation_suite: None = None) → great_expectations.core.expectation_suite.ExpectationSuite# +add_expectation_suite(expectation_suite_name: str, id: str | None = None, expectations: list[dict | ExpectationConfiguration] | None = None, evaluation_parameters: dict | None = None, data_asset_type: str | None = None, execution_engine_type: Type[ExecutionEngine] | None = None, meta: dict | None = None, expectation_suite: None = None) → great_expectations.core.expectation_suite.ExpectationSuite#
-add_expectation_suite(expectation_suite_name: None = None, id: str | None = None, expectations: list[dict | ExpectationConfiguration] | None = None, evaluation_parameters: dict | None = None, data_asset_type: str | None = None, execution_engine_type: Type[ExecutionEngine] | None = None, meta: dict | None = None, expectation_suite: great_expectations.core.expectation_suite.ExpectationSuite = None) → great_expectations.core.expectation_suite.ExpectationSuite +add_expectation_suite(expectation_suite_name: None = None, id: str | None = None, expectations: list[dict | ExpectationConfiguration] | None = None, evaluation_parameters: dict | None = None, data_asset_type: str | None = None, execution_engine_type: Type[ExecutionEngine] | None = None, meta: dict | None = None, expectation_suite: great_expectations.core.expectation_suite.ExpectationSuite = None) → great_expectations.core.expectation_suite.ExpectationSuite

Build a new ExpectationSuite and save it utilizing the context’s underlying ExpectationsStore.

@@ -256,10 +256,10 @@ initialize it, for example if a user needs to debug database connectivity.

-add_or_update_checkpoint(name: str = None, id: str | None = None, config_version: float = 1.0, template_name: str | None = None, module_name: str = 'great_expectations.checkpoint', class_name: str = 'Checkpoint', run_name_template: str | None = None, expectation_suite_name: str | None = None, batch_request: dict | None = None, action_list: Sequence[ActionDict] | None = None, evaluation_parameters: dict | None = None, runtime_configuration: dict | None = None, validations: list[dict] | None = None, profilers: list[dict] | None = None, site_names: str | list[str] | None = None, slack_webhook: str | None = None, notify_on: str | None = None, notify_with: str | list[str] | None = None, expectation_suite_id: str | None = None, expectation_suite_ge_cloud_id: str | None = None, default_validation_id: str | None = None, validator: great_expectations.validator.validator.Validator | None = None, checkpoint: None = None) → great_expectations.checkpoint.checkpoint.Checkpoint# +add_or_update_checkpoint(name: str = None, id: str | None = None, config_version: float = 1.0, template_name: str | None = None, module_name: str = 'great_expectations.checkpoint', class_name: str = 'Checkpoint', run_name_template: str | None = None, expectation_suite_name: str | None = None, batch_request: dict | None = None, action_list: Sequence[ActionDict] | None = None, evaluation_parameters: dict | None = None, runtime_configuration: dict | None = None, validations: list[dict] | None = None, profilers: list[dict] | None = None, site_names: str | list[str] | None = None, slack_webhook: str | None = None, notify_on: str | None = None, notify_with: str | list[str] | None = None, expectation_suite_id: str | None = None, expectation_suite_ge_cloud_id: str | None = None, default_validation_id: str | None = None, validator: great_expectations.validator.validator.Validator | None = None, checkpoint: None = None) → great_expectations.checkpoint.checkpoint.Checkpoint#
-add_or_update_checkpoint(name: None = None, id: None = None, config_version: float = 1.0, template_name: None = None, module_name: str = 'great_expectations.checkpoint', class_name: str = 'Checkpoint', run_name_template: None = None, expectation_suite_name: None = None, batch_request: None = None, action_list: Sequence[ActionDict] | None = None, evaluation_parameters: None = None, runtime_configuration: None = None, validations: None = None, profilers: None = None, site_names: None = None, slack_webhook: None = None, notify_on: None = None, notify_with: None = None, expectation_suite_id: None = None, expectation_suite_ge_cloud_id: None = None, default_validation_id: None = None, validator: great_expectations.validator.validator.Validator | None = None, checkpoint: great_expectations.checkpoint.checkpoint.Checkpoint = None) → great_expectations.checkpoint.checkpoint.Checkpoint +add_or_update_checkpoint(name: None = None, id: None = None, config_version: float = 1.0, template_name: None = None, module_name: str = 'great_expectations.checkpoint', class_name: str = 'Checkpoint', run_name_template: None = None, expectation_suite_name: None = None, batch_request: None = None, action_list: Sequence[ActionDict] | None = None, evaluation_parameters: None = None, runtime_configuration: None = None, validations: None = None, profilers: None = None, site_names: None = None, slack_webhook: None = None, notify_on: None = None, notify_with: None = None, expectation_suite_id: None = None, expectation_suite_ge_cloud_id: None = None, default_validation_id: None = None, validator: great_expectations.validator.validator.Validator | None = None, checkpoint: great_expectations.checkpoint.checkpoint.Checkpoint = None) → great_expectations.checkpoint.checkpoint.Checkpoint

Add a new Checkpoint or update an existing one on the context depending on whether it already exists or not.

@@ -305,10 +305,10 @@ initialize it, for example if a user needs to debug database connectivity.

-add_or_update_datasource(name: str = None, datasource: None = None, **kwargs) → BaseDatasource | FluentDatasource | LegacyDatasource# +add_or_update_datasource(name: str = None, datasource: None = None, **kwargs) → BaseDatasource | FluentDatasource | LegacyDatasource#
-add_or_update_datasource(name: None = None, datasource: BaseDatasource | FluentDatasource | LegacyDatasource = None, **kwargs) → BaseDatasource | FluentDatasource | LegacyDatasource +add_or_update_datasource(name: None = None, datasource: BaseDatasource | FluentDatasource | LegacyDatasource = None, **kwargs) → BaseDatasource | FluentDatasource | LegacyDatasource

Add a new Datasource or update an existing one on the context depending on whether

@@ -332,10 +332,10 @@ initialize it, for example if a user needs to debug database connectivity.

-add_or_update_expectation_suite(expectation_suite_name: str, id: str | None = None, expectations: list[dict | ExpectationConfiguration] | None = None, evaluation_parameters: dict | None = None, data_asset_type: str | None = None, execution_engine_type: Type[ExecutionEngine] | None = None, meta: dict | None = None, expectation_suite: None = None) → great_expectations.core.expectation_suite.ExpectationSuite# +add_or_update_expectation_suite(expectation_suite_name: str, id: str | None = None, expectations: list[dict | ExpectationConfiguration] | None = None, evaluation_parameters: dict | None = None, data_asset_type: str | None = None, execution_engine_type: Type[ExecutionEngine] | None = None, meta: dict | None = None, expectation_suite: None = None) → great_expectations.core.expectation_suite.ExpectationSuite#
-add_or_update_expectation_suite(expectation_suite_name: None = None, id: str | None = None, expectations: list[dict | ExpectationConfiguration] | None = None, evaluation_parameters: dict | None = None, data_asset_type: str | None = None, execution_engine_type: Type[ExecutionEngine] | None = None, meta: dict | None = None, expectation_suite: great_expectations.core.expectation_suite.ExpectationSuite = None) → great_expectations.core.expectation_suite.ExpectationSuite +add_or_update_expectation_suite(expectation_suite_name: None = None, id: str | None = None, expectations: list[dict | ExpectationConfiguration] | None = None, evaluation_parameters: dict | None = None, data_asset_type: str | None = None, execution_engine_type: Type[ExecutionEngine] | None = None, meta: dict | None = None, expectation_suite: great_expectations.core.expectation_suite.ExpectationSuite = None) → great_expectations.core.expectation_suite.ExpectationSuite

Add a new ExpectationSuite or update an existing one on the context depending on whether it already exists or not.

@@ -389,7 +389,7 @@ initialize it, for example if a user needs to debug database connectivity.

Relevant Documentation Links
@@ -551,7 +551,7 @@ If None, return available data assets for all datasources.

-get_batch_list(datasource_name: Optional[str] = None, data_connector_name: Optional[str] = None, data_asset_name: Optional[str] = None, batch_request: Optional[BatchRequestBase] = None, batch_data: Optional[Any] = None, data_connector_query: Optional[dict] = None, batch_identifiers: Optional[dict] = None, limit: Optional[int] = None, index: Optional[Union[int, list, tuple, slice, str]] = None, custom_filter_function: Optional[Callable] = None, sampling_method: Optional[str] = None, sampling_kwargs: Optional[dict] = None, splitter_method: Optional[str] = None, splitter_kwargs: Optional[dict] = None, runtime_parameters: Optional[dict] = None, query: Optional[str] = None, path: Optional[str] = None, batch_filter_parameters: Optional[dict] = None, batch_spec_passthrough: Optional[dict] = None, batch_request_options: Optional[Union[dict, BatchRequestOptions]] = None, **kwargs: Optional[dict]) → List[Batch]# +get_batch_list(datasource_name: Optional[str] = None, data_connector_name: Optional[str] = None, data_asset_name: Optional[str] = None, batch_request: Optional[BatchRequestBase] = None, batch_data: Optional[Any] = None, data_connector_query: Optional[dict] = None, batch_identifiers: Optional[dict] = None, limit: Optional[int] = None, index: Optional[Union[int, list, tuple, slice, str]] = None, custom_filter_function: Optional[Callable] = None, sampling_method: Optional[str] = None, sampling_kwargs: Optional[dict] = None, splitter_method: Optional[str] = None, splitter_kwargs: Optional[dict] = None, runtime_parameters: Optional[dict] = None, query: Optional[str] = None, path: Optional[str] = None, batch_filter_parameters: Optional[dict] = None, batch_spec_passthrough: Optional[dict] = None, batch_request_options: Optional[Union[dict, BatchRequestOptions]] = None, **kwargs: Optional[dict]) → List[Batch]#

Get the list of zero or more batches, based on a variety of flexible input types.

@@ -609,7 +609,7 @@ numbers retrieve from the end of the list (ex: -1 retrieves the las
-get_checkpoint(name: Optional[str] = None, ge_cloud_id: Optional[str] = None, id: Optional[str] = None) → great_expectations.checkpoint.checkpoint.Checkpoint# +get_checkpoint(name: Optional[str] = None, ge_cloud_id: Optional[str] = None, id: Optional[str] = None) → great_expectations.checkpoint.checkpoint.Checkpoint#

Retrieves a given Checkpoint by either name or id.

@@ -636,7 +636,7 @@ numbers retrieve from the end of the list (ex: -1 retrieves the las
-get_datasource(datasource_name: str = 'default') → BaseDatasource | FluentDatasource | LegacyDatasource# +get_datasource(datasource_name: str = 'default') → BaseDatasource | FluentDatasource | LegacyDatasource#

Retrieve a given Datasource by name from the context’s underlying DatasourceStore.

@@ -657,7 +657,7 @@ numbers retrieve from the end of the list (ex: -1 retrieves the las
-get_expectation_suite(expectation_suite_name: Optional[str] = None, include_rendered_content: Optional[bool] = None, ge_cloud_id: Optional[str] = None) → great_expectations.core.expectation_suite.ExpectationSuite# +get_expectation_suite(expectation_suite_name: Optional[str] = None, include_rendered_content: Optional[bool] = None, ge_cloud_id: Optional[str] = None) → great_expectations.core.expectation_suite.ExpectationSuite#

Get an Expectation Suite by name.

@@ -685,7 +685,7 @@ ExpectationConfiguration.

-get_validator(datasource_name: Optional[str] = None, data_connector_name: Optional[str] = None, data_asset_name: Optional[str] = None, batch: Optional[Batch] = None, batch_list: Optional[List[Batch]] = None, batch_request: Optional[Union[BatchRequestBase, FluentBatchRequest]] = None, batch_request_list: Optional[List[BatchRequestBase]] = None, batch_data: Optional[Any] = None, data_connector_query: Optional[Union[IDDict, dict]] = None, batch_identifiers: Optional[dict] = None, limit: Optional[int] = None, index: Optional[Union[int, list, tuple, slice, str]] = None, custom_filter_function: Optional[Callable] = None, sampling_method: Optional[str] = None, sampling_kwargs: Optional[dict] = None, splitter_method: Optional[str] = None, splitter_kwargs: Optional[dict] = None, runtime_parameters: Optional[dict] = None, query: Optional[str] = None, path: Optional[str] = None, batch_filter_parameters: Optional[dict] = None, expectation_suite_ge_cloud_id: Optional[str] = None, batch_spec_passthrough: Optional[dict] = None, expectation_suite_name: Optional[str] = None, expectation_suite: Optional[ExpectationSuite] = None, create_expectation_suite_with_name: Optional[str] = None, include_rendered_content: Optional[bool] = None, expectation_suite_id: Optional[str] = None, **kwargs) → Validator# +get_validator(datasource_name: Optional[str] = None, data_connector_name: Optional[str] = None, data_asset_name: Optional[str] = None, batch: Optional[Batch] = None, batch_list: Optional[List[Batch]] = None, batch_request: Optional[Union[BatchRequestBase, FluentBatchRequest]] = None, batch_request_list: Optional[List[BatchRequestBase]] = None, batch_data: Optional[Any] = None, data_connector_query: Optional[Union[IDDict, dict]] = None, batch_identifiers: Optional[dict] = None, limit: Optional[int] = None, index: Optional[Union[int, list, tuple, slice, str]] = None, custom_filter_function: Optional[Callable] = None, sampling_method: Optional[str] = None, sampling_kwargs: Optional[dict] = None, splitter_method: Optional[str] = None, splitter_kwargs: Optional[dict] = None, runtime_parameters: Optional[dict] = None, query: Optional[str] = None, path: Optional[str] = None, batch_filter_parameters: Optional[dict] = None, expectation_suite_ge_cloud_id: Optional[str] = None, batch_spec_passthrough: Optional[dict] = None, expectation_suite_name: Optional[str] = None, expectation_suite: Optional[ExpectationSuite] = None, create_expectation_suite_with_name: Optional[str] = None, include_rendered_content: Optional[bool] = None, expectation_suite_id: Optional[str] = None, **kwargs) → Validator#

Retrieve a Validator with a batch list and an ExpectationSuite.

@@ -738,7 +738,7 @@ numbers retrieve from the end of the list (ex: -1 retrieves the las
Return type
-

Validator

+

Validator

Raises
    @@ -804,7 +804,7 @@ numbers retrieve from the end of the list (ex: -1 retrieves the las
-run_checkpoint(checkpoint_name: str | None = None, ge_cloud_id: str | None = None, template_name: str | None = None, run_name_template: str | None = None, expectation_suite_name: str | None = None, batch_request: BatchRequestBase | FluentBatchRequest | dict | None = None, action_list: Sequence[ActionDict] | None = None, evaluation_parameters: dict | None = None, runtime_configuration: dict | None = None, validations: list[dict] | None = None, profilers: list[dict] | None = None, run_id: str | float | None = None, run_name: str | None = None, run_time: datetime.datetime | None = None, result_format: str | None = None, expectation_suite_ge_cloud_id: str | None = None, id: str | None = None, expectation_suite_id: str | None = None, **kwargs) → CheckpointResult# +run_checkpoint(checkpoint_name: str | None = None, ge_cloud_id: str | None = None, template_name: str | None = None, run_name_template: str | None = None, expectation_suite_name: str | None = None, batch_request: BatchRequestBase | FluentBatchRequest | dict | None = None, action_list: Sequence[ActionDict] | None = None, evaluation_parameters: dict | None = None, runtime_configuration: dict | None = None, validations: list[dict] | None = None, profilers: list[dict] | None = None, run_id: str | float | None = None, run_name: str | None = None, run_time: datetime.datetime | None = None, result_format: str | None = None, expectation_suite_ge_cloud_id: str | None = None, id: str | None = None, expectation_suite_id: str | None = None, **kwargs) → CheckpointResult#

Validate using an existing Checkpoint.

@@ -846,7 +846,7 @@ numbers retrieve from the end of the list (ex: -1 retrieves the las
-save_expectation_suite(expectation_suite: great_expectations.core.expectation_suite.ExpectationSuite, expectation_suite_name: Optional[str] = None, overwrite_existing: bool = True, include_rendered_content: Optional[bool] = None, **kwargs: Optional[dict]) → None# +save_expectation_suite(expectation_suite: great_expectations.core.expectation_suite.ExpectationSuite, expectation_suite_name: Optional[str] = None, overwrite_existing: bool = True, include_rendered_content: Optional[bool] = None, **kwargs: Optional[dict]) → None#

Save the provided ExpectationSuite into the DataContext using the configured ExpectationStore.

@@ -890,7 +890,7 @@ Expectations) are the only ones you’ll need.

Relevant Documentation Links
@@ -921,7 +921,7 @@ The returned object is determined by return_mode.

-update_checkpoint(checkpoint: great_expectations.checkpoint.checkpoint.Checkpoint) → great_expectations.checkpoint.checkpoint.Checkpoint# +update_checkpoint(checkpoint: great_expectations.checkpoint.checkpoint.Checkpoint) → great_expectations.checkpoint.checkpoint.Checkpoint#

Update a Checkpoint that already exists.

@@ -964,7 +964,7 @@ The returned object is determined by return_mode.

-update_datasource(datasource: BaseDatasource | FluentDatasource | LegacyDatasource) → BaseDatasource | FluentDatasource | LegacyDatasource# +update_datasource(datasource: BaseDatasource | FluentDatasource | LegacyDatasource) → BaseDatasource | FluentDatasource | LegacyDatasource#

Updates a Datasource that already exists in the store.

@@ -981,7 +981,7 @@ The returned object is determined by return_mode.

-update_expectation_suite(expectation_suite: great_expectations.core.expectation_suite.ExpectationSuite) → great_expectations.core.expectation_suite.ExpectationSuite# +update_expectation_suite(expectation_suite: great_expectations.core.expectation_suite.ExpectationSuite) → great_expectations.core.expectation_suite.ExpectationSuite#

Update an ExpectationSuite that already exists.

@@ -1001,7 +1001,7 @@ The returned object is determined by return_mode.

-update_project_config(project_config: Union[great_expectations.data_context.types.base.DataContextConfig, Mapping]) → great_expectations.data_context.types.base.DataContextConfig# +update_project_config(project_config: Union[great_expectations.data_context.types.base.DataContextConfig, Mapping]) → great_expectations.data_context.types.base.DataContextConfig#

Update the context’s config with the values from another config object.

@@ -1018,7 +1018,7 @@ The returned object is determined by return_mode.

-view_validation_result(result: CheckpointResult) → None# +view_validation_result(result: CheckpointResult) → None#

New in version 0.16.15.

diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/data_context/CloudDataContext_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/data_context/CloudDataContext_class.mdx index e79d6b2d1c0b..4fe65df91efc 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/data_context/CloudDataContext_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/data_context/CloudDataContext_class.mdx @@ -7,7 +7,7 @@ sidebar_label: CloudDataContext
-class great_expectations.data_context.CloudDataContext(project_config: Optional[Union[DataContextConfig, Mapping]] = None, context_root_dir: Optional[PathStr] = None, project_root_dir: Optional[PathStr] = None, runtime_environment: Optional[dict] = None, cloud_base_url: Optional[str] = None, cloud_access_token: Optional[str] = None, cloud_organization_id: Optional[str] = None)# +class great_expectations.data_context.CloudDataContext(project_config: Optional[Union[DataContextConfig, Mapping]] = None, context_root_dir: Optional[PathStr] = None, project_root_dir: Optional[PathStr] = None, runtime_environment: Optional[dict] = None, cloud_base_url: Optional[str] = None, cloud_access_token: Optional[str] = None, cloud_organization_id: Optional[str] = None)#

Subclass of AbstractDataContext that contains functionality necessary to work in a GX Cloud-backed environment.

@@ -32,14 +32,14 @@ sidebar_label: CloudDataContext
-add_datasource(name: str | None = None, initialize: bool = True, datasource: BaseDatasource | FluentDatasource | LegacyDatasource | None = None, **kwargs) → BaseDatasource | FluentDatasource | LegacyDatasource | None# +add_datasource(name: str | None = None, initialize: bool = True, datasource: BaseDatasource | FluentDatasource | LegacyDatasource | None = None, **kwargs) → BaseDatasource | FluentDatasource | LegacyDatasource | None#

Add a new Datasource to the data context, with configuration provided as kwargs.

Relevant Documentation Links
@@ -64,7 +64,7 @@ initialize it, for example if a user needs to debug database connectivity.

-add_expectation_suite(expectation_suite_name: str | None = None, id: str | None = None, expectations: list[dict | ExpectationConfiguration] | None = None, evaluation_parameters: dict | None = None, data_asset_type: str | None = None, execution_engine_type: Type[ExecutionEngine] | None = None, meta: dict | None = None, expectation_suite: ExpectationSuite | None = None) → ExpectationSuite# +add_expectation_suite(expectation_suite_name: str | None = None, id: str | None = None, expectations: list[dict | ExpectationConfiguration] | None = None, evaluation_parameters: dict | None = None, data_asset_type: str | None = None, execution_engine_type: Type[ExecutionEngine] | None = None, meta: dict | None = None, expectation_suite: ExpectationSuite | None = None) → ExpectationSuite#

Build a new ExpectationSuite and save it utilizing the context’s underlying ExpectationsStore.

@@ -118,7 +118,7 @@ initialize it, for example if a user needs to debug database connectivity.

-add_or_update_checkpoint(name: str | None = None, id: str | None = None, config_version: float = 1.0, template_name: str | None = None, module_name: str = 'great_expectations.checkpoint', class_name: str = 'Checkpoint', run_name_template: str | None = None, expectation_suite_name: str | None = None, batch_request: dict | None = None, action_list: Sequence[ActionDict] | None = None, evaluation_parameters: dict | None = None, runtime_configuration: dict | None = None, validations: list[CheckpointValidationConfig] | list[dict] | None = None, profilers: list[dict] | None = None, site_names: str | list[str] | None = None, slack_webhook: str | None = None, notify_on: str | None = None, notify_with: str | list[str] | None = None, expectation_suite_id: str | None = None, expectation_suite_ge_cloud_id: str | None = None, default_validation_id: str | None = None, validator: Validator | None = None, checkpoint: Checkpoint | None = None) → Checkpoint# +add_or_update_checkpoint(name: str | None = None, id: str | None = None, config_version: float = 1.0, template_name: str | None = None, module_name: str = 'great_expectations.checkpoint', class_name: str = 'Checkpoint', run_name_template: str | None = None, expectation_suite_name: str | None = None, batch_request: dict | None = None, action_list: Sequence[ActionDict] | None = None, evaluation_parameters: dict | None = None, runtime_configuration: dict | None = None, validations: list[CheckpointValidationConfig] | list[dict] | None = None, profilers: list[dict] | None = None, site_names: str | list[str] | None = None, slack_webhook: str | None = None, notify_on: str | None = None, notify_with: str | list[str] | None = None, expectation_suite_id: str | None = None, expectation_suite_ge_cloud_id: str | None = None, default_validation_id: str | None = None, validator: Validator | None = None, checkpoint: Checkpoint | None = None) → Checkpoint#

Add a new Checkpoint or update an existing one on the context depending on whether it already exists or not.

@@ -164,7 +164,7 @@ initialize it, for example if a user needs to debug database connectivity.

-add_or_update_datasource(name: str | None = None, datasource: BaseDatasource | FluentDatasource | LegacyDatasource | None = None, **kwargs) → BaseDatasource | FluentDatasource | LegacyDatasource# +add_or_update_datasource(name: str | None = None, datasource: BaseDatasource | FluentDatasource | LegacyDatasource | None = None, **kwargs) → BaseDatasource | FluentDatasource | LegacyDatasource#

Add a new Datasource or update an existing one on the context depending on whether

@@ -188,7 +188,7 @@ initialize it, for example if a user needs to debug database connectivity.

-add_or_update_expectation_suite(expectation_suite_name: str | None = None, id: str | None = None, expectations: list[dict | ExpectationConfiguration] | None = None, evaluation_parameters: dict | None = None, data_asset_type: str | None = None, execution_engine_type: Type[ExecutionEngine] | None = None, meta: dict | None = None, expectation_suite: ExpectationSuite | None = None) → ExpectationSuite# +add_or_update_expectation_suite(expectation_suite_name: str | None = None, id: str | None = None, expectations: list[dict | ExpectationConfiguration] | None = None, evaluation_parameters: dict | None = None, data_asset_type: str | None = None, execution_engine_type: Type[ExecutionEngine] | None = None, meta: dict | None = None, expectation_suite: ExpectationSuite | None = None) → ExpectationSuite#

Add a new ExpectationSuite or update an existing one on the context depending on whether it already exists or not.

@@ -242,7 +242,7 @@ initialize it, for example if a user needs to debug database connectivity.

Relevant Documentation Links
@@ -285,7 +285,7 @@ already exist. Then, it will initialize a new DataContext in that folder and wri
Relevant Documentation Links
-

Data Context

+

Data Context

@@ -433,7 +433,7 @@ If None, return available data assets for all datasources.

-get_batch_list(datasource_name: Optional[str] = None, data_connector_name: Optional[str] = None, data_asset_name: Optional[str] = None, batch_request: Optional[BatchRequestBase] = None, batch_data: Optional[Any] = None, data_connector_query: Optional[dict] = None, batch_identifiers: Optional[dict] = None, limit: Optional[int] = None, index: Optional[Union[int, list, tuple, slice, str]] = None, custom_filter_function: Optional[Callable] = None, sampling_method: Optional[str] = None, sampling_kwargs: Optional[dict] = None, splitter_method: Optional[str] = None, splitter_kwargs: Optional[dict] = None, runtime_parameters: Optional[dict] = None, query: Optional[str] = None, path: Optional[str] = None, batch_filter_parameters: Optional[dict] = None, batch_spec_passthrough: Optional[dict] = None, batch_request_options: Optional[Union[dict, BatchRequestOptions]] = None, **kwargs: Optional[dict]) → List[Batch]# +get_batch_list(datasource_name: Optional[str] = None, data_connector_name: Optional[str] = None, data_asset_name: Optional[str] = None, batch_request: Optional[BatchRequestBase] = None, batch_data: Optional[Any] = None, data_connector_query: Optional[dict] = None, batch_identifiers: Optional[dict] = None, limit: Optional[int] = None, index: Optional[Union[int, list, tuple, slice, str]] = None, custom_filter_function: Optional[Callable] = None, sampling_method: Optional[str] = None, sampling_kwargs: Optional[dict] = None, splitter_method: Optional[str] = None, splitter_kwargs: Optional[dict] = None, runtime_parameters: Optional[dict] = None, query: Optional[str] = None, path: Optional[str] = None, batch_filter_parameters: Optional[dict] = None, batch_spec_passthrough: Optional[dict] = None, batch_request_options: Optional[Union[dict, BatchRequestOptions]] = None, **kwargs: Optional[dict]) → List[Batch]#

Get the list of zero or more batches, based on a variety of flexible input types.

@@ -491,7 +491,7 @@ numbers retrieve from the end of the list (ex: -1 retrieves the las
-get_checkpoint(name: Optional[str] = None, ge_cloud_id: Optional[str] = None, id: Optional[str] = None) → great_expectations.checkpoint.checkpoint.Checkpoint# +get_checkpoint(name: Optional[str] = None, ge_cloud_id: Optional[str] = None, id: Optional[str] = None) → great_expectations.checkpoint.checkpoint.Checkpoint#

Retrieves a given Checkpoint by either name or id.

@@ -518,7 +518,7 @@ numbers retrieve from the end of the list (ex: -1 retrieves the las
-get_datasource(datasource_name: str = 'default') → BaseDatasource | FluentDatasource | LegacyDatasource# +get_datasource(datasource_name: str = 'default') → BaseDatasource | FluentDatasource | LegacyDatasource#

Retrieve a given Datasource by name from the context’s underlying DatasourceStore.

@@ -539,7 +539,7 @@ numbers retrieve from the end of the list (ex: -1 retrieves the las
-get_validator(datasource_name: Optional[str] = None, data_connector_name: Optional[str] = None, data_asset_name: Optional[str] = None, batch: Optional[Batch] = None, batch_list: Optional[List[Batch]] = None, batch_request: Optional[Union[BatchRequestBase, FluentBatchRequest]] = None, batch_request_list: Optional[List[BatchRequestBase]] = None, batch_data: Optional[Any] = None, data_connector_query: Optional[Union[IDDict, dict]] = None, batch_identifiers: Optional[dict] = None, limit: Optional[int] = None, index: Optional[Union[int, list, tuple, slice, str]] = None, custom_filter_function: Optional[Callable] = None, sampling_method: Optional[str] = None, sampling_kwargs: Optional[dict] = None, splitter_method: Optional[str] = None, splitter_kwargs: Optional[dict] = None, runtime_parameters: Optional[dict] = None, query: Optional[str] = None, path: Optional[str] = None, batch_filter_parameters: Optional[dict] = None, expectation_suite_ge_cloud_id: Optional[str] = None, batch_spec_passthrough: Optional[dict] = None, expectation_suite_name: Optional[str] = None, expectation_suite: Optional[ExpectationSuite] = None, create_expectation_suite_with_name: Optional[str] = None, include_rendered_content: Optional[bool] = None, expectation_suite_id: Optional[str] = None, **kwargs) → Validator# +get_validator(datasource_name: Optional[str] = None, data_connector_name: Optional[str] = None, data_asset_name: Optional[str] = None, batch: Optional[Batch] = None, batch_list: Optional[List[Batch]] = None, batch_request: Optional[Union[BatchRequestBase, FluentBatchRequest]] = None, batch_request_list: Optional[List[BatchRequestBase]] = None, batch_data: Optional[Any] = None, data_connector_query: Optional[Union[IDDict, dict]] = None, batch_identifiers: Optional[dict] = None, limit: Optional[int] = None, index: Optional[Union[int, list, tuple, slice, str]] = None, custom_filter_function: Optional[Callable] = None, sampling_method: Optional[str] = None, sampling_kwargs: Optional[dict] = None, splitter_method: Optional[str] = None, splitter_kwargs: Optional[dict] = None, runtime_parameters: Optional[dict] = None, query: Optional[str] = None, path: Optional[str] = None, batch_filter_parameters: Optional[dict] = None, expectation_suite_ge_cloud_id: Optional[str] = None, batch_spec_passthrough: Optional[dict] = None, expectation_suite_name: Optional[str] = None, expectation_suite: Optional[ExpectationSuite] = None, create_expectation_suite_with_name: Optional[str] = None, include_rendered_content: Optional[bool] = None, expectation_suite_id: Optional[str] = None, **kwargs) → Validator#

Retrieve a Validator with a batch list and an ExpectationSuite.

@@ -592,7 +592,7 @@ numbers retrieve from the end of the list (ex: -1 retrieves the las
Return type
-

Validator

+

Validator

Raises
    @@ -632,7 +632,7 @@ numbers retrieve from the end of the list (ex: -1 retrieves the las
-run_checkpoint(checkpoint_name: str | None = None, ge_cloud_id: str | None = None, template_name: str | None = None, run_name_template: str | None = None, expectation_suite_name: str | None = None, batch_request: BatchRequestBase | FluentBatchRequest | dict | None = None, action_list: Sequence[ActionDict] | None = None, evaluation_parameters: dict | None = None, runtime_configuration: dict | None = None, validations: list[dict] | None = None, profilers: list[dict] | None = None, run_id: str | float | None = None, run_name: str | None = None, run_time: datetime.datetime | None = None, result_format: str | None = None, expectation_suite_ge_cloud_id: str | None = None, id: str | None = None, expectation_suite_id: str | None = None, **kwargs) → CheckpointResult# +run_checkpoint(checkpoint_name: str | None = None, ge_cloud_id: str | None = None, template_name: str | None = None, run_name_template: str | None = None, expectation_suite_name: str | None = None, batch_request: BatchRequestBase | FluentBatchRequest | dict | None = None, action_list: Sequence[ActionDict] | None = None, evaluation_parameters: dict | None = None, runtime_configuration: dict | None = None, validations: list[dict] | None = None, profilers: list[dict] | None = None, run_id: str | float | None = None, run_name: str | None = None, run_time: datetime.datetime | None = None, result_format: str | None = None, expectation_suite_ge_cloud_id: str | None = None, id: str | None = None, expectation_suite_id: str | None = None, **kwargs) → CheckpointResult#

Validate using an existing Checkpoint.

@@ -674,7 +674,7 @@ numbers retrieve from the end of the list (ex: -1 retrieves the las
-save_expectation_suite(expectation_suite: great_expectations.core.expectation_suite.ExpectationSuite, expectation_suite_name: Optional[str] = None, overwrite_existing: bool = True, include_rendered_content: Optional[bool] = None, **kwargs: Optional[dict]) → None# +save_expectation_suite(expectation_suite: great_expectations.core.expectation_suite.ExpectationSuite, expectation_suite_name: Optional[str] = None, overwrite_existing: bool = True, include_rendered_content: Optional[bool] = None, **kwargs: Optional[dict]) → None#

Save the provided ExpectationSuite into the DataContext using the configured ExpectationStore.

@@ -718,7 +718,7 @@ Expectations) are the only ones you’ll need.

Relevant Documentation Links
@@ -749,7 +749,7 @@ The returned object is determined by return_mode.

-update_checkpoint(checkpoint: great_expectations.checkpoint.checkpoint.Checkpoint) → great_expectations.checkpoint.checkpoint.Checkpoint# +update_checkpoint(checkpoint: great_expectations.checkpoint.checkpoint.Checkpoint) → great_expectations.checkpoint.checkpoint.Checkpoint#

Update a Checkpoint that already exists.

@@ -792,7 +792,7 @@ The returned object is determined by return_mode.

-update_datasource(datasource: BaseDatasource | FluentDatasource | LegacyDatasource) → BaseDatasource | FluentDatasource | LegacyDatasource# +update_datasource(datasource: BaseDatasource | FluentDatasource | LegacyDatasource) → BaseDatasource | FluentDatasource | LegacyDatasource#

Updates a Datasource that already exists in the store.

@@ -809,7 +809,7 @@ The returned object is determined by return_mode.

-update_expectation_suite(expectation_suite: great_expectations.core.expectation_suite.ExpectationSuite) → great_expectations.core.expectation_suite.ExpectationSuite# +update_expectation_suite(expectation_suite: great_expectations.core.expectation_suite.ExpectationSuite) → great_expectations.core.expectation_suite.ExpectationSuite#

Update an ExpectationSuite that already exists.

@@ -829,7 +829,7 @@ The returned object is determined by return_mode.

-update_project_config(project_config: Union[great_expectations.data_context.types.base.DataContextConfig, Mapping]) → great_expectations.data_context.types.base.DataContextConfig# +update_project_config(project_config: Union[great_expectations.data_context.types.base.DataContextConfig, Mapping]) → great_expectations.data_context.types.base.DataContextConfig#

Update the context’s config with the values from another config object.

@@ -846,7 +846,7 @@ The returned object is determined by return_mode.

-view_validation_result(result: CheckpointResult) → None# +view_validation_result(result: CheckpointResult) → None#

New in version 0.16.15.

diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/data_context/EphemeralDataContext_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/data_context/EphemeralDataContext_class.mdx index 9578d77f6f5c..3b7985726897 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/data_context/EphemeralDataContext_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/data_context/EphemeralDataContext_class.mdx @@ -7,13 +7,13 @@ sidebar_label: EphemeralDataContext
-class great_expectations.data_context.EphemeralDataContext(project_config: Union[great_expectations.data_context.types.base.DataContextConfig, Mapping], runtime_environment: Optional[dict] = None)# +class great_expectations.data_context.EphemeralDataContext(project_config: Union[great_expectations.data_context.types.base.DataContextConfig, Mapping], runtime_environment: Optional[dict] = None)#

Subclass of AbstractDataContext that uses runtime values to generate a temporary or in-memory DataContext.

-add_checkpoint(name: str | None = None, config_version: float = 1.0, template_name: str | None = None, module_name: str = 'great_expectations.checkpoint', class_name: str = 'Checkpoint', run_name_template: str | None = None, expectation_suite_name: str | None = None, batch_request: dict | None = None, action_list: Sequence[ActionDict] | None = None, evaluation_parameters: dict | None = None, runtime_configuration: dict | None = None, validations: list[CheckpointValidationConfig] | list[dict] | None = None, profilers: list[dict] | None = None, site_names: str | list[str] | None = None, slack_webhook: str | None = None, notify_on: str | None = None, notify_with: str | list[str] | None = None, ge_cloud_id: str | None = None, expectation_suite_ge_cloud_id: str | None = None, default_validation_id: str | None = None, id: str | None = None, expectation_suite_id: str | None = None, validator: Validator | None = None, checkpoint: Checkpoint | None = None) → Checkpoint# +add_checkpoint(name: str | None = None, config_version: float = 1.0, template_name: str | None = None, module_name: str = 'great_expectations.checkpoint', class_name: str = 'Checkpoint', run_name_template: str | None = None, expectation_suite_name: str | None = None, batch_request: dict | None = None, action_list: Sequence[ActionDict] | None = None, evaluation_parameters: dict | None = None, runtime_configuration: dict | None = None, validations: list[CheckpointValidationConfig] | list[dict] | None = None, profilers: list[dict] | None = None, site_names: str | list[str] | None = None, slack_webhook: str | None = None, notify_on: str | None = None, notify_with: str | list[str] | None = None, ge_cloud_id: str | None = None, expectation_suite_ge_cloud_id: str | None = None, default_validation_id: str | None = None, id: str | None = None, expectation_suite_id: str | None = None, validator: Validator | None = None, checkpoint: Checkpoint | None = None) → Checkpoint#

Add a Checkpoint to the DataContext.

@@ -21,7 +21,7 @@ sidebar_label: EphemeralDataContext
-Relevant Documentation Links -
@@ -93,14 +93,14 @@ sidebar_label: EphemeralDataContext
-add_datasource(name: str | None = None, initialize: bool = True, datasource: BaseDatasource | FluentDatasource | LegacyDatasource | None = None, **kwargs) → BaseDatasource | FluentDatasource | LegacyDatasource | None# +add_datasource(name: str | None = None, initialize: bool = True, datasource: BaseDatasource | FluentDatasource | LegacyDatasource | None = None, **kwargs) → BaseDatasource | FluentDatasource | LegacyDatasource | None#

Add a new Datasource to the data context, with configuration provided as kwargs.

Relevant Documentation Links
@@ -125,7 +125,7 @@ initialize it, for example if a user needs to debug database connectivity.

-add_expectation_suite(expectation_suite_name: str | None = None, id: str | None = None, expectations: list[dict | ExpectationConfiguration] | None = None, evaluation_parameters: dict | None = None, data_asset_type: str | None = None, execution_engine_type: Type[ExecutionEngine] | None = None, meta: dict | None = None, expectation_suite: ExpectationSuite | None = None) → ExpectationSuite# +add_expectation_suite(expectation_suite_name: str | None = None, id: str | None = None, expectations: list[dict | ExpectationConfiguration] | None = None, evaluation_parameters: dict | None = None, data_asset_type: str | None = None, execution_engine_type: Type[ExecutionEngine] | None = None, meta: dict | None = None, expectation_suite: ExpectationSuite | None = None) → ExpectationSuite#

Build a new ExpectationSuite and save it utilizing the context’s underlying ExpectationsStore.

@@ -179,7 +179,7 @@ initialize it, for example if a user needs to debug database connectivity.

-add_or_update_checkpoint(name: str | None = None, id: str | None = None, config_version: float = 1.0, template_name: str | None = None, module_name: str = 'great_expectations.checkpoint', class_name: str = 'Checkpoint', run_name_template: str | None = None, expectation_suite_name: str | None = None, batch_request: dict | None = None, action_list: Sequence[ActionDict] | None = None, evaluation_parameters: dict | None = None, runtime_configuration: dict | None = None, validations: list[CheckpointValidationConfig] | list[dict] | None = None, profilers: list[dict] | None = None, site_names: str | list[str] | None = None, slack_webhook: str | None = None, notify_on: str | None = None, notify_with: str | list[str] | None = None, expectation_suite_id: str | None = None, expectation_suite_ge_cloud_id: str | None = None, default_validation_id: str | None = None, validator: Validator | None = None, checkpoint: Checkpoint | None = None) → Checkpoint# +add_or_update_checkpoint(name: str | None = None, id: str | None = None, config_version: float = 1.0, template_name: str | None = None, module_name: str = 'great_expectations.checkpoint', class_name: str = 'Checkpoint', run_name_template: str | None = None, expectation_suite_name: str | None = None, batch_request: dict | None = None, action_list: Sequence[ActionDict] | None = None, evaluation_parameters: dict | None = None, runtime_configuration: dict | None = None, validations: list[CheckpointValidationConfig] | list[dict] | None = None, profilers: list[dict] | None = None, site_names: str | list[str] | None = None, slack_webhook: str | None = None, notify_on: str | None = None, notify_with: str | list[str] | None = None, expectation_suite_id: str | None = None, expectation_suite_ge_cloud_id: str | None = None, default_validation_id: str | None = None, validator: Validator | None = None, checkpoint: Checkpoint | None = None) → Checkpoint#

Add a new Checkpoint or update an existing one on the context depending on whether it already exists or not.

@@ -225,7 +225,7 @@ initialize it, for example if a user needs to debug database connectivity.

-add_or_update_datasource(name: str | None = None, datasource: BaseDatasource | FluentDatasource | LegacyDatasource | None = None, **kwargs) → BaseDatasource | FluentDatasource | LegacyDatasource# +add_or_update_datasource(name: str | None = None, datasource: BaseDatasource | FluentDatasource | LegacyDatasource | None = None, **kwargs) → BaseDatasource | FluentDatasource | LegacyDatasource#

Add a new Datasource or update an existing one on the context depending on whether

@@ -249,7 +249,7 @@ initialize it, for example if a user needs to debug database connectivity.

-add_or_update_expectation_suite(expectation_suite_name: str | None = None, id: str | None = None, expectations: list[dict | ExpectationConfiguration] | None = None, evaluation_parameters: dict | None = None, data_asset_type: str | None = None, execution_engine_type: Type[ExecutionEngine] | None = None, meta: dict | None = None, expectation_suite: ExpectationSuite | None = None) → ExpectationSuite# +add_or_update_expectation_suite(expectation_suite_name: str | None = None, id: str | None = None, expectations: list[dict | ExpectationConfiguration] | None = None, evaluation_parameters: dict | None = None, data_asset_type: str | None = None, execution_engine_type: Type[ExecutionEngine] | None = None, meta: dict | None = None, expectation_suite: ExpectationSuite | None = None) → ExpectationSuite#

Add a new ExpectationSuite or update an existing one on the context depending on whether it already exists or not.

@@ -303,7 +303,7 @@ initialize it, for example if a user needs to debug database connectivity.

Relevant Documentation Links
@@ -337,7 +337,7 @@ of their index.html files as values

-convert_to_file_context() → FileDataContext# +convert_to_file_context() → FileDataContext#

Convert existing EphemeralDataContext into a FileDataContext.

@@ -479,7 +479,7 @@ If None, return available data assets for all datasources.

-get_batch_list(datasource_name: Optional[str] = None, data_connector_name: Optional[str] = None, data_asset_name: Optional[str] = None, batch_request: Optional[BatchRequestBase] = None, batch_data: Optional[Any] = None, data_connector_query: Optional[dict] = None, batch_identifiers: Optional[dict] = None, limit: Optional[int] = None, index: Optional[Union[int, list, tuple, slice, str]] = None, custom_filter_function: Optional[Callable] = None, sampling_method: Optional[str] = None, sampling_kwargs: Optional[dict] = None, splitter_method: Optional[str] = None, splitter_kwargs: Optional[dict] = None, runtime_parameters: Optional[dict] = None, query: Optional[str] = None, path: Optional[str] = None, batch_filter_parameters: Optional[dict] = None, batch_spec_passthrough: Optional[dict] = None, batch_request_options: Optional[Union[dict, BatchRequestOptions]] = None, **kwargs: Optional[dict]) → List[Batch]# +get_batch_list(datasource_name: Optional[str] = None, data_connector_name: Optional[str] = None, data_asset_name: Optional[str] = None, batch_request: Optional[BatchRequestBase] = None, batch_data: Optional[Any] = None, data_connector_query: Optional[dict] = None, batch_identifiers: Optional[dict] = None, limit: Optional[int] = None, index: Optional[Union[int, list, tuple, slice, str]] = None, custom_filter_function: Optional[Callable] = None, sampling_method: Optional[str] = None, sampling_kwargs: Optional[dict] = None, splitter_method: Optional[str] = None, splitter_kwargs: Optional[dict] = None, runtime_parameters: Optional[dict] = None, query: Optional[str] = None, path: Optional[str] = None, batch_filter_parameters: Optional[dict] = None, batch_spec_passthrough: Optional[dict] = None, batch_request_options: Optional[Union[dict, BatchRequestOptions]] = None, **kwargs: Optional[dict]) → List[Batch]#

Get the list of zero or more batches, based on a variety of flexible input types.

@@ -537,7 +537,7 @@ numbers retrieve from the end of the list (ex: -1 retrieves the las
-get_checkpoint(name: Optional[str] = None, ge_cloud_id: Optional[str] = None, id: Optional[str] = None) → great_expectations.checkpoint.checkpoint.Checkpoint# +get_checkpoint(name: Optional[str] = None, ge_cloud_id: Optional[str] = None, id: Optional[str] = None) → great_expectations.checkpoint.checkpoint.Checkpoint#

Retrieves a given Checkpoint by either name or id.

@@ -564,7 +564,7 @@ numbers retrieve from the end of the list (ex: -1 retrieves the las
-get_datasource(datasource_name: str = 'default') → BaseDatasource | FluentDatasource | LegacyDatasource# +get_datasource(datasource_name: str = 'default') → BaseDatasource | FluentDatasource | LegacyDatasource#

Retrieve a given Datasource by name from the context’s underlying DatasourceStore.

@@ -585,7 +585,7 @@ numbers retrieve from the end of the list (ex: -1 retrieves the las
-get_expectation_suite(expectation_suite_name: Optional[str] = None, include_rendered_content: Optional[bool] = None, ge_cloud_id: Optional[str] = None) → great_expectations.core.expectation_suite.ExpectationSuite# +get_expectation_suite(expectation_suite_name: Optional[str] = None, include_rendered_content: Optional[bool] = None, ge_cloud_id: Optional[str] = None) → great_expectations.core.expectation_suite.ExpectationSuite#

Get an Expectation Suite by name.

@@ -613,7 +613,7 @@ ExpectationConfiguration.

-get_validator(datasource_name: Optional[str] = None, data_connector_name: Optional[str] = None, data_asset_name: Optional[str] = None, batch: Optional[Batch] = None, batch_list: Optional[List[Batch]] = None, batch_request: Optional[Union[BatchRequestBase, FluentBatchRequest]] = None, batch_request_list: Optional[List[BatchRequestBase]] = None, batch_data: Optional[Any] = None, data_connector_query: Optional[Union[IDDict, dict]] = None, batch_identifiers: Optional[dict] = None, limit: Optional[int] = None, index: Optional[Union[int, list, tuple, slice, str]] = None, custom_filter_function: Optional[Callable] = None, sampling_method: Optional[str] = None, sampling_kwargs: Optional[dict] = None, splitter_method: Optional[str] = None, splitter_kwargs: Optional[dict] = None, runtime_parameters: Optional[dict] = None, query: Optional[str] = None, path: Optional[str] = None, batch_filter_parameters: Optional[dict] = None, expectation_suite_ge_cloud_id: Optional[str] = None, batch_spec_passthrough: Optional[dict] = None, expectation_suite_name: Optional[str] = None, expectation_suite: Optional[ExpectationSuite] = None, create_expectation_suite_with_name: Optional[str] = None, include_rendered_content: Optional[bool] = None, expectation_suite_id: Optional[str] = None, **kwargs) → Validator# +get_validator(datasource_name: Optional[str] = None, data_connector_name: Optional[str] = None, data_asset_name: Optional[str] = None, batch: Optional[Batch] = None, batch_list: Optional[List[Batch]] = None, batch_request: Optional[Union[BatchRequestBase, FluentBatchRequest]] = None, batch_request_list: Optional[List[BatchRequestBase]] = None, batch_data: Optional[Any] = None, data_connector_query: Optional[Union[IDDict, dict]] = None, batch_identifiers: Optional[dict] = None, limit: Optional[int] = None, index: Optional[Union[int, list, tuple, slice, str]] = None, custom_filter_function: Optional[Callable] = None, sampling_method: Optional[str] = None, sampling_kwargs: Optional[dict] = None, splitter_method: Optional[str] = None, splitter_kwargs: Optional[dict] = None, runtime_parameters: Optional[dict] = None, query: Optional[str] = None, path: Optional[str] = None, batch_filter_parameters: Optional[dict] = None, expectation_suite_ge_cloud_id: Optional[str] = None, batch_spec_passthrough: Optional[dict] = None, expectation_suite_name: Optional[str] = None, expectation_suite: Optional[ExpectationSuite] = None, create_expectation_suite_with_name: Optional[str] = None, include_rendered_content: Optional[bool] = None, expectation_suite_id: Optional[str] = None, **kwargs) → Validator#

Retrieve a Validator with a batch list and an ExpectationSuite.

@@ -666,7 +666,7 @@ numbers retrieve from the end of the list (ex: -1 retrieves the las
Return type
-

Validator

+

Validator

Raises
    @@ -732,7 +732,7 @@ numbers retrieve from the end of the list (ex: -1 retrieves the las
-run_checkpoint(checkpoint_name: str | None = None, ge_cloud_id: str | None = None, template_name: str | None = None, run_name_template: str | None = None, expectation_suite_name: str | None = None, batch_request: BatchRequestBase | FluentBatchRequest | dict | None = None, action_list: Sequence[ActionDict] | None = None, evaluation_parameters: dict | None = None, runtime_configuration: dict | None = None, validations: list[dict] | None = None, profilers: list[dict] | None = None, run_id: str | float | None = None, run_name: str | None = None, run_time: datetime.datetime | None = None, result_format: str | None = None, expectation_suite_ge_cloud_id: str | None = None, id: str | None = None, expectation_suite_id: str | None = None, **kwargs) → CheckpointResult# +run_checkpoint(checkpoint_name: str | None = None, ge_cloud_id: str | None = None, template_name: str | None = None, run_name_template: str | None = None, expectation_suite_name: str | None = None, batch_request: BatchRequestBase | FluentBatchRequest | dict | None = None, action_list: Sequence[ActionDict] | None = None, evaluation_parameters: dict | None = None, runtime_configuration: dict | None = None, validations: list[dict] | None = None, profilers: list[dict] | None = None, run_id: str | float | None = None, run_name: str | None = None, run_time: datetime.datetime | None = None, result_format: str | None = None, expectation_suite_ge_cloud_id: str | None = None, id: str | None = None, expectation_suite_id: str | None = None, **kwargs) → CheckpointResult#

Validate using an existing Checkpoint.

@@ -774,7 +774,7 @@ numbers retrieve from the end of the list (ex: -1 retrieves the las
-save_expectation_suite(expectation_suite: great_expectations.core.expectation_suite.ExpectationSuite, expectation_suite_name: Optional[str] = None, overwrite_existing: bool = True, include_rendered_content: Optional[bool] = None, **kwargs: Optional[dict]) → None# +save_expectation_suite(expectation_suite: great_expectations.core.expectation_suite.ExpectationSuite, expectation_suite_name: Optional[str] = None, overwrite_existing: bool = True, include_rendered_content: Optional[bool] = None, **kwargs: Optional[dict]) → None#

Save the provided ExpectationSuite into the DataContext using the configured ExpectationStore.

@@ -818,7 +818,7 @@ Expectations) are the only ones you’ll need.

Relevant Documentation Links
@@ -849,7 +849,7 @@ The returned object is determined by return_mode.

-update_checkpoint(checkpoint: great_expectations.checkpoint.checkpoint.Checkpoint) → great_expectations.checkpoint.checkpoint.Checkpoint# +update_checkpoint(checkpoint: great_expectations.checkpoint.checkpoint.Checkpoint) → great_expectations.checkpoint.checkpoint.Checkpoint#

Update a Checkpoint that already exists.

@@ -892,7 +892,7 @@ The returned object is determined by return_mode.

-update_datasource(datasource: BaseDatasource | FluentDatasource | LegacyDatasource) → BaseDatasource | FluentDatasource | LegacyDatasource# +update_datasource(datasource: BaseDatasource | FluentDatasource | LegacyDatasource) → BaseDatasource | FluentDatasource | LegacyDatasource#

Updates a Datasource that already exists in the store.

@@ -909,7 +909,7 @@ The returned object is determined by return_mode.

-update_expectation_suite(expectation_suite: great_expectations.core.expectation_suite.ExpectationSuite) → great_expectations.core.expectation_suite.ExpectationSuite# +update_expectation_suite(expectation_suite: great_expectations.core.expectation_suite.ExpectationSuite) → great_expectations.core.expectation_suite.ExpectationSuite#

Update an ExpectationSuite that already exists.

@@ -929,7 +929,7 @@ The returned object is determined by return_mode.

-update_project_config(project_config: Union[great_expectations.data_context.types.base.DataContextConfig, Mapping]) → great_expectations.data_context.types.base.DataContextConfig# +update_project_config(project_config: Union[great_expectations.data_context.types.base.DataContextConfig, Mapping]) → great_expectations.data_context.types.base.DataContextConfig#

Update the context’s config with the values from another config object.

@@ -946,7 +946,7 @@ The returned object is determined by return_mode.

-view_validation_result(result: CheckpointResult) → None# +view_validation_result(result: CheckpointResult) → None#

New in version 0.16.15.

diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/data_context/FileDataContext_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/data_context/FileDataContext_class.mdx index eb7aa828c6d2..1f0b9f57e180 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/data_context/FileDataContext_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/data_context/FileDataContext_class.mdx @@ -7,13 +7,13 @@ sidebar_label: FileDataContext
-class great_expectations.data_context.FileDataContext(project_config: Optional[DataContextConfig] = None, context_root_dir: Optional[PathStr] = None, project_root_dir: Optional[PathStr] = None, runtime_environment: Optional[dict] = None)# +class great_expectations.data_context.FileDataContext(project_config: Optional[DataContextConfig] = None, context_root_dir: Optional[PathStr] = None, project_root_dir: Optional[PathStr] = None, runtime_environment: Optional[dict] = None)#

Subclass of AbstractDataContext that contains functionality necessary to work in a filesystem-backed environment.

-add_checkpoint(name: str | None = None, config_version: float = 1.0, template_name: str | None = None, module_name: str = 'great_expectations.checkpoint', class_name: str = 'Checkpoint', run_name_template: str | None = None, expectation_suite_name: str | None = None, batch_request: dict | None = None, action_list: Sequence[ActionDict] | None = None, evaluation_parameters: dict | None = None, runtime_configuration: dict | None = None, validations: list[CheckpointValidationConfig] | list[dict] | None = None, profilers: list[dict] | None = None, site_names: str | list[str] | None = None, slack_webhook: str | None = None, notify_on: str | None = None, notify_with: str | list[str] | None = None, ge_cloud_id: str | None = None, expectation_suite_ge_cloud_id: str | None = None, default_validation_id: str | None = None, id: str | None = None, expectation_suite_id: str | None = None, validator: Validator | None = None, checkpoint: Checkpoint | None = None) → Checkpoint# +add_checkpoint(name: str | None = None, config_version: float = 1.0, template_name: str | None = None, module_name: str = 'great_expectations.checkpoint', class_name: str = 'Checkpoint', run_name_template: str | None = None, expectation_suite_name: str | None = None, batch_request: dict | None = None, action_list: Sequence[ActionDict] | None = None, evaluation_parameters: dict | None = None, runtime_configuration: dict | None = None, validations: list[CheckpointValidationConfig] | list[dict] | None = None, profilers: list[dict] | None = None, site_names: str | list[str] | None = None, slack_webhook: str | None = None, notify_on: str | None = None, notify_with: str | list[str] | None = None, ge_cloud_id: str | None = None, expectation_suite_ge_cloud_id: str | None = None, default_validation_id: str | None = None, id: str | None = None, expectation_suite_id: str | None = None, validator: Validator | None = None, checkpoint: Checkpoint | None = None) → Checkpoint#

Add a Checkpoint to the DataContext.

@@ -21,7 +21,7 @@ sidebar_label: FileDataContext
-Relevant Documentation Links -
@@ -93,14 +93,14 @@ sidebar_label: FileDataContext
-add_datasource(name: str | None = None, initialize: bool = True, datasource: BaseDatasource | FluentDatasource | LegacyDatasource | None = None, **kwargs) → BaseDatasource | FluentDatasource | LegacyDatasource | None# +add_datasource(name: str | None = None, initialize: bool = True, datasource: BaseDatasource | FluentDatasource | LegacyDatasource | None = None, **kwargs) → BaseDatasource | FluentDatasource | LegacyDatasource | None#

Add a new Datasource to the data context, with configuration provided as kwargs.

Relevant Documentation Links
@@ -125,7 +125,7 @@ initialize it, for example if a user needs to debug database connectivity.

-add_expectation_suite(expectation_suite_name: str | None = None, id: str | None = None, expectations: list[dict | ExpectationConfiguration] | None = None, evaluation_parameters: dict | None = None, data_asset_type: str | None = None, execution_engine_type: Type[ExecutionEngine] | None = None, meta: dict | None = None, expectation_suite: ExpectationSuite | None = None) → ExpectationSuite# +add_expectation_suite(expectation_suite_name: str | None = None, id: str | None = None, expectations: list[dict | ExpectationConfiguration] | None = None, evaluation_parameters: dict | None = None, data_asset_type: str | None = None, execution_engine_type: Type[ExecutionEngine] | None = None, meta: dict | None = None, expectation_suite: ExpectationSuite | None = None) → ExpectationSuite#

Build a new ExpectationSuite and save it utilizing the context’s underlying ExpectationsStore.

@@ -179,7 +179,7 @@ initialize it, for example if a user needs to debug database connectivity.

-add_or_update_checkpoint(name: str | None = None, id: str | None = None, config_version: float = 1.0, template_name: str | None = None, module_name: str = 'great_expectations.checkpoint', class_name: str = 'Checkpoint', run_name_template: str | None = None, expectation_suite_name: str | None = None, batch_request: dict | None = None, action_list: Sequence[ActionDict] | None = None, evaluation_parameters: dict | None = None, runtime_configuration: dict | None = None, validations: list[CheckpointValidationConfig] | list[dict] | None = None, profilers: list[dict] | None = None, site_names: str | list[str] | None = None, slack_webhook: str | None = None, notify_on: str | None = None, notify_with: str | list[str] | None = None, expectation_suite_id: str | None = None, expectation_suite_ge_cloud_id: str | None = None, default_validation_id: str | None = None, validator: Validator | None = None, checkpoint: Checkpoint | None = None) → Checkpoint# +add_or_update_checkpoint(name: str | None = None, id: str | None = None, config_version: float = 1.0, template_name: str | None = None, module_name: str = 'great_expectations.checkpoint', class_name: str = 'Checkpoint', run_name_template: str | None = None, expectation_suite_name: str | None = None, batch_request: dict | None = None, action_list: Sequence[ActionDict] | None = None, evaluation_parameters: dict | None = None, runtime_configuration: dict | None = None, validations: list[CheckpointValidationConfig] | list[dict] | None = None, profilers: list[dict] | None = None, site_names: str | list[str] | None = None, slack_webhook: str | None = None, notify_on: str | None = None, notify_with: str | list[str] | None = None, expectation_suite_id: str | None = None, expectation_suite_ge_cloud_id: str | None = None, default_validation_id: str | None = None, validator: Validator | None = None, checkpoint: Checkpoint | None = None) → Checkpoint#

Add a new Checkpoint or update an existing one on the context depending on whether it already exists or not.

@@ -225,7 +225,7 @@ initialize it, for example if a user needs to debug database connectivity.

-add_or_update_datasource(name: str | None = None, datasource: BaseDatasource | FluentDatasource | LegacyDatasource | None = None, **kwargs) → BaseDatasource | FluentDatasource | LegacyDatasource# +add_or_update_datasource(name: str | None = None, datasource: BaseDatasource | FluentDatasource | LegacyDatasource | None = None, **kwargs) → BaseDatasource | FluentDatasource | LegacyDatasource#

Add a new Datasource or update an existing one on the context depending on whether

@@ -249,7 +249,7 @@ initialize it, for example if a user needs to debug database connectivity.

-add_or_update_expectation_suite(expectation_suite_name: str | None = None, id: str | None = None, expectations: list[dict | ExpectationConfiguration] | None = None, evaluation_parameters: dict | None = None, data_asset_type: str | None = None, execution_engine_type: Type[ExecutionEngine] | None = None, meta: dict | None = None, expectation_suite: ExpectationSuite | None = None) → ExpectationSuite# +add_or_update_expectation_suite(expectation_suite_name: str | None = None, id: str | None = None, expectations: list[dict | ExpectationConfiguration] | None = None, evaluation_parameters: dict | None = None, data_asset_type: str | None = None, execution_engine_type: Type[ExecutionEngine] | None = None, meta: dict | None = None, expectation_suite: ExpectationSuite | None = None) → ExpectationSuite#

Add a new ExpectationSuite or update an existing one on the context depending on whether it already exists or not.

@@ -303,7 +303,7 @@ initialize it, for example if a user needs to debug database connectivity.

Relevant Documentation Links
@@ -346,7 +346,7 @@ already exist. Then, it will initialize a new DataContext in that folder and wri
Relevant Documentation Links
-

Data Context

+

Data Context

@@ -494,7 +494,7 @@ If None, return available data assets for all datasources.

-get_batch_list(datasource_name: Optional[str] = None, data_connector_name: Optional[str] = None, data_asset_name: Optional[str] = None, batch_request: Optional[BatchRequestBase] = None, batch_data: Optional[Any] = None, data_connector_query: Optional[dict] = None, batch_identifiers: Optional[dict] = None, limit: Optional[int] = None, index: Optional[Union[int, list, tuple, slice, str]] = None, custom_filter_function: Optional[Callable] = None, sampling_method: Optional[str] = None, sampling_kwargs: Optional[dict] = None, splitter_method: Optional[str] = None, splitter_kwargs: Optional[dict] = None, runtime_parameters: Optional[dict] = None, query: Optional[str] = None, path: Optional[str] = None, batch_filter_parameters: Optional[dict] = None, batch_spec_passthrough: Optional[dict] = None, batch_request_options: Optional[Union[dict, BatchRequestOptions]] = None, **kwargs: Optional[dict]) → List[Batch]# +get_batch_list(datasource_name: Optional[str] = None, data_connector_name: Optional[str] = None, data_asset_name: Optional[str] = None, batch_request: Optional[BatchRequestBase] = None, batch_data: Optional[Any] = None, data_connector_query: Optional[dict] = None, batch_identifiers: Optional[dict] = None, limit: Optional[int] = None, index: Optional[Union[int, list, tuple, slice, str]] = None, custom_filter_function: Optional[Callable] = None, sampling_method: Optional[str] = None, sampling_kwargs: Optional[dict] = None, splitter_method: Optional[str] = None, splitter_kwargs: Optional[dict] = None, runtime_parameters: Optional[dict] = None, query: Optional[str] = None, path: Optional[str] = None, batch_filter_parameters: Optional[dict] = None, batch_spec_passthrough: Optional[dict] = None, batch_request_options: Optional[Union[dict, BatchRequestOptions]] = None, **kwargs: Optional[dict]) → List[Batch]#

Get the list of zero or more batches, based on a variety of flexible input types.

@@ -552,7 +552,7 @@ numbers retrieve from the end of the list (ex: -1 retrieves the las
-get_checkpoint(name: Optional[str] = None, ge_cloud_id: Optional[str] = None, id: Optional[str] = None) → great_expectations.checkpoint.checkpoint.Checkpoint# +get_checkpoint(name: Optional[str] = None, ge_cloud_id: Optional[str] = None, id: Optional[str] = None) → great_expectations.checkpoint.checkpoint.Checkpoint#

Retrieves a given Checkpoint by either name or id.

@@ -579,7 +579,7 @@ numbers retrieve from the end of the list (ex: -1 retrieves the las
-get_datasource(datasource_name: str = 'default') → BaseDatasource | FluentDatasource | LegacyDatasource# +get_datasource(datasource_name: str = 'default') → BaseDatasource | FluentDatasource | LegacyDatasource#

Retrieve a given Datasource by name from the context’s underlying DatasourceStore.

@@ -600,7 +600,7 @@ numbers retrieve from the end of the list (ex: -1 retrieves the las
-get_expectation_suite(expectation_suite_name: Optional[str] = None, include_rendered_content: Optional[bool] = None, ge_cloud_id: Optional[str] = None) → great_expectations.core.expectation_suite.ExpectationSuite# +get_expectation_suite(expectation_suite_name: Optional[str] = None, include_rendered_content: Optional[bool] = None, ge_cloud_id: Optional[str] = None) → great_expectations.core.expectation_suite.ExpectationSuite#

Get an Expectation Suite by name.

@@ -628,7 +628,7 @@ ExpectationConfiguration.

-get_validator(datasource_name: Optional[str] = None, data_connector_name: Optional[str] = None, data_asset_name: Optional[str] = None, batch: Optional[Batch] = None, batch_list: Optional[List[Batch]] = None, batch_request: Optional[Union[BatchRequestBase, FluentBatchRequest]] = None, batch_request_list: Optional[List[BatchRequestBase]] = None, batch_data: Optional[Any] = None, data_connector_query: Optional[Union[IDDict, dict]] = None, batch_identifiers: Optional[dict] = None, limit: Optional[int] = None, index: Optional[Union[int, list, tuple, slice, str]] = None, custom_filter_function: Optional[Callable] = None, sampling_method: Optional[str] = None, sampling_kwargs: Optional[dict] = None, splitter_method: Optional[str] = None, splitter_kwargs: Optional[dict] = None, runtime_parameters: Optional[dict] = None, query: Optional[str] = None, path: Optional[str] = None, batch_filter_parameters: Optional[dict] = None, expectation_suite_ge_cloud_id: Optional[str] = None, batch_spec_passthrough: Optional[dict] = None, expectation_suite_name: Optional[str] = None, expectation_suite: Optional[ExpectationSuite] = None, create_expectation_suite_with_name: Optional[str] = None, include_rendered_content: Optional[bool] = None, expectation_suite_id: Optional[str] = None, **kwargs) → Validator# +get_validator(datasource_name: Optional[str] = None, data_connector_name: Optional[str] = None, data_asset_name: Optional[str] = None, batch: Optional[Batch] = None, batch_list: Optional[List[Batch]] = None, batch_request: Optional[Union[BatchRequestBase, FluentBatchRequest]] = None, batch_request_list: Optional[List[BatchRequestBase]] = None, batch_data: Optional[Any] = None, data_connector_query: Optional[Union[IDDict, dict]] = None, batch_identifiers: Optional[dict] = None, limit: Optional[int] = None, index: Optional[Union[int, list, tuple, slice, str]] = None, custom_filter_function: Optional[Callable] = None, sampling_method: Optional[str] = None, sampling_kwargs: Optional[dict] = None, splitter_method: Optional[str] = None, splitter_kwargs: Optional[dict] = None, runtime_parameters: Optional[dict] = None, query: Optional[str] = None, path: Optional[str] = None, batch_filter_parameters: Optional[dict] = None, expectation_suite_ge_cloud_id: Optional[str] = None, batch_spec_passthrough: Optional[dict] = None, expectation_suite_name: Optional[str] = None, expectation_suite: Optional[ExpectationSuite] = None, create_expectation_suite_with_name: Optional[str] = None, include_rendered_content: Optional[bool] = None, expectation_suite_id: Optional[str] = None, **kwargs) → Validator#

Retrieve a Validator with a batch list and an ExpectationSuite.

@@ -681,7 +681,7 @@ numbers retrieve from the end of the list (ex: -1 retrieves the las
Return type
-

Validator

+

Validator

Raises
    @@ -747,7 +747,7 @@ numbers retrieve from the end of the list (ex: -1 retrieves the las
-run_checkpoint(checkpoint_name: str | None = None, ge_cloud_id: str | None = None, template_name: str | None = None, run_name_template: str | None = None, expectation_suite_name: str | None = None, batch_request: BatchRequestBase | FluentBatchRequest | dict | None = None, action_list: Sequence[ActionDict] | None = None, evaluation_parameters: dict | None = None, runtime_configuration: dict | None = None, validations: list[dict] | None = None, profilers: list[dict] | None = None, run_id: str | float | None = None, run_name: str | None = None, run_time: datetime.datetime | None = None, result_format: str | None = None, expectation_suite_ge_cloud_id: str | None = None, id: str | None = None, expectation_suite_id: str | None = None, **kwargs) → CheckpointResult# +run_checkpoint(checkpoint_name: str | None = None, ge_cloud_id: str | None = None, template_name: str | None = None, run_name_template: str | None = None, expectation_suite_name: str | None = None, batch_request: BatchRequestBase | FluentBatchRequest | dict | None = None, action_list: Sequence[ActionDict] | None = None, evaluation_parameters: dict | None = None, runtime_configuration: dict | None = None, validations: list[dict] | None = None, profilers: list[dict] | None = None, run_id: str | float | None = None, run_name: str | None = None, run_time: datetime.datetime | None = None, result_format: str | None = None, expectation_suite_ge_cloud_id: str | None = None, id: str | None = None, expectation_suite_id: str | None = None, **kwargs) → CheckpointResult#

Validate using an existing Checkpoint.

@@ -789,7 +789,7 @@ numbers retrieve from the end of the list (ex: -1 retrieves the las
-save_expectation_suite(expectation_suite: great_expectations.core.expectation_suite.ExpectationSuite, expectation_suite_name: Optional[str] = None, overwrite_existing: bool = True, include_rendered_content: Optional[bool] = None, **kwargs: Optional[dict]) → None# +save_expectation_suite(expectation_suite: great_expectations.core.expectation_suite.ExpectationSuite, expectation_suite_name: Optional[str] = None, overwrite_existing: bool = True, include_rendered_content: Optional[bool] = None, **kwargs: Optional[dict]) → None#

Save the provided ExpectationSuite into the DataContext using the configured ExpectationStore.

@@ -833,7 +833,7 @@ Expectations) are the only ones you’ll need.

Relevant Documentation Links
@@ -864,7 +864,7 @@ The returned object is determined by return_mode.

-update_checkpoint(checkpoint: great_expectations.checkpoint.checkpoint.Checkpoint) → great_expectations.checkpoint.checkpoint.Checkpoint# +update_checkpoint(checkpoint: great_expectations.checkpoint.checkpoint.Checkpoint) → great_expectations.checkpoint.checkpoint.Checkpoint#

Update a Checkpoint that already exists.

@@ -907,7 +907,7 @@ The returned object is determined by return_mode.

-update_datasource(datasource: BaseDatasource | FluentDatasource | LegacyDatasource) → BaseDatasource | FluentDatasource | LegacyDatasource# +update_datasource(datasource: BaseDatasource | FluentDatasource | LegacyDatasource) → BaseDatasource | FluentDatasource | LegacyDatasource#

Updates a Datasource that already exists in the store.

@@ -924,7 +924,7 @@ The returned object is determined by return_mode.

-update_expectation_suite(expectation_suite: great_expectations.core.expectation_suite.ExpectationSuite) → great_expectations.core.expectation_suite.ExpectationSuite# +update_expectation_suite(expectation_suite: great_expectations.core.expectation_suite.ExpectationSuite) → great_expectations.core.expectation_suite.ExpectationSuite#

Update an ExpectationSuite that already exists.

@@ -944,7 +944,7 @@ The returned object is determined by return_mode.

-update_project_config(project_config: Union[great_expectations.data_context.types.base.DataContextConfig, Mapping]) → great_expectations.data_context.types.base.DataContextConfig# +update_project_config(project_config: Union[great_expectations.data_context.types.base.DataContextConfig, Mapping]) → great_expectations.data_context.types.base.DataContextConfig#

Update the context’s config with the values from another config object.

@@ -961,7 +961,7 @@ The returned object is determined by return_mode.

-view_validation_result(result: CheckpointResult) → None# +view_validation_result(result: CheckpointResult) → None#

New in version 0.16.15.

diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/data_context/data_context/context_factory.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/data_context/data_context/context_factory.mdx index 36120859afa7..f633618e0742 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/data_context/data_context/context_factory.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/data_context/data_context/context_factory.mdx @@ -8,19 +8,19 @@ sidebar_label: context_factory.py
-great_expectations.data_context.data_context.context_factory.get_context(project_config: DataContextConfig | Mapping | None = None, context_root_dir: None = None, project_root_dir: None = None, runtime_environment: dict | None = None, cloud_base_url: None = None, cloud_access_token: None = None, cloud_organization_id: None = None, cloud_mode: Optional[Literal[False]] = None, mode: Literal['ephemeral'] = None) → EphemeralDataContext +great_expectations.data_context.data_context.context_factory.get_context(project_config: DataContextConfig | Mapping | None = None, context_root_dir: None = None, project_root_dir: None = None, runtime_environment: dict | None = None, cloud_base_url: None = None, cloud_access_token: None = None, cloud_organization_id: None = None, cloud_mode: Optional[Literal[False]] = None, mode: Literal['ephemeral'] = None) → EphemeralDataContext
-great_expectations.data_context.data_context.context_factory.get_context(project_config: DataContextConfig | Mapping | None = None, context_root_dir: PathStr = None, project_root_dir: None = None, runtime_environment: dict | None = None, cloud_base_url: None = None, cloud_access_token: None = None, cloud_organization_id: None = None, cloud_mode: Optional[Literal[False]] = None) → FileDataContext +great_expectations.data_context.data_context.context_factory.get_context(project_config: DataContextConfig | Mapping | None = None, context_root_dir: PathStr = None, project_root_dir: None = None, runtime_environment: dict | None = None, cloud_base_url: None = None, cloud_access_token: None = None, cloud_organization_id: None = None, cloud_mode: Optional[Literal[False]] = None) → FileDataContext
-great_expectations.data_context.data_context.context_factory.get_context(project_config: DataContextConfig | Mapping | None = None, context_root_dir: None = None, project_root_dir: PathStr = None, runtime_environment: dict | None = None, cloud_base_url: None = None, cloud_access_token: None = None, cloud_organization_id: None = None, cloud_mode: Optional[Literal[False]] = None, mode: Optional[Literal['file']] = None) → FileDataContext +great_expectations.data_context.data_context.context_factory.get_context(project_config: DataContextConfig | Mapping | None = None, context_root_dir: None = None, project_root_dir: PathStr = None, runtime_environment: dict | None = None, cloud_base_url: None = None, cloud_access_token: None = None, cloud_organization_id: None = None, cloud_mode: Optional[Literal[False]] = None, mode: Optional[Literal['file']] = None) → FileDataContext
-great_expectations.data_context.data_context.context_factory.get_context(project_config: DataContextConfig | Mapping | None = None, context_root_dir: None = None, project_root_dir: None = None, runtime_environment: dict | None = None, cloud_base_url: str | None = None, cloud_access_token: str | None = None, cloud_organization_id: str | None = None, cloud_mode: Literal[True] = None, mode: Optional[Literal['cloud']] = None) → CloudDataContext +great_expectations.data_context.data_context.context_factory.get_context(project_config: DataContextConfig | Mapping | None = None, context_root_dir: None = None, project_root_dir: None = None, runtime_environment: dict | None = None, cloud_base_url: str | None = None, cloud_access_token: str | None = None, cloud_organization_id: str | None = None, cloud_mode: Literal[True] = None, mode: Optional[Literal['cloud']] = None) → CloudDataContext
-great_expectations.data_context.data_context.context_factory.get_context(project_config: DataContextConfig | Mapping | None = None, context_root_dir: PathStr | None = None, project_root_dir: PathStr | None = None, runtime_environment: dict | None = None, cloud_base_url: str | None = None, cloud_access_token: str | None = None, cloud_organization_id: str | None = None, cloud_mode: bool | None = None, mode: None = None) → EphemeralDataContext | FileDataContext | CloudDataContext +great_expectations.data_context.data_context.context_factory.get_context(project_config: DataContextConfig | Mapping | None = None, context_root_dir: PathStr | None = None, project_root_dir: PathStr | None = None, runtime_environment: dict | None = None, cloud_base_url: str | None = None, cloud_access_token: str | None = None, cloud_organization_id: str | None = None, cloud_mode: bool | None = None, mode: None = None) → EphemeralDataContext | FileDataContext | CloudDataContext

Method to return the appropriate Data Context depending on parameters and environment.

diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/data_context/types/base/DataContextConfig_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/data_context/types/base/DataContextConfig_class.mdx index 8651850c1a76..6dc1dcaf7340 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/data_context/types/base/DataContextConfig_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/data_context/types/base/DataContextConfig_class.mdx @@ -14,13 +14,6 @@ sidebar_label: DataContextConfig

The DataContextConfig holds all associated configuration parameters to build a Data Context. There are defaults set for minimizing configuration in typical cases, but every parameter is configurable and all defaults are overridable.

In cases where the DataContext is instantitated without a yml file, the DataContextConfig can be instantiated directly.

-
-
Relevant Documentation Links
-
-
-
Parameters
    diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/DataConnector_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/DataConnector_class.mdx index 1b10d82bb571..98f6b5e3fb31 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/DataConnector_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/DataConnector_class.mdx @@ -8,7 +8,7 @@ sidebar_label: DataConnector
    -class great_expectations.datasource.DataConnector(name: str, datasource_name: str, execution_engine: ExecutionEngine, batch_spec_passthrough: Optional[dict] = None, id: Optional[str] = None)# +class great_expectations.datasource.DataConnector(name: str, datasource_name: str, execution_engine: ExecutionEngine, batch_spec_passthrough: Optional[dict] = None, id: Optional[str] = None)#

    The base class for all Data Connectors.

    diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/data_connector/ConfiguredAssetAWSGlueDataCatalogDataConnector_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/data_connector/ConfiguredAssetAWSGlueDataCatalogDataConnector_class.mdx index 651e5fbef730..1ce9705643f0 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/data_connector/ConfiguredAssetAWSGlueDataCatalogDataConnector_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/data_connector/ConfiguredAssetAWSGlueDataCatalogDataConnector_class.mdx @@ -8,7 +8,7 @@ sidebar_label: ConfiguredAssetAWSGlueDataCatalogDataConnector
    -class great_expectations.datasource.data_connector.ConfiguredAssetAWSGlueDataCatalogDataConnector(name: str, datasource_name: str, execution_engine: Optional[great_expectations.execution_engine.execution_engine.ExecutionEngine] = None, catalog_id: Optional[str] = None, partitions: Optional[List[str]] = None, assets: Optional[Dict[str, dict]] = None, boto3_options: Optional[dict] = None, batch_spec_passthrough: Optional[dict] = None, id: Optional[str] = None)# +class great_expectations.datasource.data_connector.ConfiguredAssetAWSGlueDataCatalogDataConnector(name: str, datasource_name: str, execution_engine: Optional[great_expectations.execution_engine.execution_engine.ExecutionEngine] = None, catalog_id: Optional[str] = None, partitions: Optional[List[str]] = None, assets: Optional[Dict[str, dict]] = None, boto3_options: Optional[dict] = None, batch_spec_passthrough: Optional[dict] = None, id: Optional[str] = None)#

    A Configured Asset Data Connector used to connect to data through an AWS Glue Data Catalog.

    diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/data_connector/ConfiguredAssetAzureDataConnector_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/data_connector/ConfiguredAssetAzureDataConnector_class.mdx index 455cf894735c..434b05af5fd7 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/data_connector/ConfiguredAssetAzureDataConnector_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/data_connector/ConfiguredAssetAzureDataConnector_class.mdx @@ -8,7 +8,7 @@ sidebar_label: ConfiguredAssetAzureDataConnector
    -class great_expectations.datasource.data_connector.ConfiguredAssetAzureDataConnector(name: str, datasource_name: str, container: str, assets: dict, execution_engine: Optional[great_expectations.execution_engine.execution_engine.ExecutionEngine] = None, default_regex: Optional[dict] = None, sorters: Optional[list] = None, name_starts_with: str = '', delimiter: str = '/', azure_options: Optional[dict] = None, batch_spec_passthrough: Optional[dict] = None, id: Optional[str] = None)# +class great_expectations.datasource.data_connector.ConfiguredAssetAzureDataConnector(name: str, datasource_name: str, container: str, assets: dict, execution_engine: Optional[great_expectations.execution_engine.execution_engine.ExecutionEngine] = None, default_regex: Optional[dict] = None, sorters: Optional[list] = None, name_starts_with: str = '', delimiter: str = '/', azure_options: Optional[dict] = None, batch_spec_passthrough: Optional[dict] = None, id: Optional[str] = None)#

    Extension of ConfiguredAssetFilePathDataConnector used to connect to Azure.

    @@ -22,7 +22,7 @@ it requires more setup.

  • datasource_name (str) – required name for datasource

  • container (str) – container name for Azure Blob Storage

  • assets (dict) – dict of asset configuration (required for ConfiguredAssetDataConnector)

    • -

  • execution_engine (ExecutionEngine) – optional reference to ExecutionEngine

    • +

  • execution_engine (ExecutionEngine) – optional reference to ExecutionEngine

  • default_regex (dict) – optional regex configuration for filtering data_references

  • sorters (list) – optional list of sorters for sorting data_references

  • name_starts_with (str) – Azure prefix

    • diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/data_connector/ConfiguredAssetDBFSDataConnector_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/data_connector/ConfiguredAssetDBFSDataConnector_class.mdx index 64da09caac6e..43f3fd6b0c52 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/data_connector/ConfiguredAssetDBFSDataConnector_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/data_connector/ConfiguredAssetDBFSDataConnector_class.mdx @@ -8,7 +8,7 @@ sidebar_label: ConfiguredAssetDBFSDataConnector
    -class great_expectations.datasource.data_connector.ConfiguredAssetDBFSDataConnector(name: str, datasource_name: str, base_directory: str, assets: dict, execution_engine: great_expectations.execution_engine.execution_engine.ExecutionEngine, default_regex: Optional[dict] = None, glob_directive: str = '**/*', sorters: Optional[list] = None, batch_spec_passthrough: Optional[dict] = None, id: Optional[str] = None)# +class great_expectations.datasource.data_connector.ConfiguredAssetDBFSDataConnector(name: str, datasource_name: str, base_directory: str, assets: dict, execution_engine: great_expectations.execution_engine.execution_engine.ExecutionEngine, default_regex: Optional[dict] = None, glob_directive: str = '**/*', sorters: Optional[list] = None, batch_spec_passthrough: Optional[dict] = None, id: Optional[str] = None)#

    Extension of ConfiguredAssetFilesystemDataConnector used to connect to the DataBricks File System (DBFS).

    @@ -21,7 +21,7 @@ it requires more setup.

  • name (str) – required name for DataConnector

  • datasource_name (str) – required name for datasource

  • assets (dict) – dict of asset configuration (required for ConfiguredAssetDataConnector). These can each have their own regex and sorters

    • -

  • execution_engine (ExecutionEngine) – Reference to ExecutionEngine

    • +

  • execution_engine (ExecutionEngine) – Reference to ExecutionEngine

  • default_regex (dict) – optional regex configuration for filtering data_references

  • glob_directive (str) – glob for selecting files in directory (defaults to *)

  • sorters (list) – optional list of sorters for sorting data_references

    • diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/data_connector/ConfiguredAssetFilePathDataConnector_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/data_connector/ConfiguredAssetFilePathDataConnector_class.mdx index f96b7f550e1c..d89eaaec35bb 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/data_connector/ConfiguredAssetFilePathDataConnector_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/data_connector/ConfiguredAssetFilePathDataConnector_class.mdx @@ -8,7 +8,7 @@ sidebar_label: ConfiguredAssetFilePathDataConnector
    -class great_expectations.datasource.data_connector.ConfiguredAssetFilePathDataConnector(name: str, datasource_name: str, assets: dict, execution_engine: Optional[great_expectations.execution_engine.execution_engine.ExecutionEngine] = None, default_regex: Optional[dict] = None, sorters: Optional[list] = None, batch_spec_passthrough: Optional[dict] = None, id: Optional[str] = None)# +class great_expectations.datasource.data_connector.ConfiguredAssetFilePathDataConnector(name: str, datasource_name: str, assets: dict, execution_engine: Optional[great_expectations.execution_engine.execution_engine.ExecutionEngine] = None, default_regex: Optional[dict] = None, sorters: Optional[list] = None, batch_spec_passthrough: Optional[dict] = None, id: Optional[str] = None)#

    The ConfiguredAssetFilePathDataConnector is one of two classes (InferredAssetFilePathDataConnector being the @@ -23,7 +23,7 @@ it requires more setup.

  • name (str) – name of ConfiguredAssetFilePathDataConnector

  • datasource_name (str) – Name of datasource that this DataConnector is connected to

  • assets (dict) – configured assets as a dictionary. These can each have their own regex and sorters

    • -

  • execution_engine (ExecutionEngine) – Execution Engine object to actually read the data

    • +

  • execution_engine (ExecutionEngine) – Execution Engine object to actually read the data

  • default_regex (dict) – Optional dict the filter and organize the data_references.

  • sorters (list) – Optional list if you want to sort the data_references

  • batch_spec_passthrough (dict) – dictionary with keys that will be added directly to batch_spec

    • diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/data_connector/ConfiguredAssetFilesystemDataConnector_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/data_connector/ConfiguredAssetFilesystemDataConnector_class.mdx index 71c36dc5e874..e6fd2f496bae 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/data_connector/ConfiguredAssetFilesystemDataConnector_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/data_connector/ConfiguredAssetFilesystemDataConnector_class.mdx @@ -8,7 +8,7 @@ sidebar_label: ConfiguredAssetFilesystemDataConnector
    -class great_expectations.datasource.data_connector.ConfiguredAssetFilesystemDataConnector(name: str, datasource_name: str, base_directory: str, assets: dict, execution_engine: Optional[great_expectations.execution_engine.execution_engine.ExecutionEngine] = None, default_regex: Optional[dict] = None, glob_directive: str = '**/*', sorters: Optional[list] = None, batch_spec_passthrough: Optional[dict] = None, id: Optional[str] = None)# +class great_expectations.datasource.data_connector.ConfiguredAssetFilesystemDataConnector(name: str, datasource_name: str, base_directory: str, assets: dict, execution_engine: Optional[great_expectations.execution_engine.execution_engine.ExecutionEngine] = None, default_regex: Optional[dict] = None, glob_directive: str = '**/*', sorters: Optional[list] = None, batch_spec_passthrough: Optional[dict] = None, id: Optional[str] = None)#

    Extension of ConfiguredAssetFilePathDataConnector used to connect to Filesystem.

    @@ -21,7 +21,7 @@ it requires more setup.

  • name (str) – name of ConfiguredAssetFilesystemDataConnector

  • datasource_name (str) – Name of datasource that this DataConnector is connected to

  • assets (dict) – configured assets as a dictionary. These can each have their own regex and sorters

    • -

  • execution_engine (ExecutionEngine) – ExecutionEngine object to actually read the data

    • +

  • execution_engine (ExecutionEngine) – ExecutionEngine object to actually read the data

  • default_regex (dict) – Optional dict the filter and organize the data_references.

  • glob_directive (str) – glob for selecting files in directory (defaults to **/*) or nested directories (e.g. */*/*.csv)

  • sorters (list) – Optional list if you want to sort the data_references

    • diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/data_connector/ConfiguredAssetGCSDataConnector_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/data_connector/ConfiguredAssetGCSDataConnector_class.mdx index 965573fce1f9..1383879f107a 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/data_connector/ConfiguredAssetGCSDataConnector_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/data_connector/ConfiguredAssetGCSDataConnector_class.mdx @@ -8,7 +8,7 @@ sidebar_label: ConfiguredAssetGCSDataConnector
    -class great_expectations.datasource.data_connector.ConfiguredAssetGCSDataConnector(name: str, datasource_name: str, bucket_or_name: str, assets: dict, execution_engine: Optional[great_expectations.execution_engine.execution_engine.ExecutionEngine] = None, default_regex: Optional[dict] = None, sorters: Optional[list] = None, prefix: Optional[str] = None, delimiter: Optional[str] = None, max_results: Optional[int] = None, gcs_options: Optional[dict] = None, batch_spec_passthrough: Optional[dict] = None, id: Optional[str] = None)# +class great_expectations.datasource.data_connector.ConfiguredAssetGCSDataConnector(name: str, datasource_name: str, bucket_or_name: str, assets: dict, execution_engine: Optional[great_expectations.execution_engine.execution_engine.ExecutionEngine] = None, default_regex: Optional[dict] = None, sorters: Optional[list] = None, prefix: Optional[str] = None, delimiter: Optional[str] = None, max_results: Optional[int] = None, gcs_options: Optional[dict] = None, batch_spec_passthrough: Optional[dict] = None, id: Optional[str] = None)#

    Extension of ConfiguredAssetFilePathDataConnector used to connect to GCS.

    @@ -32,7 +32,7 @@ to Python and directly pass them in to the GCS connection object, maintaining co

  • datasource_name (str) – required name for datasource

  • bucket_or_name (str) – bucket name for Google Cloud Storage

  • assets (dict) – dict of asset configuration (required for ConfiguredAssetDataConnector)

    • -

  • execution_engine (ExecutionEngine) – optional reference to ExecutionEngine

    • +

  • execution_engine (ExecutionEngine) – optional reference to ExecutionEngine

  • default_regex (dict) – optional regex configuration for filtering data_references

  • sorters (list) – optional list of sorters for sorting data_references

  • prefix (str) – GCS prefix

    • diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/data_connector/ConfiguredAssetS3DataConnector_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/data_connector/ConfiguredAssetS3DataConnector_class.mdx index 552cad45d4d4..152b4b583861 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/data_connector/ConfiguredAssetS3DataConnector_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/data_connector/ConfiguredAssetS3DataConnector_class.mdx @@ -8,7 +8,7 @@ sidebar_label: ConfiguredAssetS3DataConnector
    -class great_expectations.datasource.data_connector.ConfiguredAssetS3DataConnector(name: str, datasource_name: str, bucket: str, assets: dict, execution_engine: Optional[great_expectations.execution_engine.execution_engine.ExecutionEngine] = None, default_regex: Optional[dict] = None, sorters: Optional[list] = None, prefix: str = '', delimiter: str = '/', max_keys: int = 1000, boto3_options: Optional[dict] = None, batch_spec_passthrough: Optional[dict] = None, id: Optional[str] = None)# +class great_expectations.datasource.data_connector.ConfiguredAssetS3DataConnector(name: str, datasource_name: str, bucket: str, assets: dict, execution_engine: Optional[great_expectations.execution_engine.execution_engine.ExecutionEngine] = None, default_regex: Optional[dict] = None, sorters: Optional[list] = None, prefix: str = '', delimiter: str = '/', max_keys: int = 1000, boto3_options: Optional[dict] = None, batch_spec_passthrough: Optional[dict] = None, id: Optional[str] = None)#

    Extension of ConfiguredAssetFilePathDataConnector used to connect to S3.

    @@ -22,7 +22,7 @@ it requires more setup.

  • datasource_name (str) – required name for datasource

  • bucket (str) – bucket for S3

  • assets (dict) – dict of asset configuration (required for ConfiguredAssetDataConnector)

    • -

  • execution_engine (ExecutionEngine) – optional reference to ExecutionEngine

    • +

  • execution_engine (ExecutionEngine) – optional reference to ExecutionEngine

  • default_regex (dict) – optional regex configuration for filtering data_references

  • sorters (list) – optional list of sorters for sorting data_references

  • prefix (str) – S3 prefix

    • diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/data_connector/ConfiguredAssetSqlDataConnector_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/data_connector/ConfiguredAssetSqlDataConnector_class.mdx index 22348245f875..8a2890a4a3b8 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/data_connector/ConfiguredAssetSqlDataConnector_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/data_connector/ConfiguredAssetSqlDataConnector_class.mdx @@ -8,7 +8,7 @@ sidebar_label: ConfiguredAssetSqlDataConnector
    -class great_expectations.datasource.data_connector.ConfiguredAssetSqlDataConnector(name: str, datasource_name: str, execution_engine: SqlAlchemyExecutionEngine, include_schema_name: bool = False, splitter_method: Optional[str] = None, splitter_kwargs: Optional[dict] = None, sorters: Optional[list] = None, sampling_method: Optional[str] = None, sampling_kwargs: Optional[dict] = None, assets: Optional[Dict[str, dict]] = None, batch_spec_passthrough: Optional[dict] = None, id: Optional[str] = None)# +class great_expectations.datasource.data_connector.ConfiguredAssetSqlDataConnector(name: str, datasource_name: str, execution_engine: SqlAlchemyExecutionEngine, include_schema_name: bool = False, splitter_method: Optional[str] = None, splitter_kwargs: Optional[dict] = None, sorters: Optional[list] = None, sampling_method: Optional[str] = None, sampling_kwargs: Optional[dict] = None, assets: Optional[Dict[str, dict]] = None, batch_spec_passthrough: Optional[dict] = None, id: Optional[str] = None)#

    A DataConnector that requires explicit listing of SQL assets you want to connect to.

    @@ -20,7 +20,7 @@ it requires more setup.

    • name (str) – The name of this DataConnector

    • datasource_name (str) – The name of the Datasource that contains it

      • -

    • execution_engine (ExecutionEngine) – An ExecutionEngine

      • +

    • execution_engine (ExecutionEngine) – An ExecutionEngine

    • include_schema_name (bool) – Should the data_asset_name include the schema as a prefix?

    • splitter_method (str) – A method to split the target table into multiple Batches

    • splitter_kwargs (dict) – Keyword arguments to pass to splitter_method

      • diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/data_connector/FilePathDataConnector_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/data_connector/FilePathDataConnector_class.mdx index 5d4a89ef58e1..133199c55b4d 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/data_connector/FilePathDataConnector_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/data_connector/FilePathDataConnector_class.mdx @@ -8,7 +8,7 @@ sidebar_label: FilePathDataConnector
      -class great_expectations.datasource.data_connector.FilePathDataConnector(name: str, datasource_name: str, execution_engine: Optional[great_expectations.execution_engine.execution_engine.ExecutionEngine] = None, default_regex: Optional[dict] = None, sorters: Optional[list] = None, batch_spec_passthrough: Optional[dict] = None, id: Optional[str] = None)# +class great_expectations.datasource.data_connector.FilePathDataConnector(name: str, datasource_name: str, execution_engine: Optional[great_expectations.execution_engine.execution_engine.ExecutionEngine] = None, default_regex: Optional[dict] = None, sorters: Optional[list] = None, batch_spec_passthrough: Optional[dict] = None, id: Optional[str] = None)#

      The base class for Data Connectors designed to access filesystem-like data.

      diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/data_connector/InferredAssetAWSGlueDataCatalogDataConnector_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/data_connector/InferredAssetAWSGlueDataCatalogDataConnector_class.mdx index 9d0d7035316d..5fde5626cfd2 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/data_connector/InferredAssetAWSGlueDataCatalogDataConnector_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/data_connector/InferredAssetAWSGlueDataCatalogDataConnector_class.mdx @@ -8,7 +8,7 @@ sidebar_label: InferredAssetAWSGlueDataCatalogDataConnector
      -class great_expectations.datasource.data_connector.InferredAssetAWSGlueDataCatalogDataConnector(name: str, datasource_name: str, execution_engine: Optional[great_expectations.execution_engine.execution_engine.ExecutionEngine] = None, catalog_id: Optional[str] = None, data_asset_name_prefix: str = '', data_asset_name_suffix: str = '', excluded_tables: Optional[list] = None, included_tables: Optional[list] = None, glue_introspection_directives: Optional[dict] = None, boto3_options: Optional[dict] = None, batch_spec_passthrough: Optional[dict] = None, id: Optional[str] = None)# +class great_expectations.datasource.data_connector.InferredAssetAWSGlueDataCatalogDataConnector(name: str, datasource_name: str, execution_engine: Optional[great_expectations.execution_engine.execution_engine.ExecutionEngine] = None, catalog_id: Optional[str] = None, data_asset_name_prefix: str = '', data_asset_name_suffix: str = '', excluded_tables: Optional[list] = None, included_tables: Optional[list] = None, glue_introspection_directives: Optional[dict] = None, boto3_options: Optional[dict] = None, batch_spec_passthrough: Optional[dict] = None, id: Optional[str] = None)#

      An Inferred Asset Data Connector used to connect to data through an AWS Glue Data Catalog.

      diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/data_connector/InferredAssetAzureDataConnector_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/data_connector/InferredAssetAzureDataConnector_class.mdx index 11fbad1c6c05..ca797f98d87f 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/data_connector/InferredAssetAzureDataConnector_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/data_connector/InferredAssetAzureDataConnector_class.mdx @@ -8,7 +8,7 @@ sidebar_label: InferredAssetAzureDataConnector
      -class great_expectations.datasource.data_connector.InferredAssetAzureDataConnector(name: str, datasource_name: str, container: str, execution_engine: Optional[great_expectations.execution_engine.execution_engine.ExecutionEngine] = None, default_regex: Optional[dict] = None, sorters: Optional[list] = None, name_starts_with: str = '', delimiter: str = '/', azure_options: Optional[dict] = None, batch_spec_passthrough: Optional[dict] = None, id: Optional[str] = None)# +class great_expectations.datasource.data_connector.InferredAssetAzureDataConnector(name: str, datasource_name: str, container: str, execution_engine: Optional[great_expectations.execution_engine.execution_engine.ExecutionEngine] = None, default_regex: Optional[dict] = None, sorters: Optional[list] = None, name_starts_with: str = '', delimiter: str = '/', azure_options: Optional[dict] = None, batch_spec_passthrough: Optional[dict] = None, id: Optional[str] = None)#

      An Inferred Asset Data Connector used to connect to Azure Blob Storage.

      diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/data_connector/InferredAssetDBFSDataConnector_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/data_connector/InferredAssetDBFSDataConnector_class.mdx index 2247abc8b8db..9b46107301d2 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/data_connector/InferredAssetDBFSDataConnector_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/data_connector/InferredAssetDBFSDataConnector_class.mdx @@ -8,7 +8,7 @@ sidebar_label: InferredAssetDBFSDataConnector
      -class great_expectations.datasource.data_connector.InferredAssetDBFSDataConnector(name: str, datasource_name: str, base_directory: str, execution_engine: great_expectations.execution_engine.execution_engine.ExecutionEngine, default_regex: Optional[dict] = None, glob_directive: str = '*', sorters: Optional[list] = None, batch_spec_passthrough: Optional[dict] = None, id: Optional[str] = None)# +class great_expectations.datasource.data_connector.InferredAssetDBFSDataConnector(name: str, datasource_name: str, base_directory: str, execution_engine: great_expectations.execution_engine.execution_engine.ExecutionEngine, default_regex: Optional[dict] = None, glob_directive: str = '*', sorters: Optional[list] = None, batch_spec_passthrough: Optional[dict] = None, id: Optional[str] = None)#

      An Inferred Asset Data Connector used to connect to data on a DBFS filesystem.

      diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/data_connector/InferredAssetFilePathDataConnector_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/data_connector/InferredAssetFilePathDataConnector_class.mdx index 6fb7ca378977..81446afe8783 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/data_connector/InferredAssetFilePathDataConnector_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/data_connector/InferredAssetFilePathDataConnector_class.mdx @@ -8,7 +8,7 @@ sidebar_label: InferredAssetFilePathDataConnector
      -class great_expectations.datasource.data_connector.InferredAssetFilePathDataConnector(name: str, datasource_name: str, execution_engine: Optional[great_expectations.execution_engine.execution_engine.ExecutionEngine] = None, default_regex: Optional[dict] = None, sorters: Optional[list] = None, batch_spec_passthrough: Optional[dict] = None, id: Optional[str] = None)# +class great_expectations.datasource.data_connector.InferredAssetFilePathDataConnector(name: str, datasource_name: str, execution_engine: Optional[great_expectations.execution_engine.execution_engine.ExecutionEngine] = None, default_regex: Optional[dict] = None, sorters: Optional[list] = None, batch_spec_passthrough: Optional[dict] = None, id: Optional[str] = None)#

      A base class for Inferred Asset Data Connectors designed to operate on file paths and implicitly determine Data Asset names through regular expressions.

      diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/data_connector/InferredAssetFilesystemDataConnector_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/data_connector/InferredAssetFilesystemDataConnector_class.mdx index 33281c716bb3..f95e5fc84bdf 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/data_connector/InferredAssetFilesystemDataConnector_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/data_connector/InferredAssetFilesystemDataConnector_class.mdx @@ -8,7 +8,7 @@ sidebar_label: InferredAssetFilesystemDataConnector
      -class great_expectations.datasource.data_connector.InferredAssetFilesystemDataConnector(name: str, datasource_name: str, base_directory: str, execution_engine: Optional[great_expectations.execution_engine.execution_engine.ExecutionEngine] = None, default_regex: Optional[dict] = None, glob_directive: str = '*', sorters: Optional[list] = None, batch_spec_passthrough: Optional[dict] = None, id: Optional[str] = None)# +class great_expectations.datasource.data_connector.InferredAssetFilesystemDataConnector(name: str, datasource_name: str, base_directory: str, execution_engine: Optional[great_expectations.execution_engine.execution_engine.ExecutionEngine] = None, default_regex: Optional[dict] = None, glob_directive: str = '*', sorters: Optional[list] = None, batch_spec_passthrough: Optional[dict] = None, id: Optional[str] = None)#

      A base class for Inferred Asset Data Connectors designed to operate on data stored in filesystems.

      diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/data_connector/InferredAssetGCSDataConnector_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/data_connector/InferredAssetGCSDataConnector_class.mdx index 08986ae930c0..31f6d36bad5a 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/data_connector/InferredAssetGCSDataConnector_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/data_connector/InferredAssetGCSDataConnector_class.mdx @@ -7,7 +7,7 @@ sidebar_label: InferredAssetGCSDataConnector
      -class great_expectations.datasource.data_connector.InferredAssetGCSDataConnector(name: str, datasource_name: str, bucket_or_name: str, execution_engine: Optional[great_expectations.execution_engine.execution_engine.ExecutionEngine] = None, default_regex: Optional[dict] = None, sorters: Optional[list] = None, prefix: Optional[str] = None, delimiter: Optional[str] = None, max_results: Optional[int] = None, gcs_options: Optional[dict] = None, batch_spec_passthrough: Optional[dict] = None, id: Optional[str] = None)# +class great_expectations.datasource.data_connector.InferredAssetGCSDataConnector(name: str, datasource_name: str, bucket_or_name: str, execution_engine: Optional[great_expectations.execution_engine.execution_engine.ExecutionEngine] = None, default_regex: Optional[dict] = None, sorters: Optional[list] = None, prefix: Optional[str] = None, delimiter: Optional[str] = None, max_results: Optional[int] = None, gcs_options: Optional[dict] = None, batch_spec_passthrough: Optional[dict] = None, id: Optional[str] = None)#

      An Inferred Asset Data Connector used to connect to Google Cloud Storage (GCS).

      diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/data_connector/InferredAssetS3DataConnector_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/data_connector/InferredAssetS3DataConnector_class.mdx index 360ffa65b8f4..90dfbe530645 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/data_connector/InferredAssetS3DataConnector_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/data_connector/InferredAssetS3DataConnector_class.mdx @@ -8,7 +8,7 @@ sidebar_label: InferredAssetS3DataConnector
      -class great_expectations.datasource.data_connector.InferredAssetS3DataConnector(name: str, datasource_name: str, bucket: str, execution_engine: Optional[great_expectations.execution_engine.execution_engine.ExecutionEngine] = None, default_regex: Optional[dict] = None, sorters: Optional[list] = None, prefix: str = '', delimiter: str = '/', max_keys: int = 1000, boto3_options: Optional[dict] = None, batch_spec_passthrough: Optional[dict] = None, id: Optional[str] = None)# +class great_expectations.datasource.data_connector.InferredAssetS3DataConnector(name: str, datasource_name: str, bucket: str, execution_engine: Optional[great_expectations.execution_engine.execution_engine.ExecutionEngine] = None, default_regex: Optional[dict] = None, sorters: Optional[list] = None, prefix: str = '', delimiter: str = '/', max_keys: int = 1000, boto3_options: Optional[dict] = None, batch_spec_passthrough: Optional[dict] = None, id: Optional[str] = None)#

      An Inferred Asset Data Connector used to connect to AWS Simple Storage Service (S3).

      diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/data_connector/InferredAssetSqlDataConnector_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/data_connector/InferredAssetSqlDataConnector_class.mdx index c027d5461fac..4c1603477256 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/data_connector/InferredAssetSqlDataConnector_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/data_connector/InferredAssetSqlDataConnector_class.mdx @@ -8,7 +8,7 @@ sidebar_label: InferredAssetSqlDataConnector
      -class great_expectations.datasource.data_connector.InferredAssetSqlDataConnector(name: str, datasource_name: str, execution_engine: SqlAlchemyExecutionEngine, data_asset_name_prefix: str = '', data_asset_name_suffix: str = '', include_schema_name: bool = False, splitter_method: Optional[str] = None, splitter_kwargs: Optional[dict] = None, sampling_method: Optional[str] = None, sampling_kwargs: Optional[dict] = None, excluded_tables: Optional[list] = None, included_tables: Optional[list] = None, skip_inapplicable_tables: bool = True, introspection_directives: Optional[dict] = None, batch_spec_passthrough: Optional[dict] = None, id: Optional[str] = None)# +class great_expectations.datasource.data_connector.InferredAssetSqlDataConnector(name: str, datasource_name: str, execution_engine: SqlAlchemyExecutionEngine, data_asset_name_prefix: str = '', data_asset_name_suffix: str = '', include_schema_name: bool = False, splitter_method: Optional[str] = None, splitter_kwargs: Optional[dict] = None, sampling_method: Optional[str] = None, sampling_kwargs: Optional[dict] = None, excluded_tables: Optional[list] = None, included_tables: Optional[list] = None, skip_inapplicable_tables: bool = True, introspection_directives: Optional[dict] = None, batch_spec_passthrough: Optional[dict] = None, id: Optional[str] = None)#

      An Inferred Asset Data Connector used to connect to an SQL database.

      diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/data_connector/RuntimeDataConnector_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/data_connector/RuntimeDataConnector_class.mdx index ba1c62b65b2d..5c2edf4d9103 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/data_connector/RuntimeDataConnector_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/data_connector/RuntimeDataConnector_class.mdx @@ -8,7 +8,7 @@ sidebar_label: RuntimeDataConnector
      -class great_expectations.datasource.data_connector.RuntimeDataConnector(name: str, datasource_name: str, execution_engine: ExecutionEngine, batch_identifiers: Optional[list] = None, batch_spec_passthrough: Optional[dict] = None, assets: Optional[dict] = None, id: Optional[str] = None)# +class great_expectations.datasource.data_connector.RuntimeDataConnector(name: str, datasource_name: str, execution_engine: ExecutionEngine, batch_identifiers: Optional[list] = None, batch_spec_passthrough: Optional[dict] = None, assets: Optional[dict] = None, id: Optional[str] = None)#

      A Data Connector that allows users to specify a Batch’s data directly using a Runtime Batch Request.

      diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/fluent/DatabricksSQLDatasource_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/fluent/DatabricksSQLDatasource_class.mdx index b35e893830f3..7fc0c4300a40 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/fluent/DatabricksSQLDatasource_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/fluent/DatabricksSQLDatasource_class.mdx @@ -8,7 +8,7 @@ sidebar_label: DatabricksSQLDatasource
      -class great_expectations.datasource.fluent.DatabricksSQLDatasource(*, type: Literal['databricks_sql'] = 'databricks_sql', name: str, id: Optional[uuid.UUID] = None, assets: List[Union[great_expectations.datasource.fluent.sql_datasource.TableAsset, great_expectations.datasource.fluent.sql_datasource.QueryAsset]] = [], connection_string: Union[great_expectations.datasource.fluent.config_str.ConfigStr, great_expectations.datasource.fluent.databricks_sql_datasource.DatabricksDsn], create_temp_table: bool = False, kwargs: Dict[str, Union[great_expectations.datasource.fluent.config_str.ConfigStr, Any]] = {})# +class great_expectations.datasource.fluent.DatabricksSQLDatasource(*, type: Literal['databricks_sql'] = 'databricks_sql', name: str, id: Optional[uuid.UUID] = None, assets: List[Union[great_expectations.datasource.fluent.sql_datasource.TableAsset, great_expectations.datasource.fluent.sql_datasource.QueryAsset]] = [], connection_string: Union[great_expectations.datasource.fluent.config_str.ConfigStr, great_expectations.datasource.fluent.databricks_sql_datasource.DatabricksDsn], create_temp_table: bool = False, kwargs: Dict[str, Union[great_expectations.datasource.fluent.config_str.ConfigStr, Any]] = {})#

      Adds a DatabricksSQLDatasource to the data context.

      @@ -25,7 +25,7 @@ are TableAsset or QueryAsset objects.

      -add_query_asset(name: str, query: str, order_by: Optional[SortersDefinition] = None, batch_metadata: Optional[BatchMetadata] = None) → QueryAsset# +add_query_asset(name: str, query: str, order_by: Optional[SortersDefinition] = None, batch_metadata: Optional[BatchMetadata] = None) → QueryAsset#

      Adds a query asset to this datasource.

      @@ -48,7 +48,7 @@ eg, it could be a QueryAsset or a SqliteQueryAsset.

      -add_table_asset(name: str, table_name: str = '', schema_name: Optional[str] = None, order_by: Optional[SortersDefinition] = None, batch_metadata: Optional[BatchMetadata] = None) → TableAsset# +add_table_asset(name: str, table_name: str = '', schema_name: Optional[str] = None, order_by: Optional[SortersDefinition] = None, batch_metadata: Optional[BatchMetadata] = None) → TableAsset#

      Adds a table asset to this datasource.

      diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/fluent/PostgresDatasource_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/fluent/PostgresDatasource_class.mdx index 97b64a9e5dab..5f84f134cc7f 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/fluent/PostgresDatasource_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/fluent/PostgresDatasource_class.mdx @@ -8,7 +8,7 @@ sidebar_label: PostgresDatasource
      -class great_expectations.datasource.fluent.PostgresDatasource(*, type: Literal['postgres'] = 'postgres', name: str, id: Optional[uuid.UUID] = None, assets: List[Union[great_expectations.datasource.fluent.sql_datasource.TableAsset, great_expectations.datasource.fluent.sql_datasource.QueryAsset]] = [], connection_string: Union[great_expectations.datasource.fluent.config_str.ConfigStr, pydantic.v1.networks.PostgresDsn], create_temp_table: bool = False, kwargs: Dict[str, Union[great_expectations.datasource.fluent.config_str.ConfigStr, Any]] = {})# +class great_expectations.datasource.fluent.PostgresDatasource(*, type: Literal['postgres'] = 'postgres', name: str, id: Optional[uuid.UUID] = None, assets: List[Union[great_expectations.datasource.fluent.sql_datasource.TableAsset, great_expectations.datasource.fluent.sql_datasource.QueryAsset]] = [], connection_string: Union[great_expectations.datasource.fluent.config_str.ConfigStr, pydantic.v1.networks.PostgresDsn], create_temp_table: bool = False, kwargs: Dict[str, Union[great_expectations.datasource.fluent.config_str.ConfigStr, Any]] = {})#

      Adds a postgres datasource to the data context.

      @@ -25,7 +25,7 @@ are TableAsset or QueryAsset objects.

      -add_query_asset(name: str, query: str, order_by: Optional[SortersDefinition] = None, batch_metadata: Optional[BatchMetadata] = None) → QueryAsset# +add_query_asset(name: str, query: str, order_by: Optional[SortersDefinition] = None, batch_metadata: Optional[BatchMetadata] = None) → QueryAsset#

      Adds a query asset to this datasource.

      @@ -48,7 +48,7 @@ eg, it could be a QueryAsset or a SqliteQueryAsset.

      -add_table_asset(name: str, table_name: str = '', schema_name: Optional[str] = None, order_by: Optional[SortersDefinition] = None, batch_metadata: Optional[BatchMetadata] = None) → TableAsset# +add_table_asset(name: str, table_name: str = '', schema_name: Optional[str] = None, order_by: Optional[SortersDefinition] = None, batch_metadata: Optional[BatchMetadata] = None) → TableAsset#

      Adds a table asset to this datasource.

      diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/fluent/SnowflakeDatasource_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/fluent/SnowflakeDatasource_class.mdx index 03d9d1b59a41..1b0101ce76ea 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/fluent/SnowflakeDatasource_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/fluent/SnowflakeDatasource_class.mdx @@ -8,7 +8,7 @@ sidebar_label: SnowflakeDatasource
      -class great_expectations.datasource.fluent.SnowflakeDatasource(*, type: Literal['snowflake'] = 'snowflake', name: str, id: Optional[uuid.UUID] = None, assets: List[Union[great_expectations.datasource.fluent.sql_datasource.TableAsset, great_expectations.datasource.fluent.sql_datasource.QueryAsset]] = [], connection_string: Union[great_expectations.datasource.fluent.snowflake_datasource.ConnectionDetails, great_expectations.datasource.fluent.config_str.ConfigStr, great_expectations.datasource.fluent.snowflake_datasource.SnowflakeDsn], create_temp_table: bool = False, kwargs: Dict[str, Union[great_expectations.datasource.fluent.config_str.ConfigStr, Any]] = {})# +class great_expectations.datasource.fluent.SnowflakeDatasource(*, type: Literal['snowflake'] = 'snowflake', name: str, id: Optional[uuid.UUID] = None, assets: List[Union[great_expectations.datasource.fluent.sql_datasource.TableAsset, great_expectations.datasource.fluent.sql_datasource.QueryAsset]] = [], connection_string: Union[great_expectations.datasource.fluent.snowflake_datasource.ConnectionDetails, great_expectations.datasource.fluent.config_str.ConfigStr, great_expectations.datasource.fluent.snowflake_datasource.SnowflakeDsn], create_temp_table: bool = False, kwargs: Dict[str, Union[great_expectations.datasource.fluent.config_str.ConfigStr, Any]] = {})#

      Adds a Snowflake datasource to the data context.

      @@ -25,7 +25,7 @@ are TableAsset or QueryAsset objects.

      -add_query_asset(name: str, query: str, order_by: Optional[SortersDefinition] = None, batch_metadata: Optional[BatchMetadata] = None) → QueryAsset# +add_query_asset(name: str, query: str, order_by: Optional[SortersDefinition] = None, batch_metadata: Optional[BatchMetadata] = None) → QueryAsset#

      Adds a query asset to this datasource.

      @@ -48,7 +48,7 @@ eg, it could be a QueryAsset or a SqliteQueryAsset.

      -add_table_asset(name: str, table_name: str = '', schema_name: Optional[str] = None, order_by: Optional[SortersDefinition] = None, batch_metadata: Optional[BatchMetadata] = None) → TableAsset# +add_table_asset(name: str, table_name: str = '', schema_name: Optional[str] = None, order_by: Optional[SortersDefinition] = None, batch_metadata: Optional[BatchMetadata] = None) → TableAsset#

      Adds a table asset to this datasource.

      diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/fluent/SqliteDatasource_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/fluent/SqliteDatasource_class.mdx index bf552b1c0be0..826f855fc705 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/fluent/SqliteDatasource_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/fluent/SqliteDatasource_class.mdx @@ -8,7 +8,7 @@ sidebar_label: SqliteDatasource
      -class great_expectations.datasource.fluent.SqliteDatasource(*, type: Literal['sqlite'] = 'sqlite', name: str, id: Optional[uuid.UUID] = None, assets: List[Union[great_expectations.datasource.fluent.sql_datasource.TableAsset, great_expectations.datasource.fluent.sql_datasource.QueryAsset]] = [], connection_string: Union[great_expectations.datasource.fluent.config_str.ConfigStr, great_expectations.datasource.fluent.sqlite_datasource.SqliteDsn], create_temp_table: bool = False, kwargs: Dict[str, Union[great_expectations.datasource.fluent.config_str.ConfigStr, Any]] = {})# +class great_expectations.datasource.fluent.SqliteDatasource(*, type: Literal['sqlite'] = 'sqlite', name: str, id: Optional[uuid.UUID] = None, assets: List[Union[great_expectations.datasource.fluent.sql_datasource.TableAsset, great_expectations.datasource.fluent.sql_datasource.QueryAsset]] = [], connection_string: Union[great_expectations.datasource.fluent.config_str.ConfigStr, great_expectations.datasource.fluent.sqlite_datasource.SqliteDsn], create_temp_table: bool = False, kwargs: Dict[str, Union[great_expectations.datasource.fluent.config_str.ConfigStr, Any]] = {})#

      Adds a sqlite datasource to the data context.

      diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/fluent/sql_datasource/QueryAsset_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/fluent/sql_datasource/QueryAsset_class.mdx index e1b1d09ede28..9d0344ef283e 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/fluent/sql_datasource/QueryAsset_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/fluent/sql_datasource/QueryAsset_class.mdx @@ -127,7 +127,7 @@ sidebar_label: QueryAsset
      -build_batch_request(options: Optional[BatchRequestOptions] = None, batch_slice: Optional[BatchSlice] = None) → BatchRequest# +build_batch_request(options: Optional[BatchRequestOptions] = None, batch_slice: Optional[BatchSlice] = None) → BatchRequest#

      A batch request that can be used to obtain batches for this DataAsset.

      diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/fluent/sql_datasource/TableAsset_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/fluent/sql_datasource/TableAsset_class.mdx index 195fcc79224a..e364a067fb34 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/fluent/sql_datasource/TableAsset_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/datasource/fluent/sql_datasource/TableAsset_class.mdx @@ -127,7 +127,7 @@ sidebar_label: TableAsset
      -build_batch_request(options: Optional[BatchRequestOptions] = None, batch_slice: Optional[BatchSlice] = None) → BatchRequest# +build_batch_request(options: Optional[BatchRequestOptions] = None, batch_slice: Optional[BatchSlice] = None) → BatchRequest#

      A batch request that can be used to obtain batches for this DataAsset.

      diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/execution_engine/ExecutionEngine_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/execution_engine/ExecutionEngine_class.mdx index a46ffaed2117..93dc440a06d9 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/execution_engine/ExecutionEngine_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/execution_engine/ExecutionEngine_class.mdx @@ -8,7 +8,7 @@ sidebar_label: ExecutionEngine
      -class great_expectations.execution_engine.ExecutionEngine(name: Optional[str] = None, caching: bool = True, batch_spec_defaults: Optional[dict] = None, batch_data_dict: Optional[dict] = None, validator: Optional[Validator] = None)# +class great_expectations.execution_engine.ExecutionEngine(name: Optional[str] = None, caching: bool = True, batch_spec_defaults: Optional[dict] = None, batch_data_dict: Optional[dict] = None, validator: Optional[Validator] = None)#

      ExecutionEngine defines interfaces and provides common methods for loading Batch of data and compute metrics.

      @@ -40,7 +40,7 @@ systems, such as SQLAlchemy and Spark; it is not available for Pandas, because P
      -get_compute_domain(domain_kwargs: dict, domain_type: Union[str, great_expectations.core.metric_domain_types.MetricDomainTypes], accessor_keys: Optional[Iterable[str]] = None) → Tuple[Any, dict, dict]# +get_compute_domain(domain_kwargs: dict, domain_type: Union[str, great_expectations.core.metric_domain_types.MetricDomainTypes], accessor_keys: Optional[Iterable[str]] = None) → Tuple[Any, dict, dict]#

      get_compute_domain() is an interface method, which computes the optimal domain_kwargs for computing metrics based on the given domain_kwargs and specific engine semantics.

      @@ -48,7 +48,7 @@ systems, such as SQLAlchemy and Spark; it is not available for Pandas, because P
      Parameters

      • domain_kwargs (dict) – a dictionary consisting of the Domain kwargs specifying which data to obtain

        • -

      • domain_type (str or MetricDomainTypes) – an Enum value indicating which metric Domain the user would like to be using, or a corresponding string value representing it. String types include “column”, “column_pair”, “table”, and “other”. Enum types include capitalized versions of these from the class MetricDomainTypes.

        • +

      • domain_type (str or MetricDomainTypes) – an Enum value indicating which metric Domain the user would like to be using, or a corresponding string value representing it. String types include “column”, “column_pair”, “table”, and “other”. Enum types include capitalized versions of these from the class MetricDomainTypes.

      • accessor_keys (str iterable) – keys that are part of the compute Domain but should be ignored when describing the Domain and simply transferred with their associated values into accessor_domain_kwargs.

      diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/execution_engine/PandasExecutionEngine_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/execution_engine/PandasExecutionEngine_class.mdx index fcbd68eacab4..d6b104aa923a 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/execution_engine/PandasExecutionEngine_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/execution_engine/PandasExecutionEngine_class.mdx @@ -25,7 +25,7 @@ import CodeBlock from '@theme/CodeBlock'; {` execution_engine: ExecutionEngine = PandasExecutionEngine(batch_data_dict={batch.id: batch.data})`}
      -get_compute_domain(domain_kwargs: dict, domain_type: Union[str, great_expectations.core.metric_domain_types.MetricDomainTypes], accessor_keys: Optional[Iterable[str]] = None) → Tuple[pandas.core.frame.DataFrame, dict, dict]# +get_compute_domain(domain_kwargs: dict, domain_type: Union[str, great_expectations.core.metric_domain_types.MetricDomainTypes], accessor_keys: Optional[Iterable[str]] = None) → Tuple[pandas.core.frame.DataFrame, dict, dict]#

      Uses the given Domain kwargs (which include row_condition, condition_parser, and ignore_row_if directives) to obtain and/or query a batch.

      @@ -34,7 +34,7 @@ import CodeBlock from '@theme/CodeBlock';
      Parameters

      • domain_kwargs (dict) – a dictionary consisting of the Domain kwargs specifying which data to obtain

        • -

      • domain_type (str or MetricDomainTypes) – an Enum value indicating which metric Domain the user would like to be using, or a corresponding string value representing it. String types include "column", "column_pair", "table", and "other". Enum types include capitalized versions of these from the class MetricDomainTypes.

        • +

      • domain_type (str or MetricDomainTypes) – an Enum value indicating which metric Domain the user would like to be using, or a corresponding string value representing it. String types include "column", "column_pair", "table", and "other". Enum types include capitalized versions of these from the class MetricDomainTypes.

      • accessor_keys (str iterable) – keys that are part of the compute Domain but should be ignored when describing the Domain and simply transferred with their associated values into accessor_domain_kwargs.

      diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/execution_engine/SparkDFExecutionEngine_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/execution_engine/SparkDFExecutionEngine_class.mdx index 78103cefe3bf..b0902068822f 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/execution_engine/SparkDFExecutionEngine_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/execution_engine/SparkDFExecutionEngine_class.mdx @@ -34,7 +34,7 @@ spark_config if provided.

      -get_compute_domain(domain_kwargs: dict, domain_type: Union[str, great_expectations.core.metric_domain_types.MetricDomainTypes], accessor_keys: Optional[Iterable[str]] = None) → Tuple[pyspark.sql.dataframe.DataFrame, dict, dict]# +get_compute_domain(domain_kwargs: dict, domain_type: Union[str, great_expectations.core.metric_domain_types.MetricDomainTypes], accessor_keys: Optional[Iterable[str]] = None) → Tuple[pyspark.sql.dataframe.DataFrame, dict, dict]#

      Uses a DataFrame and Domain kwargs (which include a row condition and a condition parser) to obtain and/or query a Batch of data.

      @@ -43,7 +43,7 @@ spark_config if provided.

      Parameters

      • domain_kwargs (dict) – a dictionary consisting of the Domain kwargs specifying which data to obtain

        • -

      • domain_type (str or MetricDomainTypes) – an Enum value indicating which metric Domain the user would like to be using, or a corresponding string value representing it. String types include “identity”, “column”, “column_pair”, “table” and “other”. Enum types include capitalized versions of these from the class MetricDomainTypes.

        • +

      • domain_type (str or MetricDomainTypes) – an Enum value indicating which metric Domain the user would like to be using, or a corresponding string value representing it. String types include “identity”, “column”, “column_pair”, “table” and “other”. Enum types include capitalized versions of these from the class MetricDomainTypes.

      • accessor_keys (str iterable) – keys that are part of the compute Domain but should be ignored when describing the Domain and simply transferred with their associated values into accessor_domain_kwargs.

      diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/execution_engine/SqlAlchemyExecutionEngine_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/execution_engine/SqlAlchemyExecutionEngine_class.mdx index 279254beea7a..1ee950f32a62 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/execution_engine/SqlAlchemyExecutionEngine_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/execution_engine/SqlAlchemyExecutionEngine_class.mdx @@ -73,7 +73,7 @@ import CodeBlock from '@theme/CodeBlock';
      -get_compute_domain(domain_kwargs: dict, domain_type: Union[str, great_expectations.core.metric_domain_types.MetricDomainTypes], accessor_keys: Optional[Iterable[str]] = None) → Tuple[sqlalchemy.sql.selectable.Selectable, dict, dict]# +get_compute_domain(domain_kwargs: dict, domain_type: Union[str, great_expectations.core.metric_domain_types.MetricDomainTypes], accessor_keys: Optional[Iterable[str]] = None) → Tuple[sqlalchemy.sql.selectable.Selectable, dict, dict]#

      Uses a given batch dictionary and Domain kwargs to obtain a SqlAlchemy column object.

      @@ -81,7 +81,7 @@ import CodeBlock from '@theme/CodeBlock';
      Parameters

      • domain_kwargs (dict) – a dictionary consisting of the Domain kwargs specifying which data to obtain

        • -

      • domain_type (str or MetricDomainTypes) – an Enum value indicating which metric Domain the user would like to be using, or a corresponding string value representing it. String types include "identity", "column", "column_pair", "table" and "other". Enum types include capitalized versions of these from the class MetricDomainTypes.

        • +

      • domain_type (str or MetricDomainTypes) – an Enum value indicating which metric Domain the user would like to be using, or a corresponding string value representing it. String types include "identity", "column", "column_pair", "table" and "other". Enum types include capitalized versions of these from the class MetricDomainTypes.

      • accessor_keys (str iterable) – keys that are part of the compute Domain but should be ignored when describing the Domain and simply transferred with their associated values into accessor_domain_kwargs.

      diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/expectation.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/expectation.mdx index cd4c81a54466..01da9c454999 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/expectation.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/expectation.mdx @@ -8,7 +8,7 @@ sidebar_label: expectation.py
      -class great_expectations.expectations.expectation.BatchExpectation(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None) +class great_expectations.expectations.expectation.BatchExpectation(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None)

      Base class for BatchExpectations.

      @@ -37,7 +37,7 @@ expectation.

      -get_success_kwargs(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None) → Dict[str, Any] +get_success_kwargs(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None) → Dict[str, Any]

      Retrieve the success kwargs.

      @@ -70,7 +70,7 @@ This method is experimental.

      -run_diagnostics(raise_exceptions_for_backends: bool = False, ignore_suppress: bool = False, ignore_only_for: bool = False, for_gallery: bool = False, debug_logger: Optional[logging.Logger] = None, only_consider_these_backends: Optional[List[str]] = None, context: Optional[AbstractDataContext] = None) → ExpectationDiagnostics +run_diagnostics(raise_exceptions_for_backends: bool = False, ignore_suppress: bool = False, ignore_only_for: bool = False, for_gallery: bool = False, debug_logger: Optional[logging.Logger] = None, only_consider_these_backends: Optional[List[str]] = None, context: Optional[AbstractDataContext] = None) → ExpectationDiagnostics

      Produce a diagnostic report about this Expectation.

      @@ -97,7 +97,7 @@ that do not exist). These errors are added under “errors” key in the report.

    • for_gallery – Bool object that when True will create empty arrays to use as examples for the Expectation Diagnostics.

    • debug_logger (optional[logging.Logger]) – Logger object to use for sending debug messages to.

    • only_consider_these_backends (optional[List[str]]) –

      • -

    • context (optional[AbstractDataContext]) – Instance of any child of “AbstractDataContext” class.

      • +

    • context (optional[AbstractDataContext]) – Instance of any child of “AbstractDataContext” class.

    Returns
    @@ -108,7 +108,7 @@ that do not exist). These errors are added under “errors” key in the report.
    -validate(validator: Validator, configuration: Optional[ExpectationConfiguration] = None, evaluation_parameters: Optional[dict] = None, interactive_evaluation: bool = True, data_context: Optional[AbstractDataContext] = None, runtime_configuration: Optional[dict] = None) → ExpectationValidationResult +validate(validator: Validator, configuration: Optional[ExpectationConfiguration] = None, evaluation_parameters: Optional[dict] = None, interactive_evaluation: bool = True, data_context: Optional[AbstractDataContext] = None, runtime_configuration: Optional[dict] = None) → ExpectationValidationResult

    Validates the expectation against the provided data.

    @@ -134,7 +134,7 @@ immediately evaluating them.

    -validate_configuration(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None) → None +validate_configuration(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None) → None

    Validates the configuration for the Expectation.

    @@ -152,7 +152,7 @@ checks as required. Overriding methods should call super().validate_config
    -class great_expectations.expectations.expectation.ColumnAggregateExpectation(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None) +class great_expectations.expectations.expectation.ColumnAggregateExpectation(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None)

    Base class for column aggregate Expectations.

    @@ -161,7 +161,7 @@ number of unique values, column type, etc.

    Relevant Documentation Links
    @@ -191,7 +191,7 @@ kwargs from the Expectation Configuration.

    -get_success_kwargs(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None) → Dict[str, Any] +get_success_kwargs(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None) → Dict[str, Any]

    Retrieve the success kwargs.

    @@ -224,7 +224,7 @@ This method is experimental.

    -run_diagnostics(raise_exceptions_for_backends: bool = False, ignore_suppress: bool = False, ignore_only_for: bool = False, for_gallery: bool = False, debug_logger: Optional[logging.Logger] = None, only_consider_these_backends: Optional[List[str]] = None, context: Optional[AbstractDataContext] = None) → ExpectationDiagnostics +run_diagnostics(raise_exceptions_for_backends: bool = False, ignore_suppress: bool = False, ignore_only_for: bool = False, for_gallery: bool = False, debug_logger: Optional[logging.Logger] = None, only_consider_these_backends: Optional[List[str]] = None, context: Optional[AbstractDataContext] = None) → ExpectationDiagnostics

    Produce a diagnostic report about this Expectation.

    @@ -251,7 +251,7 @@ that do not exist). These errors are added under “errors” key in the report.

  • for_gallery – Bool object that when True will create empty arrays to use as examples for the Expectation Diagnostics.

  • debug_logger (optional[logging.Logger]) – Logger object to use for sending debug messages to.

  • only_consider_these_backends (optional[List[str]]) –

    • -

  • context (optional[AbstractDataContext]) – Instance of any child of “AbstractDataContext” class.

    • +

  • context (optional[AbstractDataContext]) – Instance of any child of “AbstractDataContext” class.

Returns
@@ -262,7 +262,7 @@ that do not exist). These errors are added under “errors” key in the report.
-validate(validator: Validator, configuration: Optional[ExpectationConfiguration] = None, evaluation_parameters: Optional[dict] = None, interactive_evaluation: bool = True, data_context: Optional[AbstractDataContext] = None, runtime_configuration: Optional[dict] = None) → ExpectationValidationResult +validate(validator: Validator, configuration: Optional[ExpectationConfiguration] = None, evaluation_parameters: Optional[dict] = None, interactive_evaluation: bool = True, data_context: Optional[AbstractDataContext] = None, runtime_configuration: Optional[dict] = None) → ExpectationValidationResult

Validates the expectation against the provided data.

@@ -289,7 +289,7 @@ immediately evaluating them.

-class great_expectations.expectations.expectation.ColumnExpectation(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None) +class great_expectations.expectations.expectation.ColumnExpectation(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None)

Base class for column aggregate Expectations.

@@ -301,7 +301,7 @@ There is no change in functionality between the two classes; just a name change
Relevant Documentation Links
@@ -331,7 +331,7 @@ kwargs from the Expectation Configuration.

-get_success_kwargs(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None) → Dict[str, Any] +get_success_kwargs(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None) → Dict[str, Any]

Retrieve the success kwargs.

@@ -364,7 +364,7 @@ This method is experimental.

-run_diagnostics(raise_exceptions_for_backends: bool = False, ignore_suppress: bool = False, ignore_only_for: bool = False, for_gallery: bool = False, debug_logger: Optional[logging.Logger] = None, only_consider_these_backends: Optional[List[str]] = None, context: Optional[AbstractDataContext] = None) → ExpectationDiagnostics +run_diagnostics(raise_exceptions_for_backends: bool = False, ignore_suppress: bool = False, ignore_only_for: bool = False, for_gallery: bool = False, debug_logger: Optional[logging.Logger] = None, only_consider_these_backends: Optional[List[str]] = None, context: Optional[AbstractDataContext] = None) → ExpectationDiagnostics

Produce a diagnostic report about this Expectation.

@@ -391,7 +391,7 @@ that do not exist). These errors are added under “errors” key in the report.

  • for_gallery – Bool object that when True will create empty arrays to use as examples for the Expectation Diagnostics.

  • debug_logger (optional[logging.Logger]) – Logger object to use for sending debug messages to.

  • only_consider_these_backends (optional[List[str]]) –

    • -

  • context (optional[AbstractDataContext]) – Instance of any child of “AbstractDataContext” class.

    • +

  • context (optional[AbstractDataContext]) – Instance of any child of “AbstractDataContext” class.

    • Returns
    @@ -402,7 +402,7 @@ that do not exist). These errors are added under “errors” key in the report.
    -validate(validator: Validator, configuration: Optional[ExpectationConfiguration] = None, evaluation_parameters: Optional[dict] = None, interactive_evaluation: bool = True, data_context: Optional[AbstractDataContext] = None, runtime_configuration: Optional[dict] = None) → ExpectationValidationResult +validate(validator: Validator, configuration: Optional[ExpectationConfiguration] = None, evaluation_parameters: Optional[dict] = None, interactive_evaluation: bool = True, data_context: Optional[AbstractDataContext] = None, runtime_configuration: Optional[dict] = None) → ExpectationValidationResult

    Validates the expectation against the provided data.

    @@ -429,7 +429,7 @@ immediately evaluating them.

    -class great_expectations.expectations.expectation.ColumnMapExpectation(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None) +class great_expectations.expectations.expectation.ColumnMapExpectation(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None)

    Base class for ColumnMapExpectations.

    @@ -464,7 +464,7 @@ kwargs from the Expectation Configuration.

    -get_success_kwargs(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None) → Dict[str, Any] +get_success_kwargs(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None) → Dict[str, Any]

    Retrieve the success kwargs.

    @@ -497,7 +497,7 @@ This method is experimental.

    -run_diagnostics(raise_exceptions_for_backends: bool = False, ignore_suppress: bool = False, ignore_only_for: bool = False, for_gallery: bool = False, debug_logger: Optional[logging.Logger] = None, only_consider_these_backends: Optional[List[str]] = None, context: Optional[AbstractDataContext] = None) → ExpectationDiagnostics +run_diagnostics(raise_exceptions_for_backends: bool = False, ignore_suppress: bool = False, ignore_only_for: bool = False, for_gallery: bool = False, debug_logger: Optional[logging.Logger] = None, only_consider_these_backends: Optional[List[str]] = None, context: Optional[AbstractDataContext] = None) → ExpectationDiagnostics

    Produce a diagnostic report about this Expectation.

    @@ -524,7 +524,7 @@ that do not exist). These errors are added under “errors” key in the report.

  • for_gallery – Bool object that when True will create empty arrays to use as examples for the Expectation Diagnostics.

  • debug_logger (optional[logging.Logger]) – Logger object to use for sending debug messages to.

  • only_consider_these_backends (optional[List[str]]) –

    • -

  • context (optional[AbstractDataContext]) – Instance of any child of “AbstractDataContext” class.

    • +

  • context (optional[AbstractDataContext]) – Instance of any child of “AbstractDataContext” class.

    • Returns
    @@ -535,7 +535,7 @@ that do not exist). These errors are added under “errors” key in the report.
    -validate(validator: Validator, configuration: Optional[ExpectationConfiguration] = None, evaluation_parameters: Optional[dict] = None, interactive_evaluation: bool = True, data_context: Optional[AbstractDataContext] = None, runtime_configuration: Optional[dict] = None) → ExpectationValidationResult +validate(validator: Validator, configuration: Optional[ExpectationConfiguration] = None, evaluation_parameters: Optional[dict] = None, interactive_evaluation: bool = True, data_context: Optional[AbstractDataContext] = None, runtime_configuration: Optional[dict] = None) → ExpectationValidationResult

    Validates the expectation against the provided data.

    @@ -562,7 +562,7 @@ immediately evaluating them.

    -class great_expectations.expectations.expectation.ColumnPairMapExpectation(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None) +class great_expectations.expectations.expectation.ColumnPairMapExpectation(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None)

    Base class for ColumnPairMapExpectations.

    @@ -597,7 +597,7 @@ kwargs from the Expectation Configuration.

    -get_success_kwargs(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None) → Dict[str, Any] +get_success_kwargs(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None) → Dict[str, Any]

    Retrieve the success kwargs.

    @@ -630,7 +630,7 @@ This method is experimental.

    -run_diagnostics(raise_exceptions_for_backends: bool = False, ignore_suppress: bool = False, ignore_only_for: bool = False, for_gallery: bool = False, debug_logger: Optional[logging.Logger] = None, only_consider_these_backends: Optional[List[str]] = None, context: Optional[AbstractDataContext] = None) → ExpectationDiagnostics +run_diagnostics(raise_exceptions_for_backends: bool = False, ignore_suppress: bool = False, ignore_only_for: bool = False, for_gallery: bool = False, debug_logger: Optional[logging.Logger] = None, only_consider_these_backends: Optional[List[str]] = None, context: Optional[AbstractDataContext] = None) → ExpectationDiagnostics

    Produce a diagnostic report about this Expectation.

    @@ -657,7 +657,7 @@ that do not exist). These errors are added under “errors” key in the report.

  • for_gallery – Bool object that when True will create empty arrays to use as examples for the Expectation Diagnostics.

  • debug_logger (optional[logging.Logger]) – Logger object to use for sending debug messages to.

  • only_consider_these_backends (optional[List[str]]) –

    • -

  • context (optional[AbstractDataContext]) – Instance of any child of “AbstractDataContext” class.

    • +

  • context (optional[AbstractDataContext]) – Instance of any child of “AbstractDataContext” class.

    • Returns
    @@ -668,7 +668,7 @@ that do not exist). These errors are added under “errors” key in the report.
    -validate(validator: Validator, configuration: Optional[ExpectationConfiguration] = None, evaluation_parameters: Optional[dict] = None, interactive_evaluation: bool = True, data_context: Optional[AbstractDataContext] = None, runtime_configuration: Optional[dict] = None) → ExpectationValidationResult +validate(validator: Validator, configuration: Optional[ExpectationConfiguration] = None, evaluation_parameters: Optional[dict] = None, interactive_evaluation: bool = True, data_context: Optional[AbstractDataContext] = None, runtime_configuration: Optional[dict] = None) → ExpectationValidationResult

    Validates the expectation against the provided data.

    @@ -695,7 +695,7 @@ immediately evaluating them.

    -class great_expectations.expectations.expectation.Expectation(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None) +class great_expectations.expectations.expectation.Expectation(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None)

    Base class for all Expectations.

    @@ -742,7 +742,7 @@ will not be usable for the Expectation

    -get_success_kwargs(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None) → Dict[str, Any] +get_success_kwargs(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None) → Dict[str, Any]

    Retrieve the success kwargs.

    @@ -775,7 +775,7 @@ This method is experimental.

    -run_diagnostics(raise_exceptions_for_backends: bool = False, ignore_suppress: bool = False, ignore_only_for: bool = False, for_gallery: bool = False, debug_logger: Optional[logging.Logger] = None, only_consider_these_backends: Optional[List[str]] = None, context: Optional[AbstractDataContext] = None) → ExpectationDiagnostics +run_diagnostics(raise_exceptions_for_backends: bool = False, ignore_suppress: bool = False, ignore_only_for: bool = False, for_gallery: bool = False, debug_logger: Optional[logging.Logger] = None, only_consider_these_backends: Optional[List[str]] = None, context: Optional[AbstractDataContext] = None) → ExpectationDiagnostics

    Produce a diagnostic report about this Expectation.

    @@ -802,7 +802,7 @@ that do not exist). These errors are added under “errors” key in the report.

  • for_gallery – Bool object that when True will create empty arrays to use as examples for the Expectation Diagnostics.

  • debug_logger (optional[logging.Logger]) – Logger object to use for sending debug messages to.

  • only_consider_these_backends (optional[List[str]]) –

    • -

  • context (optional[AbstractDataContext]) – Instance of any child of “AbstractDataContext” class.

    • +

  • context (optional[AbstractDataContext]) – Instance of any child of “AbstractDataContext” class.

    • Returns
    @@ -813,7 +813,7 @@ that do not exist). These errors are added under “errors” key in the report.
    -validate(validator: Validator, configuration: Optional[ExpectationConfiguration] = None, evaluation_parameters: Optional[dict] = None, interactive_evaluation: bool = True, data_context: Optional[AbstractDataContext] = None, runtime_configuration: Optional[dict] = None) → ExpectationValidationResult +validate(validator: Validator, configuration: Optional[ExpectationConfiguration] = None, evaluation_parameters: Optional[dict] = None, interactive_evaluation: bool = True, data_context: Optional[AbstractDataContext] = None, runtime_configuration: Optional[dict] = None) → ExpectationValidationResult

    Validates the expectation against the provided data.

    @@ -839,7 +839,7 @@ immediately evaluating them.

    -validate_configuration(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None) → None +validate_configuration(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None) → None

    Validates the configuration for the Expectation.

    @@ -857,7 +857,7 @@ checks as required. Overriding methods should call super().validate_config
    -class great_expectations.expectations.expectation.MulticolumnMapExpectation(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None) +class great_expectations.expectations.expectation.MulticolumnMapExpectation(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None)

    Base class for MulticolumnMapExpectations.

    @@ -893,7 +893,7 @@ kwargs from the Expectation Configuration.

    -get_success_kwargs(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None) → Dict[str, Any] +get_success_kwargs(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None) → Dict[str, Any]

    Retrieve the success kwargs.

    @@ -926,7 +926,7 @@ This method is experimental.

    -run_diagnostics(raise_exceptions_for_backends: bool = False, ignore_suppress: bool = False, ignore_only_for: bool = False, for_gallery: bool = False, debug_logger: Optional[logging.Logger] = None, only_consider_these_backends: Optional[List[str]] = None, context: Optional[AbstractDataContext] = None) → ExpectationDiagnostics +run_diagnostics(raise_exceptions_for_backends: bool = False, ignore_suppress: bool = False, ignore_only_for: bool = False, for_gallery: bool = False, debug_logger: Optional[logging.Logger] = None, only_consider_these_backends: Optional[List[str]] = None, context: Optional[AbstractDataContext] = None) → ExpectationDiagnostics

    Produce a diagnostic report about this Expectation.

    @@ -953,7 +953,7 @@ that do not exist). These errors are added under “errors” key in the report.

  • for_gallery – Bool object that when True will create empty arrays to use as examples for the Expectation Diagnostics.

  • debug_logger (optional[logging.Logger]) – Logger object to use for sending debug messages to.

  • only_consider_these_backends (optional[List[str]]) –

    • -

  • context (optional[AbstractDataContext]) – Instance of any child of “AbstractDataContext” class.

    • +

  • context (optional[AbstractDataContext]) – Instance of any child of “AbstractDataContext” class.

    • Returns
    @@ -964,7 +964,7 @@ that do not exist). These errors are added under “errors” key in the report.
    -validate(validator: Validator, configuration: Optional[ExpectationConfiguration] = None, evaluation_parameters: Optional[dict] = None, interactive_evaluation: bool = True, data_context: Optional[AbstractDataContext] = None, runtime_configuration: Optional[dict] = None) → ExpectationValidationResult +validate(validator: Validator, configuration: Optional[ExpectationConfiguration] = None, evaluation_parameters: Optional[dict] = None, interactive_evaluation: bool = True, data_context: Optional[AbstractDataContext] = None, runtime_configuration: Optional[dict] = None) → ExpectationValidationResult

    Validates the expectation against the provided data.

    @@ -991,7 +991,7 @@ immediately evaluating them.

    -class great_expectations.expectations.expectation.QueryExpectation(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None) +class great_expectations.expectations.expectation.QueryExpectation(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None)

    Base class for QueryExpectations.

    @@ -1023,7 +1023,7 @@ into the QueryExpectation.

    Relevant Documentation Links
    @@ -1034,7 +1034,7 @@ into the QueryExpectation.

    -get_success_kwargs(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None) → Dict[str, Any] +get_success_kwargs(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None) → Dict[str, Any]

    Retrieve the success kwargs.

    @@ -1067,7 +1067,7 @@ This method is experimental.

    -run_diagnostics(raise_exceptions_for_backends: bool = False, ignore_suppress: bool = False, ignore_only_for: bool = False, for_gallery: bool = False, debug_logger: Optional[logging.Logger] = None, only_consider_these_backends: Optional[List[str]] = None, context: Optional[AbstractDataContext] = None) → ExpectationDiagnostics +run_diagnostics(raise_exceptions_for_backends: bool = False, ignore_suppress: bool = False, ignore_only_for: bool = False, for_gallery: bool = False, debug_logger: Optional[logging.Logger] = None, only_consider_these_backends: Optional[List[str]] = None, context: Optional[AbstractDataContext] = None) → ExpectationDiagnostics

    Produce a diagnostic report about this Expectation.

    @@ -1094,7 +1094,7 @@ that do not exist). These errors are added under “errors” key in the report.

  • for_gallery – Bool object that when True will create empty arrays to use as examples for the Expectation Diagnostics.

  • debug_logger (optional[logging.Logger]) – Logger object to use for sending debug messages to.

  • only_consider_these_backends (optional[List[str]]) –

    • -

  • context (optional[AbstractDataContext]) – Instance of any child of “AbstractDataContext” class.

    • +

  • context (optional[AbstractDataContext]) – Instance of any child of “AbstractDataContext” class.

    • Returns
    @@ -1105,7 +1105,7 @@ that do not exist). These errors are added under “errors” key in the report.
    -validate(validator: Validator, configuration: Optional[ExpectationConfiguration] = None, evaluation_parameters: Optional[dict] = None, interactive_evaluation: bool = True, data_context: Optional[AbstractDataContext] = None, runtime_configuration: Optional[dict] = None) → ExpectationValidationResult +validate(validator: Validator, configuration: Optional[ExpectationConfiguration] = None, evaluation_parameters: Optional[dict] = None, interactive_evaluation: bool = True, data_context: Optional[AbstractDataContext] = None, runtime_configuration: Optional[dict] = None) → ExpectationValidationResult

    Validates the expectation against the provided data.

    @@ -1132,7 +1132,7 @@ immediately evaluating them.

    -class great_expectations.expectations.expectation.TableExpectation(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None) +class great_expectations.expectations.expectation.TableExpectation(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None)

    Base class for TableExpectations.

    @@ -1162,7 +1162,7 @@ expectation.

    -get_success_kwargs(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None) → Dict[str, Any] +get_success_kwargs(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None) → Dict[str, Any]

    Retrieve the success kwargs.

    @@ -1195,7 +1195,7 @@ This method is experimental.

    -run_diagnostics(raise_exceptions_for_backends: bool = False, ignore_suppress: bool = False, ignore_only_for: bool = False, for_gallery: bool = False, debug_logger: Optional[logging.Logger] = None, only_consider_these_backends: Optional[List[str]] = None, context: Optional[AbstractDataContext] = None) → ExpectationDiagnostics +run_diagnostics(raise_exceptions_for_backends: bool = False, ignore_suppress: bool = False, ignore_only_for: bool = False, for_gallery: bool = False, debug_logger: Optional[logging.Logger] = None, only_consider_these_backends: Optional[List[str]] = None, context: Optional[AbstractDataContext] = None) → ExpectationDiagnostics

    Produce a diagnostic report about this Expectation.

    @@ -1222,7 +1222,7 @@ that do not exist). These errors are added under “errors” key in the report.

  • for_gallery – Bool object that when True will create empty arrays to use as examples for the Expectation Diagnostics.

  • debug_logger (optional[logging.Logger]) – Logger object to use for sending debug messages to.

  • only_consider_these_backends (optional[List[str]]) –

    • -

  • context (optional[AbstractDataContext]) – Instance of any child of “AbstractDataContext” class.

    • +

  • context (optional[AbstractDataContext]) – Instance of any child of “AbstractDataContext” class.

    • Returns
    @@ -1233,7 +1233,7 @@ that do not exist). These errors are added under “errors” key in the report.
    -validate(validator: Validator, configuration: Optional[ExpectationConfiguration] = None, evaluation_parameters: Optional[dict] = None, interactive_evaluation: bool = True, data_context: Optional[AbstractDataContext] = None, runtime_configuration: Optional[dict] = None) → ExpectationValidationResult +validate(validator: Validator, configuration: Optional[ExpectationConfiguration] = None, evaluation_parameters: Optional[dict] = None, interactive_evaluation: bool = True, data_context: Optional[AbstractDataContext] = None, runtime_configuration: Optional[dict] = None) → ExpectationValidationResult

    Validates the expectation against the provided data.

    @@ -1259,7 +1259,7 @@ immediately evaluating them.

    -validate_configuration(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None) → None +validate_configuration(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None) → None

    Validates the configuration for the Expectation.

    diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/expectation/BatchExpectation_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/expectation/BatchExpectation_class.mdx index f292f9ce6fd7..d89d7acf709e 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/expectation/BatchExpectation_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/expectation/BatchExpectation_class.mdx @@ -8,7 +8,7 @@ sidebar_label: BatchExpectation
    -class great_expectations.expectations.expectation.BatchExpectation(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None)# +class great_expectations.expectations.expectation.BatchExpectation(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None)#

    Base class for BatchExpectations.

    @@ -37,7 +37,7 @@ expectation.

    -get_success_kwargs(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None) → Dict[str, Any]# +get_success_kwargs(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None) → Dict[str, Any]#

    Retrieve the success kwargs.

    @@ -70,7 +70,7 @@ This method is experimental.

    -run_diagnostics(raise_exceptions_for_backends: bool = False, ignore_suppress: bool = False, ignore_only_for: bool = False, for_gallery: bool = False, debug_logger: Optional[logging.Logger] = None, only_consider_these_backends: Optional[List[str]] = None, context: Optional[AbstractDataContext] = None) → ExpectationDiagnostics# +run_diagnostics(raise_exceptions_for_backends: bool = False, ignore_suppress: bool = False, ignore_only_for: bool = False, for_gallery: bool = False, debug_logger: Optional[logging.Logger] = None, only_consider_these_backends: Optional[List[str]] = None, context: Optional[AbstractDataContext] = None) → ExpectationDiagnostics#

    Produce a diagnostic report about this Expectation.

    @@ -97,7 +97,7 @@ that do not exist). These errors are added under “errors” key in the report.

  • for_gallery – Bool object that when True will create empty arrays to use as examples for the Expectation Diagnostics.

  • debug_logger (optional[logging.Logger]) – Logger object to use for sending debug messages to.

  • only_consider_these_backends (optional[List[str]]) –

    • -

  • context (optional[AbstractDataContext]) – Instance of any child of “AbstractDataContext” class.

    • +

  • context (optional[AbstractDataContext]) – Instance of any child of “AbstractDataContext” class.

    • Returns
    @@ -108,7 +108,7 @@ that do not exist). These errors are added under “errors” key in the report.
    -validate(validator: Validator, configuration: Optional[ExpectationConfiguration] = None, evaluation_parameters: Optional[dict] = None, interactive_evaluation: bool = True, data_context: Optional[AbstractDataContext] = None, runtime_configuration: Optional[dict] = None) → ExpectationValidationResult# +validate(validator: Validator, configuration: Optional[ExpectationConfiguration] = None, evaluation_parameters: Optional[dict] = None, interactive_evaluation: bool = True, data_context: Optional[AbstractDataContext] = None, runtime_configuration: Optional[dict] = None) → ExpectationValidationResult#

    Validates the expectation against the provided data.

    @@ -134,7 +134,7 @@ immediately evaluating them.

    -validate_configuration(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None) → None# +validate_configuration(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None) → None#

    Validates the configuration for the Expectation.

    diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/expectation/ColumnAggregateExpectation_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/expectation/ColumnAggregateExpectation_class.mdx index 096e93768d81..a1a28d72325e 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/expectation/ColumnAggregateExpectation_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/expectation/ColumnAggregateExpectation_class.mdx @@ -8,7 +8,7 @@ sidebar_label: ColumnAggregateExpectation
    -class great_expectations.expectations.expectation.ColumnAggregateExpectation(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None)# +class great_expectations.expectations.expectation.ColumnAggregateExpectation(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None)#

    Base class for column aggregate Expectations.

    @@ -17,7 +17,7 @@ number of unique values, column type, etc.

    Relevant Documentation Links
    @@ -45,7 +45,7 @@ kwargs from the Expectation Configuration.

    -get_success_kwargs(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None) → Dict[str, Any]# +get_success_kwargs(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None) → Dict[str, Any]#

    Retrieve the success kwargs.

    @@ -78,7 +78,7 @@ This method is experimental.

    -run_diagnostics(raise_exceptions_for_backends: bool = False, ignore_suppress: bool = False, ignore_only_for: bool = False, for_gallery: bool = False, debug_logger: Optional[logging.Logger] = None, only_consider_these_backends: Optional[List[str]] = None, context: Optional[AbstractDataContext] = None) → ExpectationDiagnostics# +run_diagnostics(raise_exceptions_for_backends: bool = False, ignore_suppress: bool = False, ignore_only_for: bool = False, for_gallery: bool = False, debug_logger: Optional[logging.Logger] = None, only_consider_these_backends: Optional[List[str]] = None, context: Optional[AbstractDataContext] = None) → ExpectationDiagnostics#

    Produce a diagnostic report about this Expectation.

    @@ -105,7 +105,7 @@ that do not exist). These errors are added under “errors” key in the report.

  • for_gallery – Bool object that when True will create empty arrays to use as examples for the Expectation Diagnostics.

  • debug_logger (optional[logging.Logger]) – Logger object to use for sending debug messages to.

  • only_consider_these_backends (optional[List[str]]) –

    • -

  • context (optional[AbstractDataContext]) – Instance of any child of “AbstractDataContext” class.

    • +

  • context (optional[AbstractDataContext]) – Instance of any child of “AbstractDataContext” class.

    • Returns
    @@ -116,7 +116,7 @@ that do not exist). These errors are added under “errors” key in the report.
    -validate(validator: Validator, configuration: Optional[ExpectationConfiguration] = None, evaluation_parameters: Optional[dict] = None, interactive_evaluation: bool = True, data_context: Optional[AbstractDataContext] = None, runtime_configuration: Optional[dict] = None) → ExpectationValidationResult# +validate(validator: Validator, configuration: Optional[ExpectationConfiguration] = None, evaluation_parameters: Optional[dict] = None, interactive_evaluation: bool = True, data_context: Optional[AbstractDataContext] = None, runtime_configuration: Optional[dict] = None) → ExpectationValidationResult#

    Validates the expectation against the provided data.

    diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/expectation/ColumnExpectation_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/expectation/ColumnExpectation_class.mdx index 2f767e0e7adc..ef1e4983779f 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/expectation/ColumnExpectation_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/expectation/ColumnExpectation_class.mdx @@ -7,7 +7,7 @@ sidebar_label: ColumnExpectation
    -class great_expectations.expectations.expectation.ColumnExpectation(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None)# +class great_expectations.expectations.expectation.ColumnExpectation(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None)#

    Base class for column aggregate Expectations.

    @@ -19,7 +19,7 @@ There is no change in functionality between the two classes; just a name change
    Relevant Documentation Links
    @@ -49,7 +49,7 @@ kwargs from the Expectation Configuration.

    -get_success_kwargs(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None) → Dict[str, Any]# +get_success_kwargs(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None) → Dict[str, Any]#

    Retrieve the success kwargs.

    @@ -82,7 +82,7 @@ This method is experimental.

    -run_diagnostics(raise_exceptions_for_backends: bool = False, ignore_suppress: bool = False, ignore_only_for: bool = False, for_gallery: bool = False, debug_logger: Optional[logging.Logger] = None, only_consider_these_backends: Optional[List[str]] = None, context: Optional[AbstractDataContext] = None) → ExpectationDiagnostics# +run_diagnostics(raise_exceptions_for_backends: bool = False, ignore_suppress: bool = False, ignore_only_for: bool = False, for_gallery: bool = False, debug_logger: Optional[logging.Logger] = None, only_consider_these_backends: Optional[List[str]] = None, context: Optional[AbstractDataContext] = None) → ExpectationDiagnostics#

    Produce a diagnostic report about this Expectation.

    @@ -109,7 +109,7 @@ that do not exist). These errors are added under “errors” key in the report.

  • for_gallery – Bool object that when True will create empty arrays to use as examples for the Expectation Diagnostics.

  • debug_logger (optional[logging.Logger]) – Logger object to use for sending debug messages to.

  • only_consider_these_backends (optional[List[str]]) –

    • -

  • context (optional[AbstractDataContext]) – Instance of any child of “AbstractDataContext” class.

    • +

  • context (optional[AbstractDataContext]) – Instance of any child of “AbstractDataContext” class.

    • Returns
    @@ -120,7 +120,7 @@ that do not exist). These errors are added under “errors” key in the report.
    -validate(validator: Validator, configuration: Optional[ExpectationConfiguration] = None, evaluation_parameters: Optional[dict] = None, interactive_evaluation: bool = True, data_context: Optional[AbstractDataContext] = None, runtime_configuration: Optional[dict] = None) → ExpectationValidationResult# +validate(validator: Validator, configuration: Optional[ExpectationConfiguration] = None, evaluation_parameters: Optional[dict] = None, interactive_evaluation: bool = True, data_context: Optional[AbstractDataContext] = None, runtime_configuration: Optional[dict] = None) → ExpectationValidationResult#

    Validates the expectation against the provided data.

    diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/expectation/ColumnMapExpectation_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/expectation/ColumnMapExpectation_class.mdx index a72fa4a60f86..284a92132a0e 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/expectation/ColumnMapExpectation_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/expectation/ColumnMapExpectation_class.mdx @@ -8,7 +8,7 @@ sidebar_label: ColumnMapExpectation
    -class great_expectations.expectations.expectation.ColumnMapExpectation(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None)# +class great_expectations.expectations.expectation.ColumnMapExpectation(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None)#

    Base class for ColumnMapExpectations.

    @@ -43,7 +43,7 @@ kwargs from the Expectation Configuration.

    -get_success_kwargs(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None) → Dict[str, Any]# +get_success_kwargs(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None) → Dict[str, Any]#

    Retrieve the success kwargs.

    @@ -76,7 +76,7 @@ This method is experimental.

    -run_diagnostics(raise_exceptions_for_backends: bool = False, ignore_suppress: bool = False, ignore_only_for: bool = False, for_gallery: bool = False, debug_logger: Optional[logging.Logger] = None, only_consider_these_backends: Optional[List[str]] = None, context: Optional[AbstractDataContext] = None) → ExpectationDiagnostics# +run_diagnostics(raise_exceptions_for_backends: bool = False, ignore_suppress: bool = False, ignore_only_for: bool = False, for_gallery: bool = False, debug_logger: Optional[logging.Logger] = None, only_consider_these_backends: Optional[List[str]] = None, context: Optional[AbstractDataContext] = None) → ExpectationDiagnostics#

    Produce a diagnostic report about this Expectation.

    @@ -103,7 +103,7 @@ that do not exist). These errors are added under “errors” key in the report.

  • for_gallery – Bool object that when True will create empty arrays to use as examples for the Expectation Diagnostics.

  • debug_logger (optional[logging.Logger]) – Logger object to use for sending debug messages to.

  • only_consider_these_backends (optional[List[str]]) –

    • -

  • context (optional[AbstractDataContext]) – Instance of any child of “AbstractDataContext” class.

    • +

  • context (optional[AbstractDataContext]) – Instance of any child of “AbstractDataContext” class.

    • Returns
    @@ -114,7 +114,7 @@ that do not exist). These errors are added under “errors” key in the report.
    -validate(validator: Validator, configuration: Optional[ExpectationConfiguration] = None, evaluation_parameters: Optional[dict] = None, interactive_evaluation: bool = True, data_context: Optional[AbstractDataContext] = None, runtime_configuration: Optional[dict] = None) → ExpectationValidationResult# +validate(validator: Validator, configuration: Optional[ExpectationConfiguration] = None, evaluation_parameters: Optional[dict] = None, interactive_evaluation: bool = True, data_context: Optional[AbstractDataContext] = None, runtime_configuration: Optional[dict] = None) → ExpectationValidationResult#

    Validates the expectation against the provided data.

    diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/expectation/ColumnPairMapExpectation_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/expectation/ColumnPairMapExpectation_class.mdx index 64a335b3ac55..17a9c737644d 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/expectation/ColumnPairMapExpectation_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/expectation/ColumnPairMapExpectation_class.mdx @@ -8,7 +8,7 @@ sidebar_label: ColumnPairMapExpectation
    -class great_expectations.expectations.expectation.ColumnPairMapExpectation(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None)# +class great_expectations.expectations.expectation.ColumnPairMapExpectation(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None)#

    Base class for ColumnPairMapExpectations.

    @@ -43,7 +43,7 @@ kwargs from the Expectation Configuration.

    -get_success_kwargs(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None) → Dict[str, Any]# +get_success_kwargs(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None) → Dict[str, Any]#

    Retrieve the success kwargs.

    @@ -76,7 +76,7 @@ This method is experimental.

    -run_diagnostics(raise_exceptions_for_backends: bool = False, ignore_suppress: bool = False, ignore_only_for: bool = False, for_gallery: bool = False, debug_logger: Optional[logging.Logger] = None, only_consider_these_backends: Optional[List[str]] = None, context: Optional[AbstractDataContext] = None) → ExpectationDiagnostics# +run_diagnostics(raise_exceptions_for_backends: bool = False, ignore_suppress: bool = False, ignore_only_for: bool = False, for_gallery: bool = False, debug_logger: Optional[logging.Logger] = None, only_consider_these_backends: Optional[List[str]] = None, context: Optional[AbstractDataContext] = None) → ExpectationDiagnostics#

    Produce a diagnostic report about this Expectation.

    @@ -103,7 +103,7 @@ that do not exist). These errors are added under “errors” key in the report.

  • for_gallery – Bool object that when True will create empty arrays to use as examples for the Expectation Diagnostics.

  • debug_logger (optional[logging.Logger]) – Logger object to use for sending debug messages to.

  • only_consider_these_backends (optional[List[str]]) –

    • -

  • context (optional[AbstractDataContext]) – Instance of any child of “AbstractDataContext” class.

    • +

  • context (optional[AbstractDataContext]) – Instance of any child of “AbstractDataContext” class.

    • Returns
    @@ -114,7 +114,7 @@ that do not exist). These errors are added under “errors” key in the report.
    -validate(validator: Validator, configuration: Optional[ExpectationConfiguration] = None, evaluation_parameters: Optional[dict] = None, interactive_evaluation: bool = True, data_context: Optional[AbstractDataContext] = None, runtime_configuration: Optional[dict] = None) → ExpectationValidationResult# +validate(validator: Validator, configuration: Optional[ExpectationConfiguration] = None, evaluation_parameters: Optional[dict] = None, interactive_evaluation: bool = True, data_context: Optional[AbstractDataContext] = None, runtime_configuration: Optional[dict] = None) → ExpectationValidationResult#

    Validates the expectation against the provided data.

    diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/expectation/Expectation_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/expectation/Expectation_class.mdx index 6fb813d95381..3430ec1378b9 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/expectation/Expectation_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/expectation/Expectation_class.mdx @@ -8,7 +8,7 @@ sidebar_label: Expectation
    -class great_expectations.expectations.expectation.Expectation(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None)# +class great_expectations.expectations.expectation.Expectation(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None)#

    Base class for all Expectations.

    @@ -55,7 +55,7 @@ will not be usable for the Expectation

    -get_success_kwargs(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None) → Dict[str, Any]# +get_success_kwargs(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None) → Dict[str, Any]#

    Retrieve the success kwargs.

    @@ -88,7 +88,7 @@ This method is experimental.

    -run_diagnostics(raise_exceptions_for_backends: bool = False, ignore_suppress: bool = False, ignore_only_for: bool = False, for_gallery: bool = False, debug_logger: Optional[logging.Logger] = None, only_consider_these_backends: Optional[List[str]] = None, context: Optional[AbstractDataContext] = None) → ExpectationDiagnostics# +run_diagnostics(raise_exceptions_for_backends: bool = False, ignore_suppress: bool = False, ignore_only_for: bool = False, for_gallery: bool = False, debug_logger: Optional[logging.Logger] = None, only_consider_these_backends: Optional[List[str]] = None, context: Optional[AbstractDataContext] = None) → ExpectationDiagnostics#

    Produce a diagnostic report about this Expectation.

    @@ -115,7 +115,7 @@ that do not exist). These errors are added under “errors” key in the report.

  • for_gallery – Bool object that when True will create empty arrays to use as examples for the Expectation Diagnostics.

  • debug_logger (optional[logging.Logger]) – Logger object to use for sending debug messages to.

  • only_consider_these_backends (optional[List[str]]) –

    • -

  • context (optional[AbstractDataContext]) – Instance of any child of “AbstractDataContext” class.

    • +

  • context (optional[AbstractDataContext]) – Instance of any child of “AbstractDataContext” class.

    • Returns
    @@ -126,7 +126,7 @@ that do not exist). These errors are added under “errors” key in the report.
    -validate(validator: Validator, configuration: Optional[ExpectationConfiguration] = None, evaluation_parameters: Optional[dict] = None, interactive_evaluation: bool = True, data_context: Optional[AbstractDataContext] = None, runtime_configuration: Optional[dict] = None) → ExpectationValidationResult# +validate(validator: Validator, configuration: Optional[ExpectationConfiguration] = None, evaluation_parameters: Optional[dict] = None, interactive_evaluation: bool = True, data_context: Optional[AbstractDataContext] = None, runtime_configuration: Optional[dict] = None) → ExpectationValidationResult#

    Validates the expectation against the provided data.

    @@ -152,7 +152,7 @@ immediately evaluating them.

    -validate_configuration(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None) → None# +validate_configuration(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None) → None#

    Validates the configuration for the Expectation.

    diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/expectation/MulticolumnMapExpectation_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/expectation/MulticolumnMapExpectation_class.mdx index ab3028ea2068..80d97ae3c215 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/expectation/MulticolumnMapExpectation_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/expectation/MulticolumnMapExpectation_class.mdx @@ -8,7 +8,7 @@ sidebar_label: MulticolumnMapExpectation
    -class great_expectations.expectations.expectation.MulticolumnMapExpectation(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None)# +class great_expectations.expectations.expectation.MulticolumnMapExpectation(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None)#

    Base class for MulticolumnMapExpectations.

    @@ -44,7 +44,7 @@ kwargs from the Expectation Configuration.

    -get_success_kwargs(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None) → Dict[str, Any]# +get_success_kwargs(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None) → Dict[str, Any]#

    Retrieve the success kwargs.

    @@ -77,7 +77,7 @@ This method is experimental.

    -run_diagnostics(raise_exceptions_for_backends: bool = False, ignore_suppress: bool = False, ignore_only_for: bool = False, for_gallery: bool = False, debug_logger: Optional[logging.Logger] = None, only_consider_these_backends: Optional[List[str]] = None, context: Optional[AbstractDataContext] = None) → ExpectationDiagnostics# +run_diagnostics(raise_exceptions_for_backends: bool = False, ignore_suppress: bool = False, ignore_only_for: bool = False, for_gallery: bool = False, debug_logger: Optional[logging.Logger] = None, only_consider_these_backends: Optional[List[str]] = None, context: Optional[AbstractDataContext] = None) → ExpectationDiagnostics#

    Produce a diagnostic report about this Expectation.

    @@ -104,7 +104,7 @@ that do not exist). These errors are added under “errors” key in the report.

  • for_gallery – Bool object that when True will create empty arrays to use as examples for the Expectation Diagnostics.

  • debug_logger (optional[logging.Logger]) – Logger object to use for sending debug messages to.

  • only_consider_these_backends (optional[List[str]]) –

    • -

  • context (optional[AbstractDataContext]) – Instance of any child of “AbstractDataContext” class.

    • +

  • context (optional[AbstractDataContext]) – Instance of any child of “AbstractDataContext” class.

    • Returns
    @@ -115,7 +115,7 @@ that do not exist). These errors are added under “errors” key in the report.
    -validate(validator: Validator, configuration: Optional[ExpectationConfiguration] = None, evaluation_parameters: Optional[dict] = None, interactive_evaluation: bool = True, data_context: Optional[AbstractDataContext] = None, runtime_configuration: Optional[dict] = None) → ExpectationValidationResult# +validate(validator: Validator, configuration: Optional[ExpectationConfiguration] = None, evaluation_parameters: Optional[dict] = None, interactive_evaluation: bool = True, data_context: Optional[AbstractDataContext] = None, runtime_configuration: Optional[dict] = None) → ExpectationValidationResult#

    Validates the expectation against the provided data.

    diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/expectation/QueryExpectation_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/expectation/QueryExpectation_class.mdx index 0c0e8b8bf8d2..66a63e141c4b 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/expectation/QueryExpectation_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/expectation/QueryExpectation_class.mdx @@ -8,7 +8,7 @@ sidebar_label: QueryExpectation
    -class great_expectations.expectations.expectation.QueryExpectation(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None)# +class great_expectations.expectations.expectation.QueryExpectation(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None)#

    Base class for QueryExpectations.

    @@ -40,7 +40,7 @@ into the QueryExpectation.

    Relevant Documentation Links
    @@ -51,7 +51,7 @@ into the QueryExpectation.

    -get_success_kwargs(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None) → Dict[str, Any]# +get_success_kwargs(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None) → Dict[str, Any]#

    Retrieve the success kwargs.

    @@ -84,7 +84,7 @@ This method is experimental.

    -run_diagnostics(raise_exceptions_for_backends: bool = False, ignore_suppress: bool = False, ignore_only_for: bool = False, for_gallery: bool = False, debug_logger: Optional[logging.Logger] = None, only_consider_these_backends: Optional[List[str]] = None, context: Optional[AbstractDataContext] = None) → ExpectationDiagnostics# +run_diagnostics(raise_exceptions_for_backends: bool = False, ignore_suppress: bool = False, ignore_only_for: bool = False, for_gallery: bool = False, debug_logger: Optional[logging.Logger] = None, only_consider_these_backends: Optional[List[str]] = None, context: Optional[AbstractDataContext] = None) → ExpectationDiagnostics#

    Produce a diagnostic report about this Expectation.

    @@ -111,7 +111,7 @@ that do not exist). These errors are added under “errors” key in the report.

  • for_gallery – Bool object that when True will create empty arrays to use as examples for the Expectation Diagnostics.

  • debug_logger (optional[logging.Logger]) – Logger object to use for sending debug messages to.

  • only_consider_these_backends (optional[List[str]]) –

    • -

  • context (optional[AbstractDataContext]) – Instance of any child of “AbstractDataContext” class.

    • +

  • context (optional[AbstractDataContext]) – Instance of any child of “AbstractDataContext” class.

    • Returns
    @@ -122,7 +122,7 @@ that do not exist). These errors are added under “errors” key in the report.
    -validate(validator: Validator, configuration: Optional[ExpectationConfiguration] = None, evaluation_parameters: Optional[dict] = None, interactive_evaluation: bool = True, data_context: Optional[AbstractDataContext] = None, runtime_configuration: Optional[dict] = None) → ExpectationValidationResult# +validate(validator: Validator, configuration: Optional[ExpectationConfiguration] = None, evaluation_parameters: Optional[dict] = None, interactive_evaluation: bool = True, data_context: Optional[AbstractDataContext] = None, runtime_configuration: Optional[dict] = None) → ExpectationValidationResult#

    Validates the expectation against the provided data.

    diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/expectation/TableExpectation_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/expectation/TableExpectation_class.mdx index 5be6f4b20b52..a58a573069ab 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/expectation/TableExpectation_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/expectation/TableExpectation_class.mdx @@ -8,7 +8,7 @@ sidebar_label: TableExpectation
    -class great_expectations.expectations.expectation.TableExpectation(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None)# +class great_expectations.expectations.expectation.TableExpectation(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None)#

    Base class for TableExpectations.

    @@ -38,7 +38,7 @@ expectation.

    -get_success_kwargs(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None) → Dict[str, Any]# +get_success_kwargs(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None) → Dict[str, Any]#

    Retrieve the success kwargs.

    @@ -71,7 +71,7 @@ This method is experimental.

    -run_diagnostics(raise_exceptions_for_backends: bool = False, ignore_suppress: bool = False, ignore_only_for: bool = False, for_gallery: bool = False, debug_logger: Optional[logging.Logger] = None, only_consider_these_backends: Optional[List[str]] = None, context: Optional[AbstractDataContext] = None) → ExpectationDiagnostics# +run_diagnostics(raise_exceptions_for_backends: bool = False, ignore_suppress: bool = False, ignore_only_for: bool = False, for_gallery: bool = False, debug_logger: Optional[logging.Logger] = None, only_consider_these_backends: Optional[List[str]] = None, context: Optional[AbstractDataContext] = None) → ExpectationDiagnostics#

    Produce a diagnostic report about this Expectation.

    @@ -98,7 +98,7 @@ that do not exist). These errors are added under “errors” key in the report.

  • for_gallery – Bool object that when True will create empty arrays to use as examples for the Expectation Diagnostics.

  • debug_logger (optional[logging.Logger]) – Logger object to use for sending debug messages to.

  • only_consider_these_backends (optional[List[str]]) –

    • -

  • context (optional[AbstractDataContext]) – Instance of any child of “AbstractDataContext” class.

    • +

  • context (optional[AbstractDataContext]) – Instance of any child of “AbstractDataContext” class.

    • Returns
    @@ -109,7 +109,7 @@ that do not exist). These errors are added under “errors” key in the report.
    -validate(validator: Validator, configuration: Optional[ExpectationConfiguration] = None, evaluation_parameters: Optional[dict] = None, interactive_evaluation: bool = True, data_context: Optional[AbstractDataContext] = None, runtime_configuration: Optional[dict] = None) → ExpectationValidationResult# +validate(validator: Validator, configuration: Optional[ExpectationConfiguration] = None, evaluation_parameters: Optional[dict] = None, interactive_evaluation: bool = True, data_context: Optional[AbstractDataContext] = None, runtime_configuration: Optional[dict] = None) → ExpectationValidationResult#

    Validates the expectation against the provided data.

    @@ -135,7 +135,7 @@ immediately evaluating them.

    -validate_configuration(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None) → None# +validate_configuration(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None) → None#

    Validates the configuration for the Expectation.

    diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/metrics/ColumnAggregateMetricProvider_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/metrics/ColumnAggregateMetricProvider_class.mdx index 3fa761e9880d..3d6985673022 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/metrics/ColumnAggregateMetricProvider_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/metrics/ColumnAggregateMetricProvider_class.mdx @@ -31,7 +31,7 @@ have correct values that may simply be inherited by Metric classes.

    -Relevant Documentation Links -
    diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/metrics/ColumnMapMetricProvider_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/metrics/ColumnMapMetricProvider_class.mdx index 83694b432ca2..081edac48272 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/metrics/ColumnMapMetricProvider_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/metrics/ColumnMapMetricProvider_class.mdx @@ -18,7 +18,7 @@ metric is column_values.null (which is implemented as a Colum
    -Relevant Documentation Links -
    diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/metrics/column_aggregate_metric_provider.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/metrics/column_aggregate_metric_provider.mdx index 71ae4fe381b5..c1f872a89c90 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/metrics/column_aggregate_metric_provider.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/metrics/column_aggregate_metric_provider.mdx @@ -31,7 +31,7 @@ have correct values that may simply be inherited by Metric classes.

    -Relevant Documentation Links -
    diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/metrics/map_metric_provider/column_condition_partial.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/metrics/map_metric_provider/column_condition_partial.mdx index 60df912e219b..99777dd0c2c2 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/metrics/map_metric_provider/column_condition_partial.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/metrics/map_metric_provider/column_condition_partial.mdx @@ -8,7 +8,7 @@ sidebar_label: column_condition_partial.py
    -great_expectations.expectations.metrics.map_metric_provider.column_condition_partial.column_condition_partial(engine: Type[great_expectations.execution_engine.execution_engine.ExecutionEngine], partial_fn_type: Optional[great_expectations.core.metric_function_types.MetricPartialFunctionTypes] = None, **kwargs) +great_expectations.expectations.metrics.map_metric_provider.column_condition_partial.column_condition_partial(engine: Type[great_expectations.execution_engine.execution_engine.ExecutionEngine], partial_fn_type: Optional[great_expectations.core.metric_function_types.MetricPartialFunctionTypes] = None, **kwargs)

    Provides engine-specific support for authoring a metric_fn with a simplified signature.

    diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/metrics/map_metric_provider/column_pair_function_partial.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/metrics/map_metric_provider/column_pair_function_partial.mdx index 8e00e1c229f9..7d85c3d42a64 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/metrics/map_metric_provider/column_pair_function_partial.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/metrics/map_metric_provider/column_pair_function_partial.mdx @@ -8,7 +8,7 @@ sidebar_label: column_pair_function_partial.py
    -great_expectations.expectations.metrics.map_metric_provider.column_pair_function_partial.column_pair_function_partial(engine: Type[great_expectations.execution_engine.execution_engine.ExecutionEngine], partial_fn_type: Optional[great_expectations.core.metric_function_types.MetricPartialFunctionTypes] = None, **kwargs) +great_expectations.expectations.metrics.map_metric_provider.column_pair_function_partial.column_pair_function_partial(engine: Type[great_expectations.execution_engine.execution_engine.ExecutionEngine], partial_fn_type: Optional[great_expectations.core.metric_function_types.MetricPartialFunctionTypes] = None, **kwargs)

    Provides engine-specific support for authoring a metric_fn with a simplified signature.

    diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/metrics/metric_provider.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/metrics/metric_provider.mdx index 1d303b8b3f75..878217cebcc8 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/metrics/metric_provider.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/metrics/metric_provider.mdx @@ -46,7 +46,7 @@ have correct implementations that may simply be inherited.

    -great_expectations.expectations.metrics.metric_provider.metric_partial(engine: Type[great_expectations.execution_engine.execution_engine.ExecutionEngine], partial_fn_type: great_expectations.core.metric_function_types.MetricPartialFunctionTypes, domain_type: Union[str, great_expectations.core.metric_domain_types.MetricDomainTypes], **kwargs) → Callable[[Callable[[P], great_expectations.expectations.metrics.metric_provider.T]], Callable[[P], great_expectations.expectations.metrics.metric_provider.T]] +great_expectations.expectations.metrics.metric_provider.metric_partial(engine: Type[great_expectations.execution_engine.execution_engine.ExecutionEngine], partial_fn_type: great_expectations.core.metric_function_types.MetricPartialFunctionTypes, domain_type: Union[str, great_expectations.core.metric_domain_types.MetricDomainTypes], **kwargs) → Callable[[Callable[[P], great_expectations.expectations.metrics.metric_provider.T]], Callable[[P], great_expectations.expectations.metrics.metric_provider.T]]

    Decorator used to register a specific function as a metric partial.

    @@ -58,8 +58,8 @@ ExecutionEngine can execute locally on your data to obtain the metric value.

    -Relevant Documentation Links -
    @@ -79,7 +79,7 @@ ExecutionEngine can execute locally on your data to obtain the metric value.

    -great_expectations.expectations.metrics.metric_provider.metric_value(engine: Type[great_expectations.execution_engine.execution_engine.ExecutionEngine], metric_fn_type: Union[str, great_expectations.core.metric_function_types.MetricFunctionTypes] = MetricFunctionTypes.VALUE, **kwargs) → Callable[[Callable[[P], great_expectations.expectations.metrics.metric_provider.T]], Callable[[P], great_expectations.expectations.metrics.metric_provider.T]] +great_expectations.expectations.metrics.metric_provider.metric_value(engine: Type[great_expectations.execution_engine.execution_engine.ExecutionEngine], metric_fn_type: Union[str, great_expectations.core.metric_function_types.MetricFunctionTypes] = MetricFunctionTypes.VALUE, **kwargs) → Callable[[Callable[[P], great_expectations.expectations.metrics.metric_provider.T]], Callable[[P], great_expectations.expectations.metrics.metric_provider.T]]

    Decorator used to register a specific function as a metric value function.

    @@ -89,7 +89,7 @@ the value of the requested metric.

    -Relevant Documentation Links -
    diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/metrics/query_metric_provider/QueryMetricProvider_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/metrics/query_metric_provider/QueryMetricProvider_class.mdx index d095d7794439..abd1b7c66d7f 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/metrics/query_metric_provider/QueryMetricProvider_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/metrics/query_metric_provider/QueryMetricProvider_class.mdx @@ -19,7 +19,7 @@ sidebar_label: QueryMetricProvider
    -Relevant Documentation Links-
    diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/metrics/table_metric_provider/TableMetricProvider_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/metrics/table_metric_provider/TableMetricProvider_class.mdx index 52aaea4f5926..5dbb9419c88a 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/metrics/table_metric_provider/TableMetricProvider_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/metrics/table_metric_provider/TableMetricProvider_class.mdx @@ -29,7 +29,7 @@ have correct values that may simply be inherited by Metric classes.

    -Relevant Documentation Links-
    diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/regex_based_column_map_expectation/RegexBasedColumnMapExpectation_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/regex_based_column_map_expectation/RegexBasedColumnMapExpectation_class.mdx index ac3ad7b8c4f7..4d1b348bc6ca 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/regex_based_column_map_expectation/RegexBasedColumnMapExpectation_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/regex_based_column_map_expectation/RegexBasedColumnMapExpectation_class.mdx @@ -9,7 +9,7 @@ import CodeBlock from "@theme/CodeBlock";
    -class great_expectations.expectations.regex_based_column_map_expectation.RegexBasedColumnMapExpectation(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None)# +class great_expectations.expectations.regex_based_column_map_expectation.RegexBasedColumnMapExpectation(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None)#

    Base class for RegexBasedColumnMapExpectations.

    @@ -40,7 +40,7 @@ import CodeBlock from "@theme/CodeBlock";
    -get_success_kwargs(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None) → Dict[str, Any]# +get_success_kwargs(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None) → Dict[str, Any]#

    Retrieve the success kwargs.

    @@ -73,7 +73,7 @@ This method is experimental.

    -run_diagnostics(raise_exceptions_for_backends: bool = False, ignore_suppress: bool = False, ignore_only_for: bool = False, for_gallery: bool = False, debug_logger: Optional[logging.Logger] = None, only_consider_these_backends: Optional[List[str]] = None, context: Optional[AbstractDataContext] = None) → ExpectationDiagnostics# +run_diagnostics(raise_exceptions_for_backends: bool = False, ignore_suppress: bool = False, ignore_only_for: bool = False, for_gallery: bool = False, debug_logger: Optional[logging.Logger] = None, only_consider_these_backends: Optional[List[str]] = None, context: Optional[AbstractDataContext] = None) → ExpectationDiagnostics#

    Produce a diagnostic report about this Expectation.

    @@ -100,7 +100,7 @@ that do not exist). These errors are added under "errors" key in the report.

  • for_gallery – Bool object that when True will create empty arrays to use as examples for the Expectation Diagnostics.

  • debug_logger (optional[logging.Logger]) – Logger object to use for sending debug messages to.

  • only_consider_these_backends (optional[List[str]]) –

    • -

  • context (optional[AbstractDataContext]) – Instance of any child of "AbstractDataContext" class.

    • +

  • context (optional[AbstractDataContext]) – Instance of any child of "AbstractDataContext" class.

    • Returns
    @@ -111,7 +111,7 @@ that do not exist). These errors are added under "errors" key in the report.

    -validate(validator: Validator, configuration: Optional[ExpectationConfiguration] = None, evaluation_parameters: Optional[dict] = None, interactive_evaluation: bool = True, data_context: Optional[AbstractDataContext] = None, runtime_configuration: Optional[dict] = None) → ExpectationValidationResult# +validate(validator: Validator, configuration: Optional[ExpectationConfiguration] = None, evaluation_parameters: Optional[dict] = None, interactive_evaluation: bool = True, data_context: Optional[AbstractDataContext] = None, runtime_configuration: Optional[dict] = None) → ExpectationValidationResult#

    Validates the expectation against the provided data.

    @@ -137,7 +137,7 @@ immediately evaluating them.

    -validate_configuration(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None) → None# +validate_configuration(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None) → None#

    Raise an exception if the configuration is not viable for an expectation.

    diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/regex_based_column_map_expectation/RegexColumnMapMetricProvider_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/regex_based_column_map_expectation/RegexColumnMapMetricProvider_class.mdx index 72230b0c0406..9ee440e68eb9 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/regex_based_column_map_expectation/RegexColumnMapMetricProvider_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/regex_based_column_map_expectation/RegexColumnMapMetricProvider_class.mdx @@ -35,7 +35,7 @@ Constructed by the register_metric(…) function during Expectation
    -Relevant Documentation Links-
    diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/registry.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/registry.mdx index e2f122d1076e..66e0b23dfcdb 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/registry.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/registry.mdx @@ -8,7 +8,7 @@ sidebar_label: registry.py
    -great_expectations.expectations.registry.register_metric(metric_name: str, metric_domain_keys: Tuple[str, ...], metric_value_keys: Tuple[str, ...], execution_engine: Type[ExecutionEngine], metric_class: Type[MetricProvider], metric_provider: Optional[Callable], metric_fn_type: Optional[Union[MetricFunctionTypes, MetricPartialFunctionTypes]] = None) → dict +great_expectations.expectations.registry.register_metric(metric_name: str, metric_domain_keys: Tuple[str, ...], metric_value_keys: Tuple[str, ...], execution_engine: Type[ExecutionEngine], metric_class: Type[MetricProvider], metric_provider: Optional[Callable], metric_fn_type: Optional[Union[MetricFunctionTypes, MetricPartialFunctionTypes]] = None) → dict

    Register a Metric class for use as a callable metric within Expectations.

    diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/set_based_column_map_expectation/SetBasedColumnMapExpectation_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/set_based_column_map_expectation/SetBasedColumnMapExpectation_class.mdx index 2d5e31bef11c..cf285473a6db 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/set_based_column_map_expectation/SetBasedColumnMapExpectation_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/expectations/set_based_column_map_expectation/SetBasedColumnMapExpectation_class.mdx @@ -8,7 +8,7 @@ import CodeBlock from '@theme/CodeBlock';
    -class great_expectations.expectations.set_based_column_map_expectation.SetBasedColumnMapExpectation(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None)# +class great_expectations.expectations.set_based_column_map_expectation.SetBasedColumnMapExpectation(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None)#

    Base class for SetBasedColumnMapExpectations.

    @@ -35,7 +35,7 @@ import CodeBlock from '@theme/CodeBlock';
    -Relevant Documentation Links-
    @@ -46,7 +46,7 @@ import CodeBlock from '@theme/CodeBlock';
    -get_success_kwargs(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None) → Dict[str, Any]# +get_success_kwargs(configuration: Optional[great_expectations.core.expectation_configuration.ExpectationConfiguration] = None) → Dict[str, Any]#

    Retrieve the success kwargs.

    @@ -79,7 +79,7 @@ This method is experimental.

    -run_diagnostics(raise_exceptions_for_backends: bool = False, ignore_suppress: bool = False, ignore_only_for: bool = False, for_gallery: bool = False, debug_logger: Optional[logging.Logger] = None, only_consider_these_backends: Optional[List[str]] = None, context: Optional[AbstractDataContext] = None) → ExpectationDiagnostics# +run_diagnostics(raise_exceptions_for_backends: bool = False, ignore_suppress: bool = False, ignore_only_for: bool = False, for_gallery: bool = False, debug_logger: Optional[logging.Logger] = None, only_consider_these_backends: Optional[List[str]] = None, context: Optional[AbstractDataContext] = None) → ExpectationDiagnostics#

    Produce a diagnostic report about this Expectation.

    @@ -106,7 +106,7 @@ that do not exist). These errors are added under "errors" key in the report.

  • for_gallery – Bool object that when True will create empty arrays to use as examples for the Expectation Diagnostics.

  • debug_logger (optional[logging.Logger]) – Logger object to use for sending debug messages to.

  • only_consider_these_backends (optional[List[str]]) –

    • -

  • context (optional[AbstractDataContext]) – Instance of any child of "AbstractDataContext" class.

    • +

  • context (optional[AbstractDataContext]) – Instance of any child of "AbstractDataContext" class.

    • Returns
    @@ -117,7 +117,7 @@ that do not exist). These errors are added under "errors" key in the report.

    -validate(validator: Validator, configuration: Optional[ExpectationConfiguration] = None, evaluation_parameters: Optional[dict] = None, interactive_evaluation: bool = True, data_context: Optional[AbstractDataContext] = None, runtime_configuration: Optional[dict] = None) → ExpectationValidationResult# +validate(validator: Validator, configuration: Optional[ExpectationConfiguration] = None, evaluation_parameters: Optional[dict] = None, interactive_evaluation: bool = True, data_context: Optional[AbstractDataContext] = None, runtime_configuration: Optional[dict] = None) → ExpectationValidationResult#

    Validates the expectation against the provided data.

    diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/experimental/datasource/FabricPowerBIDatasource_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/experimental/datasource/FabricPowerBIDatasource_class.mdx index 3790beae254f..d89016d2c925 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/experimental/datasource/FabricPowerBIDatasource_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/experimental/datasource/FabricPowerBIDatasource_class.mdx @@ -8,14 +8,14 @@ sidebar_label: FabricPowerBIDatasource
    -class great_expectations.experimental.datasource.FabricPowerBIDatasource(*, type: Literal['fabric_powerbi'] = 'fabric_powerbi', name: str, id: Optional[uuid.UUID] = None, assets: List[Union[great_expectations.experimental.datasource.fabric.PowerBITable, great_expectations.experimental.datasource.fabric.PowerBIMeasure, great_expectations.experimental.datasource.fabric.PowerBIDax]] = [], workspace: Optional[Union[uuid.UUID, str]] = None, dataset: Union[uuid.UUID, str])# +class great_expectations.experimental.datasource.FabricPowerBIDatasource(*, type: Literal['fabric_powerbi'] = 'fabric_powerbi', name: str, id: Optional[uuid.UUID] = None, assets: List[Union[great_expectations.experimental.datasource.fabric.PowerBITable, great_expectations.experimental.datasource.fabric.PowerBIMeasure, great_expectations.experimental.datasource.fabric.PowerBIDax]] = [], workspace: Optional[Union[uuid.UUID, str]] = None, dataset: Union[uuid.UUID, str])#

    Microsoft Fabric Datasource.

    Semantic-Link

    -add_powerbi_dax_asset(name: str, dax_string: str, order_by: Optional[SortersDefinition] = None, batch_metadata: Optional[BatchMetadata] = None) → PowerBIDax# +add_powerbi_dax_asset(name: str, dax_string: str, order_by: Optional[SortersDefinition] = None, batch_metadata: Optional[BatchMetadata] = None) → PowerBIDax#

    Adds a PowerBIDax asset to this datasource.

    @@ -36,7 +36,7 @@ sidebar_label: FabricPowerBIDatasource
    -add_powerbi_measure_asset(name: str, measure: Union[str, List[str]], order_by: Optional[SortersDefinition] = None, batch_metadata: Optional[BatchMetadata] = None, groupby_columns: Optional[List[str]] = None, filters: Optional[Dict[str, List[str]]] = None, fully_qualified_columns: Optional[bool] = None, num_rows: Optional[int] = None, use_xmla: bool = False) → PowerBIMeasure# +add_powerbi_measure_asset(name: str, measure: Union[str, List[str]], order_by: Optional[SortersDefinition] = None, batch_metadata: Optional[BatchMetadata] = None, groupby_columns: Optional[List[str]] = None, filters: Optional[Dict[str, List[str]]] = None, fully_qualified_columns: Optional[bool] = None, num_rows: Optional[int] = None, use_xmla: bool = False) → PowerBIMeasure#

    Adds a PowerBIMeasure asset to this datasource.

    @@ -56,7 +56,7 @@ sidebar_label: FabricPowerBIDatasource
    -add_powerbi_table_asset(name: str, table: str, order_by: Optional[SortersDefinition] = None, batch_metadata: Optional[BatchMetadata] = None, fully_qualified_columns: bool = False, num_rows: Optional[int] = None, multiindex_hierarchies: bool = False, mode: Mode = 'xmla') → PowerBITable# +add_powerbi_table_asset(name: str, table: str, order_by: Optional[SortersDefinition] = None, batch_metadata: Optional[BatchMetadata] = None, fully_qualified_columns: bool = False, num_rows: Optional[int] = None, multiindex_hierarchies: bool = False, mode: Mode = 'xmla') → PowerBITable#

    Adds a PowerBITable asset to this datasource.

    diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/profile/user_configurable_profiler/UserConfigurableProfiler_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/profile/user_configurable_profiler/UserConfigurableProfiler_class.mdx index dea6ea42f812..493929e65cf9 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/profile/user_configurable_profiler/UserConfigurableProfiler_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/profile/user_configurable_profiler/UserConfigurableProfiler_class.mdx @@ -8,7 +8,7 @@ import CodeBlock from '@theme/CodeBlock';
    -class great_expectations.profile.user_configurable_profiler.UserConfigurableProfiler(profile_dataset: Union[great_expectations.core.batch.Batch, great_expectations.dataset.dataset.Dataset, great_expectations.validator.validator.Validator], excluded_expectations: Optional[List[str]] = None, ignored_columns: Optional[List[str]] = None, not_null_only: bool = False, primary_or_compound_key: Optional[List[str]] = None, semantic_types_dict: Optional[Dict[str, List[str]]] = None, table_expectations_only: bool = False, value_set_threshold: str = 'MANY')# +class great_expectations.profile.user_configurable_profiler.UserConfigurableProfiler(profile_dataset: Union[great_expectations.core.batch.Batch, great_expectations.dataset.dataset.Dataset, great_expectations.validator.validator.Validator], excluded_expectations: Optional[List[str]] = None, ignored_columns: Optional[List[str]] = None, not_null_only: bool = False, primary_or_compound_key: Optional[List[str]] = None, semantic_types_dict: Optional[Dict[str, List[str]]] = None, table_expectations_only: bool = False, value_set_threshold: str = 'MANY')#

    Build an Expectation Suite from a dataset.

    @@ -76,7 +76,7 @@ comparing whether two tables are identical, it might make the most sense to set
    -build_suite() → great_expectations.core.expectation_suite.ExpectationSuite# +build_suite() → great_expectations.core.expectation_suite.ExpectationSuite#

    Build an Expectation Suite based on the semantic_types_dict if one is provided.

    diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/rule_based_profiler/RuleBasedProfilerResult_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/rule_based_profiler/RuleBasedProfilerResult_class.mdx index cab58e61e4a8..acd41b0d9622 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/rule_based_profiler/RuleBasedProfilerResult_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/rule_based_profiler/RuleBasedProfilerResult_class.mdx @@ -8,7 +8,7 @@ sidebar_label: RuleBasedProfilerResult
    -class great_expectations.rule_based_profiler.RuleBasedProfilerResult(fully_qualified_parameter_names_by_domain: Dict[great_expectations.core.domain.Domain, List[str]], parameter_values_for_fully_qualified_parameter_names_by_domain: Optional[Dict[great_expectations.core.domain.Domain, Dict[str, great_expectations.rule_based_profiler.parameter_container.ParameterNode]]], expectation_configurations: List[great_expectations.core.expectation_configuration.ExpectationConfiguration], citation: dict, rule_domain_builder_execution_time: Dict[str, float], rule_execution_time: Dict[str, float], rule_exception_tracebacks: Dict[str, Optional[str]], catch_exceptions: bool = False, _usage_statistics_handler: Optional[great_expectations.core.usage_statistics.usage_statistics.UsageStatisticsHandler] = None)# +class great_expectations.rule_based_profiler.RuleBasedProfilerResult(fully_qualified_parameter_names_by_domain: Dict[great_expectations.core.domain.Domain, List[str]], parameter_values_for_fully_qualified_parameter_names_by_domain: Optional[Dict[great_expectations.core.domain.Domain, Dict[str, great_expectations.rule_based_profiler.parameter_container.ParameterNode]]], expectation_configurations: List[great_expectations.core.expectation_configuration.ExpectationConfiguration], citation: dict, rule_domain_builder_execution_time: Dict[str, float], rule_execution_time: Dict[str, float], rule_exception_tracebacks: Dict[str, Optional[str]], catch_exceptions: bool = False, _usage_statistics_handler: Optional[great_expectations.core.usage_statistics.usage_statistics.UsageStatisticsHandler] = None)#

    RuleBasedProfilerResult is an immutable dataclass object which holds the results of executing the RuleBasedProfiler.run() method.

    @@ -21,13 +21,13 @@ sidebar_label: RuleBasedProfilerResult

  • expectation_configurations – List of ExpectationConfiguration objects.

  • citation – dict of citations.

  • catch_exceptions (boolean) – Defaults to False. -If True, then catch exceptions and include them as part of the result object. For more detail, see [catch_exceptions](Standard Arguments).

    • +If True, then catch exceptions and include them as part of the result object. For more detail, see [catch_exceptions](Standard Arguments).

    -get_expectation_suite(expectation_suite_name: str) → great_expectations.core.expectation_suite.ExpectationSuite# +get_expectation_suite(expectation_suite_name: str) → great_expectations.core.expectation_suite.ExpectationSuite#

    Retrieve the ExpectationSuite generated during the RuleBasedProfiler run.

    diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/rule_based_profiler/data_assistant_result/DataAssistantResult_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/rule_based_profiler/data_assistant_result/DataAssistantResult_class.mdx index 84ee1b73b5f3..bf5c7ce6e6d6 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/rule_based_profiler/data_assistant_result/DataAssistantResult_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/rule_based_profiler/data_assistant_result/DataAssistantResult_class.mdx @@ -7,7 +7,7 @@ sidebar_label: DataAssistantResult
    -class great_expectations.rule_based_profiler.data_assistant_result.DataAssistantResult(_batch_id_to_batch_identifier_display_name_map: Optional[Dict[str, Set[tuple[str, Any]]]] = None, profiler_config: Optional[RuleBasedProfilerConfig] = None, profiler_execution_time: Optional[float] = None, rule_domain_builder_execution_time: Optional[Dict[str, float]] = None, rule_execution_time: Optional[Dict[str, float]] = None, rule_exception_tracebacks: Optional[Dict[str, Optional[str]]] = None, metrics_by_domain: Optional[Dict[Domain, Dict[str, ParameterNode]]] = None, expectation_configurations: Optional[List[ExpectationConfiguration]] = None, citation: Optional[dict] = None, _usage_statistics_handler: Optional[UsageStatisticsHandler] = None)# +class great_expectations.rule_based_profiler.data_assistant_result.DataAssistantResult(_batch_id_to_batch_identifier_display_name_map: Optional[Dict[str, Set[tuple[str, Any]]]] = None, profiler_config: Optional[RuleBasedProfilerConfig] = None, profiler_execution_time: Optional[float] = None, rule_domain_builder_execution_time: Optional[Dict[str, float]] = None, rule_execution_time: Optional[Dict[str, float]] = None, rule_exception_tracebacks: Optional[Dict[str, Optional[str]]] = None, metrics_by_domain: Optional[Dict[Domain, Dict[str, ParameterNode]]] = None, expectation_configurations: Optional[List[ExpectationConfiguration]] = None, citation: Optional[dict] = None, _usage_statistics_handler: Optional[UsageStatisticsHandler] = None)#

    Result from a Data Assistant run, plus plotting functionality.

    @@ -28,7 +28,7 @@ sidebar_label: DataAssistantResult
    -get_expectation_suite(expectation_suite_name: Optional[str] = None, include_profiler_config: bool = False, send_usage_event: bool = True) → ExpectationSuite# +get_expectation_suite(expectation_suite_name: Optional[str] = None, include_profiler_config: bool = False, send_usage_event: bool = True) → ExpectationSuite#

    Get Expectation Suite from “DataAssistantResult” object.

    diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/api/validator/validator/Validator_class.mdx b/docs/docusaurus/versioned_docs/version-0.18/reference/api/validator/validator/Validator_class.mdx index fe0e94876ca7..b2184b77f8c5 100644 --- a/docs/docusaurus/versioned_docs/version-0.18/reference/api/validator/validator/Validator_class.mdx +++ b/docs/docusaurus/versioned_docs/version-0.18/reference/api/validator/validator/Validator_class.mdx @@ -7,7 +7,7 @@ sidebar_label: Validator
    -class great_expectations.validator.validator.Validator(execution_engine: ExecutionEngine, interactive_evaluation: bool = True, expectation_suite: ExpectationSuite | None = None, expectation_suite_name: Optional[str] = None, data_context: Optional[AbstractDataContext] = None, batches: List[Batch] | Sequence[Batch | FluentBatch] = (), include_rendered_content: Optional[bool] = None, **kwargs)# +class great_expectations.validator.validator.Validator(execution_engine: ExecutionEngine, interactive_evaluation: bool = True, expectation_suite: ExpectationSuite | None = None, expectation_suite_name: Optional[str] = None, data_context: Optional[AbstractDataContext] = None, batches: List[Batch] | Sequence[Batch | FluentBatch] = (), include_rendered_content: Optional[bool] = None, **kwargs)#

    Validator is the key object used to create Expectations, validate Expectations, and get Metrics for Expectations.

    @@ -44,7 +44,7 @@ sidebar_label: Validator
    -get_expectation_suite(discard_failed_expectations: bool = True, discard_result_format_kwargs: bool = True, discard_include_config_kwargs: bool = True, discard_catch_exceptions_kwargs: bool = True, suppress_warnings: bool = False, suppress_logging: bool = False) → great_expectations.core.expectation_suite.ExpectationSuite# +get_expectation_suite(discard_failed_expectations: bool = True, discard_result_format_kwargs: bool = True, discard_include_config_kwargs: bool = True, discard_catch_exceptions_kwargs: bool = True, suppress_warnings: bool = False, suppress_logging: bool = False) → great_expectations.core.expectation_suite.ExpectationSuite#

    Get a copy of the Expectation Suite from the Validator object.

    @@ -67,7 +67,7 @@ sidebar_label: Validator
    -get_metric(metric: MetricConfiguration) → Any# +get_metric(metric: MetricConfiguration) → Any#

    Convenience method, return the value of the requested metric.

    @@ -104,7 +104,7 @@ sidebar_label: Validator
    -remove_expectation(expectation_configuration: great_expectations.core.expectation_configuration.ExpectationConfiguration, match_type: str = 'domain', remove_multiple_matches: bool = False, ge_cloud_id: Optional[str] = None) → List[great_expectations.core.expectation_configuration.ExpectationConfiguration]# +remove_expectation(expectation_configuration: great_expectations.core.expectation_configuration.ExpectationConfiguration, match_type: str = 'domain', remove_multiple_matches: bool = False, ge_cloud_id: Optional[str] = None) → List[great_expectations.core.expectation_configuration.ExpectationConfiguration]#

    Remove an ExpectationConfiguration from the ExpectationSuite associated with the Validator.

    @@ -159,7 +159,7 @@ sidebar_label: Validator
    -validate(expectation_suite: Optional[Union[str, great_expectations.core.expectation_suite.ExpectationSuite]] = None, run_id: Optional[Union[str, great_expectations.core.run_identifier.RunIdentifier, Dict[str, str]]] = None, data_context: Optional[Any] = None, evaluation_parameters: Optional[dict] = None, catch_exceptions: bool = True, result_format: Optional[str] = None, only_return_failures: bool = False, run_name: Optional[str] = None, run_time: Optional[str] = None, checkpoint_name: Optional[str] = None) → Union[great_expectations.core.expectation_validation_result.ExpectationValidationResult, great_expectations.core.expectation_validation_result.ExpectationSuiteValidationResult]# +validate(expectation_suite: Optional[Union[str, great_expectations.core.expectation_suite.ExpectationSuite]] = None, run_id: Optional[Union[str, great_expectations.core.run_identifier.RunIdentifier, Dict[str, str]]] = None, data_context: Optional[Any] = None, evaluation_parameters: Optional[dict] = None, catch_exceptions: bool = True, result_format: Optional[str] = None, only_return_failures: bool = False, run_name: Optional[str] = None, run_time: Optional[str] = None, checkpoint_name: Optional[str] = None) → Union[great_expectations.core.expectation_validation_result.ExpectationValidationResult, great_expectations.core.expectation_validation_result.ExpectationSuiteValidationResult]#

    Run all expectations and return the outcome of the run.