Interfaz gRPC

Documentación de la interfaz gRPC de ClickHouse

​

Introducción

ClickHouse admite la interfaz gRPC. Es un sistema de llamada a procedimientos remotos de código abierto que utiliza HTTP/2 y Protocol Buffers. La implementación de gRPC en ClickHouse admite:

• SSL;
• autenticación;
• sesiones;
• compresión;
• consultas paralelas a través del mismo canal;
• cancelación de consultas;
• obtención de información de progreso y logs;
• tablas externas.

La especificación de la interfaz se describe en clickhouse_grpc.proto.

​

Configuración de gRPC

Para usar la interfaz gRPC, establezca grpc_port en la configuración principal del servidor. Consulte las demás opciones de configuración en el siguiente ejemplo:

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

        <!-- Los dos archivos siguientes se usan solo si SSL está habilitado -->
        <ssl_cert_file>/path/to/ssl_cert_file</ssl_cert_file>
        <ssl_key_file>/path/to/ssl_key_file</ssl_key_file>

        <!-- Indica si el servidor solicita un certificado al cliente -->
        <ssl_require_client_auth>false</ssl_require_client_auth>

        <!-- El siguiente archivo se usa solo si ssl_require_client_auth=true -->
        <ssl_ca_cert_file>/path/to/ssl_ca_cert_file</ssl_ca_cert_file>

        <!-- Algoritmo de compresión predeterminado (se aplica si el cliente no especifica otro algoritmo; consulte result_compression en QueryInfo).
             Algoritmos admitidos: none, deflate, gzip, stream_gzip -->
        <compression>deflate</compression>

        <!-- Nivel de compresión predeterminado (se aplica si el cliente no especifica otro nivel; consulte result_compression en QueryInfo).
             Niveles admitidos: none, low, medium, high -->
        <compression_level>medium</compression_level>

        <!-- Límites de tamaño de mensaje de envío/recepción en bytes. -1 significa ilimitado -->
        <max_send_message_size>-1</max_send_message_size>
        <max_receive_message_size>-1</max_receive_message_size>

        <!-- Habilitar si se desean obtener registros detallados -->
        <verbose_logs>false</verbose_logs>
    </grpc>

​

Cliente incluido

Puede escribir un cliente en cualquiera de los lenguajes de programación compatibles con gRPC usando la especificación proporcionada. O bien, puede usar un cliente de Python incluido. Se encuentra en utils/grpc-client/clickhouse-grpc-client.py dentro del repositorio. El cliente incluido requiere los módulos de Python grpcio and grpcio-tools.

El cliente admite los siguientes argumentos:

• --help – Muestra un mensaje de ayuda y finaliza.
• --host HOST, -h HOST – Un nombre de servidor. Valor predeterminado: localhost. También puede usar direcciones IPv4 o IPv6.
• --port PORT – Un puerto al que conectarse. Este puerto debe estar habilitado en la configuración del servidor de ClickHouse (consulte grpc_port). Valor predeterminado: 9100.
• --user USER_NAME, -u USER_NAME – Un nombre de usuario. Valor predeterminado: default.
• --password PASSWORD – Una contraseña. Valor predeterminado: cadena vacía.
• --query QUERY, -q QUERY – Una consulta que se procesará al usar el modo no interactivo.
• --database DATABASE, -d DATABASE – Una base de datos predeterminada. Si no se especifica, se usa la base de datos actual configurada en la configuración del servidor (default de forma predeterminada).
• --format OUTPUT_FORMAT, -f OUTPUT_FORMAT – Un formato de salida para el resultado. Valor predeterminado en modo interactivo: PrettyCompact.
• --debug – Habilita la visualización de información de depuración.

Para ejecutar el cliente en modo interactivo, llámelo sin el argumento --query.

En modo por lotes, los datos de la consulta pueden pasarse mediante stdin.

Ejemplo de uso del cliente

En el siguiente ejemplo, se crea una tabla y se carga con datos desde un archivo CSV. Luego se consulta el contenido de la tabla.

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 │
└────┴───────────────────────┘