View Source EdgeDB.Query (EdgeDB v0.1.0)
A structure carrying the information related to the query.
It's mostly used in driver internally, but user can retrive it along with EdgeDB.Result
struct
from succeed query execution using :raw
option for EdgeDB.query*/4
functions. See EdgeDB.query_option/0
.
Link to this section Summary
Link to this section Types
Specs
t() :: %EdgeDB.Query{ cached: boolean(), capabilities: EdgeDB.Protocol.Enums.Capabilities.t(), cardinality: EdgeDB.Protocol.Enums.Cardinality.t(), input_codec: EdgeDB.Protocol.Codec.t() | nil, io_format: EdgeDB.Protocol.Enums.IOFormat.t(), output_codec: EdgeDB.Protocol.Codec.t() | nil, params: [any()], required: boolean(), statement: String.t() }
A structure carrying the information related to the query.
Fields:
:statement
- EdgeQL statement for execution.:cardinality
- the expected number of elements in the returned set as a result of the query.:io_format
- the preferred format of the query result.:capabilities
- query capabilities. See RFC for more information.:required
- flag specifying that the result should not be empty.:input_codec
- codec for encoding query parameters.:output_codec
- codec for decoding the query result.:cached
- flag specifying whether the request has already been cached by the connection.:params
- query parameters.