DataContextConfig
Config class for DataContext.
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
Name Description config_version (Optional[float])
config version of this DataContext.
fluent_datasources (Optional[dict])
temporary placeholder for Experimental Datasources.
expectations_store_name (Optional[str])
name of ExpectationStore to be used by DataContext.
validation_results_store_name (Optional[str])
name of ValidationResultsStore to be used by DataContext.
checkpoint_store_name (Optional[str])
name of CheckpointStore to be used by DataContext.
plugins_directory (Optional[str])
the directory in which custom plugin modules should be placed.
stores (Optional[dict])
single holder for all Stores associated with this DataContext.
data_docs_sites (Optional[dict])
DataDocs sites associated with DataContext.
config_variables_file_path (Optional[str])
path for config_variables file, if used.
analytics_enabled (Optional[bool])
whether or not to send usage statistics to the Great Expectations team.
data_context_id (Optional[UUID])
unique identifier for the DataContext.
store_backend_defaults (Optional[BaseStoreBackendDefaults])
define base defaults for platform specific StoreBackendDefaults. For example, if you plan to store expectations, validations, and data_docs in s3 use the S3StoreBackendDefaults and you may be able to specify fewer parameters.
commented_map (Optional[CommentedMap])
the CommentedMap associated with DataContext configuration. Used when instantiating with yml file.
progress_bars (Optional[ProgressBarsConfig])
allows progress_bars to be enabled or disabled globally or for metrics calculations.
Returns a JSON-serializable dict representation of this DataContextConfig.
Returns
Type Description Dict[str, JSONValues]
A JSON-serializable dict representation of this DataContextConfig.
class great_expectations.data_context.types.base.DataContextConfig(
config_version: Optional[float] = None,
fluent_datasources: Optional[dict] = None,
expectations_store_name: Optional[str] = None,
validation_results_store_name: Optional[str] = None,
checkpoint_store_name: Optional[str] = None,
plugins_directory: Optional[str] = None,
stores: Optional[Dict] = None,
data_docs_sites: Optional[Dict] = None,
config_variables_file_path: Optional[str] = None,
analytics_enabled: Optional[bool] = None,
data_context_id: Optional[uuid.UUID] = None,
store_backend_defaults: Optional[great_expectations.data_context.types.base.BaseStoreBackendDefaults] = None,
commented_map: Optional[ruamel.yaml.comments.CommentedMap] = None,
progress_bars: Optional[great_expectations.data_context.types.base.ProgressBarsConfig] = None
)
Methods
to_json_dict
to_json_dict() → Dict[str,
JSONValues]