bulk-cdk-core-extract/io.airbyte.cdk.read/PartitionReader

PartitionReader

A PartitionReader, when executed via run, emits records within the corresponding partition, and completes by returning the value of the state checkpoint.

A partition is a chunk of consecutive records within a Feed, which is either a stream or some global data feed.

Inheritors

UnlimitedTimePartitionReader

Types

Companion

object Companion

TryAcquireResourcesStatus

enum TryAcquireResourcesStatus : Enum<PartitionReader.TryAcquireResourcesStatus>

Functions

checkpoint

abstract fun checkpoint(): PartitionReadCheckpoint

Returns the forward progress made by the execution of run.

releaseResources

abstract fun releaseResources()

Called after run and checkpoint to release any resources acquired by tryAcquireResources.

run

abstract suspend fun run()

Reads the corresponding partition.

tryAcquireResources

abstract fun tryAcquireResources(): PartitionReader.TryAcquireResourcesStatus

Called before run to try to acquire all the resources required for its execution. These may be, but are not limited to: