Skip to main content
Version: 1.2.4

BatchDefinition

class great_expectations.core.batch_definition.BatchDefinition(*, id: Optional[str] = None, name: str, partitioner: Optional[great_expectations.core.batch_definition.PartitionerT] = None)#

Configuration for a batch of data.

References the DataAsset to be used, and any additional parameters needed to fetch the data.

property data_asset: DataAsset[Any, PartitionerT]#
get_batch(batch_parameters: Optional[BatchParameters] = None) Batch#

Retrieves a batch from the underlying asset. Defaults to the last batch from the asset’s batch list.

Parameters

batch_parameters – Additional parameters to be used in fetching the batch.

Returns

A Batch of data.

get_batch_identifiers_list(batch_parameters: Optional[BatchParameters] = None) List[Dict]#

Retrieves a list of available batch identifiers. These identifiers can be used to fetch specific batches via batch_options.

Parameters
  • batch_parameters – Additional parameters to be used in fetching the batch identifiers

  • list.

Returns

A list of batch identifiers.