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

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()")

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