Skip to content
This repository has been archived by the owner on Jan 29, 2024. It is now read-only.

Commit

Permalink
Merge pull request #2312 from aiven/dorota-clickhouse-supported-proto…
Browse files Browse the repository at this point in the history
…cols-interfaces

clickhouse: add ref doc for supported protocols and drivers
  • Loading branch information
wojcik-dorota authored Nov 30, 2023
2 parents f7cf0f0 + 0874e11 commit 3b193e1
Show file tree
Hide file tree
Showing 3 changed files with 56 additions and 0 deletions.
2 changes: 2 additions & 0 deletions _toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 4 additions & 0 deletions docs/products/clickhouse/reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,3 +28,7 @@ Additional reference information for Aiven for ClickHouse®:
.. grid-item-card:: :doc:`Table functions supported in Aiven for ClickHouse® </docs/products/clickhouse/reference/supported-table-functions>`
:shadow: md
:margin: 2 2 0 0
.. grid-item-card:: :doc:`Interfaces and drivers supported in Aiven for ClickHouse® </docs/products/clickhouse/reference/supported-interfaces-drivers>`
:shadow: md
:margin: 2 2 0 0

Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
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``

.. note::

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 <https://clickhouse.com/docs/en/interfaces/overview>`_.

Drivers (libraries)
-------------------

There are a number of drivers (libraries) that use one of :ref:`the fundamental underlying interfaces supported in Aiven for ClickHouse <clickhouse-interfaces>` 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.

.. seealso::

* Check out :doc:`how to use different drivers (libraries) for connecting to Aiven for ClickHouse </docs/products/clickhouse/howto/list-connect-to-service>`.

* For the full list of drivers and libraries that support connecting to ClickHouse, check out `Drivers and Interfaces <https://clickhouse.com/docs/en/interfaces/overview>`_.

.. note::

You can connect to Aiven for ClickHouse with any driver that uses TLS and one of the supported protocols.

Related reading
---------------

* :doc:`How to connect to Aiven for ClickHouse using different libraries </docs/products/clickhouse/howto/list-connect-to-service>`
* `Drivers and interfaces supported in ClickHouse <https://clickhouse.com/docs/en/interfaces/overview>`_

0 comments on commit 3b193e1

Please sign in to comment.