Light
Dark
System
v4latest
v5dev
v4latest
v3
v2
v1

Casts

There are different ways that casts appear in EdgeQL.

A type cast expression converts the specified value to another value of the specified type:

"<" type ">" expression

The type must be a valid type expression denoting a non-abstract scalar or a container type.

For example, the following expression casts an integer value into a string:

Copy
db> 
select <str>10;
{"10"}

See the type cast operator section for more information on type casting rules.

You can cast a UUID into an object:

Copy
db> 
select <Hero><uuid>'01d9cc22-b776-11ed-8bef-73f84c7e91e7';
{default::Hero {id: 01d9cc22-b776-11ed-8bef-73f84c7e91e7}}

If you try to cast a UUID that no object of the type has as its id property, you’ll get an error:

Copy
db> 
select <Hero><uuid>'aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa';
edgedb error: CardinalityViolationError: 'default::Hero' with id 'aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa' does not exist

Assignment casts happen when inserting new objects. Numeric types will often be automatically cast into the specific type corresponding to the property they are assigned to. This is to avoid extra typing when dealing with numeric value using fewer bits:

Copy
# Automatically cast a literal 42 (which is int64
# by default) into an int16 value.
insert MyObject {
    int16_val := 42
};

If assignment casting is supported for a given pair of types, explicit casting of those types is also supported.

Implicit casts happen automatically whenever the value type doesn’t match the expected type in an expression. This is mostly supported for numeric casts that don’t incur any potential information loss (in form of truncation), so typically from a less precise type, to a more precise one. The int64 to float64 is a notable exception, which can suffer from truncation of significant digits for very large integer values. There are a few scenarios when implicit casts can occur:

  1. Passing arguments that don’t match exactly the types in the function signature:

    Copy
    db> 
    ... 
    with x := <float32>12.34
    select math::ceil(x);
    {13}

    The function math::ceil() only takes int64, float64, bigint, or decimal as its argument. So the float32 value will be implicitly cast into a float64 in order to match a valid signature.

  2. Using operands that don’t match exactly the types in the operator signature (this works the same way as for functions):

    Copy
    db> 
    select 1 + 2.3;
    {3.3}

    The operator + is defined only for operands of the same type, so in the expression above the int64 value 1 is implicitly cast into a float64 in order to match the other operand and produce a valid signature.

  3. Mixing different numeric types in a set:

    Copy
    db> 
    select {1, 2.3, <float32>4.5} is float64;
    {true, true, true}

    All elements in a set have to be of the same type, so the values are cast into float64 as that happens to be the common type to which all the set elements can be implicitly cast. This would work out the same way if union was used instead:

    Copy
    db> 
    select (1 union 2.3 union <float32>4.5) is float64;
    {true, true, true}

If implicit casting is supported for a given pair of types, assignment and explicit casting of those types is also supported.

The UUID-to-object cast is only available in EdgeDB 3.0+.

from to

json

str

float32

float64

int16

int32

int64

bigint

decimal

bool

bytes

uuid

datetime

duration

local_date

local_datetime

local_time

relative_duration

date_duration

enum

object

json

<>

<>

<>

<>

<>

<>

<>

<>

<>

<>

<>

<>

<>

<>

<>

<>

<>

<>

<>

str

<>

<>

<>

<>

<>

<>

<>

<>

<>

<>

<>

<>

<>

<>

<>

<>

<>

:=

float32

<>

<>

impl

<>*

<>*

<>*

<>*

<>

float64

<>

<>

:=

<>*

<>*

<>*

<>*

<>

int16

<>

<>

impl

impl

impl

impl

impl

impl

int32

<>

<>

impl

<>

impl

impl

impl

int64

<>

<>

:=

impl

:=

:=

impl

impl

bigint

impl

decimal

<>

<>

<>

<>

<>

<>

<>

<>

bool

<>

<>

bytes

<>

uuid

<>

<>

<>

datetime

<>

<>

duration

<>

<>

<>

local_date

<>

<>

impl

local_datetime

<>

<>

<>

<>

local_time

<>

<>

relative_duration

<>

<>

<>

<>

date_duration

<>

<>

impl

enum

<>

<>

object

<>

  • <> - can be cast explicitly

  • := - assignment cast is supported

  • impl - implicit cast is supported

  • *- When casting a float type to an integer type, the fractional value naturally cannot be preserved after the cast. When executing this cast, we round to the nearest integer, rounding ties to the nearest even (e.g., 1.5 is rounded up to 2; 2.5 is also rounded to 2).

Light
Dark
System

We use ChatGPT with additional context from our documentation to answer your questions. Not all answers will be accurate. Please join our Discord if you need more help.