weaviate-client
    Preparing search index...

    Interface Data<T>

    interface Data<T> {
        deleteById: (id: string) => Promise<boolean>;
        deleteMany: <V extends boolean = false>(
            where: FilterValue,
            opts?: DeleteManyOptions<V>,
        ) => Promise<DeleteManyReturn<V>>;
        exists: (id: string) => Promise<boolean>;
        ingest: (
            objs: Iterable<DataObject<T> | NonReferenceInputs<T>>,
        ) => Promise<BatchObjectsReturn<T>>;
        insert: (obj?: NonReferenceInputs<T> | InsertObject<T>) => Promise<string>;
        insertMany: (
            objects: (DataObject<T> | NonReferenceInputs<T>)[],
        ) => Promise<BatchObjectsReturn<T>>;
        referenceAdd: <P extends Properties>(
            args: ReferenceArgs<P>,
        ) => Promise<void>;
        referenceAddMany: <P extends Properties>(
            refs: ReferenceArgs<P>[],
        ) => Promise<BatchReferencesReturn>;
        referenceDelete: <P extends Properties>(
            args: ReferenceArgs<P>,
        ) => Promise<void>;
        referenceReplace: <P extends Properties>(
            args: ReferenceArgs<P>,
        ) => Promise<void>;
        replace: (obj: ReplaceObject<T>) => Promise<void>;
        update: (obj: UpdateObject<T>) => Promise<void>;
    }

    Type Parameters

    • T
    Index

    Properties

    deleteById deleteMany exists ingest insert insertMany referenceAdd referenceAddMany referenceDelete referenceReplace replace update

    Properties

    deleteById: (id: string) => Promise<boolean>
    deleteMany: <V extends boolean = false>(
        where: FilterValue,
        opts?: DeleteManyOptions<V>,
    ) => Promise<DeleteManyReturn<V>>
    exists: (id: string) => Promise<boolean>
    ingest: (
        objs: Iterable<DataObject<T> | NonReferenceInputs<T>>,
    ) => Promise<BatchObjectsReturn<T>>
    insert: (obj?: NonReferenceInputs<T> | InsertObject<T>) => Promise<string>

    Insert a single object into the collection.

    If you don't provide any options to the function, then an empty object will be created.

    Type Declaration

    insertMany: (
        objects: (DataObject<T> | NonReferenceInputs<T>)[],
    ) => Promise<BatchObjectsReturn<T>>

    Insert multiple objects into the collection.

    This object does not perform any batching for you. It sends all objects in a single request to Weaviate.

    Type Declaration

    referenceAdd: <P extends Properties>(args: ReferenceArgs<P>) => Promise<void>

    Create a reference between an object in this collection and any other object in Weaviate.

    Type Declaration

    referenceAddMany: <P extends Properties>(
        refs: ReferenceArgs<P>[],
    ) => Promise<BatchReferencesReturn>

    Create multiple references between an object in this collection and any other object in Weaviate.

    This method is optimized for performance and sends all references in a single request.

    Type Declaration

    referenceDelete: <P extends Properties>(args: ReferenceArgs<P>) => Promise<void>

    Delete a reference between an object in this collection and any other object in Weaviate.

    Type Declaration

    referenceReplace: <P extends Properties>(
        args: ReferenceArgs<P>,
    ) => Promise<void>

    Replace a reference between an object in this collection and any other object in Weaviate.

    Type Declaration

    replace: (obj: ReplaceObject<T>) => Promise<void>

    Replace an object in the collection.

    This is equivalent to a PUT operation.

    Type Declaration

    update: (obj: UpdateObject<T>) => Promise<void>

    Update an object in the collection.

    This is equivalent to a PATCH operation.

    Type Declaration

    Settings

    Member Visibility

    On This Page

    Properties