О сервисе Yandex WebSQL

Yandex WebSQL — это сервис Yandex Cloud, который позволит вам подключаться к публично доступным БД и кластерам управляемых БД.

Подключившись к БД, вы сможете просматривать схемы, таблицы и представления БД, а также выполнять запросы. Сервис работает в браузере и предлагает удобные подсказки и команды для выполнения запросов.

Вы можете устанавливать подключения к кластерам управляемых БД из облаков и каталогов, которые принадлежат вашей организации Yandex Cloud. Если вы перейдете в другую организацию, то вам будет доступен набор кластеров из других облаков и каталогов. Добавленные подключения будут доступны, пока вы работаете в текущей организации Yandex Cloud.

Yandex WebSQL поддерживает работу со следующими версиями БД:

• PostgreSQL: 12 и выше.
• MySQL®: 5 и выше.
• ClickHouse®: 23 и выше.
• Valkey™ (только нешардированные кластеры): 6 и выше.

Пользовательский интерфейсПользовательский интерфейс

Для работы с Yandex WebSQL используйте:

• Панель управления — крайняя левая панель с иконками Подключения, Сохраненные запросы и История запросов.
• Подключения — панель просмотра существующих и добавления новых подключений к БД.
• Панель данных — крайняя правая панель, на которой можно формировать запросы и просматривать результаты их выполнения, а также просматривать настройки подключений и информацию об объектах БД.

Во время работы в интерфейсе Yandex WebSQL к URL текущей страницы автоматически добавляются идентификаторы сущностей Yandex WebSQL, которые вы открываете. Таким образом вы можете поделиться с другими пользователями прямой ссылкой на кластер, подключение, БД, сохраненный запрос или запрос из истории в сервисе Yandex WebSQL.

Например, во время работы с сервисом Yandex WebSQL вы сохранили запрос и хотите поделиться им с другим пользователем. Для этого вы выбираете нужный запрос в разделе Сохраненные запросы и копируете URL из адресной строки.
URL будет иметь вид:

https://websql.yandex.cloud/folders/<идентификатор_вашего_каталога>/saved-queries/<идентификатор_сохраненного_запроса>`

По этой ссылке нужный пользователь сможет перейти прямо на страницу с сохраненным запросом в сервисе Yandex WebSQL.

ПодключенияПодключения

В Yandex WebSQL вы можете создавать, использовать и контролировать подключения к БД. В разделе Подключения можно работать со следующими типами подключений:

• Подключения к кластерам Yandex Cloud — подключения к БД в кластерах управляемых БД через внутреннюю сеть Yandex Cloud. Такие кластеры необязательно должны быть публично доступными.
• Внешние подключения — подключения к публично доступным БД через Интернет.

В подразделе Подключения Yandex Cloud автоматически отображаются кластеры PostgreSQL, ClickHouse®, MySQL® и Valkey™ из текущего каталога, если у пользователя есть доступ к ним. В строке над разделом Подключения вы можете выбрать другой каталог. Список кластеров обновится автоматически.

Подключения к БД одного кластера управляемых БД группируются в разворачивающийся список под именем этого кластера. Изменить это имя в Yandex WebSQL нельзя, но вы можете изменить имя кластера в сервисе управляемых БД. Это изменение автоматически отразится в разделе Подключения.

Внешние подключения не группируются, даже если адрес хоста БД одинаков.

Yandex WebSQL также поддерживает интеграцию с сервисом Yandex MetaData Hub на уровне каталога пользователя. Созданные в Yandex WebSQL подключения автоматически появляются в Connection Manager сервиса Yandex MetaData Hub и наоборот.

Вы также можете редактировать настройки подключения и удалять ненужные подключения. После подключения к БД вы сможете просматривать схемы, таблицы и представления (VIEW). Таблицы и представления в рамках одного подключения объединяются в группы. Группировка представлений доступна, если в БД есть хотя бы одно представление.

ЗапросыЗапросы

Для каждой БД можно выполнять запросы с использованием подсказок: начните вводить команду запроса и выберите подходящую из выпадающего списка. Вы также можете использовать готовые шаблоны запросов или сохранять свои запросы в виде пользовательских шаблонов.

С помощью истории запросов можно посмотреть, какие запросы вы выполняли ранее, и повторить их.

Подробнее о выполнении запросов см. в инструкции.

Сохраненные запросыСохраненные запросы

Сохраненный запрос — это запрос, сохраненный в качестве шаблона. Вы можете сохранить любой запрос. Он будет доступен в разделе Сохраненные запросы на панели управления.

Подробнее о работе с сохраненными запросами см. в инструкции.

Запросы из историиЗапросы из истории

Запросы из истории — это запросы, выполненные в вашей организации Yandex Cloud в рамках текущей сессии подключения. Они отображаются в разделе История запросов. Рядом с запросом отображается статус запроса:

• — запрос выполнен успешно;
• — запрос не удалось выполнить;
• — произошла непредвиденная ошибка на стороне Yandex WebSQL.

Подробнее о работе с запросами из истории см. в инструкции.