AlloyDB Connection

See the Connector Marketplace topic. Please request your administrator to start a trial or subscribe to the Premium AlloyDB connector.

AlloyDB is a distributed database system designed for high availability and reliability.

This topic describes how to authenticate to AlloyDB and configure any necessary connection properties in the AlloyDB connection connector.

Connection Configuration #

Each connection property available in the AlloyDB connector is explained below.

Connection Name #

The name of the connection to be created should be provided. This is the name that will display on the list of available connections.

Connection Type #

Option to choose between either connecting securely using SSH Tunnel or, proceed with a Direct Connection when connecting to AlloyDB.

If Connection Type value is SSH Tunnel, additional fields will be displayed.

To know more about SSH Tunneling with Gathr, see SSH Tunneling

SSH Tunnel #

If SSH Tunnel is selected, additional configuration parameters will get listed.

SSH Key #

The SSH key should be provided to authenticate the associated SSH host and SSH user.

SSH Host #

Public IP address of your SSH host.

SSH User #

Default SSH username.

If Connection Type value is Direct Connection, then proceed by updating the following fields.

Server #

The server or IP address of the AlloyDB server.

Port #

The port for the AlloyDB server.

User #

The AlloyDB user account used to authenticate.

Password #

The password used to authenticate the user.

Database #

The name of the AlloyDB Database.

Enable SSL #

Option to enable SSL. This field sets whether the connector will attempt to negotiate TLS/SSL connections to the server. By default, the connector checks the server’s certificate against the system’s trusted certificate store.

Upload Keystore File #

If SSL is enabled, a keystore file has to be uploaded using this option.

Advanced Configuration #

This section contains additional configuration parameters.

Visibility #

Visibility restrictions used to filter exposed metadata for tables with privileges granted to them for the current user.

By default, visibility filtering is not applied. Filtering values are case insensitive.

For example, the ‘SELECT,INSERT’ filter is restricting metadata visibility only for those tables which may be accessed by the current user for the SELECT and INSERT operations. Supported privilege values are SELECT, INSERT, UPDATE, DELETE, and REFERENCES.

Add Configuration: Additional properties can be added using this option as key-value pairs.

After entering all the details, click on the TEST button.

If the connection service identification and authentication details are provided correctly, a success message stating “connection available” is generated.

Click on the CREATE button to save the changes.

If the details are incorrect or the server is down, you will get a message “Connection unavailable”.