JDBC Driver for Azure Cosmos DB

Build 22.0.8462

Connecting from Code

This section describes how to connect with the JDBC DriverManager or CosmosDBDataSource interfaces.

Connecting with the DriverManager

When connecting with the DriverManager class, the CData JDBC Driver for Azure Cosmos DB follows the JDBC convention: First, load the CosmosDB driver class. Then, make a connection.

Load the Driver

The following step is optional per the JDBC 4.0 specification.
Class.forName("cdata.jdbc.cosmosdb.CosmosDBDriver");

Establish a Connection

Provide the connection string with the getConnection method of the static DriverManager class. Start the connection string with "jdbc:cosmosdb:". A typical connection string is the following:

Connection conn = DriverManager.getConnection("jdbc:cosmosdb:AccountEndpoint=myAccountEndpoint;AccountKey=myAccountKey;");
Alternatively, you can prepare the connection options using a Properties object. Pass the Properties object to the DriverManager.
prop.setProperty("AccountEndpoint","myAccountEndpoint");
prop.setProperty("AccountKey","myAccountKey");

Connection conn = DriverManager.getConnection("jdbc:cosmosdb:",prop);

Connecting with the CosmosDBDataSource Class

You can use the CosmosDBDataSource class to create pooled connections, as shown in the following example. See Connection Pooling for more information.

The following example instantiates a pooled Connection object:

CosmosDBDataSource ds = new CosmosDBDataSource("jdbc:cosmosdb:UseConnectionPooling=true;AccountEndpoint=myAccountEndpoint;AccountKey=myAccountKey;"); 
Connection conn = ds.getConnection();

Copyright (c) 2023 CData Software, Inc. - All rights reserved.
Build 22.0.8462