Azure Cosmos DB Sink Connector for Confluent Cloud

Note

This is a Quick Start for the managed cloud connector.

The Microsoft Azure Cosmos DB Sink connector for Confluent Cloud writes data to a Microsoft Azure Cosmos database. The connector polls data from Apache Kafka® and writes to database containers.

Features

The Azure Cosmos DB Sink connector supports the following features:

  • Topic mapping: Maps the Kafka Topic to the Azure Cosmos DB container.
  • Multiple key strategies:
    • FullKeyStrategy: The ID generated is the Kafka record key. This is the default option.
    • KafkaMetadataStrategy: The ID generated is a concatenation of the Kafka topic, partition, and offset. For example: ${topic}-${partition}-${offset}.
    • ProvidedInKeyStrategy: The ID generated is the id field found in the key object.
    • ProvidedInValueStrategy: The ID generated is the id field found in the value object. Every record must have (lower case) id field. This is an Azure Cosmos DB requirement. See the lower case id prerequisite.

The following shows an example of each strategy and the resulting id in Azure Cosmos.

ID Strategies

ID strategies

For more information and examples to use with the Confluent Cloud API for Connect, see the Confluent Cloud API for Connect section.

Limitations

Be sure to review the following information.

Quick Start

Use this quick start to get up and running with the Confluent Cloud Azure Cosmos DB Sink connector. The quick start provides the basics of selecting the connector and configuring it to stream Kafka events to an Azure Cosmos DB container.

Prerequisites
  • Authorized access to a Confluent Cloud cluster on Azure.

  • The Confluent CLI installed and configured for the cluster. See Install the Confluent CLI.

  • Schema Registry must be enabled to use a Schema Registry-based format (for example, Avro, JSON_SR (JSON Schema), or Protobuf). See Schema Registry Enabled Environments for additional information.

  • At least one source Kafka topic must exist in your Confluent Cloud cluster before creating the sink connector.

  • The Azure Cosmos DB and the Kafka cluster must be in the same region.

  • The Azure Cosmos DB requires an id field in every record. See ID strategies for an example of how each of these works. The following strategies are provided to generate the ID:

    • FullKeyStrategy: The ID generated is the Kafka record key. This is the default option.

    • KafkaMetadataStrategy: The ID generated is a concatenation of the Kafka topic, partition, and offset. For example: ${topic}-${partition}-${offset}.

    • ProvidedInKeyStrategy: The ID generated is the id field found in the key object.

    • ProvidedInValueStrategy: The ID generated is the id field found in the value object. If you select this ID strategy, you must create a new field named id. You can also use the following ksqlDB statement. The example below uses a topic named orders.

      CREATE STREAM ORDERS_STREAM WITH (
         KAFKA_TOPIC = 'orders',
         VALUE_FORMAT = 'AVRO'
         );
      CREATE STREAM ORDER_AUGMENTED AS
         SELECT
            ORDERID AS `id`,
              ORDERTIME,
              ITEMID,
              ORDERUNITS,
              ADDRESS
         FROM  ORDERS_STREAM;
      

Note

  • The connector supports Upsert based on id.
  • The connector does not support Delete for tombstone records.

Using the Confluent Cloud Console

Step 1: Launch your Confluent Cloud cluster.

See the Quick Start for Confluent Cloud for installation instructions.

Step 2: Add a connector.

In the left navigation menu, click Connectors. If you already have connectors in your cluster, click + Add connector.

Step 3: Select your connector.

Click the Azure Cosmos DB sink connector card.

Azure Cosmos DB Sink Connector Card

Step 4: Enter the connector details.

Note

  • Ensure you have all your prerequisites completed.
  • An asterisk ( * ) designates a required entry.

At the Add Azure Cosmos DB Sink Connector screen, complete the following:

If you’ve already populated your Kafka topics, select the topic(s) you want to connect from the Topics list.

To create a new topic, click +Add new topic.

Step 5: Check for records.

Verify that records are being produced in your Azure Cosmos database.

For more information and examples to use with the Confluent Cloud API for Connect, see the Confluent Cloud API for Connect section.

Tip

When you launch a connector, a Dead Letter Queue topic is automatically created. See Confluent Cloud Dead Letter Queue for details.

Using the Confluent CLI

Complete the following steps to set up and run the connector using the Confluent CLI.

Note

  • Make sure you have all your prerequisites completed.
  • The example commands use Confluent CLI version 2. For more information see, Confluent CLI v2.

Step 1: List the available connectors.

Enter the following command to list available connectors:

confluent connect plugin list

Step 2: Show the required connector configuration properties.

Enter the following command to show the required connector properties:

confluent connect plugin describe <connector-catalog-name>

For example:

confluent connect plugin describe CosmosDbSink

Example output:

Following are the required configs:
connector.class: CosmosDbSink
name
input.data.format
kafka.auth.mode
kafka.api.key
kafka.api.secret
connect.cosmos.connection.endpoint
connect.cosmos.master.key
connect.cosmos.databasename
connect.cosmos.containers.topicmap
tasks.max
topics

Step 3: Create the connector configuration file.

Create a JSON file that contains the connector configuration properties. The following example shows the required connector properties.

{
  "name": "CosmosDbSinkConnector_0",
  "config": {
    "connector.class": "CosmosDbSink",
    "name": "CosmosDbSinkConnector_0",
    "input.data.format": "AVRO",
    "kafka.auth.mode": "KAFKA_API_KEY",
    "kafka.api.key": "****************",
    "kafka.api.secret": "**********************************************",
    "topics": "pageviews",
    "connect.cosmos.connection.endpoint": "https://myaccount.documents.azure.com:443/",
    "connect.cosmos.master.key": "****************************************",
    "connect.cosmos.databasename": "myDBname",
    "connect.cosmos.containers.topicmap": "pageviews#Container2",
    "cosmos.id.strategy": "FullKeyStrategy",
    "tasks.max": "1"
  }
}

Note the following property definitions:

  • "connector.class": Identifies the connector plugin name.
  • "input.data.format": Sets the input Kafka record value format (data coming from the Kafka topic). Valid entries are AVRO, JSON_SR, PROTOBUF, or JSON. You must have Confluent Cloud Schema Registry configured if using a schema-based message format (for example, Avro, JSON_SR (JSON Schema), or Protobuf).
  • "name": Sets a name for your new connector.
  • "kafka.auth.mode": Identifies the connector authentication mode you want to use. There are two options: SERVICE_ACCOUNT or KAFKA_API_KEY (the default). To use an API key and secret, specify the configuration properties kafka.api.key and kafka.api.secret, as shown in the example configuration (above). To use a service account, specify the Resource ID in the property kafka.service.account.id=<service-account-resource-ID>. To list the available service account resource IDs, use the following command:

    confluent iam service-account list
    

    For example:

    confluent iam service-account list
    
       Id     | Resource ID |       Name        |    Description
    +---------+-------------+-------------------+-------------------
       123456 | sa-l1r23m   | sa-1              | Service account 1
       789101 | sa-l4d56p   | sa-2              | Service account 2
    
  • "connect.cosmos.connection.endpoint": A URI with the form https://ccloud-cosmos-db-1.documents.azure.com:443/.

  • "connect.cosmos.master.key": The Azure Cosmos master key.

  • "connect.cosmos.databasename": The name of your Cosmos DB.

  • "connect.cosmos.containers.topicmap": A comma-delimited list of Kafka topics mapped to Cosmos DB containers. The mapping between Kafka topics and Azure Cosmos DB containers. For example: topic#container1,topic2#container2.

  • (Optional) "cosmos.id.strategy": Defaults to FullKeyStrategy. Enter one of the following strategies:

    • FullKeyStrategy: The ID generated is the Kafka record key.
    • KafkaMetadataStrategy: The ID generated is a concatenation of the Kafka topic, partition, and offset. For example: ${topic}-${partition}-${offset}.
    • ProvidedInKeyStrategy: The ID generated is the id field found in the key object. Every record must have (lower case) id field. This is an Azure Cosmos DB requirement. See Lower case id prerequisite.
    • ProvidedInValueStrategy: The ID generated is the id field found in the value object. Every record must have (lower case) id field. This is an Azure Cosmos DB requirement. See Lower case id prerequisite.

    See ID strategies for an example of how each of these works.

  • "tasks": The number of tasks to use with the connector. For Confluent Cloud and Confluent Cloud Enterprise, organizations are limited to one task and one connector. Use of this connector is free for a limited time.

Single Message Transforms: See the Single Message Transforms (SMT) documentation for details about adding SMTs using the CLI.

See Configuration Properties for all property values and descriptions.

Step 4: Load the properties file and create the connector.

Enter the following command to load the configuration and start the connector:

confluent connect create --config <file-name>.json

For example:

confluent connect create --config azure-cosmos-sink-config.json

Example output:

Created connector CosmosDbSinkConnector_0 lcc-do6vzd

Step 4: Check the connector status.

Enter the following command to check the connector status:

confluent connect list

Example output:

ID           |             Name              | Status  | Type | Trace
+------------+-------------------------------+---------+------+-------+
lcc-do6vzd   | CosmosDbSinkConnector_0       | RUNNING | sink |       |

Step 5: Check for records.

..Verify that records are populating the endpoint.

For more information and examples to use with the Confluent Cloud API for Connect, see the Confluent Cloud API for Connect section.

Tip

When you launch a connector, a Dead Letter Queue topic is automatically created. See Confluent Cloud Dead Letter Queue for details.

Configuration Properties

Use the following configuration properties with this connector.

Note

These are properties for the managed cloud connector.

How should we connect to your data?

name

Sets a name for your connector.

  • Type: string
  • Valid Values: A string at most 64 characters long
  • Importance: high

Input messages

input.data.format

Sets the input Kafka record value format. Valid entries are AVRO, JSON_SR, PROTOBUF, or JSON. Note that you need to have Confluent Cloud Schema Registry configured if using a schema-based message format like AVRO, JSON_SR, and PROTOBUF.

  • Type: string
  • Importance: high

Kafka Cluster credentials

kafka.auth.mode

Kafka Authentication mode. It can be one of KAFKA_API_KEY or SERVICE_ACCOUNT. It defaults to KAFKA_API_KEY mode.

  • Type: string
  • Default: KAFKA_API_KEY
  • Valid Values: KAFKA_API_KEY, SERVICE_ACCOUNT
  • Importance: high
kafka.api.key
  • Type: password
  • Importance: high
kafka.service.account.id

The Service Account that will be used to generate the API keys to communicate with Kafka Cluster.

  • Type: string
  • Importance: high
kafka.api.secret
  • Type: password
  • Importance: high

Which topics do you want to get data from?

topics

Identifies the topic name or a comma-separated list of topic names.

  • Type: list
  • Importance: high

How should we connect to your Azure Cosmos DB?

connect.cosmos.connection.endpoint

Cosmos endpoint URL. For example: https://connect-cosmosdb.documents.azure.com:443/.

  • Type: string
  • Importance: high
connect.cosmos.master.key

Cosmos connection master (primary) key.

  • Type: password
  • Importance: high
connect.cosmos.databasename

Cosmos target database to write records into.

  • Type: string
  • Importance: high
connect.cosmos.containers.topicmap

A comma delimited list of Kafka topics mapped to Cosmos containers. For example: topic1#con1,topic2#con2.

  • Type: string
  • Importance: high

Database details

cosmos.id.strategy

The IdStrategy class name to use for generating a unique document id (id). FullKeyStrategy uses the full record key as ID. KafkaMetadataStrategy uses a concatenation of the kafka topic, partition, and offset as ID, with dashes as separator. i.e. ${topic}-${partition}-${offset}. ProvidedInKeyStrategy and ProvidedInValueStrategy use the id field found in the key and value objects respectively as ID.

  • Type: string
  • Default: FullKeyStrategy
  • Valid Values: FullKeyStrategy, KafkaMetadataStrategy, ProvidedInKeyStrategy, ProvidedInValueStrategy
  • Importance: low

Number of tasks for this connector

tasks.max
  • Type: int
  • Valid Values: [1,…]
  • Importance: high

Next Steps

See also

For an example that shows fully-managed Confluent Cloud connectors in action with Confluent Cloud ksqlDB, see the Cloud ETL Demo. This example also shows how to use Confluent CLI to manage your resources in Confluent Cloud.

../_images/topology.png