ClickHouse.Interface behaviour (ClickHouse v0.17.1) View Source
A behaviour to implement a network interface with a ClickHouse server.
Link to this section Summary
Callbacks
A callback to execute a query with the network interface.
A callback to start the network interface.
A callback to stream the next query results with the network interface.
A callback to start a query result stream with the network interface.
Link to this section Types
Specs
t() :: module()
The ClickHouse network interface.
Link to this section Callbacks
Specs
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.
Specs
start_link(keyword()) :: GenServer.on_start()
A callback to start the network interface.
Specs
stream_next( client :: ClickHouse.Client.t(), result_stream :: ClickHouse.Stream.t() ) :: {:cont, ClickHouse.ResultStream.t()} | {:cont, ClickHouse.ResultStream.t(), ClickHouse.ResultStreamChunk.t()} | {:halt, ClickHouse.ResultStream.t()} | {:error, ClickHouse.error()}
A callback to stream the next query results with the network interface.
Specs
stream_start( client :: ClickHouse.Client.t(), query :: ClickHouse.Query.t(), opts :: keyword() ) :: {:ok, ClickHouse.ResultStream.t()} | {:error, ClickHouse.error()}
A callback to start a query result stream with the network interface.