How to connect to AlloyDB Data from IntelliJ

The CData JDBC Driver for AlloyDB enables you to access AlloyDB as a JDBC data source, providing integration with rapid development tools in IDEs. This article shows how to use the data source configuration wizard to connect to AlloyDB data in IntelliJ.

Create a JBDC Data Source for AlloyDB

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

1. In the Data Sources window, right-click and then click Add Data Source -> DB Data Source.

2. In the Data Source Properties dialog that appears, the following properties are required:

   • JDBC Driver Files: Click the button next to this menu to add the JDBC Driver file cdata.jdbc.alloydb.jar, located in the installation directory.
   • JDBC Driver Class: In this menu, select cdata.jdbc.alloydb.AlloyDBDriver from the list.

   • Database URL: Enter the connection URL in the JDBC URL property. The URL must start with jdbc:alloydb: and includes connection properties separated with semicolons.

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

     • Server: The host name or IP of the server hosting the AlloyDB database.
     • 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.

     You can also optionally set the following:

     • Database: The database to connect to when connecting to the AlloyDB Server. If this is not set, the user's default database will be used.
     • Port: The port of the server hosting the AlloyDB database. This property is set to 5432 by default.

     Authenticating with 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.

     Authenticating with pg_hba.conf Auth Schemes

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

     Find instructions about authentication setup on the AlloyDB Server here.

     Authenticating with MD5 Authentication

     This authentication method must be enabled by setting the auth-method in the pg_hba.conf file to md5.

     Authenticating with SASL Authentication

     This authentication method must be enabled by setting the auth-method in the pg_hba.conf file to scram-sha-256.

     Authenticating with Kerberos

     The authentication with Kerberos is initiated by AlloyDB Server when the ∏ is trying to connect to it. You should set up Kerberos on the AlloyDB Server to activate this authentication method. Once you have Kerberos authentication set up on the AlloyDB Server, see the Kerberos section of the help documentation for details on how to authenticate with Kerberos.

     Built-in Connection String Designer

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

     java -jar cdata.jdbc.alloydb.jar

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

     A typical JDBC URL is the following:

     jdbc:alloydb:User=alloydb;Password=admin;Database=alloydb;Server=127.0.0.1;Port=5432

Edit and Save AlloyDB Data

To discover schema information, right-click the data source you just created and click Refresh Tables. To query a table, right-click it and then click Open Tables Editor. You can also modify records in the Table Editor.