JDBC Driver for Azure Synapse

Build 22.0.8389

Connecting from Code

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

Connecting with the DriverManager

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

Load the Driver

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

Establish a Connection

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

Connection conn = DriverManager.getConnection("jdbc:azuresynapse:user=myuser;password=mypassword;Server=localhost;Database=Northwind;");
Alternatively, you can prepare the connection options using a Properties object. Pass the Properties object to the DriverManager.
Properties prop = new Properties();
prop.setProperty("user","myuser");
prop.setProperty("password","mypassword");
prop.setProperty("Server","localhost");
prop.setProperty("Database","Northwind");

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

Connecting with the AzureSynapseDataSource Class

You can use the AzureSynapseDataSource 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:

AzureSynapseDataSource ds = new AzureSynapseDataSource("cdata.jdbc.azuresynapse.AzureSynapseDriver", "jdbc:azuresynapse:UseConnectionPooling=true;user=myuser;password=mypassword;Server=localhost;Database=Northwind;"); 
Connection conn = ds.getConnection();

Copyright (c) 2022 CData Software, Inc. - All rights reserved.
Build 22.0.8389