Type alias CreateGraphOptions

CreateGraphOptions: {
    isDisjoint?: boolean;
    isSmart?: boolean;
    numberOfShards?: number;
    orphanCollections?: (string | ArangoCollection)[] | string | ArangoCollection;
    replicationFactor?: number | "satellite";
    satellites?: (string | ArangoCollection)[];
    smartGraphAttribute?: string;
    waitForSync?: boolean;
    writeConcern?: number;
}

Option for creating a graph.

Type declaration

  • Optional isDisjoint?: boolean

    (Enterprise Edition cluster only.) If set to true, the graph will be created as a Disjoint SmartGraph.

    Default: false

  • Optional isSmart?: boolean

    (Enterprise Edition cluster only.) If set to true, the graph will be created as a SmartGraph.

    Default: false

  • Optional numberOfShards?: number

    (Cluster only.) Number of shards that is used for every collection within this graph.

    Has no effect when replicationFactor is set to "satellite".

  • Optional orphanCollections?: (string | ArangoCollection)[] | string | ArangoCollection

    Additional vertex collections. Documents within these collections do not have edges within this graph.

  • Optional replicationFactor?: number | "satellite"

    (Cluster only.) Replication factor used when initially creating collections for this graph.

    Default: 1

  • Optional satellites?: (string | ArangoCollection)[]

    (Enterprise Edition cluster only.) Collections to be included in a Hybrid SmartGraph.

  • Optional smartGraphAttribute?: string

    (Enterprise Edition cluster only.) Attribute containing the shard key value to use for smart sharding.

  • Optional waitForSync?: boolean

    If set to true, the request will wait until all modifications have been synchronized to disk before returning successfully.

    Default: false

  • Optional writeConcern?: number

    (Cluster only.) Write concern for new collections in the graph.

    Has no effect when replicationFactor is set to "satellite".

Settings

Theme