Skip to Content

Azure Cosmos DB connector

Summary

The Azure Cosmos DB connector establishes access to Azure Cosmos DB.

The Azure Cosmos DB connector provides an interface for creating an Azure Cosmos DB connection, the foundation used for generating instances of Azure Cosmos DB activities. These activities, once configured, interact with Azure Cosmos DB through the connection.

The Azure Cosmos DB connector is accessed from the design component palette's Project endpoints and connectors tab (see Design component palette).

Note

This connector can be used only with Private agents. In addition, it is a Connector SDK-based connector, which may be referred to by Jitterbit when communicating changes made to connectors built with the Connector SDK.

Connection documentation

In addition to the Azure Cosmos DB connection, see the comprehensive Azure Cosmos DB connection details page. Configuration details such as these are included on that page:

  • Getting Started: Initial steps for establishing a connection.
  • Advanced Features: User-defined views and SSL configuration.
  • Data Model: The data model that the connector uses to represent the endpoint.
  • Advanced Configurations Properties: Properties that can be defined to configure a connection for both basic and advanced configurations.

Activity documentation

Together, a specific Azure Cosmos DB connection and its activities are referred to as an Azure Cosmos DB endpoint:

Azure Cosmos DB activity types

  • Query: Retrieves records from a table at Azure Cosmos DB and is intended to be used as a source in an operation.

  • Create: Inserts a record into a table at Azure Cosmos DB and is intended to be used as a target in an operation.

  • Update: Updates a record in a table at Azure Cosmos DB and is intended to be used as a target in an operation.

  • Delete: Deletes a record from a table at Azure Cosmos DB and is intended to be used as a target in an operation.

  • Execute: Executes a procedure at Azure Cosmos DB and is intended to be used as a target in an operation.

Prerequisites and supported API versions

The Azure Cosmos DB connector requires the use of an agent version 10.1 or later. These agent versions automatically download the latest version of the connector when required.

This connector requires the use of a Private agent.

Refer to the endpoint documentation for information on the schema nodes and fields.

Troubleshooting

If you experience issues with the Azure Cosmos DB connector, these troubleshooting steps are recommended:

  1. Click the Test button in the connection configuration to ensure the connection is successful and to ensure the latest version of the connector is downloaded to the agent (unless using the Disable Auto Connector Update organization policy).

  2. Check the operation logs for any information written during execution of the operation.

  3. Enable operation debug logging for private agents to generate additional log files and data.

  4. Enable connector verbose logging for this connector using this specific configuration entry of logger name and level:

    <logger name="org.jitterbit.connector.verbose.logging.CosmosDB" level="TRACE"/>

  5. Check the agent logs for more information.