BatchDefinition

class great_expectations.core.batch.BatchDefinition(datasource_name: str, data_connector_name: str, data_asset_name: str, batch_identifiers: IDDict, batch_spec_passthrough: dict | None = None)#

Precisely identifies a set of data from a data source.

More concretely, a BatchDefinition includes all the information required to precisely identify a set of data from the external data source that should be translated into a Batch. One or more BatchDefinitions should always bereturned from the Datasource, as a result of processing the Batch Request.

-Relevant Documentation Links -

• Batch

Parameters:

• datasource_name – name of the Datasource used to connect to the data

• data_connector_name – name of the DataConnector used to connect to the data

• data_asset_name – name of the DataAsset used to connect to the data

• batch_identifiers – key-value pairs that the DataConnector will use to obtain a specific set of data

• batch_spec_passthrough – a dictionary of additional parameters that the ExecutionEngine will use to obtain a specific set of data

Returns:

BatchDefinition

to_json_dict() → dict[str, JSONValues]#

Returns a JSON-serializable dict representation of this BatchDefinition.

Returns:

A JSON-serializable dict representation of this BatchDefinition.