Type alias GraphInfo

GraphInfo: { edgeDefinitions: EdgeDefinition[]; isDisjoint?: boolean; isSatellite?: boolean; isSmart?: boolean; name: string; numberOfShards?: number; orphanCollections: string[]; replicationFactor?: number; smartGraphAttribute?: string; writeConcern?: number }

General information about a graph.

Type declaration

  • edgeDefinitions: EdgeDefinition[]

    Definitions for the relations of the graph.

  • Optional isDisjoint?: boolean

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

  • Optional isSatellite?: boolean

    (Enterprise Edition cluster only.) If set to true, the graph is a SatelliteGraph.

  • Optional isSmart?: boolean

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

  • name: string

    Name of the graph.

  • Optional numberOfShards?: number

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

  • orphanCollections: string[]

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

  • Optional replicationFactor?: number

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

  • Optional smartGraphAttribute?: string

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

  • Optional writeConcern?: number

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

Settings

Theme

Generated using TypeDoc