View Source ClickHouse.Interface behaviour (ClickHouse v0.30.2)

@callback execute(
  client :: ClickHouse.Client.t(),
  query :: ClickHouse.Query.t(),
  opts :: keyword()
) :: {:ok, ClickHouse.Result.t()} | {:error, ClickHouse.error()}

A callback to execute a query with the network interface.

start_link(keyword)

@callback start_link(keyword()) :: GenServer.on_start()

A callback to start the network interface.

stream_into_next(t, arg2)

@callback stream_into_next(ClickHouse.Stream.t(), {:cont, iodata()} | :done | :halt) ::
  {:ok, ClickHouse.Stream.t() | ClickHouse.Result.t()}
  | {:error, ClickHouse.error()}

A callback to stream the next chunk into the network interface.

stream_into_start(t)

@callback stream_into_start(ClickHouse.Stream.t()) ::
  {:ok, ClickHouse.Stream.t()} | {:error, ClickHouse.error()}

A callback to start streaming a collectable into the network interface.

stream_next(t)

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

A callback to stream the next chunk with the network interface.

stream_start(t)

@callback stream_start(ClickHouse.Stream.t()) ::
  {:ok, ClickHouse.Stream.t()} | {:error, ClickHouse.error()}

A callback to start a query stream with the network interface.

Settings View Source ClickHouse.Interface behaviour (ClickHouse v0.30.2)

Link to this section Summary

Types

Callbacks

Link to this section Types

t()