Snowflex.Transport behaviour (Snowflex v1.6.0)

Behaviour module that defines the interface for Snowflake transport implementations.

See Snowflex.Transport.Http for the default implementation.

Summary

Types

connection_opts()

cursor()

fetch_result()

query_result()

Callbacks

deallocate(pid)

Clean up cursor state after streaming is complete. See DBConnection.handle_deallocate/4 for more information.

declare(pid, t, any, t)

Declare a statement (primarily for streaming) and return a cursor. See DBConnection.handle_declare/4 for more information.

disconnect(pid)

Disconnect from the database. See DBConnection.handle_close/3 for more information.

execute_statement(pid, t, any, t)

Execute a statement. See DBConnection.handle_execute/4 for more information.

fetch(pid, cursor, t)

Fetch the next result from a cursor. Return {:ok, result} while the cursor may still hold more results and {:halt, result} once it is exhausted. See DBConnection.handle_fetch/4 for more information.

ping(pid)

Periodic pings to the server, default is once per second. See DBConnection.ping/1 for more information.

start_link(connection_opts)

Types

connection_opts()

@type connection_opts() :: Keyword.t()

cursor()

@type cursor() :: term()

fetch_result()

@type fetch_result() ::
  {:ok, Snowflex.Result.t()}
  | {:halt, Snowflex.Result.t()}
  | {:error, Snowflex.Error.t()}

query_result()

@type query_result() :: {:ok, Snowflex.Result.t()} | {:error, Snowflex.Error.t()}

Callbacks

deallocate(pid)

@callback deallocate(pid()) :: :ok

Clean up cursor state after streaming is complete. See DBConnection.handle_deallocate/4 for more information.

declare(pid, t, any, t)

@callback declare(pid(), String.t(), any(), Keyword.t()) ::
  {:ok, cursor()} | {:error, Snowflex.Error.t()}

Declare a statement (primarily for streaming) and return a cursor. See DBConnection.handle_declare/4 for more information.

disconnect(pid)

@callback disconnect(pid()) :: :ok

Disconnect from the database. See DBConnection.handle_close/3 for more information.

execute_statement(pid, t, any, t)

@callback execute_statement(pid(), String.t(), any(), Keyword.t()) :: query_result()

Execute a statement. See DBConnection.handle_execute/4 for more information.

fetch(pid, cursor, t)

@callback fetch(pid(), cursor(), Keyword.t()) :: fetch_result()

Fetch the next result from a cursor. Return {:ok, result} while the cursor may still hold more results and {:halt, result} once it is exhausted. See DBConnection.handle_fetch/4 for more information.

ping(pid)

@callback ping(pid()) :: query_result()

Periodic pings to the server, default is once per second. See DBConnection.ping/1 for more information.

start_link(connection_opts)

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