velocious 1.0.108 → 1.0.109

package/dist/src/database/drivers/base.d.ts

@@ -0,0 +1,365 @@
+export default class VelociousDatabaseDriversBase {
+    /**
+     * @param {import("../../configuration-types.js").DatabaseConfigurationType} config
+     * @param {import("../../configuration.js").default} configuration
+     */
+    constructor(config: import("../../configuration-types.js").DatabaseConfigurationType, configuration: import("../../configuration.js").default);
+    /** @type {number | undefined} */
+    idSeq: number | undefined;
+    _args: import("../../configuration-types.js").DatabaseConfigurationType;
+    configuration: import("../../configuration.js").default;
+    mutex: any;
+    logger: Logger;
+    _transactionsCount: number;
+    _transactionsActionsMutex: any;
+    /**
+     * @param {string} tableName
+     * @param {string} columnName
+     * @param {string} referencedTableName
+     * @param {string} referencedColumnName
+     * @param {object} args
+     * @returns {Promise<void>}
+     */
+    addForeignKey(tableName: string, columnName: string, referencedTableName: string, referencedColumnName: string, args: object): Promise<void>;
+    /**
+     * @abstract
+     * @param {import("../table-data/index.js").default} _tableData
+     * @returns {Promise<string[]>}
+     */
+    alterTableSQLs(_tableData: import("../table-data/index.js").default): Promise<string[]>;
+    /**
+     * @abstract
+     * @returns {Promise<void>}
+     */
+    connect(): Promise<void>;
+    /**
+     * @abstract
+     * @param {string} databaseName
+     * @param {object} [args]
+     * @param {boolean} [args.ifNotExists]
+     * @returns {string[]}
+     */
+    createDatabaseSql(databaseName: string, args?: {
+        ifNotExists?: boolean;
+    }): string[];
+    /**
+     * @abstract
+     * @param {CreateIndexSqlArgs} indexData
+     * @returns {Promise<string[]>}
+     */
+    createIndexSQLs(indexData: CreateIndexSqlArgs): Promise<string[]>;
+    /**
+     * @param {import("../table-data/index.js").default} tableData
+     * @returns {Promise<void>}
+     */
+    createTable(tableData: import("../table-data/index.js").default): Promise<void>;
+    /**
+     * @abstract
+     * @param {import("../table-data/index.js").default} tableData
+     * @returns {Promise<string[]>}
+     */
+    createTableSql(tableData: import("../table-data/index.js").default): Promise<string[]>;
+    /**
+     * @param {DeleteSqlArgsType} args
+     * @returns {Promise<void>}
+     */
+    delete(args: DeleteSqlArgsType): Promise<void>;
+    /**
+     * @abstract
+     * @param {DeleteSqlArgsType} args
+     * @returns {string}
+     */
+    deleteSql(args: DeleteSqlArgsType): string;
+    /**
+     * @param {string} tableName
+     * @param {DropTableSqlArgsType} [args]
+     * @returns {Promise<void>}
+     */
+    dropTable(tableName: string, args?: DropTableSqlArgsType): Promise<void>;
+    /**
+     * @abstract
+     * @param {string} tableName
+     * @param {DropTableSqlArgsType} [args]
+     * @returns {Promise<string[]>}
+     */
+    dropTableSQLs(tableName: string, args?: DropTableSqlArgsType): Promise<string[]>;
+    /**
+     * @abstract
+     * @param {any} value
+     * @returns {any}
+     */
+    escape(value: any): any;
+    /**
+     * @returns {import("../../configuration-types.js").DatabaseConfigurationType}
+     */
+    getArgs(): import("../../configuration-types.js").DatabaseConfigurationType;
+    /**
+     * @returns {import("../../configuration.js").default}
+     */
+    getConfiguration(): import("../../configuration.js").default;
+    /**
+     * @returns {number | undefined}
+     */
+    getIdSeq(): number | undefined;
+    /**
+     * @abstract
+     * @returns {Promise<Array<import("./base-table.js").default>>}
+     */
+    getTables(): Promise<Array<import("./base-table.js").default>>;
+    /**
+     * @param {string} name
+     * @param {object} [args]
+     * @param {boolean} args.throwError
+     * @returns {Promise<import("./base-table.js").default | undefined>}
+     */
+    getTableByName(name: string, args?: {
+        throwError: boolean;
+    }): Promise<import("./base-table.js").default | undefined>;
+    /**
+     * @abstract
+     * @returns {string}
+     */
+    getType(): string;
+    /**
+     * @param {InsertSqlArgsType} args
+     * @returns {Promise<void>}
+     */
+    insert(args: InsertSqlArgsType): Promise<void>;
+    /**
+     * @abstract
+     * @param {string} tableName
+     * @param {Array<string>} columns
+     * @param {Array<Array<string>>} rows
+     * @returns {Promise<void>}
+     */
+    insertMultiple(tableName: string, columns: Array<string>, rows: Array<Array<string>>): Promise<void>;
+    /**
+     * @abstract
+     * @param {InsertSqlArgsType} args
+     * @returns {string}
+     */
+    insertSql(args: InsertSqlArgsType): string;
+    /**
+     * @abstract
+     * @returns {Promise<number>}
+     */
+    lastInsertID(): Promise<number>;
+    /**
+     * @param {any} value
+     * @returns {any}
+     */
+    _convertValue(value: any): any;
+    /**
+     * @abstract
+     * @returns {import("../query-parser/options.js").default}
+     */
+    options(): import("../query-parser/options.js").default;
+    /**
+     * @param {any} value
+     * @returns {number | string}
+     */
+    quote(value: any): number | string;
+    /**
+     * @param {string} columnName
+     * @returns {string}
+     */
+    quoteColumn(columnName: string): string;
+    /**
+     * @param {string} columnName
+     * @returns {string}
+     */
+    quoteIndex(columnName: string): string;
+    /**
+     * @param {string} tableName
+     * @returns {string}
+     */
+    quoteTable(tableName: string): string;
+    /**
+     * @returns {Query}
+     */
+    newQuery(): Query;
+    /**
+     * @param {string} tableName
+     * @returns {Promise<QueryResultType>}
+     */
+    select(tableName: string): Promise<QueryResultType>;
+    /**
+     * @param {number | undefined} newIdSeq
+     * @returns {void}
+     */
+    setIdSeq(newIdSeq: number | undefined): void;
+    /**
+     * @abstract
+     * @returns {boolean}
+     */
+    shouldSetAutoIncrementWhenPrimaryKey(): boolean;
+    /**
+     * @abstract
+     * @returns {boolean}
+     */
+    supportsInsertIntoReturning(): boolean;
+    /**
+     * @param {string} tableName
+     * @returns {Promise<boolean>}
+     */
+    tableExists(tableName: string): Promise<boolean>;
+    /**
+     * @param {() => Promise<void>} callback
+     * @returns {Promise<any>}
+     */
+    transaction(callback: () => Promise<void>): Promise<any>;
+    /**
+     * @returns {Promise<void>}
+     */
+    startTransaction(): Promise<void>;
+    /**
+     * @returns {Promise<void>}
+     */
+    _startTransactionAction(): Promise<void>;
+    /**
+     * @returns {Promise<void>}
+     */
+    commitTransaction(): Promise<void>;
+    /**
+     * @returns {Promise<void>}
+     */
+    _commitTransactionAction(): Promise<void>;
+    /**
+     * @param {string} sql
+     * @returns {Promise<QueryResultType>}
+     */
+    query(sql: string): Promise<QueryResultType>;
+    /**
+     * @abstract
+     * @param {string} sql
+     * @returns {Promise<QueryResultType>}
+     */
+    _queryActual(sql: string): Promise<QueryResultType>;
+    /**
+     * @abstract
+     * @param {Query} _query
+     * @returns {string}
+     */
+    queryToSql(_query: Query): string;
+    /**
+     * @param {Error} _error
+     * @returns {boolean}
+     */
+    retryableDatabaseError(_error: Error): boolean;
+    /**
+     * @returns {Promise<void>}
+     */
+    rollbackTransaction(): Promise<void>;
+    /**
+     * @returns {Promise<void>}
+     */
+    _rollbackTransactionAction(): Promise<void>;
+    /**
+     * @returns {string}
+     */
+    generateSavePointName(): string;
+    /**
+     * @param {string} savePointName
+     * @returns {Promise<void>}
+     */
+    startSavePoint(savePointName: string): Promise<void>;
+    /**
+     * @param {string} savePointName
+     * @returns {Promise<void>}
+     */
+    _startSavePointAction(savePointName: string): Promise<void>;
+    /**
+     * @param {string} tableName
+     * @param {string} oldColumnName
+     * @param {string} newColumnName
+     * @returns {Promise<void>}
+     */
+    renameColumn(tableName: string, oldColumnName: string, newColumnName: string): Promise<void>;
+    /**
+     * @param {string} savePointName
+     * @returns {Promise<void>}
+     */
+    releaseSavePoint(savePointName: string): Promise<void>;
+    /**
+     * @param {string} savePointName
+     * @returns {Promise<void>}
+     */
+    _releaseSavePointAction(savePointName: string): Promise<void>;
+    /**
+     * @param {string} savePointName
+     * @returns {Promise<void>}
+     */
+    rollbackSavePoint(savePointName: string): Promise<void>;
+    /**
+     * @param {string} savePointName
+     * @returns {Promise<void>}
+     */
+    _rollbackSavePointAction(savePointName: string): Promise<void>;
+    /**
+     * @returns {Promise<void>}
+     */
+    truncateAllTables(): Promise<void>;
+    /**
+     * @param {UpdateSqlArgsType} args
+     * @returns {Promise<void>}
+     */
+    update(args: UpdateSqlArgsType): Promise<void>;
+    /**
+     * @abstract
+     * @param {UpdateSqlArgsType} args
+     * @returns {string}
+     */
+    updateSql(args: UpdateSqlArgsType): string;
+    /**
+     * @abstract
+     * @returns {Promise<void>}
+     */
+    disableForeignKeys(): Promise<void>;
+    /**
+     * @abstract
+     * @returns {Promise<void>}
+     */
+    enableForeignKeys(): Promise<void>;
+    /**
+     * @param {function() : void} callback
+     * @returns {Promise<any>}
+     */
+    withDisabledForeignKeys(callback: () => void): Promise<any>;
+}
+export type CreateIndexSqlArgs = {
+    columns: Array<string | import("./../table-data/table-column.js").default>;
+    ifNotExists?: boolean;
+    name?: string;
+    unique?: boolean;
+    tableName: string;
+};
+export type DropTableSqlArgsType = {
+    cascade?: boolean;
+    ifExists?: boolean;
+};
+export type DeleteSqlArgsType = {
+    tableName: string;
+    conditions: {
+        [key: string]: any;
+    };
+};
+export type InsertSqlArgsType = {
+    columns?: string[];
+    data?: {
+        [key: string]: any;
+    };
+    multiple?: boolean;
+    returnLastInsertedColumnNames?: string[];
+    rows?: Array<Array<any>>;
+    tableName: string;
+};
+export type QueryRowType = Record<string, any>;
+export type QueryResultType = Array<QueryRowType>;
+export type UpdateSqlArgsType = {
+    conditions: object;
+    data: object;
+    tableName: string;
+};
+import { Logger } from "../../logger.js";
+import Query from "../query/index.js";
+//# sourceMappingURL=base.d.ts.map

package/dist/src/database/drivers/base.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../../../../src/database/drivers/base.js"],"names":[],"mappings":"AAmDA;IAIE;;;OAGG;IACH,oBAHW,OAAO,8BAA8B,EAAE,yBAAyB,iBAChE,OAAO,wBAAwB,EAAE,OAAO,EASlD;IAdD,iCAAiC;IACjC,OADW,MAAM,GAAG,SAAS,CACZ;IAOf,wEAAmB;IACnB,wDAAkC;IAClC,WAAwB;IACxB,eAA8B;IAC9B,2BAA2B;IAC3B,+BAA4C;IAG9C;;;;;;;OAOG;IACH,yBAPW,MAAM,cACN,MAAM,uBACN,MAAM,wBACN,MAAM,QACN,MAAM,GACJ,OAAO,CAAC,IAAI,CAAC,CAsBzB;IAED;;;;OAIG;IACH,2BAHW,OAAO,wBAAwB,EAAE,OAAO,GACtC,OAAO,CAAC,MAAM,EAAE,CAAC,CAI7B;IAED;;;OAGG;IACH,WAFa,OAAO,CAAC,IAAI,CAAC,CAIzB;IAED;;;;;;OAMG;IACH,gCALW,MAAM,SAEd;QAAuB,WAAW,GAA1B,OAAO;KACf,GAAU,MAAM,EAAE,CAE2E;IAEhG;;;;OAIG;IACH,2BAHW,kBAAkB,GAChB,OAAO,CAAC,MAAM,EAAE,CAAC,CAI7B;IAED;;;OAGG;IACH,uBAHW,OAAO,wBAAwB,EAAE,OAAO,GACtC,OAAO,CAAC,IAAI,CAAC,CAQzB;IAED;;;;OAIG;IACH,0BAHW,OAAO,wBAAwB,EAAE,OAAO,GACtC,OAAO,CAAC,MAAM,EAAE,CAAC,CAI7B;IAED;;;OAGG;IACH,aAHW,iBAAiB,GACf,OAAO,CAAC,IAAI,CAAC,CAMzB;IAED;;;;OAIG;IACH,gBAHW,iBAAiB,GACf,MAAM,CAIlB;IAED;;;;OAIG;IACH,qBAJW,MAAM,SACN,oBAAoB,GAClB,OAAO,CAAC,IAAI,CAAC,CAQzB;IAED;;;;;OAKG;IACH,yBAJW,MAAM,SACN,oBAAoB,GAClB,OAAO,CAAC,MAAM,EAAE,CAAC,CAI7B;IAED;;;;OAIG;IACH,cAHW,GAAG,GACD,GAAG,CAIf;IAED;;OAEG;IACH,WAFa,OAAO,8BAA8B,EAAE,yBAAyB,CAI5E;IAED;;OAEG;IACH,oBAFa,OAAO,wBAAwB,EAAE,OAAO,CAMpD;IAED;;OAEG;IACH,YAFa,MAAM,GAAG,SAAS,CAI9B;IAED;;;OAGG;IACH,aAFa,OAAO,CAAC,KAAK,CAAC,OAAO,iBAAiB,EAAE,OAAO,CAAC,CAAC,CAI7D;IAED;;;;;OAKG;IACH,qBALW,MAAM,SAEd;QAAsB,UAAU,EAAxB,OAAO;KACf,GAAU,OAAO,CAAC,OAAO,iBAAiB,EAAE,OAAO,GAAG,SAAS,CAAC,CAqBlE;IAED;;;OAGG;IACH,WAFa,MAAM,CAIlB;IAED;;;OAGG;IACH,aAHW,iBAAiB,GACf,OAAO,CAAC,IAAI,CAAC,CAMzB;IAED;;;;;;OAMG;IACH,0BALW,MAAM,WACN,KAAK,CAAC,MAAM,CAAC,QACb,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,GAClB,OAAO,CAAC,IAAI,CAAC,CAIzB;IAED;;;;OAIG;IACH,gBAHW,iBAAiB,GACf,MAAM,CAIlB;IAED;;;OAGG;IACH,gBAFa,OAAO,CAAC,MAAM,CAAC,CAI3B;IAED;;;OAGG;IACH,qBAHW,GAAG,GACD,GAAG,CAQf;IAED;;;OAGG;IACH,WAFa,OAAO,4BAA4B,EAAE,OAAO,CAIxD;IAED;;;OAGG;IACH,aAHW,GAAG,GACD,MAAM,GAAG,MAAM,CAS3B;IAED;;;OAGG;IACH,wBAHW,MAAM,GACJ,MAAM,CAIlB;IAED;;;OAGG;IACH,uBAHW,MAAM,GACJ,MAAM,CAIlB;IAED;;;OAGG;IACH,sBAHW,MAAM,GACJ,MAAM,CAIlB;IAED;;OAEG;IACH,YAFa,KAAK,CASjB;IAED;;;OAGG;IACH,kBAHW,MAAM,GACJ,OAAO,CAAC,eAAe,CAAC,CAUpC;IAED;;;OAGG;IACH,mBAHW,MAAM,GAAG,SAAS,GAChB,IAAI,CAIhB;IAED;;;OAGG;IACH,wCAFa,OAAO,CAInB;IAED;;;OAGG;IACH,+BAFa,OAAO,CAE0B;IAE9C;;;OAGG;IACH,uBAHW,MAAM,GACJ,OAAO,CAAC,OAAO,CAAC,CAS5B;IAED;;;OAGG;IACH,sBAHW,MAAM,OAAO,CAAC,IAAI,CAAC,GACjB,OAAO,CAAC,GAAG,CAAC,CAoDxB;IAED;;OAEG;IACH,oBAFa,OAAO,CAAC,IAAI,CAAC,CAOzB;IAED;;OAEG;IACH,2BAFa,OAAO,CAAC,IAAI,CAAC,CAIzB;IAED;;OAEG;IACH,qBAFa,OAAO,CAAC,IAAI,CAAC,CAOzB;IAED;;OAEG;IACH,4BAFa,OAAO,CAAC,IAAI,CAAC,CAIzB;IAED;;;OAGG;IACH,WAHW,MAAM,GACJ,OAAO,CAAC,eAAe,CAAC,CAsBpC;IAED;;;;OAIG;IACH,kBAHW,MAAM,GACJ,OAAO,CAAC,eAAe,CAAC,CAIpC;IAED;;;;OAIG;IACH,mBAHW,KAAK,GACH,MAAM,CAEiD;IAEpE;;;OAGG;IACH,+BAHW,KAAK,GACH,OAAO,CAInB;IAED;;OAEG;IACH,uBAFa,OAAO,CAAC,IAAI,CAAC,CAOzB;IAED;;OAEG;IACH,8BAFa,OAAO,CAAC,IAAI,CAAC,CAIzB;IAED;;OAEG;IACH,yBAFa,MAAM,CAIlB;IAED;;;OAGG;IACH,8BAHW,MAAM,GACJ,OAAO,CAAC,IAAI,CAAC,CAMzB;IAED;;;OAGG;IACH,qCAHW,MAAM,GACJ,OAAO,CAAC,IAAI,CAAC,CAIzB;IAED;;;;;OAKG;IACH,wBALW,MAAM,iBACN,MAAM,iBACN,MAAM,GACJ,OAAO,CAAC,IAAI,CAAC,CAgBzB;IAED;;;OAGG;IACH,gCAHW,MAAM,GACJ,OAAO,CAAC,IAAI,CAAC,CAMzB;IAED;;;OAGG;IACH,uCAHW,MAAM,GACJ,OAAO,CAAC,IAAI,CAAC,CAIzB;IAED;;;OAGG;IACH,iCAHW,MAAM,GACJ,OAAO,CAAC,IAAI,CAAC,CAMzB;IAED;;;OAGG;IACH,wCAHW,MAAM,GACJ,OAAO,CAAC,IAAI,CAAC,CAIzB;IAED;;OAEG;IACH,qBAFa,OAAO,CAAC,IAAI,CAAC,CAgCzB;IAED;;;OAGG;IACH,aAHW,iBAAiB,GACf,OAAO,CAAC,IAAI,CAAC,CAMzB;IAED;;;;OAIG;IACH,gBAHW,iBAAiB,GACf,MAAM,CAIlB;IAED;;;OAGG;IACH,sBAFa,OAAO,CAAC,IAAI,CAAC,CAIzB;IAED;;;OAGG;IACH,qBAFa,OAAO,CAAC,IAAI,CAAC,CAIzB;IAED;;;OAGG;IACH,kCAHW,MAAa,IAAI,GACf,OAAO,CAAC,GAAG,CAAC,CAUxB;CACF;;aA1uBa,KAAK,CAAC,MAAM,GAAG,OAAO,iCAAiC,EAAE,OAAO,CAAC;kBACjE,OAAO;WACP,MAAM;aACN,OAAO;eACP,MAAM;;;cAIN,OAAO;eACP,OAAO;;;eAIP,MAAM;gBACN;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAC;;;cAIpB,MAAM,EAAE;WACR;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAC;eACpB,OAAO;oCACP,MAAM,EAAE;WACR,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;eACjB,MAAM;;2BAGP,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;8BACnB,KAAK,CAAC,YAAY,CAAC;;gBAIlB,MAAM;UACN,MAAM;eACN,MAAM;;uBAGC,iBAAiB;kBACpB,mBAAmB"}