Type alias ReadGraphDocumentOptions

ReadGraphDocumentOptions: {
    allowDirtyRead?: boolean;
    graceful?: boolean;
    rev?: string;
}

Options for retrieving a document from a graph collection.

Type declaration

  • Optional allowDirtyRead?: boolean

    If set to true, the request will explicitly permit ArangoDB to return a potentially dirty or stale result and arangojs will load balance the request without distinguishing between leaders and followers.

    Default: false

  • Optional graceful?: boolean

    If set to true, null is returned instead of an exception being thrown if the document does not exist.

    Default: false

  • Optional rev?: string

    If set to a document revision, the document will only be returned if its _rev property matches this value.

    See also documents.DocumentMetadata.

Settings

Theme