@sqb/connect 4.0.6 → 4.0.9

package/dist/client/Cursor.js

@@ -1,252 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Cursor = void 0;
-const strict_typed_events_1 = require("strict-typed-events");
-const doublylinked_1 = __importDefault(require("doublylinked"));
-const putil_taskqueue_1 = __importDefault(require("putil-taskqueue"));
-const debug_1 = __importDefault(require("debug"));
-const putil_varhelpers_1 = require("putil-varhelpers");
-const helpers_1 = require("./helpers");
-const CursorStream_1 = require("./CursorStream");
-const debug = (0, debug_1.default)('sqb:cursor');
-class Cursor extends strict_typed_events_1.AsyncEventEmitter {
-    constructor(connection, fields, adapterCursor, request) {
-        super();
-        this._taskQueue = new putil_taskqueue_1.default();
-        this._fetchCache = new doublylinked_1.default();
-        this._rowNum = 0;
-        this._fetchedAll = false;
-        this._fetchedRows = 0;
-        this._connection = connection;
-        this._intlcur = adapterCursor;
-        this._fields = fields;
-        this._request = request;
-        this._prefetchRows = request?.fetchRows || 100;
-    }
-    /**
-     * Returns the Connection instance
-     */
-    get connection() {
-        return this._connection;
-    }
-    /**
-     * Returns if cursor is before first record.
-     */
-    get isBof() {
-        return !this._rowNum;
-    }
-    /**
-     * Returns if cursor is closed.
-     */
-    get isClosed() {
-        return !this._intlcur;
-    }
-    /**
-     * Returns if cursor is after last record.
-     */
-    get isEof() {
-        return this._fetchedAll && this.rowNum > this._fetchedRows;
-    }
-    /**
-     * Returns number of fetched record count from database.
-     */
-    get fetchedRows() {
-        return this._fetchedRows;
-    }
-    /**
-     * Returns object instance which contains information about fields.
-     */
-    get fields() {
-        return this._fields;
-    }
-    /**
-     * Returns current row
-     */
-    get row() {
-        return this._row;
-    }
-    /**
-     * Returns current row number.
-     */
-    get rowNum() {
-        return this._rowNum;
-    }
-    /**
-     * Enables cache
-     */
-    cached() {
-        if (this.fetchedRows)
-            throw new Error('Cache can be enabled before fetching rows');
-        if (!this._cache)
-            this._cache = new doublylinked_1.default();
-    }
-    /**
-     * Closes cursor
-     */
-    async close() {
-        if (!this._intlcur)
-            return;
-        try {
-            await this._intlcur.close();
-            this._intlcur = undefined;
-            debug('close');
-            this.emit('close');
-        }
-        catch (err) {
-            debug('close-error:', err);
-            this.emit('error', err);
-            throw err;
-        }
-    }
-    /**
-     * If cache is enabled, this call fetches and keeps all records in the internal cache.
-     * Otherwise it throws error. Once all all records fetched,
-     * you can close Cursor safely and can continue to use it in memory.
-     * Returns number of fetched rows
-     */
-    async fetchAll() {
-        if (!this._cache)
-            throw new Error('fetchAll() method needs cache to be enabled');
-        const n = this.rowNum;
-        const v = await this._seek(Number.MAX_SAFE_INTEGER, true);
-        await this._seek(n - this.rowNum, true);
-        return v;
-    }
-    /**
-     * Moves cursor to given row number.
-     * cursor can move both forward and backward if cache enabled.
-     * Otherwise it throws error.
-     */
-    async moveTo(rowNum) {
-        await this._seek(rowNum - this.rowNum);
-        return this.row;
-    }
-    /**
-     * Moves cursor forward by one row and returns that row.
-     * And also it allows iterating over rows easily.
-     */
-    async next() {
-        debug('next');
-        await this._seek(1);
-        return this.row;
-    }
-    /**
-     *  Moves cursor back by one row and returns that row.
-     *  And also it allows iterating over rows easily.
-     */
-    async prev() {
-        await this._seek(-1);
-        return this.row;
-    }
-    /**
-     * Moves cursor before first row. (Required cache enabled)
-     */
-    reset() {
-        if (!this._cache)
-            throw new Error('reset() method needs cache to be enabled');
-        this._cache.reset();
-        this._rowNum = 0;
-        this.emit('reset');
-    }
-    /**
-     * Moves cursor by given step. If caching is enabled,
-     * cursor can move both forward and backward. Otherwise it throws error.
-     */
-    async seek(step) {
-        await this._seek(step);
-        return this.row;
-    }
-    /**
-     * Creates and returns a readable stream.
-     */
-    toStream(options) {
-        return new CursorStream_1.CursorStream(this, options);
-    }
-    toString() {
-        return '[object ' + Object.getPrototypeOf(this).constructor.name + ']';
-    }
-    inspect() {
-        return this.toString();
-    }
-    /**
-     *
-     */
-    async _seek(step, silent) {
-        step = (0, putil_varhelpers_1.coerceToInt)(step, 0);
-        if (!step || (step > 0 && this.isClosed))
-            return this.rowNum;
-        if (step < 0 && !this._cache)
-            throw new Error('To move cursor back, it needs cache to be enabled');
-        const _this = this;
-        await this._taskQueue.enqueue(async function () {
-            /* If moving backward */
-            if (step < 0) {
-                /* Seek cache */
-                while (step < 0 && _this._cache?.cursor) {
-                    _this._row = _this._cache.prev();
-                    _this._rowNum--;
-                    step++;
-                }
-                return;
-            }
-            while (step > 0) {
-                if (_this.isEof)
-                    return;
-                /* Seek cache */
-                while (step > 0 && _this._cache && (_this._row = _this._cache.next())) {
-                    _this._rowNum++;
-                    step--;
-                }
-                /* Fetch from prefetch cache */
-                while (step > 0 && (_this._row = _this._fetchCache.shift())) {
-                    _this._rowNum++;
-                    step--;
-                }
-                if (_this._fetchedAll) {
-                    _this._rowNum++;
-                    _this.emit('eof');
-                    return;
-                }
-                if (!step || _this._fetchedAll)
-                    return;
-                await _this._fetchRows();
-            }
-        });
-        if (!silent)
-            this.emit('move', this.row, this._rowNum);
-        return this._rowNum;
-    }
-    /**
-     *
-     */
-    async _fetchRows() {
-        if (!this._intlcur)
-            throw new Error('Cursor is closed');
-        let rows = await this._intlcur.fetch(this._prefetchRows);
-        if (rows && rows.length) {
-            debug('Fetched %d rows from database', rows.length);
-            // Normalize rows
-            rows = this._request.objectRows ?
-                (0, helpers_1.normalizeRowsToObjectRows)(this._fields, this._intlcur.rowType, rows, this._request) :
-                (0, helpers_1.normalizeRowsToArrayRows)(this._fields, this._intlcur.rowType, rows, this._request);
-            (0, helpers_1.callFetchHooks)(rows, this._request);
-            for (const [idx, row] of rows.entries()) {
-                this.emit('fetch', row, (this._rowNum + idx + 1));
-            }
-            /* Add rows to cache */
-            if (this._cache) {
-                this._cache.push(...rows);
-            }
-            else
-                this._fetchCache.push(...rows);
-            this._fetchedRows += rows.length;
-            return;
-        }
-        this._fetchedAll = true;
-        return this.close();
-    }
-}
-exports.Cursor = Cursor;

package/dist/client/CursorStream.d.ts

@@ -1,29 +0,0 @@
-/// <reference types="node" />
-import { Readable } from 'stream';
-import { Cursor } from './Cursor';
-export interface CursorStreamOptions {
-    objectMode?: boolean;
-    limit?: number;
-}
-declare const inspect: unique symbol;
-export declare class CursorStream extends Readable {
-    private readonly _cursor;
-    private readonly _objectMode?;
-    private readonly _limit;
-    private _rowNum;
-    private _eof;
-    constructor(cursor: Cursor, options?: CursorStreamOptions);
-    /**
-     * Returns if stream is closed.
-     */
-    get isClosed(): boolean;
-    /**
-     * Closes stream and releases the cursor
-     */
-    close(): Promise<void>;
-    toString(): string;
-    [inspect](): string;
-    _read(): void;
-    emit(event: string | symbol, ...args: any[]): boolean;
-}
-export {};

package/dist/client/CursorStream.js

@@ -1,100 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CursorStream = void 0;
-const stream_1 = require("stream");
-const debug_1 = __importDefault(require("debug"));
-const inspect = Symbol.for('nodejs.util.inspect.custom');
-const debug = (0, debug_1.default)('sqb:cursorstream');
-class CursorStream extends stream_1.Readable {
-    constructor(cursor, options) {
-        super(options);
-        this._rowNum = -1;
-        this._eof = false;
-        this._cursor = cursor;
-        this._objectMode = options?.objectMode;
-        this._limit = options?.limit || Number.MAX_SAFE_INTEGER;
-        this.on('end', () => {
-            this.close().catch(() => false);
-        });
-        cursor.once('close', () => this.emit('close'));
-        cursor.on('error', (err) => this.emit('error', err));
-    }
-    /**
-     * Returns if stream is closed.
-     */
-    get isClosed() {
-        return this._cursor.isClosed;
-    }
-    /**
-     * Closes stream and releases the cursor
-     */
-    close() {
-        this.pause();
-        this.unpipe();
-        return this._cursor.close();
-    }
-    toString() {
-        return '[object ' + Object.getPrototypeOf(this).constructor.name + ']';
-    }
-    [inspect]() {
-        return this.toString();
-    }
-    _read() {
-        if (this._rowNum >= this._limit) {
-            this.pause();
-            this.unpipe();
-            this.emit('end');
-            return;
-        }
-        this._cursor.next().then(row => {
-            if (this._eof)
-                return this.push(null);
-            let buf = '';
-            if (this._rowNum < 0) {
-                this._rowNum = 0;
-                if (!this._objectMode)
-                    buf += '[';
-            }
-            if (!row) {
-                this._eof = true;
-                if (!this._objectMode) {
-                    buf += ']';
-                    this.push(buf);
-                }
-                else
-                    this.push(null);
-                return;
-            }
-            this._rowNum++;
-            if (this._objectMode)
-                this.push(row);
-            else {
-                if (this._rowNum > 1)
-                    buf += ',';
-                this.push(buf + JSON.stringify(row));
-            }
-        }).catch(err => {
-            /* istanbul ignore next */
-            if (typeof this.destroy == 'function')
-                this.destroy(err);
-            else
-                this.emit('error', err);
-            this.close().catch(() => 0);
-        });
-    }
-    emit(event, ...args) {
-        try {
-            if (event === 'error' && !this.listenerCount('error'))
-                return false;
-            return super.emit(event, ...args);
-        }
-        catch (ignored) {
-            debug('emit-error', ignored);
-            return false;
-        }
-    }
-}
-exports.CursorStream = CursorStream;

package/dist/client/FieldInfoMap.d.ts

@@ -1,10 +0,0 @@
-import { FieldInfo } from './types';
-export declare class FieldInfoMap {
-    private _obj;
-    private _arr;
-    add(field: FieldInfo): void;
-    get(k: string | number): FieldInfo;
-    entries(): [string, FieldInfo][];
-    keys(): string[];
-    values(): FieldInfo[];
-}

package/dist/client/FieldInfoMap.js

@@ -1,33 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.FieldInfoMap = void 0;
-class FieldInfoMap {
-    constructor() {
-        this._obj = {};
-        this._arr = [];
-    }
-    add(field) {
-        const idx = field.index != null ? field.index : this._arr.length;
-        this._arr[idx] = field;
-        field.index = idx;
-        this._obj = this._arr.reduce((a, f) => {
-            a[f.name.toUpperCase()] = f;
-            return a;
-        }, {});
-    }
-    get(k) {
-        if (typeof k === 'number')
-            return this._arr[k];
-        return this._obj[k.toUpperCase()];
-    }
-    entries() {
-        return Object.entries(this._obj);
-    }
-    keys() {
-        return Object.keys(this._obj);
-    }
-    values() {
-        return [...this._arr];
-    }
-}
-exports.FieldInfoMap = FieldInfoMap;

package/dist/client/SqbClient.d.ts

@@ -1,70 +0,0 @@
-import { Pool as LightningPool } from 'lightning-pool';
-import { AsyncEventEmitter } from 'strict-typed-events';
-import { Maybe, Type } from 'ts-gems';
-import { classes } from '@sqb/builder';
-import { ClientConfiguration, QueryExecuteOptions, TransactionFunction, ClientDefaults, ConnectionOptions, QueryRequest, ObjectQueryResult, ArrayQueryResult } from './types';
-import { SqbConnection } from './SqbConnection';
-import { Repository } from '../orm/repository.class';
-declare const inspect: unique symbol;
-interface SqbClientEvents {
-    execute: (request: QueryRequest) => void;
-    error: (error: Error) => void;
-    closing: () => void;
-    close: () => void;
-    acquire: (connection: SqbConnection) => Promise<void>;
-    terminate: () => void;
-}
-export declare class SqbClient extends AsyncEventEmitter<SqbClientEvents> {
-    private readonly _adapter;
-    private readonly _pool;
-    private readonly _defaults;
-    private readonly _entities;
-    constructor(config: ClientConfiguration);
-    get defaults(): ClientDefaults;
-    /**
-     * Returns dialect
-     */
-    get dialect(): string;
-    /**
-     * Returns database driver name
-     */
-    get driver(): string;
-    /**
-     * Returns true if pool is closed
-     */
-    get isClosed(): boolean;
-    get pool(): LightningPool;
-    /**
-     * Obtains a connection from the connection pool and executes the callback
-     */
-    acquire(fn: TransactionFunction, options?: ConnectionOptions): Promise<any>;
-    /**
-     * Obtains a connection from the connection pool.
-     */
-    acquire(options?: ConnectionOptions): Promise<SqbConnection>;
-    /**
-     * Shuts down the pool and destroys all resources.
-     */
-    close(terminateWait?: number): Promise<void>;
-    /**
-     * Executes a query or callback with a new acquired connection.
-     */
-    execute(query: string | classes.Query, options?: QueryExecuteOptions & {
-        objectRows: true;
-    }): Promise<ObjectQueryResult>;
-    execute(query: string | classes.Query, options?: QueryExecuteOptions & {
-        objectRows: false;
-    }): Promise<ArrayQueryResult>;
-    execute(query: string | classes.Query, options?: QueryExecuteOptions): Promise<ObjectQueryResult | ArrayQueryResult>;
-    /**
-     * Tests the pool
-     */
-    test(): Promise<void>;
-    getRepository<T>(entity: Type<T> | string, opts?: {
-        schema?: string;
-    }): Repository<T>;
-    getEntity<T>(name: string): Maybe<Type<T>>;
-    toString(): string;
-    [inspect](): string;
-}
-export {};

package/dist/client/SqbClient.js

@@ -1,167 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SqbClient = void 0;
-const lightning_pool_1 = require("lightning-pool");
-const putil_varhelpers_1 = require("putil-varhelpers");
-const strict_typed_events_1 = require("strict-typed-events");
-const debug_1 = __importDefault(require("debug"));
-const SqbConnection_1 = require("./SqbConnection");
-const extensions_1 = require("./extensions");
-const repository_class_1 = require("../orm/repository.class");
-const entity_model_1 = require("../orm/model/entity-model");
-const debug = (0, debug_1.default)('sqb:client');
-const inspect = Symbol.for('nodejs.util.inspect.custom');
-class SqbClient extends strict_typed_events_1.AsyncEventEmitter {
-    constructor(config) {
-        super();
-        this._entities = {};
-        if (!(config && typeof config === 'object'))
-            throw new TypeError('Configuration object required');
-        let adapter;
-        if (config.driver) {
-            adapter = extensions_1.adapters.find(x => x.driver === config.driver);
-            if (!adapter)
-                throw new Error(`No database adapter registered for "${config.driver}" driver`);
-        }
-        else if (config.dialect) {
-            adapter = extensions_1.adapters.find(x => x.dialect === config.dialect);
-            if (!adapter)
-                throw new Error(`No database adapter registered for "${config.dialect}" dialect`);
-        }
-        if (!adapter)
-            throw new Error(`You must provide one of "driver" or "dialect" properties`);
-        this._adapter = adapter;
-        this._defaults = config.defaults || {};
-        const poolOptions = {};
-        const popts = config.pool || {};
-        poolOptions.acquireMaxRetries = (0, putil_varhelpers_1.coerceToInt)(popts.acquireMaxRetries, 0);
-        poolOptions.acquireRetryWait = (0, putil_varhelpers_1.coerceToInt)(popts.acquireRetryWait, 2000);
-        poolOptions.acquireTimeoutMillis = (0, putil_varhelpers_1.coerceToInt)(popts.acquireTimeoutMillis, 0);
-        poolOptions.idleTimeoutMillis = (0, putil_varhelpers_1.coerceToInt)(popts.idleTimeoutMillis, 30000);
-        poolOptions.max = (0, putil_varhelpers_1.coerceToInt)(popts.max, 10);
-        poolOptions.maxQueue = (0, putil_varhelpers_1.coerceToInt)(popts.maxQueue, 1000);
-        poolOptions.max = (0, putil_varhelpers_1.coerceToInt)(popts.max, 10);
-        poolOptions.min = (0, putil_varhelpers_1.coerceToInt)(popts.min, 0);
-        poolOptions.minIdle = (0, putil_varhelpers_1.coerceToInt)(popts.minIdle, 0);
-        poolOptions.validation = (0, putil_varhelpers_1.coerceToBoolean)(popts.validation, false);
-        const cfg = { ...config };
-        const poolFactory = {
-            create: () => adapter.connect(cfg),
-            destroy: instance => instance.close(),
-            reset: instance => instance.reset(),
-            validate: instance => instance.test()
-        };
-        this._pool = (0, lightning_pool_1.createPool)(poolFactory, poolOptions);
-        this._pool.on('closing', () => this.emit('closing'));
-        this._pool.on('close', () => this.emit('close'));
-        this._pool.on('terminate', () => this.emit('terminate'));
-        // @ts-ignore
-        this._pool.on('error', (...args) => this.emit('error', ...args));
-    }
-    get defaults() {
-        return this._defaults;
-    }
-    /**
-     * Returns dialect
-     */
-    get dialect() {
-        return this._adapter.dialect;
-    }
-    /**
-     * Returns database driver name
-     */
-    get driver() {
-        return this._adapter.driver;
-    }
-    /**
-     * Returns true if pool is closed
-     */
-    get isClosed() {
-        return this._pool.state === lightning_pool_1.PoolState.CLOSED;
-    }
-    get pool() {
-        return this._pool;
-    }
-    async acquire(arg0, arg1) {
-        debug('acquire');
-        if (typeof arg0 === 'function') {
-            const connection = await this.acquire(arg1);
-            try {
-                return await arg0(connection);
-            }
-            finally {
-                connection.release();
-            }
-        }
-        const options = arg1;
-        const adapterConnection = await this._pool.acquire();
-        const opts = { autoCommit: this.defaults.autoCommit, ...options };
-        const connection = new SqbConnection_1.SqbConnection(this, adapterConnection, opts);
-        await this.emitAsync({ event: 'acquire', serial: true }, connection);
-        connection.on('execute', (request) => this.emit('execute', request));
-        connection.on('error', (error) => this.emit('error', error));
-        return connection;
-    }
-    /**
-     * Shuts down the pool and destroys all resources.
-     */
-    async close(terminateWait) {
-        const ms = terminateWait == null ? Infinity : 0;
-        return this._pool.close(ms);
-    }
-    async execute(query, options) {
-        debug('execute');
-        const connection = await this.acquire();
-        try {
-            const qr = await connection.execute(query, options);
-            if (qr && qr.cursor) {
-                connection.retain();
-                qr.cursor.once('close', () => connection.release());
-            }
-            return qr;
-        }
-        finally {
-            connection.release();
-        }
-    }
-    /**
-     * Tests the pool
-     */
-    async test() {
-        const connection = await this.acquire();
-        try {
-            await connection.test();
-        }
-        finally {
-            connection.release();
-        }
-    }
-    getRepository(entity, opts) {
-        let ctor;
-        if (typeof entity === 'string') {
-            ctor = this.getEntity(entity);
-            if (!ctor)
-                throw new Error(`Repository "${entity}" is not registered`);
-        }
-        else
-            ctor = entity;
-        const entityDef = entity_model_1.EntityModel.get(ctor);
-        if (!entityDef)
-            throw new Error(`You must provide an @Entity annotated constructor`);
-        return new repository_class_1.Repository(entityDef, this, opts?.schema);
-    }
-    getEntity(name) {
-        return this._entities[name];
-    }
-    toString() {
-        return '[object ' + Object.getPrototypeOf(this).constructor.name + '(' +
-            this.dialect + ')]';
-    }
-    [inspect]() {
-        return this.toString();
-    }
-}
-exports.SqbClient = SqbClient;