BatchDefinition
Configuration for a batch of data.
References the DataAsset to be used, and any additional parameters needed to fetch the data.
Retrieves a batch from the underlying asset. Defaults to the last batch from the asset's batch list.
Parameters
Name Description batch_parameters
Additional parameters to be used in fetching the batch.
Returns
Type Description Batch
A Batch of data.
Retrieves a list of available batch identifiers. These identifiers can be used to fetch specific batches via batch_options.
Parameters
Name Description batch_parameters
Additional parameters to be used in fetching the batch identifiers list.
Returns
Type Description List[Dict]
A list of batch identifiers.
Save the batch definition to the underlying data context.
Signature
class great_expectations.core.batch_definition.BatchDefinition(
*,
id: Optional[str] = None,
name: str,
partitioner: Optional[great_expectations.core.batch_definition.PartitionerT] = None
)
Properties
| Name | Description | Reference |
|---|---|---|
| The parent DataAsset for this Batch Definition. | DataAsset |
Methods
get_batch
Signature
get_batch(
batch_parameters: Optional[BatchParameters] = None
) → Batch
get_batch_identifiers_list
Signature
get_batch_identifiers_list(
batch_parameters: Optional[BatchParameters] = None
) → List[Dict]
save
Signature
save() → None