Подключение с помощью IDE

Yandex Query позволяет выполнять подключения по протоколу Java DataBase Connectivity (JDBC), поэтому для работы с подключениями в Query подходят графические IDE, также поддерживающие этот протокол: например DBeaver, DataGrip или другие.

В этом документе описан процесс подключения с помощью DBeaver, но подключение в рамках любой системы, поддерживающей источники данных JDBC, выполняется аналогично.

DBeaverDBeaver

DBeaver — бесплатный кроссплатформенный инструмент управления базами данных с открытым исходным кодом, который обеспечивает удобный интерфейс для подключения к различным базам данных и выполнения SQL-запросов. Он поддерживает множество баз данных, включая MySQL, PostgreSQL, Oracle, SQLite и другие.

JDBC-драйверJDBC-драйвер

Для подключения к Yandex Query из DBeaver понадобится JDBC-драйвер. Так как Yandex Query построен с помощью федеративных запросов YDB, то для подключения будет использоваться JDBC-драйвер YDB.

Для скачивания драйвера выполните следующие шаги:

1. Перейдите в репозиторий ydb-jdbc-driver.
2. Выберите последний релиз (отмечен тегом Latest) и сохраните файл ydb-jdbc-driver-shaded-<driver-version>.jar.

Подключение JDBC-драйвера к DBeaverПодключение JDBC-драйвера к DBeaver

Для подключения JDBC-драйвера выполните следующие шаги:

1. Выберите в верхнем меню DBeaver пункт База данных, а затем подпункт Управление драйверами:

   

2. Чтобы создать новый драйвер, в открывшемся окне Менеджер Драйверов нажмите кнопку Новый:

   

3. В открывшемся окне Создать драйвер, в поле Имя драйвера, укажите Yandex Query:

   

4. Перейдите в раздел Библиотеки, нажмите кнопку Добавить файл, укажите путь к скачанному ранее JDBC-драйверу YDB и нажмите кнопку OK:

   

5. В списке драйверов появится драйвер Yandex Query. Дважды кликните по новому драйверу и перейдите на вкладку Библиотеки, нажмите кнопку Найти Класс и в выпадающем списке выберите tech.ydb.jdbc.YdbDriver.

   Важно

   Обязательно явно выберите пункт выпадающего списка tech.ydb.jdbc.YdbDriver, нажав на него. В противном случае DBeaver будет считать, что драйвер не был выбран.

   

Создание подключения к Yandex QueryСоздание подключения к Yandex Query

Для создания подключения необходимо выполнить предварительные шаги:

1. Создайте сервисный аккаунт dbeaver с ролью editor.

2. Создайте авторизованный ключ для сервисного аккаунта и сохраните его в файл.

После этого выполните следующие шаги:

1. В DBeaver создайте новое соединение, указав тип соединения Yandex Query.

2. В открывшемся окне перейдите в раздел Главное.

3. В подразделе Общие, в поле ввода JDBC URL, укажите следующий путь:

   jdbc:ydb:grpcs://grpc.yandex-query.cloud.yandex.net:2135/<folder_id>?saFile=<path_to_auth_key_file.json>&useQueryService=false
   

   Где:

   • folder_id — идентификатор каталога, в котором будут выполняться запросы к Yandex Query.
   • path_to_auth_key_file.json — путь к файлу с авторизованным ключом.
   • useQueryService — режим подключения. Yandex Query поддерживает только режим useQueryService=false.

   

4. Нажмите кнопку Тест соединения ... для проверки настроек.

   Если все настройки выполнены правильно, то появится сообщение об успешном тестировании соединения:

   

5. Нажмите кнопку Готово для сохранения соединения.

Работа с Yandex QueryРабота с Yandex Query

С помощью DBeaver можно просматривать список и структуру привязок к данным:

А также выполнять запросы к данным: