Connection management

The Connections section in Yandex WebSQL enables you to:

• Create a connection to public databases or managed database clusters. To learn more about creating connections, see this guide.
• View information about a managed database cluster.
• View information about a connection.
• View information about a database.
• Change connection settings.
• Update a connection.
• Add a connection to a managed database cluster.
• Delete the connection you no longer need.

Viewing information about a managed database clusterViewing information about a managed database cluster

To view cluster settings:

1. Under Connections, select the managed database cluster.
2. Click to the right of the cluster name and select Cluster information.

This will bring up a panel with cluster settings.

Viewing information about a connectionViewing information about a connection

To view connection settings:

1. Under Connections, select the connection.
2. Click to the right of the connection name and select Connection information.

This will bring up a panel with connection settings.

There are groups of tables and views (VIEW) within a single connection. For more information on how to view info about tables and views, see this guide.

Viewing information about a databaseViewing information about a database

To view database settings:

1. Under Connections, select the database.
2. Click to the right of the database name and select Database information.

This will bring up a panel with DB settings.

Changing connection settingsChanging connection settings

Changing connection settings for a managed database clusterChanging connection settings for a managed database cluster

To change connection settings:

1. Under Connections, select the connection.
2. Click to the right of the connection name and select Edit connection.
3. Enter a new name for the connection.
4. In the Cluster field, select the managed database cluster you want to connect to.
5. Specify the Username you will use to connect to cluster databases.
6. To change the password, select the Change password option and enter a new user password.
7. List the Databases you want to connect to. You can only connect to the databases that exist in this cluster. The user you specified must have access to them configured.
8. Click Apply.

Changing connection settings for a public databaseChanging connection settings for a public database

To change connection settings:

1. Under Connections, select the connection.

2. Click to the right of the connection name and select Edit connection.

3. Enter a new name for the connection.

4. Under Hosts, configure the hosts:

   • Specify the database host FQDN and port number for connecting to the database.

   • For ClickHouse®, also specify the Native Protocol port and shard name.

   • (Optional) Enable TLS.

     If your company has a certification authority (CA), the certificate issued by the CA will be used by default. If the company has no CA, upload the server's TLS certificate.

5. Specify the Username you will use to connect to cluster databases.

6. To change the password, select the Change password option and enter a new user password.

7. List the Databases you want to connect to. You can only connect to existing databases. The user you specified must have access to them configured.

8. Click Apply.

Updating a connectionUpdating a connection

In the Connection section, you can view the status of connections and update them or reconnect to databases. Active connections are marked in green, while inactive ones, in red.

Updating an active connectionUpdating an active connection

1. Select the active DB connection.
2. Click to the right of the database name and select Update database.

This will update the entire hierarchy for this database, including tables and views. If a table was deleted from a database, you will need to refresh the connection for the changes to appear in Yandex WebSQL.

To refresh all active connections, click in the top-right corner of the Connection section.

Reconnecting inactive connectionsReconnecting inactive connections

1. Select the inactive connection.
2. Click to the right of the database name and select Reconnect.

Adding a connection to a managed database clusterAdding a connection to a managed database cluster

Connections to databases within a cluster are grouped into an expandable list under the name of that cluster. In the connection settings, such databases will have the same URL and port number.

If you already have a database connection in a cluster, you can add a connection to another database in the same cluster:

1. Under Connections, select the cluster you need in the connection tree.
2. Click to the right of the cluster name and select Add connection.
3. In the window that opens, the Database type and Cluster fields will be automatically filled out. Specify the connection name, database name, and the relevant login credentials.
4. Click Connect.

Deleting a connectionDeleting a connection

1. Under Connections, select the connection.
2. Click to the right of its name and select Delete connection.
3. In the window that opens, click Apply.

The connection will be deleted from both Yandex WebSQL and Connection Manager in Yandex MetaData Hub.

You can also delete a connection from Connection Manager in Yandex MetaData Hub. This connection will be automatically deleted from Yandex WebSQL. Deletion is limited to the user's folder.

ClickHouse® is a registered trademark of ClickHouse, Inc.