ClickHouse v0.30.0

View Source ClickHouse.Interface.HTTP (ClickHouse v0.30.0)

An interface to interact with a ClickHouse server via HTTP.

Link to this section Summary

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

execute(client, query, opts \\ [])

Executes a query via HTTP.

start_link(opts)

Starts the HTTP network interface.

stream_next(stream)

Streams the next results of a query via HTTP.

stream_start(stream)

Starts a query result stream via HTTP.

Link to this section Functions

Link to this function

child_spec(init_arg)

View Source

Returns a specification to start this module under a supervisor.

See Supervisor.

Link to this function

execute(client, query, opts \\ [])

View Source 
@spec execute(ClickHouse.Client.t(), ClickHouse.Query.t(), keyword()) ::
  {:ok, ClickHouse.Result.t()} | {:error, ClickHouse.error()}

Executes a query via HTTP.

Link to this function

start_link(opts)

View Source 
@spec start_link(keyword()) :: GenServer.on_start()

Starts the HTTP network interface.

Link to this function

stream_next(stream)

View Source 
@spec stream_next(ClickHouse.Stream.t()) ::
  {:cont, ClickHouse.Stream.t()}
  | {:cont, ClickHouse.Stream.t(), iodata()}
  | {:halt, ClickHouse.Stream.t()}
  | {:error, ClickHouse.error()}

Streams the next results of a query via HTTP.

Link to this function

stream_start(stream)

View Source 
@spec stream_start(ClickHouse.Stream.t()) ::
  {:ok, ClickHouse.Stream.t()} | {:error, ClickHouse.error()}

Starts a query result stream via HTTP.