Documentation

clickhouse.query() function

clickhouse.query() is a user-contributed function maintained by the package author.

clickhouse.query() queries data from ClickHouse using specified parameters.

Function type signature
(
    query: string,
    ?cors: string,
    ?format: string,
    ?limit: A,
    ?max_bytes: B,
    ?url: string,
) => stream[C] where A: Stringable, B: Stringable, C: Record
  • Copy
  • Fill window

For more information, see Function type signatures.

Parameters

url

ClickHouse HTTP API URL. Default is http://127.0.0.1:8123.

query

(Required) ClickHouse query to execute.

limit

Query rows limit. Defaults is 100.

cors

Request remote CORS headers. Defaults is 1.

max_bytes

Query bytes limit. Default is 10000000.

format

Query format. Default is CSVWithNames.

For information about available formats, see ClickHouse formats.

Examples

Query ClickHouse

import "contrib/qxip/clickhouse"

option clickhouse.defaultURL = "https://play@play.clickhouse.com"

clickhouse.query(query: "SELECT version()")
  • Copy
  • Fill window

Was this page helpful?

Thank you for your feedback!


The future of Flux

Flux is going into maintenance mode. You can continue using it as you currently are without any changes to your code.

Read more

New in InfluxDB 3.2

Key enhancements in InfluxDB 3.2 and the InfluxDB 3 Explorer UI is now generally available.

See the Blog Post

InfluxDB 3.2 is now available for both Core and Enterprise, bringing the general availability of InfluxDB 3 Explorer, a new UI that simplifies how you query, explore, and visualize data. On top of that, InfluxDB 3.2 includes a wide range of performance improvements, feature updates, and bug fixes including automated data retention and more.

For more information, check out: