JDBC Driver for AlloyDB

Build 23.0.8839

Establishing a Connection

Creating a JDBC Data Source

You can create a JDBC data source to connect from your Java application. Creating a JDBC data source based on the CData JDBC Driver for AlloyDB consists of three basic steps:

  • Add the driver JAR file to the classpath. The JAR file is located in the lib subfolder of the installation directory. Note that the .lic file must be located in the same folder as the JAR file.
  • Provide the driver class. For example:
  • Provide the JDBC URL. For example:

    The second format above can be used whenever there is a conflict in your application between drivers using the same URL format to ensure you are using the CData driver. The URL must start with either "jdbc:alloydb:" or "jdbc:cdata:alloydb:" and can include any of the connection properties in name-value pairs separated with semicolons.

Connecting to AlloyDB

The following connection properties are required in order to connect to AlloyDB.

  • Server: The host name or IP of the server hosting the AlloyDB database.
  • Port (optional): The port of the server hosting the AlloyDB database. This property is set to 5432 by default.
  • User: The user which will be used to authenticate with the AlloyDB server.
  • Password: The password which will be used to authenticate with the AlloyDB server.
  • Database (optional): The database to connect to when connecting to the AlloyDB Server. If this is not set, the user's default database will be used.

Authenticating to AlloyDB

Standard Authentication

Standard authentication (using the user/password combination supplied earlier) is the default form of authentication.

No further action is required to leverage Standard Authentication to connect.

pg_hba.conf Auth Schemes

There are additional methods of authentication supported by the driver which must be enabled in the pg_hba.conf file on the AlloyDB server.

You may find instructions about authentication setup on the AlloyDB Server here.


You can authenticate using MD5 password verification by setting the auth-method in the pg_hba.conf file to md5.


The driver can authenticate by verifying the password with SASL (particularly, SCRAM-SHA-256).

To use this authentication method, set the auth-method in the pg_hba.conf file to scram-sha-256.


The authentication with Kerberos is initiated by AlloyDB Server when the CData JDBC Driver for AlloyDB is trying to connect to it. Set up Kerberos on the AlloyDB Server to activate this authentication method. Once you have Kerberos authentication set up on the AlloyDB server, see Using Kerberos for details regarding how to authenticate with Kerberos by the driver.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 23.0.8839