Connect to AlloyDB Data in Aqua Data Studio

The CData JDBC Driver for AlloyDB integrates AlloyDB data with wizards and analytics in IDEs like Aqua Data Studio. This article shows how to connect to AlloyDB data through the connection manager and execute queries.

Create a JDBC Data Source

You can use the connection manager to define connection properties and save them in a new JDBC data source. The AlloyDB data source can then be accessed from Aqua Data Studio tools.

1. In Aqua Data Studio, select Register Server from the Servers menu.
2. In the Register Server form, select the 'Generic - JDBC' connection.
3. Enter the following JDBC connection properties:
   • Name: Enter a name for the data source; for example, AlloyDB.
   • Driver Location: Click the Browse button and select the cdata.jdbc.alloydb.jar file, located in the lib subfolder of the installation directory.
   • Driver: Enter the Driver's class name, cdata.jdbc.alloydb.AlloyDBDriver.

   • URL: Enter the JDBC URL, which starts with jdbc:alloydb: and is followed by a semicolon-separated list of connection properties.

     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.

     👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)
     A typical JDBC URL is below:

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

   👁 The JDBC data source, defined by the JAR path, driver class, and JDBC URL. (QuickBooks is shown.)
   

Query AlloyDB Data

You can now query the tables exposed.