The great_expectations utility helps data teams eliminate pipeline debt, through data testing, documentation, and profiling.

Getting Started #

Prerequisites #

If you haven't already, follow the initial steps of the Getting Started guide:

  1. Install Meltano
  2. Create your Meltano project

Installation and configuration #

Using the Command Line Interface #

  1. Add the great_expectations utilitie to your project using meltano add : 

    meltano add utility great_expectations
  2. Configure the settings below using meltano config .

Next steps #

  1. Refer to the installation instructions for advanced configurations.
  2. Create expectations suites and checkpoints!

If you run into any issues, learn how to get help.

Settings #

These and other supported settings are documented below. To quickly find the setting you're looking for, use the Table of Contents at the top of the page.

Great Expectations Home Directory (ge_home) #

  • Environment variable: GE_HOME, alias: GREAT_EXPECTATIONS_GE_HOME
  • Default: $MELTANO_PROJECT_ROOT/utilities/great_expectations

How to use #

Manage this setting using meltano config or an environment variable: 

meltano config great_expectations set ge_home <ge_home>

export GE_HOME=<ge_home>

Additional Configuration #

If you are using Great Expectations to validate data in a database or warehouse, you might need to install the appropriate drivers. Common options are supported by Great Expectations as pip extras, and any additional packages you may want can be added too by configuring a custom pip_url for the great_expectations utility:

# set the _pip_url extra setting
meltano config great_expectations set _pip_url "great_expectations[redshift]; awscli"
# re-install the great_expectations plugin for changes to take effect
meltano install utility great_expectations

Looking for help? #

If you're having trouble getting the great_expectations utilitie to work, look for an existing issue in its repository, file a new issue, or join the Meltano Slack community and ask for help in the #plugins-general channel.

Found an issue on this page? #

This page is generated from a YAML file that you can contribute changes to. Edit it on GitHub!