@weaviate
    Preparing search index...

    Interface Aliases

    interface Aliases {
        create: (args: CreateAliasArgs) => Promise<void>;
        delete: (alias: string) => Promise<void>;
        get: (alias: string) => Promise<Alias>;
        listAll: (opts?: AliasListAllOptions) => Promise<Alias[] | undefined>;
        update: (args: UpdateAliasArgs) => Promise<void>;
    }
    Index
    create delete get listAll update
    create: (args: CreateAliasArgs) => Promise<void>

    Create alias for a collection.

    The collection must exist prior to aliasing it. One alias cannot be created for multiple collections simultaneously.

    Type Declaration

    delete: (alias: string) => Promise<void>

    Delete a collection alias.

    Type Declaration

      • (alias: string): Promise<void>

      • Parameters

        • alias: string

          Alias definition to delete.

        Returns Promise<void>

        Awaitable promise.

    get: (alias: string) => Promise<Alias>

    Get information about an alias.

    Type Declaration

      • (alias: string): Promise<Alias>

      • Parameters

        • alias: string

          Alias to fetch.

        Returns Promise<Alias>

        Alias definition.

    listAll: (opts?: AliasListAllOptions) => Promise<Alias[] | undefined>

    List all aliases defined in the schema.

    Type Declaration

    update: (args: UpdateAliasArgs) => Promise<void>

    Replace target collection the alias points to.

    To change the alias that points to the collection, delete the alias and create a new one.

    Type Declaration

      • (args: UpdateAliasArgs): Promise<void>

      • Parameters

        Returns Promise<void>

        Awaitable promise.

    Settings
    Member Visibility

    On This Page
    Properties