Перейти к основному содержимому
Перейти к основному содержимому

Интерфейс gRPC

Введение​

ClickHouse поддерживает gRPC интерфейс. Это система удалённых вызовов процедур с открытым исходным кодом, использующая HTTP/2 и Protocol Buffers. Реализация gRPC в ClickHouse поддерживает:

  • SSL;
  • аутентификацию;
  • сеансы;
  • сжатие;
  • параллельные запросы через один канал;
  • отмену запросов;
  • получение прогресса и логов;
  • внешние таблицы.

Спецификация интерфейса описана в clickhouse_grpc.proto.

Конфигурация gRPC​

Для использования gRPC интерфейса задайте grpc_port в главном конфигурационном файле сервера. Другие параметры конфигурации приведены в следующем примере:

Встроенный клиент​

Вы можете написать клиент на любом из языков программирования, поддерживаемых gRPC, используя предоставленную спецификацию. Или вы можете использовать встроенный клиент на Python. Он находится в utils/grpc-client/clickhouse-grpc-client.py в репозитории. Встроенный клиент требует Python модули grpcio и grpcio-tools.

Клиент поддерживает следующие аргументы:

  • --help – Показывает сообщение помощи и завершает работу.
  • --host HOST, -h HOST – Имя сервера. Значение по умолчанию: localhost. Вы также можете использовать адреса IPv4 или IPv6.
  • --port PORT – Порт для подключения. Этот порт должен быть включен в конфигурации сервера ClickHouse (см. grpc_port). Значение по умолчанию: 9100.
  • --user USER_NAME, -u USER_NAME – Имя пользователя. Значение по умолчанию: default.
  • --password PASSWORD – Пароль. Значение по умолчанию: пустая строка.
  • --query QUERY, -q QUERY – Запрос, который нужно обработать в неинтерактивном режиме.
  • --database DATABASE, -d DATABASE – База данных по умолчанию. Если не указана, используется текущая база данных, установленная в настройках сервера (по умолчанию default).
  • --format OUTPUT_FORMAT, -f OUTPUT_FORMAT – Формат вывода результата format. Значение по умолчанию для интерактивного режима: PrettyCompact.
  • --debug – Включает отображение отладочной информации.

Чтобы запустить клиент в интерактивном режиме, вызовите его без аргумента --query.

В пакетном режиме данные запроса могут передаваться через stdin.

Пример использования клиента

В следующем примере создаётся таблица и загружается данные из CSV файла. Затем запрашивается содержимое таблицы.

Результат: