Connect to Cosmos DB Data from a Connection Pool in JBoss

CData JDBC drivers can be configured in JBoss by following the standard procedure for connection pooling. This article details how to access Cosmos DB data from a connection pool in JBoss applications. This article details how to use the JBoss Management Interface to configure the CData JDBC Driver for Cosmos DB. You will then access Cosmos DB data from a connection pool.

Create a JDBC Data Source for Cosmos DB from the Management Console

Follow the steps below to add the driver JAR and define required connection properties.

1. In the Runtime menu, select the Domain or Server menu, depending on whether you are deploying to a managed domain or to a stand-alone server, and click "Manage deployments" to open the Deployments page.
2. Click Add. In the resulting wizard, add the JAR file and license for the driver, located in the lib subfolder of the installation directory. Finish the wizard with the defaults, select the driver, and click Enable.
3. In the Configuration menu, click Subsystems -> Connector -> Datasources. This opens the JDBC Datasources page.
4. Click Add and, in the resulting wizard, enter a name for the driver and the JNDI name. For example: java:jboss/root/jdbc/CosmosDB
5. Select the driver that you added above.

6. Enter the JDBC URL and the username and password. The syntax of the JDBC URL is jdbc:cosmosdb: followed by a semicolon-separated list of connection properties.

   To obtain the connection string needed to connect to a Cosmos DB account using the SQL API, log in to the Azure Portal, select Azure Cosmos DB, and select your account. In the Settings section, click Connection String and set the following values:

   • AccountEndpoint: The Cosmos DB account URL from the Keys blade of the Cosmos DB account
   • AccountKey: In the Azure portal, navigate to the Cosmos DB service and select your Azure Cosmos DB account. From the resource menu, go to the Keys page. Find the PRIMARY KEY value and set AccountKey to this value.

   Built-in Connection String Designer

   For assistance in constructing the JDBC URL, use the connection string designer built into the Cosmos DB JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

   java -jar cdata.jdbc.cosmosdb.jar

   Fill in the connection properties and copy the connection string to the clipboard.

   A typical connection string is below:

   jdbc:cosmosdb:AccountEndpoint=myAccountEndpoint;AccountKey=myAccountKey;
7. Test the connection and finish the wizard. Select the Cosmos DB data source and click Enable.

More JBoss Integration

The steps above show how to configure the driver in a simple connection pooling scenario. For more information, refer to the Data Source Management chapter in the JBoss EAP documentation.