Getting started with Yandex WebSQL

You can connect to managed database clusters from clouds and folders that belong to your Yandex Cloud organization. If you switch to a different organization, you will have access to clusters from other clouds and folders. The connections you added will be available while you are in the current cloud.

Once connected to a database, you will be able to view DB schemas, tables, and views, as well as run queries. It is a web-based tool that simplifies writing queries by suggesting prompts and commands.

Yandex WebSQL supports the following DB versions:

• PostgreSQL: 12 or higher.
• MySQL®: 5 or higher.
• ClickHouse®: 23 or higher.
• Valkey™/Valkey™ (non-sharded clusters only): 6 or higher.
• MongoDB/Yandex StoreDoc: 6 or higher.
• Yandex Managed Service for Trino (currently at the Preview stage): 454 or higher
• Greenplum®: 6 or higher

In this section, you will learn how to connect to:

• Managed database clusters within Yandex Cloud.
• Custom DB installations over the internet.

Getting startedGetting started

1. Go to the management console and log in to Yandex Cloud or sign up if not signed up yet.
2. On the Yandex Cloud Billing page, make sure you have a billing account linked and its status is ACTIVE or TRIAL_ACTIVE. If you do not have a billing account, create one.
3. Select the organization to work with Yandex WebSQL in or create a new one.

How to connect to a managed database cluster within Yandex CloudHow to connect to a managed database cluster within Yandex Cloud

Before creating a connection, make sure you have selected the right folder. If you have access to PostgreSQL, ClickHouse®, MySQL®, Greenplum®, Valkey™, or Yandex StoreDoc clusters previously created in that folder, they will automatically appear in the Yandex Cloud connections subsection. You will only need to create a connection to the appropriate database in the cluster.

WebSQL uses connections in Yandex MetaData Hub Connection Manager, so all connections configured in Connection Manager are automatically available in WebSQL provided that the user has the appropriate roles.

To create a connection to a Yandex Cloud managed database cluster:

1. Make sure WebSQL access is enabled in the cluster settings.
2. Open Yandex WebSQL Connections.
3. In Connections, click .
4. In the Database type field, select the database you need: PostgreSQL, ClickHouse®, MySQL®, Valkey™, Yandex StoreDoc, or Greenplum®.
5. In the Cluster folder field, select the folder hosting the required cluster.
6. In the Cluster field, select the managed database cluster you want to connect to.
7. Specify the Username you will use to connect to cluster databases.
8. Enter the user Password.
9. 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.
10. Click Create.

If the connection is successful, you will see the cluster structure in the connection tree. Connections to databases within a cluster are grouped into an expandable list under the name of that cluster.

How to connect to a custom DB installationHow to connect to a custom DB installation

To connect to a custom DB installation over the internet:

1. Open Yandex WebSQL Connections.

2. In Connections, click .

3. In the bottom-left corner of the window that opens, click External connection.

4. Name the connection.

5. In the Database type field, select the database: PostgreSQL, ClickHouse®, MySQL®, Valkey™, MongoDB, Greenplum®, Valkey™, or Yandex StoreDoc.

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

   • Optionally, 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.

7. Specify the Username you will use to connect to the database.

8. Enter the user Password.

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

10. Click Create.

If the connection is successful, you will see the database structure in the connection tree.

What's nextWhat's next

• Manage connections
• Run queries
• Create query templates
• View query history

ClickHouse® is a registered trademark of ClickHouse, Inc.