Version: 1.5.5

Configure project Stores

Stores are used by GX Core to store and retreive information ranging from project metadata such as Expectation Suite configurations to the Validation Results generated when Checkpoints are run.

Ephemeral Data Contexts store this information in memory. File Data Contexts, however, store this information in files that can be copied or shared between other File Data Contexts.

By default, Store files are created in folders within the base_folder of the File Data Context. However, you can update your Data Context to specify where these Stores should reside, or to indicate existing Stores to load when the Data Context is initialized.

Prerequisites:

Procedure

Instructions
Sample code

Load a File Data Context.

Because Store configurations are loaded when a Data Context is initialized, an Ephemeral Data Context will always initialize with default in-memory Stores and any changes to them will not persist when a new Ephemeral Data Context is initialized.

This procedure assumes you have a File Data Context loaded as the variable context:
Python
```
import great_expectations as gx

# Load a File Data Context
context = gx.get_context(mode="file")
```
Determine the Store to update.

GX utilizes 5 Stores for different types of data and metadata. These Stores are the Expectations Store, Validation Definitions Store, Checkpoint Store, Validation Results Store, and the Suite Parameter Store. All Stores can be accessed by passing a corresponding key to a Data Context's variables.config.stores attribute.

The variables.config.stores attribute gives access to the configuration values prior to any string substitution that may take palce, which also allows you to include string substitution references in your configuration. To view the resolved path after string substitution takes place, use variables.stores. For more information on how to configure string substitution references and values see Configure credentials.

The following code shows how to print the configuration for each of these stores:
Python
```
print(context.variables.config.stores["expectations_store"])
print(context.variables.config.stores["validation_definition_store"])
print(context.variables.config.stores["checkpoint_store"])
print(context.variables.config.stores["validation_results_store"])
```
When updating a Store configuration you will use the same key to access it from your Data Context's variables.config.stores attribute as was used to print it in the above example.
Update the base_path of the Store to change.

Each Store has a store_backend configuration that determines how and where the Store accesses and saves information. To change the location of a Store, you will update the store_backend configuration's base_directory value. For instance, to change the location of an Expectation Store, you would update the expectation_store_directory variable in the following code and execute it:
Python
```
expectation_store_directory = "my_expectations_store/"
context.variables.config.stores["expectations_store"]["store_backend"][
    "base_directory"
] = expectation_store_directory
```
The path provided for the base_directory should be either be an absolute path, or a path relative to the File Data Context's project_root_dir.
Save the File Data Context variables.

Once a Data Context's variables have been updated, the changes need to be saved to the Data Context's configuration file so that they will persist when the Data Context is loaded in the future. This is done with:
Python
```
context.variables.save()
```
Re-initialize the File Data Context.

Because Store configurations are loaded when the Data Context is initialized, you will need to re-initialize your Data Context before your changes will take effect. This is done by loading the Data Context again, exactly as when it was loaded the first time:
Python
```
context = gx.get_context(mode="file")
```

Python
import great_expectations as gx

# Load a File Data Context
context = gx.get_context(mode="file")
set_up_context_for_example(context)

# Access the Stores through the Data Context's `variables` attribute:
print(context.variables.config.stores["expectations_store"])
print(context.variables.config.stores["validation_definition_store"])
print(context.variables.config.stores["checkpoint_store"])
print(context.variables.config.stores["validation_results_store"])

# Update the path of the Data Context's Expectations Store:
expectation_store_directory = "my_expectations_store/"
context.variables.config.stores["expectations_store"]["store_backend"][
    "base_directory"
] = expectation_store_directory

# Save changes to the Data Context's configuration:
context.variables.save()

# Re-initialize the Data Context:
context = gx.get_context(mode="file")

Prerequisites:​

Procedure​

Prerequisites:

Procedure