How to rekey a stream with a value

Question:

How can I add a key or change the key to a Kafka topic?

Edit this page

Example use case:

Suppose you have an unkeyed stream of movie ratings from movie-goers. Because the stream is not keyed, ratings for the same movie aren't guaranteed to be placed into the same partition. In this tutorial, we'll write a program that creates a new topic keyed by the movie's name. When the key is consistent, it becomes possible to process these ratings at scale and in parallel.

Code example:

Try it

1
Initialize the project

To get started, make a new directory anywhere you’d like for this project:

mkdir rekey-a-stream && cd rekey-a-stream

Then make the following directories to set up its structure:

mkdir src test

2
Get Confluent Platform

Next, create the following docker-compose.yml file to obtain Confluent Platform:

---
version: '2'

services:
  zookeeper:
    image: confluentinc/cp-zookeeper:6.1.0
    hostname: zookeeper
    container_name: zookeeper
    ports:
      - "2181:2181"
    environment:
      ZOOKEEPER_CLIENT_PORT: 2181
      ZOOKEEPER_TICK_TIME: 2000

  broker:
    image: confluentinc/cp-kafka:6.1.0
    hostname: broker
    container_name: broker
    depends_on:
      - zookeeper
    ports:
      - "29092:29092"
    environment:
      KAFKA_BROKER_ID: 1
      KAFKA_ZOOKEEPER_CONNECT: 'zookeeper:2181'
      KAFKA_LISTENER_SECURITY_PROTOCOL_MAP: PLAINTEXT:PLAINTEXT,PLAINTEXT_HOST:PLAINTEXT
      KAFKA_ADVERTISED_LISTENERS: PLAINTEXT://broker:9092,PLAINTEXT_HOST://localhost:29092
      KAFKA_OFFSETS_TOPIC_REPLICATION_FACTOR: 1
      KAFKA_TRANSACTION_STATE_LOG_MIN_ISR: 1
      KAFKA_TRANSACTION_STATE_LOG_REPLICATION_FACTOR: 1
      KAFKA_GROUP_INITIAL_REBALANCE_DELAY_MS: 0

  schema-registry:
    image: confluentinc/cp-schema-registry:6.1.0
    hostname: schema-registry
    container_name: schema-registry
    depends_on:
      - broker
    ports:
      - "8081:8081"
    environment:
      SCHEMA_REGISTRY_HOST_NAME: schema-registry
      SCHEMA_REGISTRY_KAFKASTORE_BOOTSTRAP_SERVERS: 'broker:9092'

  ksqldb-server:
    image: confluentinc/ksqldb-server:0.17.0
    hostname: ksqldb-server
    container_name: ksqldb-server
    depends_on:
      - broker
      - schema-registry
    ports:
      - "8088:8088"
    environment:
      KSQL_CONFIG_DIR: "/etc/ksqldb"
      KSQL_LOG4J_OPTS: "-Dlog4j.configuration=file:/etc/ksqldb/log4j.properties"
      KSQL_BOOTSTRAP_SERVERS: "broker:9092"
      KSQL_HOST_NAME: ksqldb-server
      KSQL_LISTENERS: "http://0.0.0.0:8088"
      KSQL_CACHE_MAX_BYTES_BUFFERING: 0
      KSQL_KSQL_SCHEMA_REGISTRY_URL: "http://schema-registry:8081"

  ksqldb-cli:
    image: confluentinc/ksqldb-cli:0.17.0
    container_name: ksqldb-cli
    depends_on:
      - broker
      - ksqldb-server
    entrypoint: /bin/sh
    environment:
      KSQL_CONFIG_DIR: "/etc/ksqldb"
    tty: true
    volumes:
      - ./src:/opt/app/src
      - ./test:/opt/app/test

And launch it by running:

docker-compose up -d

3
Write the program interactively using the CLI

To begin developing interactively, open up the ksqlDB CLI:

docker exec -it ksqldb-cli ksql http://ksqldb-server:8088

First, you’ll need to create a Kafka topic and stream to represent the movie ratings data. The following creates both in one shot. Notice that the stream has 2 partitions and no key set.

CREATE STREAM ratings (old INT KEY, id INT, rating DOUBLE)
    WITH (kafka_topic='ratings',
          partitions=2,
          value_format='avro');

Then insert the ratings data. Because the stream has no key, the records will be inserted in approximately a round-robin manner across the different partitions.

INSERT INTO ratings (old, id, rating) VALUES (1, 294, 8.2);
INSERT INTO ratings (old, id, rating) VALUES (2, 294, 8.5);
INSERT INTO ratings (old, id, rating) VALUES (3, 354, 9.9);
INSERT INTO ratings (old, id, rating) VALUES (4, 354, 9.7);
INSERT INTO ratings (old, id, rating) VALUES (5, 782, 7.8);
INSERT INTO ratings (old, id, rating) VALUES (6, 782, 7.7);
INSERT INTO ratings (old, id, rating) VALUES (7, 128, 8.7);
INSERT INTO ratings (old, id, rating) VALUES (8, 128, 8.4);
INSERT INTO ratings (old, id, rating) VALUES (9, 780, 2.1);

Now that you have a stream, let’s examine what key the Kafka messages have using the PRINT command:

PRINT ratings FROM BEGINNING LIMIT 9;

This should yield roughly the following output. PRINT pulls from all partitions of a topic. The order will be different depending on how the records were actually inserted:

Key format: KAFKA_INT or KAFKA_STRING
Value format: AVRO
rowtime: 2020/05/04 23:24:30.376 Z, key: 1, value: {"ID": 294, "RATING": 8.2}, partition: 0
rowtime: 2020/05/04 23:24:30.684 Z, key: 2, value: {"ID": 294, "RATING": 8.5}, partition: 1
rowtime: 2020/05/04 23:24:30.781 Z, key: 3, value: {"ID": 354, "RATING": 9.9}, partition: 1
rowtime: 2020/05/04 23:24:30.949 Z, key: 4, value: {"ID": 354, "RATING": 9.7}, partition: 1
rowtime: 2020/05/04 23:24:31.099 Z, key: 5, value: {"ID": 782, "RATING": 7.8}, partition: 0
rowtime: 2020/05/04 23:24:30.560 Z, key: 6, value: {"ID": 782, "RATING": 7.7}, partition: 1
rowtime: 2020/05/04 23:24:30.873 Z, key: 7, value: {"ID": 128, "RATING": 8.7}, partition: 1
rowtime: 2020/05/04 23:24:31.021 Z, key: 8, value: {"ID": 128, "RATING": 8.4}, partition: 0
rowtime: 2020/05/04 23:24:31.178 Z, key: 9, value: {"ID": 780, "RATING": 2.1}, partition: 0
Topic printing ceased

Note that the key is null for every message. This means that ratings data for the same movie could be spread across multiple partitions. This is generally not good for scalability when you care about having the same "kind" of data in a single partition.

Let’s fix that. Using KSQL’s appropriately named PARTITION BY clause we can apply a key to the messages and write it to a new stream. Here we’ll use the movie identifier, ID.

First we tell ksqlDB to query data from the beginning of the topic:

SET 'auto.offset.reset' = 'earliest';

Then, issue the following to create a new stream that is continuously populated by its query:

CREATE STREAM RATINGS_REKEYED
    WITH (KAFKA_TOPIC='ratings_keyed_by_id') AS
    SELECT *
    FROM RATINGS
    PARTITION BY ID;

To check that it’s working, let’s first describe the new stream:

DESCRIBE RATINGS_REKEYED;

Your output should resemble:

Name                 : RATINGS_REKEYED
 Field  | Type

 ID     | INTEGER          (key)
 RATING | DOUBLE
 OLD    | INTEGER

For runtime statistics and query details run: DESCRIBE <Stream,Table> EXTENDED;

Note the (key) at the end of the ID row that indicates the column is now stored in the Kafka message’s key.

Next, we can print out the contents of the output stream’s underlying topic to ensure the key has been correctly set.

PRINT ratings_keyed_by_id FROM BEGINNING LIMIT 9;

This should yield the roughly the following output:

Key format: KAFKA_INT
Value format: AVRO
rowtime: 2020/05/04 23:24:30.376 Z, key: 128, value: {"RATING": 8.4, "OLD": 8}, partition: 0
rowtime: 2020/05/04 23:24:30.684 Z, key: 128, value: {"RATING": 8.7, "OLD": 7}, partition: 0
rowtime: 2020/05/04 23:24:30.781 Z, key: 294, value: {"RATING": 8.2, "OLD": 1}, partition: 0
rowtime: 2020/05/04 23:24:30.949 Z, key: 294, value: {"RATING": 8.5, "OLD": 2}, partition: 0
rowtime: 2020/05/04 23:24:31.099 Z, key: 354, value: {"RATING": 9.7, "OLD": 4}, partition: 0
rowtime: 2020/05/04 23:24:30.560 Z, key: 354, value: {"RATING": 9.9, "OLD": 3}, partition: 0
rowtime: 2020/05/04 23:24:30.873 Z, key: 780, value: {"RATING": 2.1, "OLD": 9}, partition: 1
rowtime: 2020/05/04 23:24:31.021 Z, key: 782, value: {"RATING": 7.7, "OLD": 6}, partition: 0
rowtime: 2020/05/04 23:24:31.178 Z, key: 782, value: {"RATING": 7.8, "OLD": 5}, partition: 0
Topic printing ceased

As you can see, the key format is now KAFKA_INT and the ID column in each row has been removed from the value and into the key, meaning the data has be repartitioned such that all movies with the same ID are now in exactly one partition.

4
Write your statements to a file

Now that you have a series of statements that’s doing the right thing, the last step is to put them into a file so that they can be used outside the CLI session. Create a file at src/statements.sql with the following content:

CREATE STREAM ratings (old INT KEY, id INT, rating DOUBLE)
    WITH (kafka_topic='ratings',
          partitions=2,
          value_format='avro');

CREATE STREAM RATINGS_REKEYED
  WITH (KAFKA_TOPIC='ratings_keyed_by_id') AS
    SELECT *
    FROM RATINGS
    PARTITION BY ID;

Test it

1
Create the test data

Create a file at test/input.json with the inputs for testing:

{
  "inputs": [
    {
      "topic": "ratings",
      "key": 1,
      "value": {
        "id": 294,
        "rating": 8.2
      }
    },
    {
      "topic": "ratings",
      "key": 2,
      "value": {
        "id": 294,
        "rating": 8.5
      }
    },
    {
      "topic": "ratings",
      "key": 3,
      "value": {
        "id": 354,
        "rating": 9.9
      }
    },
    {
      "topic": "ratings",
      "key": 4,
      "value": {
        "id": 354,
        "rating": 9.7
      }
    },
    {
      "topic": "ratings",
      "key": 5,
      "value": {
        "id": 782,
        "rating": 7.8
      }
    },
    {
      "topic": "ratings",
      "key": 6,
      "value": {
        "id": 782,
        "rating": 7.7
      }
    },
    {
      "topic": "ratings",
      "key": 7,
      "value": {
        "id": 128,
        "rating": 8.7
      }
    },
    {
      "topic": "ratings",
      "key": 8,
      "value": {
        "id": 128,
        "rating": 8.4
      }
    },
    {
      "topic": "ratings",
      "key": 9,
      "value": {
        "id": 780,
        "rating": 2.1
      }
    }
  ]
}

Similarly, create a file at test/output.json with the expected outputs:

{
  "outputs": [
    {
      "topic": "ratings_keyed_by_id",
      "key": 294,
      "value": {
        "RATING": 8.2,
        "OLD": 1
      }
    },
    {
      "topic": "ratings_keyed_by_id",
      "key": 294,
      "value": {
        "RATING": 8.5,
        "OLD": 2
      }
    },
    {
      "topic": "ratings_keyed_by_id",
      "key": 354,
      "value": {
        "RATING": 9.9,
        "OLD": 3
      }
    },
    {
      "topic": "ratings_keyed_by_id",
      "key": 354,
      "value": {
        "RATING": 9.7,
        "OLD": 4
      }
    },
    {
      "topic": "ratings_keyed_by_id",
      "key": 782,
      "value": {
        "RATING": 7.8,
        "OLD": 5
      }
    },
    {
      "topic": "ratings_keyed_by_id",
      "key": 782,
      "value": {
        "RATING": 7.7,
        "OLD": 6
      }
    },
    {
      "topic": "ratings_keyed_by_id",
      "key": 128,
      "value": {
        "RATING": 8.7,
        "OLD": 7
      }
    },
    {
      "topic": "ratings_keyed_by_id",
      "key": 128,
      "value": {
        "RATING": 8.4,
        "OLD": 8
      }
    },
    {
      "topic": "ratings_keyed_by_id",
      "key": 780,
      "value": {
        "RATING": 2.1,
        "OLD": 9
      }
    }
  ]
}

2
Invoke the tests

Lastly, invoke the tests using the test runner and the statements file that you created earlier:

docker exec ksqldb-cli ksql-test-runner -i /opt/app/test/input.json -s /opt/app/src/statements.sql -o /opt/app/test/output.json

Which should pass:

	 >>> Test passed!

Take it to production

1
Send the statements to the REST API

Launch your statements into production by sending them to the REST API with the following command:

tr '\n' ' ' < src/statements.sql | \
sed 's/;/;\'$'\n''/g' | \
while read stmt; do
    echo '{"ksql":"'$stmt'", "streamsProperties": {}}' | \
        curl -s -X "POST" "http://localhost:8088/ksql" \
             -H "Content-Type: application/vnd.ksql.v1+json; charset=utf-8" \
             -d @- | \
        jq
done

Deploy on Confluent Cloud

1
Run your app to Confluent Cloud

Instead of running a local Kafka cluster, you may use Confluent Cloud, a fully-managed Apache Kafka service.

  1. Sign up for Confluent Cloud, a fully-managed Apache Kafka service.

  2. After you log in to Confluent Cloud Console, click on Add cloud environment and name the environment learn-kafka. Using a new environment keeps your learning resources separate from your other Confluent Cloud resources.

  3. From the Billing & payment section in the Menu, apply the promo code CC100KTS to receive an additional $100 free usage on Confluent Cloud (details).

  4. Click on LEARN and follow the instructions to launch a Kafka cluster and to enable Schema Registry.

Confluent Cloud

Next, from the Confluent Cloud Console, click on Clients to get the cluster-specific configurations, e.g. Kafka cluster bootstrap servers and credentials, Confluent Cloud Schema Registry and credentials, etc., and set the appropriate parameters in your client application.

Now you’re all set to run your streaming application locally, backed by a Kafka cluster fully managed by Confluent Cloud.