How to Connect DBeaver to AlloyDB via a JDBC Driver

The CData JDBC Driver for AlloyDB implements JDBC standards that enable third-party tools to interoperate, from wizards in IDEs to business intelligence tools. This article shows how to connect to AlloyDB data with wizards in DBeaver and browse data in the DBeaver GUI.

Create a JDBC Data Source for AlloyDB Data

Follow the steps below to load the driver JAR in DBeaver.

1. Open the DBeaver application and, in the "Database" menu, select the "Driver Manager" option. Click "New" to open the "Create new driver" form.
2. In the Settings tab:
   • Set Driver Name to a user-friendly name for the driver (e.g. CData JDBC Driver for AlloyDB).
   • Set Class Name to the class name for the JDBC driver: cdata.jdbc.alloydb.AlloyDBDriver.
   • Set URL Template to jdbc:alloydb:.
3. In the Libraries tab, click "Add File," navigate to the "lib" folder in the installation directory (C:\Program Files\CData[product_name] XXXX\) and select the JAR file (cdata.jdbc.AlloyDB.jar).

Create a Connection to AlloyDB Data

Follow the steps below to add credentials and other required connection properties.

1. In the "Database" menu, click "New Database Connection."
2. In the "Connect to a database" wizard that results, select the driver you just created (e.g. CData JDBC Driver for AlloyDB) and click "Next >."
3. On the Main tab of the configuration wizard, set the JDBC URL, using the required 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.

   Below is a typical connection string:

   jdbc:alloydb:User=alloydb;Password=admin;Database=alloydb;Server=127.0.0.1;Port=5432
4. Click "Test Connection ..." to ensure you have configured the connection properly.
5. Click "Finish."

Query AlloyDB Data

You can now query information from the tables exposed by the connection: Right-click a Table and then click View Table. The data is available on the Data tab.

More Information & Free Trial