Container for properties you can access through views. Container specifications give details about storage related details. For instance, how to index the data, and what constraints should be present. You can define a single container to only contain nodes (node), only contain edges (edge), or to contain both (all).

interface ContainerCreateDefinition {
    constraints?: Record<string, ConstraintDefinition>;
    description?: string;
    externalId: string;
    indexes?: Record<string, IndexDefinition>;
    name?: string;
    properties: Record<string, ContainerCorePropertyDefinition>;
    space: string;
    usedFor?: ContainerUsedFor;
}

Properties

constraints?: Record<string, ConstraintDefinition>

Set of constraints to apply to the container. Constraint identifiers must be between 1 and 43 characters long.

description?: string

Description of what the property contains, and how you intend to use it.

externalId: string

External-id of the container. The values Query, Mutation, Subscription, String, Int32, Int64, Int, Float32, Float64, Float, Timestamp, JSONObject, Date, Numeric, Boolean, PageInfo, File, Sequence and TimeSeries are reserved.

indexes?: Record<string, IndexDefinition>

Set of indexes to apply to the container. Up to 10 indexes can be added on a container. Index identifiers must be between 1 and 43 characters long.

name?: string

Readable name for container meant for use in UIs

properties: Record<string, ContainerCorePropertyDefinition>

We index the property by a local unique identifier. The identifier has to have a length of between 1 and 255 characters. It must also match the pattern ^[a-zA-Z0-9][a-zA-Z0-9_-]{0,253}[a-zA-Z0-9]?$ , and it cannot be any of the following reserved identifiers: space, externalId, createdTime, lastUpdatedTime, deletedTime, edge_id, node_id, project_id, property_group, seq, tg_table_name, and extensions. The maximum number of properties depends on the project subscription and is by default 100.

space: string

Id of the space the container belongs to

Should this operation apply to nodes, edges or both.