gRPC-интерфейс

Документация по gRPC-интерфейсу в ClickHouse

​

Введение

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

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

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

​

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

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

<grpc_port>9100</grpc_port>
    <grpc>
        <enable_ssl>false</enable_ssl>

        <!-- Следующие два файла используются только при включённом SSL -->
        <ssl_cert_file>/path/to/ssl_cert_file</ssl_cert_file>
        <ssl_key_file>/path/to/ssl_key_file</ssl_key_file>

        <!-- Запрашивает ли сервер сертификат у клиента -->
        <ssl_require_client_auth>false</ssl_require_client_auth>

        <!-- Следующий файл используется только при ssl_require_client_auth=true -->
        <ssl_ca_cert_file>/path/to/ssl_ca_cert_file</ssl_ca_cert_file>

        <!-- Алгоритм сжатия по умолчанию (применяется, если клиент не указал другой алгоритм; см. result_compression в QueryInfo).
             Поддерживаемые алгоритмы: none, deflate, gzip, stream_gzip -->
        <compression>deflate</compression>

        <!-- Уровень сжатия по умолчанию (применяется, если клиент не указал другой уровень; см. result_compression в QueryInfo).
             Поддерживаемые уровни: none, low, medium, high -->
        <compression_level>medium</compression_level>

        <!-- Ограничения на размер отправляемых/получаемых сообщений в байтах. -1 означает без ограничений -->
        <max_send_message_size>-1</max_send_message_size>
        <max_receive_message_size>-1</max_receive_message_size>

        <!-- Включите для получения подробных журналов -->
        <verbose_logs>false</verbose_logs>
    </grpc>

​

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

Вы можете написать клиент на любом из языков программирования, поддерживаемых gRPC, используя предоставленную спецификацию. Или можно использовать встроенный клиент Python. Он находится в utils/grpc-client/clickhouse-grpc-client.py в репозитории. Для встроенного клиента требуются Python-модули grpcio and 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 – Формат вывода результата. Значение по умолчанию для интерактивного режима: PrettyCompact.
• --debug – Включает вывод отладочной информации.

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

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

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

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

Query

./clickhouse-grpc-client.py -q "CREATE TABLE grpc_example_table (id UInt32, text String) ENGINE = MergeTree() ORDER BY id;"
echo -e "0,Input data for\n1,gRPC protocol example" > a.csv
cat a.csv | ./clickhouse-grpc-client.py -q "INSERT INTO grpc_example_table FORMAT CSV"

./clickhouse-grpc-client.py --format PrettyCompact -q "SELECT * FROM grpc_example_table;"

Response

┌─id─┬─text──────────────────┐
│  0 │ Input data for        │
│  1 │ gRPC protocol example │
└────┴───────────────────────┘