Skip to content

Commit

Permalink
Merge develop into maintenance/DX-469/DX-470/alexsherstinsky/link/ass…
Browse files Browse the repository at this point in the history
…ess_checkpoint_operation_with_fluent_datasource_batch_request-2023_04_20-5
  • Loading branch information
github-actions[bot] committed Apr 20, 2023
2 parents 58f1acc + 2070428 commit 4f59fc5
Show file tree
Hide file tree
Showing 33 changed files with 132 additions and 0 deletions.
5 changes: 5 additions & 0 deletions docs/docusaurus/docs/components/warnings/_in_progress.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
:::caution In progress

The fluent datasources and yaml configuration are not working as expected. A new method for connecting to data sources will be added to this document soon. In the meantime, use the [Great Expectations Slack channel](https://greatexpectations.io/slack) if you encounter issues and need assistance.

:::
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ title: How to Use Great Expectations in AWS Glue
import Prerequisites from './components/deployment_pattern_prerequisites.jsx'
import Congratulations from '../guides/connecting_to_your_data/components/congratulations.md'

import InProgress from '/docs/components/warnings/_in_progress.md'

<InProgress />

This Guide demonstrates how to set up, initialize and run validations against your data on AWS Glue Spark Job.
We will cover case with RuntimeDataConnector and use S3 as metadata store.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import Congratulations from '../guides/connecting_to_your_data/components/congratulations.md'
import TechnicalTag from '@site/docs/term_tags/_tag.mdx';
import InProgress from '/docs/components/warnings/_in_progress.md'

<InProgress />

Great Expectations works well with many types of Databricks workflows. This guide will help you run Great Expectations in [Databricks](https://databricks.com/).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ title: How to use Great Expectations in Deepnote
import Prerequisites from './components/deployment_pattern_prerequisites.jsx'
import TechnicalTag from '@site/docs/term_tags/_tag.mdx';

import InProgress from '/docs/components/warnings/_in_progress.md'

<InProgress />

_This piece of documentation was authored by [Allan Campopiano](https://www.linkedin.com/in/allan-campopiano-703394120)._

This guide will help you get started with Great Expectations on Deepnote. You will learn how to validate columns in a Pandas DataFrame,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ title: How to Use Great Expectations in EMR Serverless
import Prerequisites from './components/deployment_pattern_prerequisites.jsx'
import Congratulations from '../guides/connecting_to_your_data/components/congratulations.md'

import InProgress from '/docs/components/warnings/_in_progress.md'

<InProgress />

This Guide demonstrates how to set up, initialize and run validations against your data on AWS EMR Serverless.
We will cover case with RuntimeDataConnector and use S3 as metadata store.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ import TabItem from '@theme/TabItem';
import Congratulations from '../guides/connecting_to_your_data/components/congratulations.md'
import TechnicalTag from '@site/docs/term_tags/_tag.mdx';

import InProgress from '/docs/components/warnings/_in_progress.md'

<InProgress />

This guide will help you integrate Great Expectations (GX) with [Google Cloud Platform](https://cloud.google.com/gcp) (GCP) using our recommended workflow.

<Prerequisites>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ title: How to Use Great Expectations with Meltano
---
import Prerequisites from './components/deployment_pattern_prerequisites.jsx'

import InProgress from '/docs/components/warnings/_in_progress.md'

<InProgress />

This guide will help you get Great Expectations installed, configured, and running in your Meltano project.

[Meltano](https://meltano.com/) is an Open Source DataOps OS that's used to install and configure data applications (Great Expectations, Singer, dbt, Airflow, etc.) that your team's data platform is built on top of, all in one central repository.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ title: How to Use Great Expectations with Prefect

import Prerequisites from './components/deployment_pattern_prerequisites.jsx'

import InProgress from '/docs/components/warnings/_in_progress.md'

<InProgress />

This guide will help you run a Great Expectations with [Prefect](https://prefect.io/)

<Prerequisites>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ title: How to Use Great Expectations with YData-Synthetic
import Prerequisites from './components/deployment_pattern_prerequisites.jsx'
import TechnicalTag from '@site/docs/term_tags/_tag.mdx';

import InProgress from '/docs/components/warnings/_in_progress.md'

<InProgress />

_This piece of documentation was authored by [Arunn Thevapalan](https://www.linkedin.com/in/arunn-thevapalan/)._

[YData-Synthetic](https://github.com/ydataai/ydata-synthetic) is an open-source synthetic data engine. Using different kinds of Generative Adversarial Networks (GANS), the engine learns patterns and statistical properties of original data. It can create endless samples of synthetic data that resemble the original data.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ import TabItem from '@theme/TabItem';
import Congratulations from './components/_congratulations_aws_athena.md'
import TechnicalTag from '@site/docs/term_tags/_tag.mdx';

import InProgress from '/docs/components/warnings/_in_progress.md'

<InProgress />

<!-- Part 1: Setup -->

<!-- 1.1 Ensure that the AWS CLI is ready for use -->
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,10 @@ import InstantiateDataContext from '@site/docs/guides/connecting_to_your_data/cl

<!-- 2.3 Configure your Datasource -->

import InProgress from '/docs/components/warnings/_in_progress.md'

<InProgress />

import ConfigureYourDatasource from '@site/docs/guides/connecting_to_your_data/cloud/s3/components_pandas/_configure_your_datasource.mdx'

<!-- 2.4 Save the Datasource configuration to your DataContext -->
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ import TabItem from '@theme/TabItem';
import Congratulations from './components/_congratulations_aws_redshift.md'
import TechnicalTag from '@site/docs/term_tags/_tag.mdx';

import InProgress from '/docs/components/warnings/_in_progress.md'

<InProgress />

<!-- Part 1: Setup -->

<!-- 1.1 Ensure that the AWS CLI is ready for use -->
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ import TabItem from '@theme/TabItem';
import Congratulations from './components/_congratulations_aws_s3_spark.md'
import TechnicalTag from '@site/docs/term_tags/_tag.mdx';

import InProgress from '/docs/components/warnings/_in_progress.md'

<InProgress />

<!-- Part 1: Setup -->

<!-- 1.1 Ensure that the AWS CLI is ready for use -->
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@ import TechnicalTag from '@site/docs/term_tags/_tag.mdx';

<!-- Only keep one of the 'To best understand this document' lines. For processes like the Universal Map steps, use the first one. For processes like the Architecture Reviews, use the second one. -->

import InProgress from '/docs/components/warnings/_in_progress.md'

<InProgress />

:::note Prerequisites
- Completing the [Quickstart guide](tutorials/quickstart/quickstart.md) is recommended.
:::
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ import TechnicalTag from '@site/docs/term_tags/_tag.mdx';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

import InProgress from '/docs/components/warnings/_in_progress.md'

<InProgress />

In this guide, you will utilize a <TechnicalTag tag="profiler" text="UserConfigurableProfiler" /> to create an <TechnicalTag tag="expectation_suite" text="Expectation Suite" /> that can be used to gauge whether two tables are identical. This workflow can be used, for example, to validate migrated data.

<Prerequisites>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ title: How to create a new Expectation Suite by profiling from a jsonschema file
import Prerequisites from '../../connecting_to_your_data/components/prerequisites.jsx'
import TechnicalTag from '@site/docs/term_tags/_tag.mdx';

import InProgress from '/docs/components/warnings/_in_progress.md'

<InProgress />

The ``JsonSchemaProfiler`` helps you quickly create <TechnicalTag tag="expectation_suite" text="Expectation Suites" /> from jsonschema files.

<Prerequisites>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ title: How to create a new Expectation Suite using Rule Based Profilers
import Prerequisites from '../../../guides/connecting_to_your_data/components/prerequisites.jsx';
import TechnicalTag from '@site/docs/term_tags/_tag.mdx';

import InProgress from '/docs/components/warnings/_in_progress.md'

<InProgress />

In this tutorial, you will develop hands-on experience with configuring a Rule-Based <TechnicalTag tag="profiler" text="Profiler" /> to create an <TechnicalTag tag="expectation_suite" text="Expectation Suite" />. You will <TechnicalTag tag="profiling" text="Profile" /> several <TechnicalTag tag="batch" text="Batches" /> of NYC yellow taxi trip data to come up with reasonable estimates for the ranges of <TechnicalTag tag="expectation" text="Expectations" /> for several numeric columns.

:::warning
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ title: How to create Expectations that span multiple Batches using Evaluation Pa
import Prerequisites from '../../../guides/connecting_to_your_data/components/prerequisites.jsx';
import TechnicalTag from '@site/docs/term_tags/_tag.mdx';

import InProgress from '/docs/components/warnings/_in_progress.md'

<InProgress />

This guide will help you create <TechnicalTag tag="expectation" text="Expectations" /> that span multiple <TechnicalTag tag="batch" text="Batches" /> of data using <TechnicalTag tag="evaluation_parameter" text="Evaluation Parameters" /> (see also <TechnicalTag tag="evaluation_parameter_store" text="Evaluation Parameter Stores" />). This pattern is useful for things like verifying that row counts between tables stay consistent.

<Prerequisites>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ title: How to dynamically load evaluation parameters from a database
import Prerequisites from '../../connecting_to_your_data/components/prerequisites.jsx'
import TechnicalTag from '@site/docs/term_tags/_tag.mdx';

import InProgress from '/docs/components/warnings/_in_progress.md'

<InProgress />

This guide will help you create an <TechnicalTag tag="expectation" text="Expectation" /> that loads part of its Expectation configuration from a database at runtime. Using a dynamic <TechnicalTag tag="evaluation_parameter" text="Evaluation Parameter" /> makes it possible to maintain part of an <TechnicalTag tag="expectation_suite" text="Expectation Suite" /> in a shared database.

<Prerequisites>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ title: How to create an Expectation Suite with the Onboarding Data Assistant
import Prerequisites from '../../../guides/connecting_to_your_data/components/prerequisites.jsx'
import TechnicalTag from '@site/docs/term_tags/_tag.mdx';

import InProgress from '/docs/components/warnings/_in_progress.md'

<InProgress />

This guide demonstrates how to use the Onboarding Data Assistant to Profile your data and automate the generation of an
Expectation Suite, which you can then adjust to be suited for your specific needs.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ title: How to create and edit Expectations with the User Configurable Profiler
import Prerequisites from '../../guides/connecting_to_your_data/components/prerequisites.jsx'
import TechnicalTag from '@site/docs/term_tags/_tag.mdx';

import InProgress from '/docs/components/warnings/_in_progress.md'

<InProgress />

This guide will help you create a new <TechnicalTag tag="expectation_suite" text="Expectation Suite" /> by profiling your data with the User Configurable <TechnicalTag tag="profiler" text="Profiler" />.

<Prerequisites>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ import IfYouStillNeedToSetupGX from '/docs/components/prerequisites/_if_you_stil
import DataContextInitializeQuickOrFilesystem from '/docs/components/setup/link_lists/_data_context_initialize_quick_or_filesystem.mdx'
import ConnectingToDataFluently from '/docs/components/connect_to_data/link_lists/_connecting_to_data_fluently.md'

import InProgress from '/docs/components/warnings/_in_progress.md'

<InProgress />

To Validate data we must first define a set of Expectations for that data to be Validated against. In this guide, you'll learn how to create Expectations and interactively edit them with feedback from Validating each against a Batch of data. Validating your Expectations as you define them allows you to quickly determine if the Expectations are suitable for our data, and identify where changes might be necessary.

:::info Does this process edit my data?
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ title: How to use auto-initializing Expectations
import Prerequisites from '../../guides/connecting_to_your_data/components/prerequisites.jsx'
import TechnicalTag from '@site/docs/term_tags/_tag.mdx';

import InProgress from '/docs/components/warnings/_in_progress.md'

<InProgress />

This guide will walk you through the process of using a auto-initializing <TechnicalTag tag="expectation" text="Expectations" /> to automate parameter estimation when you are creating Expectations interactively by using a <TechnicalTag tag="batch" text="Batch" /> or Batches that have been loaded into a <TechnicalTag tag="validator" text="Validator" />.

:::note PREREQUISITES: THIS HOW-TO GUIDE ASSUMES YOU HAVE:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ title: How to configure notebooks generated by suite-edit

import Prerequisites from '../connecting_to_your_data/components/prerequisites.jsx'

import InProgress from '/docs/components/warnings/_in_progress.md'

<InProgress />

This guide shows how to customize the Jupyter Notebooks generated by `great_expectations suite edit`

<Prerequisites>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ import TechnicalTag from '@site/docs/term_tags/_tag.mdx';
import Tabs from '@theme/Tabs'
import TabItem from '@theme/TabItem'

import InProgress from '/docs/components/warnings/_in_progress.md'

<InProgress />

This guide will demonstrate how to Validate data using a Checkpoint that is configured and run entirely in-memory. This workflow is appropriate for environments or workflows where a user does not want to or cannot use a Checkpoint Store, e.g. in a [hosted environment](../../../deployment_patterns/how_to_instantiate_a_data_context_hosted_environments.md).


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ title: How to add validations data or suites to a Checkpoint
import Prerequisites from '../../../guides/connecting_to_your_data/components/prerequisites.jsx';
import TechnicalTag from '@site/docs/term_tags/_tag.mdx';

import InProgress from '/docs/components/warnings/_in_progress.md'

<InProgress />

This guide will help you add validation data or <TechnicalTag tag="expectation_suite" text="Expectation Suites" /> to an existing <TechnicalTag tag="checkpoint" text="Checkpoint" />. This is useful if you want to aggregate individual validations (across Expectation Suites or <TechnicalTag tag="datasource" text="Datasources" />) into a single Checkpoint.


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ title: How to configure a new Checkpoint using test_yaml_config
import Prerequsities from '../../connecting_to_your_data/components/prerequisites.jsx'
import TechnicalTag from '@site/docs/term_tags/_tag.mdx';

import InProgress from '/docs/components/warnings/_in_progress.md'

<InProgress />

This how-to guide demonstrates advanced examples for configuring a <TechnicalTag tag="checkpoint" text="Checkpoint" /> using ``test_yaml_config``. **Note:** For a basic guide on creating a new Checkpoint, please see [How to create a new Checkpoint](../../../guides/validation/checkpoints/how_to_create_a_new_checkpoint.md).

``test_yaml_config`` is a convenience method for configuring the moving parts of a Great Expectations deployment. It allows you to quickly test out configs for <TechnicalTag tag="datasource" text="Datasources" />, <TechnicalTag tag="store" text="Stores" />, and Checkpoints. ``test_yaml_config`` is primarily intended for use within a notebook, where you can iterate through an edit-run-check loop in seconds.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@ import DOptionalCheckYourStoredCheckpointConfig from './components_how_to_create
import EOptionalTestRunTheNewCheckpointAndOpenDataDocs from './components_how_to_create_a_new_checkpoint/_e_optional_test_run_the_new_checkpoint_and_open_data_docs.mdx'
import AdditionalResources from './components_how_to_create_a_new_checkpoint/_additional_resources.mdx'

import InProgress from '/docs/components/warnings/_in_progress.md'

<InProgress />

<Preface />

<StepsForCheckpoints />
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import TechnicalTag from '@site/docs/term_tags/_tag.mdx';

import InProgress from '/docs/components/warnings/_in_progress.md'

<InProgress />

This guide will help you pass an in-memory DataFrame to an existing <TechnicalTag tag="checkpoint" text="Checkpoint" />. This is especially useful if you already have your data in memory due to an existing process such as a pipeline runner.


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import TechnicalTag from '@site/docs/term_tags/_tag.mdx';

import InProgress from '/docs/components/warnings/_in_progress.md'

<InProgress />

This guide will help you <TechnicalTag tag="validation" text="Validate" /> your data by running a <TechnicalTag tag="checkpoint" text="Checkpoint" />.

The best way to Validate data in production with Great Expectations is using a <TechnicalTag tag="checkpoint" text="Checkpoint" />. The advantage of using a Checkpoint is ease of use, due to its principal capability of combining the existing configuration in order to set up and perform the Validation:
Expand Down
4 changes: 4 additions & 0 deletions docs/docusaurus/docs/terms/batch_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ import ConnectHeader from '/docs/images/universal_map/_um_connect_header.mdx';
import CreateHeader from '/docs/images/universal_map/_um_create_header.mdx';
import ValidateHeader from '/docs/images/universal_map/_um_validate_header.mdx';

import InProgress from '/docs/components/warnings/_in_progress.md'

<InProgress />


<UniversalMap setup='inactive' connect='active' create='active' validate='active'/>

Expand Down
4 changes: 4 additions & 0 deletions docs/docusaurus/docs/terms/checkpoint.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ import ValidateHeader from '/docs/images/universal_map/_um_validate_header.mdx';
import TechnicalTag from '../term_tags/_tag.mdx';
import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

import InProgress from '/docs/components/warnings/_in_progress.md'

<InProgress />

<UniversalMap setup='inactive' connect='inactive' create='inactive' validate='active'/>

## Overview
Expand Down
4 changes: 4 additions & 0 deletions docs/docusaurus/docs/terms/datasource.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ import CreateHeader from '/docs/images/universal_map/_um_create_header.mdx';
import ValidateHeader from '/docs/images/universal_map/_um_validate_header.mdx';
import TechnicalTag from '../term_tags/_tag.mdx';

import InProgress from '/docs/components/warnings/_in_progress.md'

<InProgress />

<UniversalMap setup='inactive' connect='active' create='active' validate='active'/>

### Definition
Expand Down

0 comments on commit 4f59fc5

Please sign in to comment.