Skip to main content
Version: 1.3.7

DirectoryDataAsset

Signature

class great_expectations.datasource.fluent.data_asset.path.directory_asset.DirectoryDataAsset(*, name: <pydantic.v1.fields.DeferredType object at 0x7f20592534a0>, type: <pydantic.v1.fields.DeferredType object at 0x7f2059253560>, id: <pydantic.v1.fields.DeferredType object at 0x7f2059253620> = None, order_by: <pydantic.v1.fields.DeferredType object at 0x7f20592536e0> = None, batch_metadata: <pydantic.v1.fields.DeferredType object at 0x7f2059253830> = None, batch_definitions: <pydantic.v1.fields.DeferredType object at 0x7f20592539e0> = None, connect_options: <pydantic.v1.fields.DeferredType object at 0x7f2059253aa0> = None, data_directory: pathlib.Path, **extra_data: typing.Any)

Base class for PathDataAssets which batch by combining the contents of a directory.

Methods

Signature

add_batch_definition_daily(name: str, column: str) → BatchDefinition

Add a BatchDefinition, which creates a single Batch for each day in the directory.

Parameters

NameDescription

name

Name of the Batch Definition.

Returns

TypeDescription

BatchDefinition

A BatchDefinition that is partitioned daily.

Signature

add_batch_definition_monthly(name: str, column: str) → BatchDefinition

Add a BatchDefinition which creates a single batch for each month in the directory.

Parameters

NameDescription

name

Name of the Batch Definition.

Returns

TypeDescription

BatchDefinition

A BatchDefinition that is partitioned monthly.

Signature

add_batch_definition_whole_directory(name: str) → BatchDefinition

Add a BatchDefinition which creates a single batch for the entire directory.

Signature

add_batch_definition_yearly(name: str, column: str) → BatchDefinition

Add a BatchDefinition which creates a single batch for each year in the directory.

Parameters

NameDescription

name

Name of the Batch Definition.

Returns

TypeDescription

BatchDefinition

A BatchDefinition that is partitioned yearly.

Signature

delete_batch_definition(name: str)None

Delete a batch definition.

Parameters

NameDescription

name (str)

Name of the BatchDefinition to delete.

Signature

get_batch_definition(name: str) → great_expectations.core.batch_definition.BatchDefinition

Get a batch definition.

Parameters

NameDescription

name (str)

Name of the BatchDefinition to get.

Raises

TypeDescription

KeyError

If the BatchDefinition does not exist.