Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Pay attention, that both streams are use as examples for KStream (ie, record stream) and KTable (ie, changelog stream) with different semantics. For KTable, so-called tombstone records with format key:null are of special interest, as they delete a key (those records are shown as null in all examples to highlight tombstone semantics). Last but not least, in Kafka Streams each join is "customized" by the user with a ValueJoiner function that compute the actual result. Hence, we show output records as "X - Y" with X and Y being the left and right value, respectively, given to the value joiner. If the output is shown as null (ie, tombstone message), ValueJoiner will not be called because a result record will be deleted.

Improved Left/Outer Stream-Stream Join (v3.

...

1.x

...

 and newer)
Anchor
spurious
spurious

Warning

Prior to version 3.01.x Kafka Streams might emit so called "spurious" left/outer join result. In this section we only explain the different new behavior that avoids spurious left/outer stream-stream join results. See New Join Semantics below that describe all joins in more details, including spurious left/output join behavior in versions 0.10.2.x  to 23.80.x

(See 

Jira
serverASF JIRA
serverId5aa69414-a9e9-3523-82ec-879b028fb15b
keyKAFKA-10847
)

...

This is a sliding window join, ie, all tuples that are "close" to each other with regard to time (ie, time difference up to window size) are joined. The result is a KStream. The table below shows the output (for each processed input record) for left and outer join only (as inner joins are not subject to spurious join results). Pay attention, that some input records do not produce output records, and that left/outer output record are emitted with some "delay" (ie, only emitted after grace-period passed). Also note, that the new behavior requires to set a gracePeriod in the window definition to specify when left/outer join result should be emitted via ofTimeDifferenceNoGrace() or ofTimeDifferenceWithGrace(...) (setting the grace period using the old and now deprecated API, JoinWindows.of(...).grace(...), will not result in this new behavior, but will produce the same result as in older releases, 0.10.2.x  to 23.80.x).

In contrast to the later examples, we assume a window size of 15, and a grace period of 5. 

ts

STREAM_1 (left)

STREAM_2 (right)

innerJoin (same as in older versions)

leftJoin

outerJoin

1

null





2


null




3

A





4


a

A - aA - a

A - a

5

B


B - a

B - a

B - a

6


b

A - b

B - b

A - b

B - b

A - b

B - b

7

null





8


null




9

C


C - a

C - b

C - a

C - b

C - a

C - b

10


c

A - c

B - c

C - c

A - c

B - c

C - c

A - c

B - c

C - c

11


null




12

null





13


null




14


d

B - d

C - d

B - d

C - d

B - d

C - d

15

D


D - b

D - c

D - d

D - b

D - c

D - d

D - b

D - c

D - d

...




40E



...




60F

E - nullE - null
...




80
f
F - nullF - null
...




100G


null - f

New Join Semantics (v0.10.2.x and newer)
Anchor
newJoinSemantics
newJoinSemantics

...

The table below marks so called "spurious" left/outer join results, that are in the result in version 0.10.2.x to 23.80.x, in bold face. Compare Improved left/outer stream-stream join above for version 3.01.x that avoids spurious results.

...

...

...

...

ts
LHS-Stream
(K, extracted-FK)
RHS-Stream State (FK,V)Inner-Join OutputLeft-Join Output
1Publish event to LHS(k,1)(1,foo)(k,1,foo)(k,1,foo)
2Change LHS fk(k,2)(1,foo)(k,null)(k,2,null)
3Change LHS fk(k,3)(1,foo)(k,null)(k,3,null)
4Publish RHS entity-

(1,foo)
(3,bar)

(k,3,bar)(k,3,bar)
5Delete k(k,null)

(1,foo)
(3,bar)

(k,null)(k,null,null)
6Publish original event again(k,1)

(1,foo)
(3,bar)

(k,1,foo)(k,1,foo)
7Publish event to LHS(q,10)

(1,foo)
(3,bar)

-(q,null,10)
8Publish RHS entity-

(1,foo)
(3,bar)
(q,baz)

(q,10,baz)(q,10,baz)


Old Join Semantics (v0.10.0.x and v0.10.1.x

...

)
Anchor
oldJoinSemantics
oldJoinSemantics

Kafka Streams 0.10.0.x and 0.10.1.x (and older) offers the follow join operators:

...