EdgeDB
v0.6.1

View Source EdgeDB.NamedTuple (EdgeDB v0.6.1)

An immutable value representing an EdgeDB named tuple value.

EdgeDB.NamedTuple implements Access behavior to access fields by index or key and Enumerable protocol for iterating over tuple values.

iex(1)> {:ok, client} = EdgeDB.start_link()
iex(2)> nt = EdgeDB.query_required_single!(client, "select (a := 1, b := 'a', c := [3])")
#EdgeDB.NamedTuple<a: 1, b: "a", c: [3]>
iex(3)> nt[:b]
"a"
iex(4)> nt["c"]
[3]
iex(4)> nt[0]
1

Link to this section Summary

Types

t()

An immutable value representing an EdgeDB named tuple value.

Functions

keys(named_tuple)

Get named tuple keys.

to_map(named_tuple)

Convert a named tuple into a regular map.

to_tuple(nt)

Convert a named tuple to a regular erlang tuple.

Link to this section Types

Link to this opaque

t()

View Source (opaque) 
@opaque t()

An immutable value representing an EdgeDB named tuple value.

Link to this section Functions

Link to this function

keys(named_tuple)

View Source 
@spec keys(t()) :: [String.t()]

Get named tuple keys.

iex(1)> {:ok, client} = EdgeDB.start_link()
iex(2)> nt = EdgeDB.query_required_single!(client, "select (a := 1, b := 'a', c := [3])")
iex(3)> EdgeDB.NamedTuple.keys(nt)
["a", "b", "c"]
Link to this function

to_map(named_tuple)

View Source (since 0.3.0) 
@spec to_map(t()) :: %{required(String.t()) => term()}

Convert a named tuple into a regular map.

iex(1)> {:ok, client} = EdgeDB.start_link()
iex(2)> nt = EdgeDB.query_required_single!(client, "select (a := 1, b := 'a', c := [3])")
iex(3)> EdgeDB.NamedTuple.to_map(nt)
%{"a" => 1, "b" => "a", "c" => [3]}
Link to this function

to_tuple(nt)

View Source 
@spec to_tuple(t()) :: tuple()

Convert a named tuple to a regular erlang tuple.

iex(1)> {:ok, client} = EdgeDB.start_link()
iex(2)> nt = EdgeDB.query_required_single!(client, "select (a := 1, b := 'a', c := [3])")
iex(3)> EdgeDB.NamedTuple.to_tuple(nt)
{1, "a", [3]}