logo
Documentation Case Studies Blog
Community
  • Community Home
  • Slack
  • GitHub
  • Discuss
  • Join Cloud
  • Documentation
  • Case Studies
  • Blog
  • Community Home
  • Slack
  • GitHub
  • Discuss
great_expectations
latest
  • Introduction
    • What is Great Expectations?
    • Why would I use Great Expectations?
    • Key features
    • What does Great Expectations NOT do?
    • How do I get started?
  • Guides
    • Tutorials
      • Quick start
      • How to quickly explore Expectations in a notebook
        • Steps
        • Additional notes
        • Additional resources
        • Comments
      • Getting started with Great Expectations – v2 (Batch Kwargs) API
        • Set up the tutorial data and initialize a Data Context
        • Connect to data
        • Create your first Expectations
        • How to use Data Docs
        • Validate your data using a Checkpoint
        • Optional: Customize your deployment
      • Getting started with Great Expectations – v3 (Batch Request) API
        • Set up the tutorial data and initialize a Data Context
        • Connect to data
        • Create your first Expectations
        • How to use Data Docs
        • Validate your data using a Checkpoint
        • Optional: Customize your deployment
      • How to create Expectations
        • Create an Expectation Suite
        • Review an Expectation Suite
        • Edit an Expectation Suite
        • Jupyter Notebook for Creating and Editing Expectation Suites
    • Workflows and patterns
      • Deploying Great Expectations with Airflow
        • Running validation using the GreatExpectationsOperator
        • Running validation using a PythonOperator
        • Running a validation using a Checkpoint & BashOperator
        • Additional resources
        • Comments
      • Deploying Great Expectations with Google Cloud Composer (Hosted Airflow)
        • Steps
        • Additional resources
        • Comments
      • Deploying Great Expectations with Astronomer
        • Using the Great Expectations Airflow Operator in an Astronomer Deployment
        • Step 1: Set the DataContext root directory
        • Step 2: Set the environment variables for credentials
      • Deploying Great Expectations in a hosted environment without file system or CLI
        • Step 1: Configure your Data Context
        • Step 2: Create Expectation Suites and add Expectations
        • Step 3: Run validation
        • Step 4: Use Data Docs
        • Additional notes
    • How-to guides
      • Configuring Data Contexts
        • How to create a new Data Context with the CLI
        • How to configure DataContext components using test_yaml_config
        • How to use a YAML file or environment variables to populate credentials
        • How to populate credentials from a secrets store
        • How to instantiate a Data Context without a yml file
        • How to instantiate a Data Context on an EMR Spark cluster
        • How to instantiate a Data Context on Databricks Spark cluster
      • Configuring Datasources
        • How to choose which DataConnector to use
        • How to configure a BigQuery Datasource
        • How to configure a ConfiguredAssetDataConnector
        • How to configure a Databricks AWS Datasource
        • How to configure a Databricks Azure Datasource
        • How to configure a MSSQL Datasource
        • How to configure a MySQL Datasource
        • How to configure a Pandas/filesystem Datasource
        • How to configure a Pandas/S3 Datasource
        • How to configure a Redshift Datasource
        • How to configure a self managed Spark Datasource
        • How to configure a Snowflake Datasource
        • How to configure a Spark/filesystem Datasource
        • How to configure an Athena Datasource
        • How to configure an EMR Spark Datasource
        • How to configure an InferredAssetDataConnector
        • How to Configure a Data Connector to Sort Batches
      • Configuring metadata stores
        • How to configure a Validation Result store in Azure blob storage
        • How to configure a Validation Result store in GCS
        • How to configure a Validation Result store in S3
        • How to configure a Validation Result store on a filesystem
        • How to configure a Validation Result store to PostgreSQL
        • How to configure an Expectation store in Amazon S3
        • How to configure an Expectation store in Azure blob storage
        • How to configure an Expectation store in GCS
        • How to configure an Expectation store on a filesystem
        • How to configure an Expectation store to PostgreSQL
        • How to configure a MetricsStore
      • Creating Batches
        • How to configure a RuntimeDataConnector (V3 API only)
        • How to load a Batch using an active Data Connector
        • How to load a database table, view, or query result as a batch
        • How to load a Pandas DataFrame as a Batch
        • How to load a Spark DataFrame as a Batch
      • Creating and editing Expectations
        • How to contribute a new Expectation to Great Expectations
        • How to create a new Expectation Suite using the CLI
        • How to create a new Expectation Suite without a sample Batch
        • How to create a new Expectation Suite without the CLI
        • How to create a new Expectation Suite from a jsonschema file
        • How to create an Expectation Suite with the User Configurable Profiler
        • How to create custom Expectations
        • How to create custom Expectations for pandas
        • How to create custom Expectations for Spark
        • How to create custom Expectations for SQLAlchemy
        • How to create Expectations that span multiple Batches using Evaluation Parameters
        • How to Create Parameterized Expectations - Super Fast
        • How to dynamically load evaluation parameters from a database
        • How to edit an Expectation Suite using a disposable notebook
      • Validation
        • How to add a Validation Operator - V2 (Batch Kwargs) API
        • How to add validations, data, or suites to a Checkpoint
        • How to create a new Checkpoint
        • How to configure a new Checkpoint using test_yaml_config
        • How to deploy a scheduled Checkpoint with cron
        • How to implement a custom Validation Operator
        • How to implement custom notifications
        • How to run a Checkpoint in Airflow
        • How to run a Checkpoint in python
        • How to run a Checkpoint in terminal
        • How to store Validation Results as a Validation Action
        • How to trigger Email as a Validation Action
        • How to trigger Slack notifications as a Validation Action
        • How to update Data Docs as a Validation Action
        • How to validate data without a Checkpoint
      • Configuring Data Docs
        • How to add comments to Expectations and display them in Data Docs
        • How to Create Renderers for Custom Expectations
        • How to host and share Data Docs on a filesystem
        • How to host and share Data Docs on Azure Blob Storage
        • How to host and share Data Docs on GCS
        • How to host and share Data Docs on S3
      • Configuring Generated Notebooks
        • How to configure notebooks generated by “suite edit”
      • Migrating between versions
        • How to use the project check-config command
      • Miscellaneous
        • How to use the Great Expectations command line interface (CLI)
        • How to add support for a new SQLAlchemy dialect
        • How to add comments to a page on docs.greatexpectations.io
        • How to setup Opsgenie alert notifications
        • TEMPLATE: How to {stub}
        • TEMPLATE: How to {do something}
        • How to use the Great Expectation Docker images
        • How to write a how to guide
  • Reference
    • Glossary of Expectations
      • Dataset
        • Table shape
        • Missing values, unique values, and types
        • Sets and ranges
        • String matching
        • Datetime and JSON parsing
        • Aggregate functions
        • Multi-column
        • Distributional functions
      • FileDataAsset
    • Core Concepts
      • Key Ideas
      • Concepts in the Codebase
        • Expectations and Metrics
        • Datasources
        • Validation
        • Data Context
        • Data Docs
        • Profilers
      • Design Decisions
    • Supporting resources
      • pip
      • virtual environments
      • jupyter notebooks and jupyter lab
      • git
    • Spare Parts
      • Data Context Reference
        • Configuration
        • Managing Environment and Secrets
        • Default Out of Box Config File
      • Usage Statistics
      • Profiling Reference
        • Expectations and Profiling
        • How to Run Profiling
        • Custom Profilers
        • Profiling Limitations
      • Data Docs Reference
        • Data Docs Site Configuration
        • Building Data Docs
        • Customizing Data Docs
    • API Reference
      • Subpackages
        • great_expectations.checkpoint
        • great_expectations.cli
        • great_expectations.core
        • great_expectations.data_asset
        • great_expectations.data_context
        • great_expectations.dataset
        • great_expectations.datasource
        • great_expectations.exceptions
        • great_expectations.execution_engine
        • great_expectations.expectations
        • great_expectations.jupyter_ux
        • great_expectations.marshmallow__shade
        • great_expectations.profile
        • great_expectations.render
        • great_expectations.rule_based_profiler
        • great_expectations.self_check
        • great_expectations.types
        • great_expectations.validation_operators
        • great_expectations.validator
      • Submodules
        • great_expectations._version
        • great_expectations.util
      • Package Contents
        • Classes
        • Functions
  • Community resources
    • Get in touch with the Great Expectations team
    • Ask a question
    • File a bug report or feature request
    • Contribute code or documentation
  • Contributing
    • Setting up your dev environment
      • Prerequisites
      • Fork and clone the repository
      • Install python dependencies
      • (Optional) Configure resources for testing and documentation
      • Run tests to confirm that everything is working
      • Start coding!
    • Contribution checklist
      • Before submitting a pull request
      • How to submit a pull request
    • Making changes directly through Github
      • Start editing
      • Submit a pull request
    • Testing
      • Running tests
      • Writing unit and integration tests
      • Unit tests for Expectations
      • Manual testing
    • Levels of maturity
    • Style Guide
      • General conventions
      • code
      • .rst files
    • Miscellaneous
      • Core team
      • Contributor license agreement (CLA)
      • Release checklist
      • Issue Tags
  • Changelog
    • Develop
    • 0.13.22
    • 0.13.21
    • 0.13.20
    • 0.13.19
    • 0.13.18
    • 0.13.17
    • 0.13.16
    • 0.13.15
    • 0.13.14
    • 0.13.13
    • 0.13.12
    • 0.13.11
    • 0.13.10
    • 0.13.9
    • 0.13.8
    • 0.13.7
    • 0.13.6
    • 0.13.5
    • 0.13.4
    • 0.13.3
    • 0.13.2
    • 0.13.1
    • 0.13.0
    • 0.12.10
    • 0.12.9
    • 0.12.8
    • 0.12.7
    • 0.12.6
    • 0.12.5
    • 0.12.4
    • 0.12.3
    • 0.12.2
    • 0.12.1
    • 0.12.0
    • 0.11.9
    • 0.11.8
    • 0.11.7
    • 0.11.6
    • 0.11.5
    • 0.11.4
    • 0.11.3
    • 0.11.2
    • 0.11.1
    • 0.11.0
    • 0.10.12
    • 0.10.11
    • 0.10.10
    • 0.10.8
    • 0.10.7
    • 0.10.6
    • 0.10.5
    • 0.10.4
    • 0.10.3
    • 0.10.2
    • 0.10.1
    • 0.10.0
    • 0.9.11
    • 0.9.10
    • 0.9.9
    • 0.9.8
    • 0.9.7
    • 0.9.6
    • 0.9.5
    • 0.9.4
    • 0.9.3
    • 0.9.2
    • 0.9.1
    • 0.9.0
    • 0.8.9__develop
    • 0.8.8
    • 0.8.7
    • 0.8.6
    • 0.8.5
    • 0.8.4.post0
    • 0.8.4
    • 0.8.3
    • 0.8.2.post0
    • 0.8.2
    • 0.8.1
    • 0.8.0
    • v0.7.11
    • v0.7.10
    • v0.7.9
    • v0.7.8
    • 0.7.7
    • 0.7.6
    • 0.7.5
    • 0.7.4
    • 0.7.3
    • 0.7.2
    • 0.7.1
    • 0.7.0
    • 0.6.1
    • 0.6.0
    • 0.5.1
    • 0.5.0
    • 0.4.5
    • 0.4.4
    • 0.4.3
    • 0.4.2
    • 0.4.1
    • 0.4.0
    • 0.3.2
    • 0.3.1
    • 0.2
great_expectations
  • »
  • Welcome to Great Expectations!
  • Edit on GitHub

Welcome to Great Expectations!¶

Great Expectations is the leading tool for validating, documenting, and profiling your data to maintain quality and improve communication between teams. Head over to the Introduction to learn more, or jump straight to our Getting started with Great Expectations – v2 (Batch Kwargs) API guide.

Attention

Welcome! In addition to perusing the documentation, please feel free to ask questions on our Slack channel or discussion forum!

  • Introduction
    • What is Great Expectations?
    • Why would I use Great Expectations?
    • Key features
    • What does Great Expectations NOT do?
    • How do I get started?
  • Guides
    • Tutorials
    • Workflows and patterns
    • How-to guides
  • Reference
    • Glossary of Expectations
    • Core Concepts
    • Supporting resources
    • Spare Parts
    • API Reference
  • Community resources
    • Get in touch with the Great Expectations team
    • Ask a question
    • File a bug report or feature request
    • Contribute code or documentation
  • Contributing
  • Changelog

Index¶

  • Index

  • Module Index

Next

© Copyright 2020, The Great Expectations Team. Revision e7182155.

Built with Sphinx using a theme provided by Read the Docs.
Read the Docs v: latest
Versions
latest
stable
0.13.22
0.13.21
0.13.20
0.13.19
0.13.18
0.13.17
0.13.16
0.13.15
0.13.14
0.13.13
0.13.12
0.13.11
0.13.10
0.13.9
0.13.8
0.13.7
0.13.6
0.13.5
0.13.4
0.12.1
0.12.0
0.11.9
0.11.8
0.11.7
0.11.6
0.11.5
0.11.4
0.11.3
0.11.2
0.11.1
v0.11.x
0.11.0
0.10.12
0.10.11
0.10.10
0.10.9
0.10.8
0.10.7
0.10.6
0.10.5
0.10.4
0.10.3
0.10.2
0.10.1
0.10.0
0.9.11
0.9.10
0.9.9
0.9.8
0.9.7
0.9.6
0.9.5
0.9.4
0.9.3
0.9.2
0.9.1
0.9.0_a
0.9.0
0.8.8
0.8.7
0.8.6
0.8.5
0.8.4.post0
0.8.4
0.8.3
0.8.2.post0
0.8.2
0.8.1
0.8.0
0.7.11
v0.6.1
v0.5.1
v0.4.5
v0.3.2
Downloads
html
On Read the Docs
Project Home
Builds