CockroachDB Connection

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

CockroachDB is a commercial distributed SQL database management system.

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

Connection Configuration #

Each connection property available in the CockroachDB 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 CockroachDB.

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.

Host #

The host name or IP address of the CockroachDB server.

Port #

The port for the CockroachDB server.

Database #

The name of the CockroachDB Database.

User #

The CockroachDB user account used to authenticate.

Password #

The password used to authenticate the user.

Cluster #

The cluster to connect to when connecting to the CockroachDB server.

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.

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”.