weaviate-client/dist/node/cjs/alias/index.d.ts

JS/TS client for Weaviate

import { ConnectionREST } from '../index.js';
import { Alias, AliasListAllOptions, CreateAliasArgs, UpdateAliasArgs } from './types.js';
export interface Aliases {
    /**
     * Create alias for a collection.
     *
     * The collection must exist prior to aliasing it.
     * One alias cannot be created for multiple collections simultaneously.
     *
     * @param {string} args.collection Original collection name.
     * @param {string} args.alias Alias for collection.
     * @returns {Promise<void>} Awaitable promise.
     * */
    create: (args: CreateAliasArgs) => Promise<void>;
    /**
     * List all aliases defined in the schema.
     *
     * @param {string | undefined} [opts.collection] Get all aliases defined for this collection.
     * @returns {Promise<Alias[] | undefined>} An array of aliases.
     */
    listAll: (opts?: AliasListAllOptions) => Promise<Alias[] | undefined>;
    /**
     * Get information about an alias.
     *
     * @param {string} alias Alias to fetch.
     * @return {Promise<Alias>} Alias definition.
     */
    get: (alias: string) => Promise<Alias>;
    /**
     * Replace target collection the alias points to.
     *
     * To change the alias that points to the collection,
     * delete the alias and create a new one.
     *
     * @param {string} args.alias Alias to update.
     * @param {string} args.collection New collection the alias should point to.
     * @return {Promise<void>} Awaitable promise.
     */
    update: (args: UpdateAliasArgs) => Promise<void>;
    /**
     * Delete a collection alias.
     *
     * @param {string} alias Alias definition to delete.
     * @return {Promise<void>} Awaitable promise.
     */
    delete: (alias: string) => Promise<void>;
}
declare const alias: (connection: ConnectionREST) => Aliases;
export default alias;