DBeaver

DBeaver — кроссплатформенный инструмент для работы с базами данных, предназначенный для разработчиков, администраторов баз данных, аналитиков и всех, кто работает с данными.

Apache Doris принимает запросы по протоколу MySQL. В DBeaver 26.1.1 и более поздних версиях есть источник данных Apache Doris, который позволяет выполнять запросы к внутренним и внешним каталогам.

Если в окне Select your database нет Apache Doris, используйте драйвер MySQL. См. раздел Подключение с помощью драйвера MySQL.

Сценарии использования

• Просмотр каталогов, баз данных, таблиц, представлений и других метаданных Apache Doris.
• Выполнение запросов и анализ данных в редакторе SQL.
• Управление внутренними и внешними каталогами в одном инструменте.
• Просмотр сеансов, системных переменных, привилегий пользователей и другой информации о работе системы.

Предварительные требования

• Установите DBeaver 26.1.1 или более поздней версии с сайта https://dbeaver.com.
• Убедитесь, что кластер Apache Doris доступен по сети и у вас есть адрес хоста FE, порт протокола MySQL, имя пользователя и пароль.
• Для подключения к внешнему каталогу в формате catalog.db используйте Doris 2.1.0 или более поздней версии.

Подключение DBeaver к Doris

Подключение с помощью драйвера Apache Doris (рекомендуется)

Требование к версии

Требуется DBeaver 26.1.1 или более поздней версии.

Шаг 1: Создание подключения к базе данных

Запустите DBeaver.

Нажмите значок плюса (+) в левом верхнем углу или выберите Database > New Database Connection в строке меню. DBeaver откроет окно Connect to a database.

Шаг 2: Выбор драйвера Apache Doris

В окне Select your database найдите или выберите Apache Doris, затем нажмите Next.

Шаг 3: Настройка подключения к Doris

На вкладке Main окна Apache Doris connection settings укажите следующие значения:

Поле	Описание	Пример
Хост	Имя хоста или IP-адрес FE. Если вы используете SSH-туннель, укажите локальный адрес перенаправления.	127.0.0.1
Порт	Порт протокола MySQL на FE. Если вы используете SSH-туннель, укажите локальный порт перенаправления.	9030 или 19030
База данных/схема	Необязательное поле. Целевая база данных. Для подключения непосредственно к внешнему каталогу используйте формат catalog.db.	example_db или hive.example_db
Имя пользователя	Имя пользователя для кластера Doris.	admin
Пароль	Пароль для кластера Doris.	-

Значение Database/Schema определяет, какой каталог и какую базу данных откроет DBeaver:

• Оставьте поле пустым, чтобы после подключения просматривать каталоги и базы данных в навигаторе баз данных.
• Укажите имя базы данных, чтобы открыть её во внутреннем каталоге.
• Укажите catalog.db, чтобы открыть базу данных в заданном внешнем каталоге. DBeaver отобразит таблицы из этого каталога и этой базы данных.

примечание

Для использования формата catalog.db требуется Doris 2.1.0 или более поздней версии.

Подключение к внутреннему каталогу:

Подключение к внешнему каталогу:

Чтобы использовать встроенную в DBeaver поддержку SSH, нажмите SSH, Proxy в правом верхнем углу и настройте туннель. Если вы уже настроили локальное перенаправление портов, укажите локальный адрес и порт в полях Host и Port.

Шаг 4: Проверка и сохранение подключения

Нажмите Test Connection в левом нижнем углу.

Когда DBeaver сообщит об успешном подключении, нажмите OK.

Нажмите Finish, чтобы сохранить подключение.

Шаг 5: Просмотр объектов Doris

Новый источник данных появится в навигаторе баз данных. Разверните его, чтобы просматривать каталоги, базы данных, таблицы и представления Doris.

Настройка свойств драйвера

Драйвер Apache Doris использует MySQL Connector/J для подключения к порту протокола MySQL на FE. По умолчанию используется порт 9030 и пользователь root. Шаблон URL JDBC:

jdbc:mysql://{host}[:{port}]/[{database}]

Класс драйвера:

com.mysql.cj.jdbc.Driver

По умолчанию драйвер задаёт следующие параметры:

connectTimeout=20000
rewriteBatchedStatements=true
useSSL=false
enabledTLSProtocols=TLSv1.2,TLSv1.3

Параметр useSSL=false по умолчанию отключает TLS/SSL. Если на порту протокола MySQL на FE включён TLS и цепочка сертификатов настроена правильно, задайте свойства SSL для MySQL Connector/J в разделе Driver properties. Например:

useSSL=true
sslMode=REQUIRED

Чтобы проверять центр сертификации, настройте хранилище доверенных сертификатов Java (truststore):

sslMode=VERIFY_CA
trustCertificateKeyStoreUrl=file:/path/to/doris-truststore.jks
trustCertificateKeyStorePassword=<password>

Чтобы также проверять имя хоста сервера, используйте:

sslMode=VERIFY_IDENTITY

При использовании VERIFY_IDENTITY значение Host в DBeaver должно совпадать с SAN или CN сертификата.

Подключение с помощью драйвера MySQL

Если в окне Select your database нет Apache Doris, подключитесь с помощью драйвера MySQL.

Шаг 1: Создание подключения к базе данных

Запустите DBeaver.

Нажмите значок плюса (+) в левом верхнем углу или выберите Database > New Database Connection в строке меню. DBeaver откроет окно Connect to a database.

Шаг 2: Выбор драйвера MySQL

В окне Select your database выберите MySQL.

Шаг 3: Настройка подключения к Doris

На вкладке Main окна Connection Settings укажите следующие значения:

Поле	Описание	Пример
Хост сервера	Имя хоста или IP-адрес FE.	127.0.0.1
Порт	Порт протокола MySQL на FE.	9030
База данных	Целевая база данных. Для подключения непосредственно к внешнему каталогу используйте формат catalog.db.	example_db или hive.example_db
Имя пользователя	Имя пользователя для кластера Doris.	admin
Пароль	Пароль для кластера Doris.	-

Значение Database определяет каталог по умолчанию:

• Укажите имя базы данных, чтобы открыть её во внутреннем каталоге.
• Укажите catalog.db, чтобы открыть базу данных в заданном внешнем каталоге. DBeaver отобразит таблицы из этого каталога и этой базы данных.

Если вам нужен прямой доступ к нескольким каталогам, создайте отдельные источники данных Doris.

примечание

Для использования формата catalog.db требуется Doris 2.1.0 или более поздней версии.

Подключение к внутреннему каталогу:

Подключение к внешнему каталогу:

Шаг 4: Проверка и сохранение подключения

Нажмите Test Connection в левом нижнем углу.

Когда DBeaver сообщит об успешном подключении, нажмите OK.

Нажмите Finish, чтобы сохранить подключение.

Шаг 5: Управление базой данных

Новый источник данных появится в навигаторе баз данных. Используйте его для подключения к базе данных и управления ею.

Выбор драйвера и поддерживаемые возможности

Выбор драйвера

Драйвер Apache Doris и драйвер MySQL подключаются к Doris через порт протокола MySQL на FE. Они различаются главным образом тем, как DBeaver представляет метаданные, организует объекты в навигаторе и предоставляет функции администрирования.

При выборе драйвера руководствуйтесь следующими рекомендациями:

Сценарий использования	Рекомендуемый драйвер
Подключение к Doris, выполнение SQL и просмотр баз данных и таблиц	Драйвер Apache Doris
Просмотр внутреннего каталога и нескольких внешних каталогов в одном подключении	Драйвер Apache Doris
В текущей версии DBeaver нет источника данных Apache Doris	Драйвер MySQL
Просмотр разделов «Пользователи», «Диспетчер сеансов» и «Информация о системе»	Драйвер MySQL

Если вы работаете только с внутренним каталогом, оба драйвера позволяют подключаться к Doris и выполнять SQL. Тем не менее рекомендуется использовать драйвер Apache Doris.

Сравнение возможностей

Возможность	Драйвер Apache Doris	Драйвер MySQL
Подключение к Doris и выполнение SQL	Поддерживается	Поддерживается
Просмотр внутреннего каталога	Поддерживается	Поддерживается
Просмотр нескольких каталогов в одном подключении	Поддерживается	Не поддерживается
Просмотр внешних каталогов в навигаторе баз данных	Поддерживается	Не поддерживается
Использование catalog.db в качестве контекста SQL по умолчанию	Поддерживается	Поддерживается
Просмотр таблиц, представлений, столбцов и DDL	Поддерживается	Поддерживается
Редактор SQL и консоль SQL	Поддерживается	Поддерживается
Просмотр данных через интерфейс	Поддерживается	Поддерживается
Вставка данных через интерфейс	Поддерживается	Поддерживается
Просмотр разделов «Пользователи», «Диспетчер сеансов» и «Информация о системе»	Не поддерживается	Поддерживается
Инструменты > Анализ	Не поддерживается	Поддерживается
Инструменты > Очистка таблицы	Не поддерживается	Поддерживается

Область поддержки

В этой таблице поддерживаемые возможности определены явным списком:

• В область поддержки этого документа входят только возможности, явно отмеченные в таблице как «Поддерживается».
• Операции в интерфейсе DBeaver и функции администрирования, не перечисленные в таблице, не поддерживаются.
• При использовании драйвера MySQL наличие функции MySQL в интерфейсе DBeaver не означает, что Doris её поддерживает.
• Разделы «Пользователи», «Диспетчер сеансов» и «Информация о системе» доступны только для чтения. В DBeaver нельзя изменять пользователей, привилегии или сеансы.
• Поддержка Analyse и Truncate распространяется только на меню «Инструменты» DBeaver при использовании драйвера MySQL. При использовании драйвера Apache Doris выполняйте соответствующие SQL-инструкции Doris в редакторе SQL.

Важные ограничения

Ни один из драйверов не поддерживает следующие операции:

• Обновление или удаление существующих данных через интерфейс.
• Создание таблиц через интерфейс.
• Добавление или изменение столбцов через интерфейс.
• Создание или изменение индексов через интерфейс.
• Создание внешних ключей или триггеров через интерфейс.
• Настройка моделей ключей, партиций, бакетов, количества реплик или свойств таблицы через интерфейс.
• Использование разделов «Состояние сеанса», «Глобальное состояние» или «Панель мониторинга».
• Проверка, оптимизация, восстановление или создание дампа базы данных.

Используйте редактор SQL для изменения схем таблиц Doris, а также для обновления или удаления существующих данных.