arangojs/lib/cjs/collection.d.ts

The official ArangoDB JavaScript driver.

import { Connection } from "./connection";
import { ArrayCursor } from "./cursor";
export declare enum CollectionType {
    DOCUMENT_COLLECTION = 2,
    EDGE_COLLECTION = 3
}
export declare type DocumentHandle = string | {
    _key?: string;
    _id?: string;
};
export declare type IndexHandle = string | {
    id?: string;
};
export declare function isArangoCollection(collection: any): collection is ArangoCollection;
export interface ArangoCollection {
    isArangoCollection: true;
    name: string;
}
export declare const DOCUMENT_NOT_FOUND = 1202;
export declare const COLLECTION_NOT_FOUND = 1203;
export declare abstract class BaseCollection implements ArangoCollection {
    isArangoCollection: true;
    name: string;
    abstract type: CollectionType;
    protected _idPrefix: string;
    protected _connection: Connection;
    constructor(connection: Connection, name: string);
    protected _documentPath(documentHandle: DocumentHandle): string;
    protected _documentHandle(documentHandle: DocumentHandle): string;
    protected _indexHandle(indexHandle: IndexHandle): string;
    protected _get(path: string, qs?: any): Promise<any>;
    protected _put(path: string, body: any): Promise<any>;
    get(): Promise<any>;
    exists(): Promise<boolean>;
    create(properties?: any): Promise<any>;
    properties(): Promise<any>;
    count(): Promise<any>;
    figures(): Promise<any>;
    revision(): Promise<any>;
    checksum(opts?: any): Promise<any>;
    load(count?: boolean): Promise<any>;
    unload(): Promise<any>;
    setProperties(properties: any): Promise<any>;
    rename(name: string): Promise<any>;
    rotate(): Promise<any>;
    truncate(): Promise<any>;
    drop(opts?: any): Promise<any>;
    documentExists(documentHandle: DocumentHandle): Promise<boolean>;
    document(documentHandle: DocumentHandle, graceful?: boolean): Promise<any>;
    replace(documentHandle: DocumentHandle, newValue: any, opts?: any): Promise<any>;
    update(documentHandle: DocumentHandle, newValue: any, opts?: any): Promise<any>;
    bulkUpdate(newValues: any, opts?: any): Promise<any>;
    remove(documentHandle: DocumentHandle, opts?: any): Promise<any>;
    list(type?: string): Promise<any>;
    all(opts?: any): Promise<ArrayCursor>;
    any(): Promise<any>;
    first(opts?: any): Promise<any>;
    last(opts?: any): Promise<any>;
    byExample(example: any, opts?: any): Promise<ArrayCursor>;
    firstExample(example: any): Promise<any>;
    removeByExample(example: any, opts?: any): Promise<any>;
    replaceByExample(example: any, newValue: any, opts?: any): Promise<any>;
    updateByExample(example: any, newValue: any, opts?: any): Promise<any>;
    lookupByKeys(keys: string[]): Promise<any>;
    removeByKeys(keys: string[], options: any): Promise<any>;
    import(data: any, opts?: any): Promise<any>;
    indexes(): Promise<any>;
    index(indexHandle: IndexHandle): Promise<any>;
    createIndex(details: any): Promise<any>;
    dropIndex(indexHandle: IndexHandle): Promise<any>;
    createCapConstraint(opts?: any): Promise<any>;
    createHashIndex(fields: string[] | string, opts?: any): Promise<any>;
    createSkipList(fields: string[] | string, opts?: any): Promise<any>;
    createPersistentIndex(fields: string[] | string, opts?: any): Promise<any>;
    createGeoIndex(fields: string[] | string, opts?: any): Promise<any>;
    createFulltextIndex(fields: string[] | string, minLength?: number): Promise<any>;
    fulltext(attribute: any, query: any, opts?: any): Promise<ArrayCursor>;
}
export interface DocumentSaveOptions {
    waitForSync?: boolean;
    returnNew?: boolean;
    returnOld?: boolean;
    overwrite?: boolean;
    silent?: boolean;
}
export declare class DocumentCollection extends BaseCollection {
    type: CollectionType;
    constructor(connection: Connection, name: string);
    save(data: any, opts?: DocumentSaveOptions | boolean): Promise<any>;
}
export declare class EdgeCollection extends BaseCollection {
    type: CollectionType;
    constructor(connection: Connection, name: string);
    protected _documentPath(documentHandle: DocumentHandle): string;
    edge(documentHandle: DocumentHandle, graceful?: boolean): Promise<any>;
    save(data: any, opts?: DocumentSaveOptions | boolean): Promise<any>;
    save(data: any, fromId: DocumentHandle, toId: DocumentHandle, opts?: DocumentSaveOptions | boolean): Promise<any>;
    protected _edges(documentHandle: DocumentHandle, direction: any): Promise<any>;
    edges(vertex: DocumentHandle): Promise<any>;
    inEdges(vertex: DocumentHandle): Promise<any>;
    outEdges(vertex: DocumentHandle): Promise<any>;
    traversal(startVertex: DocumentHandle, opts?: any): Promise<any>;
}
export declare function constructCollection(connection: Connection, data: any): DocumentCollection;
//# sourceMappingURL=collection.d.ts.map