Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "graph"

import type { Graph } from "arangojs/graph";

TODO

Index

Classes

Type aliases

Type aliases

EdgeDefinition

EdgeDefinition: { collection: string; from: string[]; to: string[] }

An edge definition used to define a collection of edges in a Graph.

Type declaration

  • collection: string

    Name of the collection containing the edges.

  • from: string[]

    Array of names of collections containing the start vertices.

  • to: string[]

    Array of names of collections containing the end vertices.

GraphCollectionInsertOptions

GraphCollectionInsertOptions: { returnNew?: undefined | false | true; waitForSync?: undefined | false | true }

TODO

Type declaration

  • Optional returnNew?: undefined | false | true
  • Optional waitForSync?: undefined | false | true

GraphCollectionReadOptions

GraphCollectionReadOptions: { allowDirtyRead?: undefined | false | true; graceful?: undefined | false | true; rev?: undefined | string }

TODO

Type declaration

  • Optional allowDirtyRead?: undefined | false | true
  • Optional graceful?: undefined | false | true
  • Optional rev?: undefined | string

GraphCollectionRemoveOptions

GraphCollectionRemoveOptions: { returnOld?: undefined | false | true; rev?: undefined | string; waitForSync?: undefined | false | true }

TODO

Type declaration

  • Optional returnOld?: undefined | false | true
  • Optional rev?: undefined | string
  • Optional waitForSync?: undefined | false | true

GraphCollectionReplaceOptions

GraphCollectionReplaceOptions: { keepNull?: undefined | false | true; returnNew?: undefined | false | true; returnOld?: undefined | false | true; rev?: undefined | string; waitForSync?: undefined | false | true }

TODO

Type declaration

  • Optional keepNull?: undefined | false | true
  • Optional returnNew?: undefined | false | true
  • Optional returnOld?: undefined | false | true
  • Optional rev?: undefined | string
  • Optional waitForSync?: undefined | false | true

GraphCreateOptions

GraphCreateOptions: { isSmart?: undefined | false | true; minReplicationFactor?: undefined | number; numberOfShards?: undefined | number; orphanCollections?: string[]; replicationFactor?: number | "satellite"; smartGraphAttribute?: undefined | string; waitForSync?: undefined | false | true; writeConcern?: undefined | number }

TODO

Type declaration

  • Optional isSmart?: undefined | false | true

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

    Default: false

  • Optional minReplicationFactor?: undefined | number

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

    deprecated

    Renamed to writeConcern in ArangoDB 3.6.

  • Optional numberOfShards?: undefined | number

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

  • Optional orphanCollections?: string[]

    An array of additional vertex collections. Documents within these collections do not have edges within this graph.

  • Optional replicationFactor?: number | "satellite"

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

    Default: 1

  • Optional smartGraphAttribute?: undefined | string

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

    Note: isSmart must be set to true.

  • Optional waitForSync?: undefined | false | true

    If set to true, the request will wait until everything is synced to disk before returning successfully.

  • Optional writeConcern?: undefined | number

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

GraphInfo

GraphInfo: { _id: string; _key: string; _rev: string; edgeDefinitions: EdgeDefinition[]; isSatellite?: undefined | false | true; isSmart?: undefined | false | true; minReplicationFactor?: undefined | number; name: string; numberOfShards?: undefined | number; orphanCollections: string[]; replicationFactor?: undefined | number; smartGraphAttribute?: undefined | string; writeConcern?: undefined | number }

TODO

Type declaration

  • _id: string
  • _key: string
  • _rev: string
  • edgeDefinitions: EdgeDefinition[]
  • Optional isSatellite?: undefined | false | true

    Enterprise Edition only

  • Optional isSmart?: undefined | false | true

    Enterprise Edition only

  • Optional minReplicationFactor?: undefined | number
    deprecated

    Renamed to writeConcern in ArangoDB 3.6.

  • name: string
  • Optional numberOfShards?: undefined | number
  • orphanCollections: string[]
  • Optional replicationFactor?: undefined | number
  • Optional smartGraphAttribute?: undefined | string

    Enterprise Edition only

  • Optional writeConcern?: undefined | number

Generated using TypeDoc