Instream v0.9.0 Instream.Connection behaviour
Connection (pool) definition.
All database connections will be made using a user-defined extension of this module.
Example Module
defmodule MyConnection do
use Instream.Connection, otp_app: :my_application
end
Example Configuration
config :my_application, MyConnection,
hosts: [ "primary.example.com", "secondary.example.com" ],
password: "pass",
pool: [ max_overflow: 10, size: 5 ],
port: 8086,
scheme: "http",
username: "root"
Summary
Callbacks
Returns the (internal) pool module
Returns a supervisable pool child_spec
Returns the connection configuration
Executes a query
Executes a reading query
Executes a writing query
Types
Callbacks
Specs
execute(query :: query_type, opts :: Keyword.t) :: any
Executes a query.
Passing [async: true]
in the options always returns :ok.
The command will be executed asynchronously.
Executes a reading query.
See Instream.Connection.execute/2
and Instream.Data.Read.query/2
for a complete list of available options.
Specs
write(payload :: map | [map], opts :: Keyword.t) :: any
Executes a writing query.
See Instream.Connection.execute/2
and Instream.Data.Write.query/2
for a complete list of available options.