@grandlinex/kernel
    Preparing search index...

    Interface ICoreDb

    Don't use this interface use {IDataBase} instead

    IDataBase

    interface ICoreDb {
        canUpdate(): Promise<boolean>;
        configExist(key: string): Promise<boolean>;
        connect(): Promise<boolean>;
        createEntity<E extends IEntity>(
            config: EntityConfig<E>,
            entity: EProperties<E>,
        ): Promise<E>;
        debug(...ags: unknown[]): void;
        deleteEntityBulkById(className: string, e_id: string[]): Promise<boolean>;
        deleteEntityById(className: string, e_id: string): Promise<boolean>;
        deleteKey(e_id: string): Promise<void>;
        disconnect(): Promise<boolean>;
        error(...ags: unknown[]): void;
        execScripts(list: RawQuery[]): Promise<null | any[]>;
        findEntity<E extends IEntity>(
            config: EntityConfig<E>,
            search: QInterfaceSearch<E>,
        ): Promise<null | E>;
        getCache(): any;
        getConfig(key: string): Promise<undefined | ConfigType>;
        getCurrenDBVersion(): Promise<string>;
        getEntityBulkById<E extends IEntity>(
            config: EntityConfig<E>,
            e_id: string[],
        ): Promise<E[]>;
        getEntityById<E extends IEntity>(
            config: EntityConfig<E>,
            e_id: string,
        ): Promise<null | E>;
        getEntityList<E extends IEntity>(query: QueryInterface<E>): Promise<E[]>;
        getEntityMeta(): ICoreEntityMetaInterface[];
        getKey(e_id: string): Promise<null | GKey>;
        getName(): string;
        getRawDBObject(): any;
        info(...ags: unknown[]): void;
        initEntity<E extends IEntity>(
            className: string,
            entity: E,
        ): Promise<boolean>;
        initNewDB(): Promise<void>;
        isConnected(): boolean;
        lError(message: string): Error;
        log(...ags: unknown[]): void;
        removeConfig(key: string): Promise<void>;
        setConfig(key: string, value: string): Promise<boolean>;
        setConnected(): void;
        setKey(secret: string, iv: Buffer, auth: Buffer): Promise<string>;
        setUpdateChain(chain: IBaseDBUpdate): void;
        start(): Promise<void>;
        update(): Promise<boolean>;
        updateBulkEntity<E extends IEntity>(
            config: EntityConfig<E>,
            e_id: string[],
            entity: EUpDateProperties<E>,
        ): Promise<boolean>;
        updateEntity<E extends IEntity>(
            config: EntityConfig<E>,
            e_id: string,
            entity: EUpDateProperties<E>,
        ): Promise<boolean>;
        verbose(...ags: unknown[]): void;
        warn(...ags: unknown[]): void;
    }

    Hierarchy (View Summary)

    Implemented by

    Index

    Methods

    • Returns Promise<boolean>

    • Parameters

      • key: string

      Returns Promise<boolean>

    • Returns Promise<boolean>

    • Parameters

      • ...ags: unknown[]

      Returns void

    • Parameters

      • className: string
      • e_id: string[]

      Returns Promise<boolean>

    • Parameters

      • className: string
      • e_id: string

      Returns Promise<boolean>

    • Parameters

      • e_id: string

      Returns Promise<void>

    • Returns Promise<boolean>

    • Parameters

      • ...ags: unknown[]

      Returns void

    • Parameters

      Returns Promise<null | any[]>

    • Returns any

    • Parameters

      • key: string

      Returns Promise<undefined | ConfigType>

    • Returns Promise<string>

    • Parameters

      • e_id: string

      Returns Promise<null | GKey>

    • Returns string

    • Returns any

    • Parameters

      • ...ags: unknown[]

      Returns void

    • Type Parameters

      Parameters

      • className: string
      • entity: E

      Returns Promise<boolean>

    • Returns Promise<void>

    • Returns boolean

    • Parameters

      • message: string

      Returns Error

    • Parameters

      • ...ags: unknown[]

      Returns void

    • Parameters

      • key: string

      Returns Promise<void>

    • Parameters

      • key: string
      • value: string

      Returns Promise<boolean>

    • Returns void

    • Parameters

      • secret: string
      • iv: Buffer
      • auth: Buffer

      Returns Promise<string>

    • Returns Promise<void>

    • Returns Promise<boolean>

    • Parameters

      • ...ags: unknown[]

      Returns void

    • Parameters

      • ...ags: unknown[]

      Returns void