Properties - Data Definition (DDL)

CREATE PROPERTY

Define a new property.

[ WITH with-item [, ...] ]
{CREATE|ALTER} {TYPE|LINK} SourceName "{"
  [ ... ]
  CREATE [{REQUIRED | OPTIONAL}] [{SINGLE | MULTI}]
    PROPERTY name
    [ EXTENDING base [, ...] ] -> type
    [ "{" subcommand; [...] "}" ] ;
  [ ... ]
"}"

Computable property form:

[ WITH with-item [, ...] ]
{CREATE|ALTER} {TYPE|LINK} SourceName "{"
  [ ... ]
  CREATE [{REQUIRED | OPTIONAL}] [{SINGLE | MULTI}]
    PROPERTY name := expression;
  [ ... ]
"}"

Abstract property form:

[ WITH with-item [, ...] ]
CREATE ABSTRACT PROPERTY [module::]name [EXTENDING base [, ...]]
[ "{" subcommand; [...] "}" ]

where subcommand is one of

  SET default := expression
  SET readonly := {true | false}
  CREATE ANNOTATION annotation-name := value
  CREATE CONSTRAINT constraint-name ...

Description

{CREATE|ALTER} {TYPE|LINK} ... CREATE PROPERTY defines a new concrete property for a given object type or link.

There are three forms of CREATE PROPERTY, as shown in the syntax synopsis above. The first form is the canonical definition form, the second form is a syntax shorthand for defining a computable property, and the third is a form to define an abstract property item. The abstract form allows creating the property in the specified module. Concrete property forms are always created in the same module as the containing object or property.

Parameters

Most sub-commands and options of this command are identical to the SDL property declaration. The following subcommands are allowed in the CREATE PROPERTY block:

SET default := expression

Specifies the default value for the property as an EdgeQL expression. Other than a slight syntactical difference this is the same as the corresponding SDL declaration.

SET readonly := {true | false}

Specifies whether the property is considered read-only. Other than a slight syntactical difference this is the same as the corresponding SDL declaration.

CREATE ANNOTATION annotation-name := value

Set property annotation-name to value.

See CREATE ANNOTATION for details.

CREATE CONSTRAINT

Define a concrete constraint on the property. See CREATE CONSTRAINT for details.

Examples

Define a new link address on the User object type:

Copy

ALTER TYPE User {
    CREATE PROPERTY address -> str
};

Define a new property number_of_connections as a computable on the User object type counting the number of interests:

Copy

ALTER TYPE User {
    CREATE PROPERTY number_of_connections :=
        count(.interests)
};

Define a new abstract link orderable with weight property:

Copy

CREATE ABSTRACT LINK orderable {
    CREATE PROPERTY weight -> std::int64
};

ALTER PROPERTY

Change the definition of a property.

[ WITH with-item [, ...] ]
{CREATE | ALTER} {TYPE | LINK} source "{"
  [ ... ]
  ALTER PROPERTY name
  [ "{" ] subcommand; [...] [ "}" ];
  [ ... ]
"}"


[ WITH with-item [, ...] ]
ALTER ABSTRACT PROPERTY [module::]name
[ "{" ] subcommand; [...] [ "}" ];

where subcommand is one of

  SET default := expression
  RESET default
  SET readonly := {true | false}
  RESET readonly
  RENAME TO newname
  EXTENDING ...
  SET REQUIRED
  SET OPTIONAL
  RESET OPTIONALITY
  SET SINGLE
  SET MULTI
  RESET CARDINALITY
  SET TYPE typename [USING (<conversion-expr)]
  RESET TYPE
  USING (computable-expr)
  CREATE ANNOTATION annotation-name := value
  ALTER ANNOTATION annotation-name := value
  DROP ANNOTATION annotation-name
  CREATE CONSTRAINT constraint-name ...
  ALTER CONSTRAINT constraint-name ...
  DROP CONSTRAINT constraint-name ...

Description

{CREATE|ALTER} {TYPE|LINK} ... CREATE PROPERTY defines a new concrete property for a given object type or link.

ALTER ABSTRACT PROPERTY changes the definition of an abstract property item.

Parameters

source: The name of an object type or link on which the property is defined. May be optionally qualified with module.
name: The unqualified name of the property to modify.
module: Optional name of the module to create or alter the abstract property in. If not specified, the current module is used.

The following subcommands are allowed in the ALTER LINK block:

RENAME TO newname

Change the name of the property to newname. All concrete properties inheriting from this property are also renamed.

EXTENDING ...

Alter the property parent list. The full syntax of this subcommand is:

EXTENDING name [, ...]
   [ FIRST | LAST | BEFORE parent | AFTER parent ]

This subcommand makes the property a child of the specified list of parent property items. The requirements for the parent-child relationship are the same as when creating a property.

It is possible to specify the position in the parent list using the following optional keywords:

FIRST – insert parent(s) at the beginning of the parent list,
LAST – insert parent(s) at the end of the parent list,
BEFORE <parent> – insert parent(s) before an existing parent,
AFTER <parent> – insert parent(s) after an existing parent.

SET REQUIRED

Make the property required.

SET OPTIONAL

Make the property no longer required (i.e. make it optional).

RESET OPTIONALITY

Reset the optionality of the property to the default value (OPTIONAL), or, if the property is inherited, to the value inherited from properties in supertypes.

SET SINGLE

Change the maximum cardinality of the property set to one. Only valid for concrete properties.

SET MULTI

Change the maximum cardinality of the property set to greater than one. Only valid for concrete properties;

RESET CARDINALITY

Reset the maximum cardinality of the property to the default value (SINGLE), or, if the property is inherited, to the value inherited from properties in supertypes.

SET TYPE typename [USING (<conversion-expr)]

Change the type of the property to the specified typename. The optional USING clause specifies a conversion expression that computes the new property value from the old. The conversion expression must return a singleton set and is evaluated on each element of MULTI properties. A USING clause must be provided if there is no implicit or assignment cast from old to new type.

RESET TYPE

Reset the type of the property to the type inherited from properties of the same name in supertypes. It is an error to RESET TYPE on a property that is not inherited.

USING (computable-expr)

Change the expression of a computable property. Only valid for concrete properties.

ALTER ANNOTATION annotation-name;

Alter property annotation annotation-name. See ALTER ANNOTATION for details.

DROP ANNOTATION annotation-name;

Remove property annotation-name. See DROP ANNOTATION for details.

ALTER CONSTRAINT constraint-name ...

Alter the definition of a constraint for this property. See ALTER CONSTRAINT for details.

DROP CONSTRAINT constraint-name;

Remove a constraint from this property. See DROP CONSTRAINT for details.

RESET default

Remove the default value from this property, or reset it to the value inherited from a supertype, if the property is inherited.

RESET readonly

Set property writability to the default value (writable), or, if the property is inherited, to the value inherited from properties in supertypes.

All the subcommands allowed in the CREATE PROPERTY block are also valid subcommands for ALTER PROPERTY block.

Examples

Set the title annotation of property address of object type User to "Home address":

Copy

ALTER TYPE User {
    ALTER PROPERTY address
        CREATE ANNOTATION title := "Home address";
};

Add a maximum-length constraint to property address of object type User:

Copy

ALTER TYPE User {
    ALTER PROPERTY address {
        CREATE CONSTRAINT max_len_value(500);
    };
};

Rename the property weight of link orderable to sort_by:

Copy

ALTER ABSTRACT LINK orderable {
    ALTER PROPERTY weight RENAME TO sort_by;
};

Redefine the computable property number_of_connections to be the number of friends:

Copy

ALTER TYPE User {
    ALTER PROPERTY number_of_connections USING (
        count(.friends)
    )
};

DROP PROPERTY

Remove a property from the schema.

[ WITH with-item [, ...] ]
{CREATE|ALTER} TYPE TypeName "{"
  [ ... ]
  DROP LINK name
  [ ... ]
"}"


[ WITH with-item [, ...] ]
DROP ABSTRACT PROPERTY name ;

Description

ALTER {TYPE|LINK} DROP PROPERTY removes the specified property from its containing object type or link. All properties that inherit from this property are also removed.

DROP ABSTRACT PROPERTY removes the specified abstract property item from the schema.

Example

Remove property address from type User:

Copy

ALTER TYPE User {
    DROP PROPERTY address;
};