View Source EdgeDB.Result (EdgeDB v0.5.0)
A structure that contains information related to the query result.
It's mostly used in client internally, but user can retrive it along with EdgeDB.Query
struct
from succeed query execution using :raw
option for EdgeDB.query*/4
functions. See EdgeDB.query_option/0
.
Link to this section Summary
Functions
Process the result and extract the data.
Link to this section Types
@type t() :: %EdgeDB.Result{ cardinality: EdgeDB.Protocol.Enums.cardinality(), required: boolean(), set: EdgeDB.Set.t() | [binary()], statement: String.t() | nil }
A structure that contains information related to the query result.
Fields:
:statement
- EdgeQL statement that was executed.:required
- flag specifying that the result should not be empty.:set
- query result.:cardinality
- the expected number of elements in the returned set as a result of the query.
Link to this section Functions
@spec extract(t()) :: {:ok, EdgeDB.Set.t() | term() | :done} | {:error, Exception.t()}
Process the result and extract the data.