Offset -- Read Position of Streaming Query¶

Offset is the <> of <> that represent progress of a streaming query in <> format.

[[contract]] .Offset Contract (Abstract Methods Only) [cols="30m,70",options="header",width="100%"] |=== | Method | Description

| json a| [[json]]

[source, java]¶

String json()¶

Converts the offset to JSON format (JSON-encoded 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

|===

[[extensions]] .Offsets [cols="30,70",options="header",width="100%"] |=== | Offset | Description

| ContinuousMemoryStreamOffset | [[ContinuousMemoryStreamOffset]]

| FileStreamSourceOffset | [[FileStreamSourceOffset]]

| KafkaSourceOffset | [[KafkaSourceOffset]]

| LongOffset | [[LongOffset]]

| RateStreamOffset | [[RateStreamOffset]]

| SerializedOffset | [[SerializedOffset]] JSON-encoded offset that is used when loading an offset from an external storage, e.g. from checkpoint after restart

| TextSocketOffset | [[TextSocketOffset]]

|===