Schema properties

String

Stores a JSON string.

Example:

name str

format

Test.

mask

A mask or array of masks. Example:

phone str @mask(["(##) #####-####"])

Number

Stores a JSON number.

Example:

name num

Integer

Stores a JSON number.

Example:

name int

Boolean

Stores a JSON boolean.

Example:

is_active bool

Date

Stores a JSON boolean.

Example:

is_active bool

Datetime

Stores a JSON boolean.

Example:

is_active bool

Object

Represents a nested object.

Example:

details {
  properties {
    weight num
  }
}

Reference

Represents a link to a document of another or the same collection. In the database, a ObjectId BSON object is stored.

Example:

created_by User

Array

Properties prefixed with an [] are turned into an array. For example, if you wish to have an array of strings, write []str.

Example:

comments []{
  properties {
    text str
    liked_by []User
  }
}

A special syntax is used to add array constraints.

You may specify a range of minimum and maximum allowed array elements like so:

• [1..3]: minimum 1 element, maximum 3 elements
• [1..]: minimum 1 element, no maximum limit
• [@uniqueItems]: elements can not repeat within the array
• [1.. @uniqueItems]: minimum 1 element, no maximum limit, elements can not repeat within the array