diff --git a/docs/streams/upgrade-guide.html b/docs/streams/upgrade-guide.html index c9c689e36c178..3e4d5ad486f03 100644 --- a/docs/streams/upgrade-guide.html +++ b/docs/streams/upgrade-guide.html @@ -64,6 +64,8 @@

Upgrade Guide and API Changes

for more details.

+

For a table that shows Streams API compatibility with Kafka broker versions, see Broker Compatibility.

+

Notable compatibility changes in past releases

Downgrading from 3.5.x or newer version to 3.4.x or older version needs special attention: @@ -1292,6 +1294,57 @@

  • JoinWindows has no default size anymore: JoinWindows.of("name").within(1000) changes to JoinWindows.of(1000)
    • +

    Streams API broker compatibility

    + +

    The following table shows which versions of the Kafka Streams API are compatible with various Kafka broker versions.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Kafka Broker (columns)
    Kafka Streams API (rows)0.10.0.x0.10.1.x and 0.10.2.x0.11.0.x and
    1.0.x and
    1.1.x and
    2.0.x and
    2.1.x and
    2.2.x and
    2.3.x and
    2.4.x and
    2.5.x and
    2.6.x and
    2.7.x and
    2.8.x and
    3.0.x and
    3.1.x and
    3.2.x and
    3.3.x and
    3.4.x and
    3.5.x
    0.10.0.xcompatiblecompatiblecompatible
    0.10.1.x and 0.10.2.xcompatiblecompatible
    0.11.0.xcompatible with exactly-once turned off
    (requires broker version 0.11.0.x or higher)    		compatible
    1.0.x and
    1.1.x and
    2.0.x and
    2.1.x and
    2.2.0 and
    2.2.0    		compatible with exactly-once turned off
    (requires broker version 0.11.0.x or higher);
    requires message format 0.10 or higher;
    message headers are not supported
    (requires broker version 0.11.0.x or higher
    with message format 0.11 or higher)    		compatible; requires message format 0.10 or higher;
    if message headers are used, message format 0.11
    or higher required
    2.2.1 and
    2.3.x and
    2.4.x and
    2.5.x and
    2.6.x and
    2.7.x and
    2.8.x and
    3.0.x and
    3.1.x and
    3.2.x and
    3.3.x and
    3.4.x and
    3.5.x    		compatible; requires message format 0.11 or higher;
    enabling exactly-once v2 requires 2.4.x or higher
    +