Offset — Read Position of Streaming Query¶

Offset is an abstraction of stream positions.

Contract¶

JSON Representation¶

String json()

JSON-encoded representation of the offset

Used when:

• MicroBatchExecution stream execution engine is requested to construct the next streaming micro-batch and run a streaming micro-batch (with MicroBatchReader sources)
• OffsetSeq is requested for the textual representation
• OffsetSeqLog is requested to serialize metadata (write metadata in serialized format)
• ProgressReporter is requested to record trigger offsets
• ContinuousExecution stream execution engine is requested to run a streaming query in continuous mode and commit an epoch

Implementations¶

• ContinuousMemoryStreamOffset
• FileStreamSourceOffset
• KafkaSourceOffset
• LongOffset
• SerializedOffset
• TextSocketOffset