From 6e394cb94d27e6aeca01091c106ce84652b594f2 Mon Sep 17 00:00:00 2001 From: Dorota Wojcik Date: Wed, 29 Nov 2023 09:44:47 +0100 Subject: [PATCH 1/2] draft --- _toc.yml | 2 ++ docs/products/clickhouse/reference.rst | 4 +++ .../supported-interfaces-drivers.rst | 33 +++++++++++++++++++ 3 files changed, 39 insertions(+) create mode 100644 docs/products/clickhouse/reference/supported-interfaces-drivers.rst diff --git a/_toc.yml b/_toc.yml index b13c341644..33a6bd19ee 100644 --- a/_toc.yml +++ b/_toc.yml @@ -855,6 +855,8 @@ entries: entries: - file: docs/products/clickhouse/reference/supported-table-engines title: Table engines + - file: docs/products/clickhouse/reference/supported-interfaces-drivers + title: Interfaces and drivers - file: docs/products/clickhouse/reference/metrics-list title: ClickHouse metrics in Grafana - file: docs/products/clickhouse/reference/supported-table-functions diff --git a/docs/products/clickhouse/reference.rst b/docs/products/clickhouse/reference.rst index 724adc8807..9b39ba84fa 100644 --- a/docs/products/clickhouse/reference.rst +++ b/docs/products/clickhouse/reference.rst @@ -28,3 +28,7 @@ Additional reference information for Aiven for ClickHouse®: .. grid-item-card:: :doc:`Table functions supported in Aiven for ClickHouse® ` :shadow: md :margin: 2 2 0 0 + .. grid-item-card:: :doc:`Interfaces and drivers supported in Aiven for ClickHouse® ` + :shadow: md + :margin: 2 2 0 0 + diff --git a/docs/products/clickhouse/reference/supported-interfaces-drivers.rst b/docs/products/clickhouse/reference/supported-interfaces-drivers.rst new file mode 100644 index 0000000000..361252330f --- /dev/null +++ b/docs/products/clickhouse/reference/supported-interfaces-drivers.rst @@ -0,0 +1,33 @@ +Interfaces and drivers supported in Aiven for ClickHouse® +===================================================================== + +Find out what technologies and tools you can use to interact with Aiven for ClickHouse®. + +.. _clickhouse-interfaces: + +Interfaces (protocols) +---------------------- + +Aiven for ClickHouse® supports the following fundamental underlying interfaces (protocols): + +* ``HTTPS`` +* ``Native TCP`` +* ``MySQL Interface`` + +.. topic:: Full list of interfaces (protocols) supported in Aiven for ClickHouse + + Check out `Drivers and Interfaces `_ for all the details. + +Drivers (libraries) +------------------- + +There are a number of drivers (libraries) that use one of :ref:`the fundamental underlying interfaces supported in Aiven for ClickHouse ` under the hood. It's up to you to pick up a driver (library) of your choice and use it for connecting to your Aiven for ClickHouse service. + +.. topic:: Full list of drivers (libraries) supported in Aiven for ClickHouse + + Check out `Drivers and Interfaces `_ for all the details. + +Related reading +--------------- + +Check out :doc:`how to connect to Aiven for ClickHouse using different libraries `. From 0874e11ac75aaaaf09838b1c376f3ee4b76defbb Mon Sep 17 00:00:00 2001 From: Dorota Wojcik Date: Wed, 29 Nov 2023 13:42:47 +0100 Subject: [PATCH 2/2] Joe's comments --- .../supported-interfaces-drivers.rst | 27 +++++++++++++++---- 1 file changed, 22 insertions(+), 5 deletions(-) diff --git a/docs/products/clickhouse/reference/supported-interfaces-drivers.rst b/docs/products/clickhouse/reference/supported-interfaces-drivers.rst index 361252330f..ab517ad29e 100644 --- a/docs/products/clickhouse/reference/supported-interfaces-drivers.rst +++ b/docs/products/clickhouse/reference/supported-interfaces-drivers.rst @@ -14,20 +14,37 @@ Aiven for ClickHouse® supports the following fundamental underlying interfaces * ``Native TCP`` * ``MySQL Interface`` -.. topic:: Full list of interfaces (protocols) supported in Aiven for ClickHouse +.. note:: - Check out `Drivers and Interfaces `_ for all the details. + For security reasons, you need TLS (plaintext) to connect to Aiven for ClickHouse. + +.. topic:: Not supported interfaces (protocols) + + * `HTTP` + * `gRPC` + * `PostgreSQL` + +.. seealso:: + + For the full list of interfaces and protocols supported in ClickHouse, check out `Drivers and Interfaces `_. Drivers (libraries) ------------------- There are a number of drivers (libraries) that use one of :ref:`the fundamental underlying interfaces supported in Aiven for ClickHouse ` under the hood. It's up to you to pick up a driver (library) of your choice and use it for connecting to your Aiven for ClickHouse service. -.. topic:: Full list of drivers (libraries) supported in Aiven for ClickHouse +.. seealso:: + + * Check out :doc:`how to use different drivers (libraries) for connecting to Aiven for ClickHouse `. - Check out `Drivers and Interfaces `_ for all the details. + * For the full list of drivers and libraries that support connecting to ClickHouse, check out `Drivers and Interfaces `_. + +.. note:: + + You can connect to Aiven for ClickHouse with any driver that uses TLS and one of the supported protocols. Related reading --------------- -Check out :doc:`how to connect to Aiven for ClickHouse using different libraries `. +* :doc:`How to connect to Aiven for ClickHouse using different libraries ` +* `Drivers and interfaces supported in ClickHouse `_