Light
Dark
System
v3latest
v3latest
v2
v1

Constraints

exclusive

Enforce uniqueness among all instances of the containing type

expression

Custom constraint expression

one_of

A list of allowable values

max_value

Maximum value numerically/lexicographically

max_ex_value

Maximum value numerically/lexicographically (exclusive range)

max_len_value

Maximum length (strings only)

min_value

Minimum value numerically/lexicographically

min_ex_value

Minimum value numerically/lexicographically (exclusive range)

min_len_value

Minimum length (strings only)

regexp

Regex constraint (strings only)

constraint

std::expression
std::expression on (expr)

A constraint based on an arbitrary boolean expression.

The expression constraint may be used as in this example to create a custom scalar type:

Copy
scalar type starts_with_a extending str {
    constraint expression on (__subject__[0] = 'A');
}

Example of using an expression constraint based on a couple of object properties to restrict maximum magnitude for a vector:

Copy
type Vector {
    required x: float64;
    required y: float64;
    constraint expression on (
        __subject__.x^2 + __subject__.y^2 < 25
    );
}

constraint

std::one_of
std::one_of(variadic members: anytype)

Specifies a list of allowed values.

Example:

Copy
scalar type Status extending str {
    constraint one_of ('Open', 'Closed', 'Merged');
}

constraint

std::max_value
std::max_value(max: anytype)

Specifies the maximum allowed value.

Example:

Copy
scalar type max_100 extending int64 {
    constraint max_value(100);
}

constraint

std::max_ex_value
std::max_ex_value(max: anytype)

Specifies a non-inclusive upper bound for the value.

Example:

Copy
scalar type maxex_100 extending int64 {
    constraint max_ex_value(100);
}

In the example above, in contrast to the max_value constraint, a value of the maxex_100 type cannot be 100 since the valid range of max_ex_value does not include the value specified in the constraint.

constraint

std::max_len_value
std::max_len_value(max: int64)

Specifies the maximum allowed length of a value.

Example:

Copy
scalar type Username extending str {
    constraint max_len_value(30);
}

constraint

std::min_value
std::min_value(min: anytype)

Specifies the minimum allowed value.

Example:

Copy
scalar type non_negative extending int64 {
    constraint min_value(0);
}

constraint

std::min_ex_value
std::min_ex_value(min: anytype)

Specifies a non-inclusive lower bound for the value.

Example:

Copy
scalar type positive_float extending float64 {
    constraint min_ex_value(0);
}

In the example above, in contrast to the min_value constraint, a value of the positive_float type cannot be 0 since the valid range of mix_ex_value does not include the value specified in the constraint.

constraint

std::min_len_value
std::min_len_value(min: int64)

Specifies the minimum allowed length of a value.

Example:

Copy
scalar type four_decimal_places extending int64 {
    constraint min_len_value(4);
}

constraint

std::regexp
std::regexp(pattern: str)

Limits to string values matching a regular expression.

Example:

Copy
scalar type LettersOnly extending str {
    constraint regexp(r'[A-Za-z]*');
}

See our documentation on regular expression patterns for more information on those.

constraint

std::exclusive

Specifies that the link or property value must be exclusive (unique).

When applied to a multi link or property, the exclusivity constraint guarantees that for every object, the set of values held by a link or property does not intersect with any other such set in any other object of this type.

This constraint is only valid for concrete links and properties. Scalar type definitions cannot include this constraint.

Example:

Copy
type User {
    # Make sure user names are unique.
    required name: str {
        constraint exclusive;
    }

    # Make sure none of the "owned" items belong
    # to any other user.
    multi owns: Item {
        constraint exclusive;
    }
}

Sometimes it’s necessary to create a type where each combination of properties is unique. This can be achieved by defining an exclusive constraint for the type, rather than on each property:

Copy
type UniqueCoordinates {
    required x: int64;
    required y: int64;

    # Each combination of x and y must be unique.
    constraint exclusive on ( (.x, .y) );
}

In principle, many possible expressions can appear in the on (<expr>) clause of the exclusive constraint with a few caveats:

  • The expression can only contain references to the immediate properties or links of the type.

  • No backlinks or long paths are allowed.

  • Only Immutable functions are allowed in the constraint expression.

This constraint also has an additional effect of creating an implicit index on the link or property. This means that in the above example there’s no need to add explicit indexes for the name property.

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.