arangojs/lib/cjs/graph.d.ts

The official ArangoDB JavaScript driver.

import { ArangoCollection, BaseCollection, CollectionType, DocumentHandle, EdgeCollection } from "./collection";
import { Connection } from "./connection";
export declare class GraphVertexCollection extends BaseCollection {
    type: CollectionType;
    graph: Graph;
    constructor(connection: Connection, name: string, graph: Graph);
    document(documentHandle: DocumentHandle, graceful?: boolean): Promise<any>;
    vertex(documentHandle: DocumentHandle, graceful?: boolean): Promise<any>;
    save(data: any, opts?: {
        waitForSync?: boolean;
    }): Promise<any>;
    replace(documentHandle: DocumentHandle, newValue: any, opts?: any): Promise<any>;
    update(documentHandle: DocumentHandle, newValue: any, opts?: any): Promise<any>;
    remove(documentHandle: DocumentHandle, opts?: any): Promise<any>;
}
export declare class GraphEdgeCollection extends EdgeCollection {
    type: CollectionType;
    graph: Graph;
    constructor(connection: Connection, name: string, graph: Graph);
    document(documentHandle: DocumentHandle, graceful?: boolean): Promise<any>;
    save(data: any, opts?: {
        waitForSync?: boolean;
    }): Promise<any>;
    save(data: any, fromId: DocumentHandle, toId: DocumentHandle, opts?: {
        waitForSync?: boolean;
    }): Promise<any>;
    replace(documentHandle: DocumentHandle, newValue: any, opts?: any): Promise<any>;
    update(documentHandle: DocumentHandle, newValue: any, opts?: any): Promise<any>;
    remove(documentHandle: DocumentHandle, opts?: any): Promise<any>;
}
export declare class Graph {
    name: string;
    private _connection;
    constructor(connection: Connection, name: string);
    get(): Promise<any>;
    exists(): Promise<boolean>;
    create(properties?: any, opts?: {
        waitForSync?: boolean;
    }): Promise<any>;
    drop(dropCollections?: boolean): Promise<any>;
    vertexCollection(collectionName: string): GraphVertexCollection;
    listVertexCollections(opts?: {
        excludeOrphans?: boolean;
    }): Promise<any>;
    vertexCollections(opts?: {
        excludeOrphans?: boolean;
    }): Promise<any>;
    addVertexCollection(collection: string | ArangoCollection): Promise<any>;
    removeVertexCollection(collection: string | ArangoCollection, dropCollection?: boolean): Promise<any>;
    edgeCollection(collectionName: string): GraphEdgeCollection;
    listEdgeCollections(): Promise<any>;
    edgeCollections(): Promise<any>;
    addEdgeDefinition(definition: any): Promise<any>;
    replaceEdgeDefinition(definitionName: string, definition: any): Promise<any>;
    removeEdgeDefinition(definitionName: string, dropCollection?: boolean): Promise<any>;
    traversal(startVertex: DocumentHandle, opts: any): Promise<any>;
}
//# sourceMappingURL=graph.d.ts.map