About Yandex WebSQL
Yandex WebSQL is a Yandex Cloud service that allows you to connect to public databases and managed database clusters.
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.
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 Yandex Cloud organization.
Yandex WebSQL supports the following DB versions:
- PostgreSQL: 12 and higher
- MySQL®: 5 and higher
- ClickHouse®: 23 and higher
- Redis (non-sharded clusters only): 6 and higher
GUI
To work with Yandex WebSQL, use:
- Control panel: Far-left panel with icons for Connections, Saved queries, and Query history.
- Connections: Panel for viewing existing database connections and adding new ones.
- Data panel: Far-right panel where you can build queries and view the results of their execution, as well as view connection settings and DB object information.
In the Yandex WebSQL interface, the URL of the current page automatically includes the IDs of the Yandex WebSQL entities you open. This enables you to share a direct link to a cluster, connection, database, saved query, or historical query in Yandex WebSQL with other users.
For example, while using Yandex WebSQL, you saved a query and want to share it with another user. To do this, go to the Saved queries section, select the query you need, and copy its URL from the address bar.
The URL will look like this:https://websql.yandex.cloud/folders/<your_folder_ID>/saved-queries/<saved_query_ID>`This link will take the user directly to the page with the saved query in Yandex WebSQL.
Connections
In Yandex WebSQL, you can create, use, and manage DB connections. In the Connections section, you can work with the following types of connections:
- Connections to Yandex Cloud clusters: Connections to databases in managed database clusters via the Yandex Cloud internal network. Such clusters do not necessarily have to be publicly available.
- External connections: Connections to public databases over the internet.
The Yandex Cloud connections subsection automatically displays PostgreSQL, ClickHouse®, MySQL®, and Redis clusters from the current folder if the user has access to them. You can select a different folder in the bar above the Connections section. The list of clusters will update automatically.
Connections to databases within a single managed database cluster are grouped into an expandable list under the name of that cluster. You cannot change this name in Yandex WebSQL but you can update the cluster name in the managed database service. The Connections section will automatically show this update.
External connections are not grouped together even if they share the same DB host address.
Yandex WebSQL also supports integration with Yandex MetaData Hub at the user folder level. Connections created in Yandex WebSQL automatically appear in Yandex MetaData Hub Connection Manager and vice versa.
You can also edit connection settings and delete connections you no longer need. After you connect to a DB, you can monitor schemas, tables, and views (VIEW). Tables and views within one connection are grouped together. Grouping of views is available if there is at least one view in the DB.
Queries
For each database, you can run queries using tooltips: start typing a query command and select the suitable one from the drop-down list. You can also use ready-made templates or save your queries as custom templates.
Query history allows you to see and repeat your previous queries.
To learn more about running queries, see this guide.
Saved queries
A saved query is a query saved as a template. You can save any query. It will appear in the Saved queries section on the control panel.
To learn more about using saved queries, see this guide.
Historical queries
Historical queries are queries executed in your Yandex Cloud organization within the current connection session. They are displayed in the Query history section. Next to each query, you can find its status:
- : Query executed successfully.
- : Query execution failed.
- : Unexpected error on the Yandex WebSQL side.
To learn more about handling historical queries, see this guide.