Returns a specification to start this module under a supervisor.

See Supervisor.

Returns a pool name which can be used to acquire a connection from a pool of servers responsible with a specific type of operations: read, write and route, or all of the above: "direct"

peek into the main Router state, and return the internal state controlling the connections to the server/server. Mostly for internal use or for helping driver developers.

The authentication credentials will be sanitized, if any

Examples:

iex> Bolt.Sips.info() %{default: %{connections: %{direct: %{"localhost:7687" => 0}, routing_query: nil, zorba: %{"localhost:7687" => 0}}, user_options: [basic_auth: [username: "**", password: "**"], socket: Bolt.Sips.Socket, port: 7687, routing_context: %{}, schema: "bolt", hostname: "localhost", timeout: 15000, ssl: false, with_etls: false, prefix: :default, url: "bolt://localhost", pool_size: 10, max_overflow: 2, role: :zorba]}}

sends the query (and its parameters) to the server and returns {:ok, Response.t()} or {:error, Error} otherwise

send a query and an associated map of parameters. Returns the server response or an error

send a query and an associated map of parameters with options. Returns the server response or an error The opts keyword list will be passed to DbConnection.execute/4. By default, the query will timeout after 15_000 milliseconds, this may be overriden by setting the timeout option in opts.

The same as query/2 but raises a Exception if it fails. Returns the server response otherwise.

The same as query/3 but raises a Exception if it fails.

The same as query/4 but raises a Exception if it fails.

the registry name used across the various driver components

Rollback a database transaction and release lock on connection.

When inside of a transaction/3 call does a non-local return, using a throw/1 to cause the transaction to enter a failed state and the transaction/3 call returns {:error, reason}. If transaction/3 calls are nested the connection is marked as failed until the outermost transaction call does the database rollback.

Example

{:error, :oops} = Bolt.Sips.transaction(pool, fn(conn) ->
  Bolt.Sips.rollback(conn, :oops)
end)

extract the routing table from the router

Start or add a new Neo4j connection

Options:

• :url- a full url to pointing to a running Neo4j server. Please remember you must specify the scheme used to connect to the server. Valid schemes:bolt,bolt+routingandneo4j - the last two being used for connecting to a Neo4j causal cluster.
• :pool_size - the size of the connection pool. Default: 15
• :timeout - a connection timeout value defined in milliseconds. Default: 15_000
• :ssl-true, if the connection must be encrypted. Default:false
• :prefix- used for differentiating between multiple connections available in the same app. Default::default

Example of valid configurations (i.e. defined in config/dev.exs) and usage:

This is the most basic configuration:

config :bolt_sips, Bolt,
  url: "bolt://localhost:7687"

and if you need to connect to remote servers:

config :bolt_sips, Bolt,
  url: "bolt://Bilbo:Baggins@hobby-hobbits.dbs.graphenedb.com:24786",
  ssl: true,
  timeout: 15_000,

Example with a configuration defined in the config/dev.exs:

opts = Application.get_env(:bolt_sips, Bolt)
{:ok, pid} = Bolt.Sips.start_link(opts)

Bolt.Sips.query!(pid, "CREATE (a:Person {name:'Bob'})")
Bolt.Sips.query!(pid, "MATCH (a:Person) RETURN a.name AS name")
|> Enum.map(&(&1["name"]))

Or defining an ad-hoc configuration:

Example with a configuration defined in the config/dev.exs:

{:ok, _neo} = Bolt.Sips.start_link(url: "bolt://neo4j:test@localhost")

conn = Bolt.Sips.conn()
Bolt.Sips.query!(conn, "return 1 as n")

terminate a pool of connections with the role specified

Example:

  setup do
    {:ok, [main_conn: Bolt.Sips.conn()]}
  end

  test "execute statements in transaction", %{main_conn: main_conn} do
    Bolt.Sips.transaction(main_conn, fn conn ->
      book =
        Bolt.Sips.query!(conn, "CREATE (b:Book {title: "The Game Of Trolls"}) return b")
        |> Response.first()

      assert %{"b" => g_o_t} = book
      assert g_o_t.properties["title"] == "The Game Of Trolls"
      Bolt.Sips.rollback(conn, :changed_my_mind)
    end)

    books = Bolt.Sips.query!(main_conn, "MATCH (b:Book {title: "The Game Of Trolls"}) return b")
    assert Enum.count(books) == 0
  end