View Source EdgeDB.Protocol.Enums (EdgeDB v0.4.0)

Definition for enumerations used in EdgeDB protocol.

Link to this section Summary

Types

Query capabilities.

Query capabilities.

Cardinality of the query result.

Compilation flags for query to extend it's features.

Compilation flags for query to extend it's features.

Data output format.

Link to this section Types

@type capabilities() :: [capability()]

Query capabilities.

@type capability() ::
  :readonly
  | :modifications
  | :session_config
  | :transaction
  | :ddl
  | :persistent_config
  | :all
  | :execute
  | :legacy_execute

Query capabilities.

Values:

  • :readonly - query is read-only.
  • :modifications - query is not read-only.
  • :session_config - query contains session config change.
  • :transaction - query contains start/commit/rollback of transaction or savepoint manipulation.
  • :ddl - query contains DDL.
  • :persistent_config - server or database config change.
  • :all - all possible capabilities.
  • :execute - capabilities to execute query.
@type cardinality() :: :no_result | :at_most_one | :one | :many | :at_least_one

Cardinality of the query result.

Values:

  • :no_result - query doesn't return anything.
  • :at_most_one - query return an optional single elements.
  • :one - query return a single element.
  • :many - query return a set of elements.
  • :at_least_one - query return a set with at least of one elements.
Link to this type

compilation_flag()

View Source (since 0.4.0)
@type compilation_flag() ::
  :inject_output_type_ids
  | :inject_output_type_names
  | :inject_output_object_ids

Compilation flags for query to extend it's features.

Values:

  • :inject_output_type_ids - inject __tid__ property as .__type__.id alias into returned objects.
  • :inject_output_type_names - inject __tname__ property as .__type__.name alias into returned objects.
  • :inject_output_object_ids - inject id property into returned objects.
Link to this type

compilation_flags()

View Source (since 0.4.0)
@type compilation_flags() :: [compilation_flag()]

Compilation flags for query to extend it's features.

Link to this type

output_format()

View Source (since 0.4.0)
@type output_format() :: :binary | :json | :json_elements | :none

Data output format.

Values:

  • :binary - return data encoded in binary.
  • :json - return data as single row and single field that contains the result set as a single JSON array.
  • :json_elements - return a single JSON string per top-level set element. This can be used to iterate over a large result set efficiently.
  • :none - prevent EdgeDB from returning anything event if EdgeQL query does it.