NewFactory constructs a new Factory.

WithDiff makes an option to set whether rangefeed events carry the previous value in addition to the new value.

WithFiltering makes an option to set whether to filter out rangefeeds events where the user has set omit_from_changefeeds in their session.

WithFrontierQuantized enables quantization of timestamps down to the nearest multiple of d to potentially reduce overhead in the frontier thanks to more sub-spans having equal timestamps and thus being able to be merged, resulting in fewer distinct spans in the frontier.

WithFrontierSpanVisitor sets up a callback to optionally inspect the frontier after a checkpoint is processed.

WithInitialScan enables an initial scan of the data in the span.

WithInitialScanParallelismFn configures rangefeed to issue up to specified number of concurrent initial scan requests.

WithInvoker makes an option to invoke the rangefeed tasks such as running the the client and processing events emitted by the client with a caller-supplied function, which can make it easier to introspect into work done by a given caller as the stacks for these tasks will now include the caller's invoker.

WithMemoryMonitor configures rangefeed to use memory monitor when issuing scan requests.

WithOnCheckpoint sets up a callback that's invoked whenever a check point event is emitted.

WithOnDeleteRange sets up a callback that's invoked whenever an MVCC range deletion tombstone is written.

WithOnFrontierAdvance sets up a callback that's invoked whenever the rangefeed frontier is advanced.

WithOnInitialScanError sets up a callback to report errors during the initial scan to the caller.

WithOnInternalError sets up a callback to report unrecoverable errors during operation.

WithOnMetadata sets up a callback that's invoked when a partial rangefeed is spawned.

WithOnScanCompleted sets up a callback which is invoked when a span (or part of the span) have been completed when performing an initial scan.

WithOnSSTable sets up a callback that's invoked whenever an SSTable is ingested.

WithOnValues sets up a callback that's invoked whenever a batch of values is passed such as during initial scans, allowing passing it as a batch to the client rather than key-by-key to reduce overhead.

WithPProfLabel configures rangefeed to annotate go routines started by range feed with the specified key=value label.

WithRetry configures the retry options for the rangefeed.

WithRowTimestampInInitialScan indicates whether the timestamp of rows reported during an initial scan should correspond to the timestamp of that row as it exists in KV or should correspond to the timestamp of the initial scan.

WithSystemTablePriority communicates that the rangefeed is over a system table and thus operates at a higher priority (this primarily affects admission control).

WithTargetScanBytes configures rangefeed to request specified number of bytes per scan request.

Factory is used to construct RangeFeeds.

RangeFeed represents a running RangeFeed.

TestingKnobs is used to inject behavior into a rangefeed for testing.

DB is an adapter to the underlying KV store.

Option configures a RangeFeed.

VisitableFrontier is the subset of the span.Frontier interface required to inspect the content of the frontier.

FrontierSpanVisitor is called when the frontier is updated by a checkpoint, and is passed the iterable frontier, as well as if the checkpoint advanced it when it was added.

OnCheckpoint is called when a rangefeed checkpoint occurs.

OnDeleteRange is called when an MVCC range tombstone is written (e.g.

OnFrontierAdvance is called when the rangefeed frontier is advanced with the new frontier timestamp.

OnInitialScanDone is called when an initial scan is finished before any rows from the rangefeed are supplied.

OnInitialScanError is called when an initial scan encounters an error.

OnMetadata is called when a RangefeedMetadata event is passed to the eventCh.

OnScanCompleted is called when the rangefeed initial scan completes scanning the span.

OnSSTable is called when an SSTable is ingested.

OnUnrecoverableError is called when the rangefeed exits with an unrecoverable error (preventing internal retries).

OnValue is called for each rangefeed value.

OnValue is called for a batch of rangefeed values.