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 #2170 from aiven/dorota-clickhouse-add-ref-docs
Browse files Browse the repository at this point in the history
clickhouse: add supported table functions and file formats
  • Loading branch information
wojcik-dorota authored Oct 9, 2023
2 parents f5fc07e + 7421db0 commit abad34f
Show file tree
Hide file tree
Showing 4 changed files with 70 additions and 1 deletion.
6 changes: 5 additions & 1 deletion _toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -812,9 +812,13 @@ entries:
title: Reference
entries:
- file: docs/products/clickhouse/reference/supported-table-engines
title: Supported table engines
title: Table engines
- file: docs/products/clickhouse/reference/metrics-list
title: ClickHouse metrics in Grafana
- file: docs/products/clickhouse/reference/supported-table-functions
title: Table functions
- file: docs/products/clickhouse/reference/s3-supported-file-formats
title: S3 file formats
- file: docs/products/clickhouse/reference/supported-input-output-formats
title: Formats for ClickHouse-Kafka data exchange
- file: docs/products/clickhouse/reference/advanced-params
Expand Down
8 changes: 8 additions & 0 deletions docs/products/clickhouse/reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,11 @@ Additional reference information for Aiven for ClickHouse®:
.. grid-item-card:: :doc:`Advanced parameters </docs/products/clickhouse/reference/advanced-params>`
:shadow: md
:margin: 2 2 0 0

.. grid-item-card:: :doc:`File formats for the S3 table function in Aiven for ClickHouse® </docs/products/clickhouse/reference/s3-supported-file-formats>`
:shadow: md
:margin: 2 2 0 0

.. 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
17 changes: 17 additions & 0 deletions docs/products/clickhouse/reference/s3-supported-file-formats.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
File formats for the S3 table function in Aiven for ClickHouse®
===============================================================

The `S3 table function <https://clickhouse.com/docs/en/sql-reference/table-functions/s3>`_ allows you to select and insert data in S3-compatible storages. The S3 table function in Aiven for ClickHouse® can be used with the following file formats:

* ``Arrow``
* ``CSV``
* ``JSON``
* ``TSV``
* ``Parquet``
* ``ORC``
* ``Avro``

.. seealso::

* :doc:`Table functions supported in Aiven for ClickHouse® </docs/products/clickhouse/reference/supported-table-functions>`
* :doc:`Read and pull data from S3 object storages and web resources over HTTP </docs/products/clickhouse/howto/run-federated-queries>`
40 changes: 40 additions & 0 deletions docs/products/clickhouse/reference/supported-table-functions.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
Table functions supported in Aiven for ClickHouse®
==================================================

`Table functions <https://clickhouse.com/docs/en/sql-reference/table-functions>`_ can be used to construct tables, for example, in a FROM clause of a query or in an INSERT INTO TABLE FUNCTION statement.

.. topic:: Sample usage of the S3 table function

.. code-block:: bash
SELECT *
FROM deltaLake('s3://bucket/path/to/lake')
Aiven for ClickHouse® supports the following table functions:

* ``cluster``
* ``clusterAllReplicas``
* ``cosn``
* ``deltaLake``
* ``format``
* ``generateRandom``
* ``hudi``
* ``iceberg``
* ``input``
* ``merge``
* ``mysql``
* ``null``
* ``numbers``
* ``numbers_mt``
* ``postgresql``
* ``remote``
* ``remoteSecure``
* ``s3``
* ``s3Cluster``
* ``url``
* ``values``
* ``view``
* ``viewExplain``
* ``viewIfPermitted``
* ``zeros``
* ``zeros_mt``

0 comments on commit abad34f

Please sign in to comment.