Boltx.Query (Boltx v0.0.4)

This module defines a structure to represent Boltx single query.

A Boltx query consists of a statement and additional data (extra).

Summary

Types

Extra contains additional options. Introduced in bolt 3

t()

Types

@type extra() ::
  {:bookmarks, [String.t()] | nil}
  | {:mode, String.t() | nil}
  | {:db, String.t() | nil}
  | {:tx_metadata, String.t() | nil}

Extra contains additional options. Introduced in bolt 3

  • :bookmarks - is a list of strings containing some kind of bookmark identification, e.g., ["neo4j-bookmark-transaction:1", "neo4j-bookmark-transaction:2"]. (default: []).

  • :mode - specifies what kind of server the RUN message is targeting. For write access use "w" and for read access use "r". (default: w).

  • :db - specifies the database name for multi-database to select where the transaction takes place. null and "" denote the server-side configured default database. (default: null) Introduced in bolt 4.0

  • :tx_metadata - is a map that can contain some metadata information, mainly used for logging. (default: null)

@type t() :: %Boltx.Query{extra: extra(), statement: String.t()}