org.apache.spark.sql.connector.read.streaming

Interface ReadLimit

All Known Implementing Classes:

CompositeReadLimit, ReadAllAvailable, ReadMaxFiles, ReadMaxRows, ReadMinRows

@Evolving
public interface ReadLimit

Interface representing limits on how much to read from a MicroBatchStream when it implements SupportsAdmissionControl. There are several child interfaces representing various kinds of limits.

Since:

3.0.0

See Also:

SupportsAdmissionControl.latestOffset(Offset, ReadLimit), ReadAllAvailable, ReadMaxRows

Method Summary

Modifier and Type	Method and Description
static ReadLimit	allAvailable()
static ReadLimit	compositeLimit(ReadLimit[] readLimits)
static ReadLimit	maxFiles(int files)
static ReadLimit	maxRows(long rows)
static ReadLimit	minRows(long rows, long maxTriggerDelayMs)

Method Detail

minRows

static ReadLimit minRows(long rows,
                         long maxTriggerDelayMs)

maxRows

static ReadLimit maxRows(long rows)

maxFiles

static ReadLimit maxFiles(int files)

allAvailable

static ReadLimit allAvailable()

compositeLimit

static ReadLimit compositeLimit(ReadLimit[] readLimits)