Skip to content


JoinStateWatermarkPredicate is the <> of <> that are described by a <> and <>.

JoinStateWatermarkPredicate is created using StreamingSymmetricHashJoinHelper utility (for planning a StreamingSymmetricHashJoinExec physical operator for execution with execution-specific configuration)

JoinStateWatermarkPredicate is used to create a OneSideHashJoiner (and JoinStateWatermarkPredicates).

[[contract]] .JoinStateWatermarkPredicate Contract [cols="30m,70",options="header",width="100%"] |=== | Method | Description

| desc a| [[desc]]

[source, scala]

desc: String

Used exclusively for the <>

| expr a| [[expr]]

[source, scala]

expr: Expression

A Catalyst Expression

Used for the <> and a JoinStateWatermarkPredicates (for StreamingSymmetricHashJoinExec physical operator)


[[implementations]] .JoinStateWatermarkPredicates [cols="30,70",options="header",width="100%"] |=== | JoinStateWatermarkPredicate | Description

| JoinStateKeyWatermarkPredicate a| [[JoinStateKeyWatermarkPredicate]] Watermark predicate on state keys (i.e. when the streaming watermark is defined either on the left or right join keys)

Created when StreamingSymmetricHashJoinHelper utility is requested for a JoinStateWatermarkPredicates for the left and right side of a stream-stream join (when IncrementalExecution is requested to optimize a query plan with a StreamingSymmetricHashJoinExec physical operator)

Used when OneSideHashJoiner is requested for the stateKeyWatermarkPredicateFunc and then to remove an old state

| JoinStateValueWatermarkPredicate | [[JoinStateValueWatermarkPredicate]] Watermark predicate on state values


NOTE: JoinStateWatermarkPredicate is a Scala sealed trait which means that all the <> are in the same compilation unit (a single file).

=== [[toString]] Textual Representation -- toString Method

[source, scala]

toString: String

NOTE: toString is part of the ++[java.lang.Object] contract for the string representation of the object.

toString uses the <> and <> for the string representation:

[desc]: [expr]