@imbricate/core/database-manager/database-manager.d.ts

Imbricate Core, Notebook for Engineers

/**
 * @author WMXPY
 * @namespace DatabaseManager
 * @description Database Manager
 */
import { ImbricateDatabaseAuditOptions } from "../database/definition";
import { ImbricateDatabaseSchemaForCreation } from "../database/schema";
import { ImbricateDatabaseQuery } from "./definition";
import { IMBRICATE_DATABASE_MANAGER_FEATURE } from "./feature";
import { ImbricateDatabaseManagerCreateDatabaseOutcome, ImbricateDatabaseManagerGetDatabaseOutcome, ImbricateDatabaseManagerQueryDatabasesOutcome, ImbricateDatabaseManagerRemoveDatabaseOutcome } from "./outcome";
export interface IImbricateDatabaseManager {
    /**
     * Supported features of the database manager
     */
    readonly supportedFeatures: IMBRICATE_DATABASE_MANAGER_FEATURE[];
    /**
     * List all databases in the origin
     *
     * @returns a promise of the databases in the origin
     *  Symbol: S_DatabaseManager_ListDatabases_Stale - if the databases are stale
     */
    queryDatabases(query: ImbricateDatabaseQuery): PromiseLike<ImbricateDatabaseManagerQueryDatabasesOutcome>;
    /**
     * Get one database from the origin
     *
     * @param uniqueIdentifier unique identifier of the database
     *
     * @returns a promise of the database
     *  Symbol: S_DatabaseManager_GetDatabase_NotFound - if the database is not found
     */
    getDatabase(uniqueIdentifier: string): PromiseLike<ImbricateDatabaseManagerGetDatabaseOutcome>;
    /**
     * Create a new database
     *
     * @param databaseName name of the database
     * @param schema schema of the database
     * @param auditOptions audit options of the database
     *
     * @returns a promise of the created database
     *  Symbol: S_DatabaseManager_CreateDatabase_IdentifierDuplicated - if the identifier is duplicated
     */
    createDatabase(databaseName: string, schema: ImbricateDatabaseSchemaForCreation, auditOptions?: ImbricateDatabaseAuditOptions): PromiseLike<ImbricateDatabaseManagerCreateDatabaseOutcome>;
    /**
     * Remove a database from the origin
     *
     * @param uniqueIdentifier unique identifier of the database
     * @param auditOptions audit options of deletion
     *
     * @returns a promise of the outcome of the removal
     *  Symbol: S_DatabaseManager_RemoveDatabase_NotFound - if the database is not found
     */
    removeDatabase(uniqueIdentifier: string, auditOptions?: ImbricateDatabaseAuditOptions): PromiseLike<ImbricateDatabaseManagerRemoveDatabaseOutcome>;
}