Links

Examples

Declare an abstract link “friends_base” with a helpful title:

abstract link friends_base {
    # declare a specific title for the link
    annotation title := 'Close contacts';
}

Declare a concrete link “friends” within a “User” type:

type User {
    required property name -> str;
    property address -> str;
    # define a concrete link "friends"
    multi link friends extending friends_base-> User;

    index on (__subject__.name);
}

abstract type Friendly {
    # this type can have "friends"
    link friends -> Friendly;
}

type User extending Friendly {
    # overload the link target to be User, specifically
    overloaded multi link friends -> User;
    # ... other links and properties
}

Syntax

Define a new link corresponding to the more explicit DDL commands.

 Concrete link form used inside type declaration:
 [ overloaded ] [{required | optional}] [{single | multi}]
   link name
   [ extending base [, ...] ] -> type
   [ "{"
       [ default := expression ; ]
       [ readonly := {true | false} ; ]
       [ on target delete action ; ]
       [ annotation-declarations ]
       [ property-declarations ]
       [ constraint-declarations ]
       ...
     "}" ]


 Computable link form used inside type declaration:
 [{required | optional}] [{single | multi}]
   link name := expression;

 Computable link form used inside type declaration (extended):
 [ overloaded ] [{required | optional}] [{single | multi}]
   link name
   [ extending base [, ...] ] [-> type]
   [ "{"
       USING (expression) ;
       [ annotation-declarations ]
       [ constraint-declarations ]
       ...
     "}" ]

Abstract link form:
 abstract link name [extending base [, ...]]
 [ "{"
     [ readonly := {true | false} ; ]
     [ annotation-declarations ]
     [ property-declarations ]
     [ constraint-declarations ]
     [ index-declarations ]
     ...
   "}" ]

Description

There are several forms of link declaration, as shown in the syntax synopsis above. The first form is the canonical definition form, the second and third forms are used for defining a computable link, and the last one is a form to define an abstract link. The abstract form allows declaring the link directly inside a module. Concrete link forms are always used as sub-declarations for an object type.

The following options are available:

overloaded

If specified, indicates that the link is inherited and that some feature of it may be altered in the current object type. It is an error to declare a link as overloaded if it is not inherited.

required

If specified, the link is considered required for the parent object type. It is an error for an object to have a required link resolve to an empty value. Child links always inherit the required attribute, i.e it is not possible to make a required link non-required by extending it.

optional

This is the default qualifier assumed when no qualifier is specified, but it can also be specified explicitly. The link is considered optional for the parent object type, i.e. it is possible for the link to resolve to an empty value.

multi

Specifies that there may be more than one instance of this link in an object, in other words, Object.link may resolve to a set of a size greater than one.

single

Specifies that there may be at most one instance of this link in an object, in other words, Object.link may resolve to a set of a size not greater than one. single is assumed if nether multi nor single qualifier is specified.

extending base [, ...]

Optional clause specifying the parents of the new link item.

Use of extending creates a persistent schema relationship between the new link and its parents. Schema modifications to the parent(s) propagate to the child.

If the same property name exists in more than one parent, or is explicitly defined in the new link and at least one parent, then the data types of the property targets must be compatible. If there is no conflict, the link properties are merged to form a single property in the new link item.

type

The type must be a valid type expression denoting an object type.

The valid SDL sub-declarations are listed below:

default := expression

Specifies the default value for the link as an EdgeQL expression. The default value is used in an INSERT statement if an explicit value for this link is not specified.

readonly := {true | false}

If true, the link is considered read-only. Modifications of this link are prohibited once an object is created. All of the derived links must preserve the original read-only value.

annotation-declarations

Set link annotation to a given value.

property-declarations

Define a concrete property on the link.

constraint-declarations

Define a concrete constraint on the link.

index-declarations

Define an index for this abstract link. Note that this index can only refer to link properties.