@naturalcycles/db-lib/dist/adapter/file/file.db.model.d.ts

Lowest Common Denominator API to supported Databases

import type { CommonLogger } from '@naturalcycles/js-lib/log';
import type { ObjectWithId } from '@naturalcycles/js-lib/types';
import type { DBSaveBatchOperation } from '../../db.model.js';
import type { DBQueryOrder } from '../../query/dbQuery.js';
export interface FileDBPersistencePlugin {
    ping: () => Promise<void>;
    getTables: () => Promise<string[]>;
    loadFile: <ROW extends ObjectWithId>(table: string) => Promise<ROW[]>;
    saveFiles: (ops: DBSaveBatchOperation<any>[]) => Promise<void>;
}
export interface FileDBCfg {
    plugin: FileDBPersistencePlugin;
    /**
     * @default undefined, which means "insertion order"
     */
    sortOnSave?: DBQueryOrder<any>;
    /**
     * @default true
     * If true - will run `sortObjectDeep()` on each object to achieve deterministic sort
     */
    sortObjects?: boolean;
    /**
     * Defaults to `console`.
     */
    logger?: CommonLogger;
    /**
     * @default false
     */
    logStarted?: boolean;
    /**
     * @default true
     */
    logFinished?: boolean;
}