View Source EdgeDB.Query (EdgeDB v0.4.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

Types

t()

A structure carrying the information related to the query.

Link to this section Types

@type t() :: %EdgeDB.Query{
  cached: boolean(),
  capabilities: EdgeDB.Protocol.Enums.capabilities(),
  cardinality: EdgeDB.Protocol.Enums.cardinality(),
  codec_storage: EdgeDB.Protocol.CodecStorage.t(),
  implicit_limit: non_neg_integer(),
  inline_object_ids: boolean(),
  inline_type_ids: boolean(),
  inline_type_names: boolean(),
  input_codec: EdgeDB.Protocol.Codec.id() | nil,
  is_script: boolean(),
  output_codec: EdgeDB.Protocol.Codec.id() | nil,
  output_format: EdgeDB.Protocol.Enums.output_format(),
  params: [any()],
  required: boolean(),
  statement: String.t()
}

A structure carrying the information related to the query.

Fields:

  • :statement - EdgeQL statement for execution.
  • :output_format - the preferred format of the query result.
  • :implicit_limit - the implicit limit of elements count in the returned set as a result of the query.
  • :inline_type_names - flag specifying that the result objects should contain type name as property.
  • :inline_type_ids - flag specifying that the result objects should contain type ID as property.
  • :inline_object_ids - flag specifying that the result objects should contain ID as property.
  • :cardinality - the expected number of elements in the returned set as a result of the query.
  • :required - flag specifying that the result should not be empty.
  • :is_script - flag specifying that the query statement is a script that shouldn't have any return value.
  • :capabilities - query capabilities. See RFC for more information.
  • :input_codec - codec for encoding query parameters.
  • :output_codec - codec for decoding the query result.
  • :codec_storage - codec storage from connection used by query to encode parameters.
  • :cached - flag specifying whether the request has already been cached by the connection.
  • :params - query parameters.