forge-sql-orm/dist/core/ForgeSQLSelectOperations.js

Drizzle ORM integration for Atlassian @forge/sql. Provides a custom driver, schema migration, two levels of caching (local and global via @forge/kvs), optimistic locking, and query analysis.

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.ForgeSQLSelectOperations = void 0;
const sql_1 = require("@forge/sql");
/**
 * Class implementing SQL select operations for ForgeSQL ORM.
 * Provides methods for executing queries and mapping results to entity types.
 */
class ForgeSQLSelectOperations {
    options;
    /**
     * Creates a new instance of ForgeSQLSelectOperations.
     * @param {ForgeSqlOrmOptions} options - Configuration options for the ORM
     */
    constructor(options) {
        this.options = options;
    }
    /**
     * Executes a Drizzle query and returns a single result.
     * Throws an error if more than one record is returned.
     *
     * @template T - The type of the query builder
     * @param {T} query - The Drizzle query to execute
     * @returns {Promise<Awaited<T> extends Array<any> ? Awaited<T>[number] | undefined : Awaited<T> | undefined>} A single result object or undefined
     * @throws {Error} If more than one record is returned
     */
    async executeQueryOnlyOne(query) {
        const results = await query;
        const datas = results;
        if (!datas.length) {
            return undefined;
        }
        if (datas.length > 1) {
            throw new Error(`Expected 1 record but returned ${datas.length}`);
        }
        return datas[0];
    }
    /**
     * Executes a raw SQL query and returns the results.
     * Logs the query if logging is enabled.
     *
     * @template T - The type of the result objects
     * @param {string} query - The raw SQL query to execute
     * @param {SqlParameters[]} [params] - Optional SQL parameters
     * @returns {Promise<T[]>} A list of results as objects
     */
    async executeRawSQL(query, params) {
        if (this.options.logRawSqlQuery) {
            const paramsStr = params ? `, with params: ${JSON.stringify(params)}` : "";
            // eslint-disable-next-line no-console
            console.debug(`Executing with SQL ${query}${paramsStr}`);
        }
        const sqlStatement = sql_1.sql.prepare(query);
        if (params) {
            sqlStatement.bindParams(...params);
        }
        const result = await sqlStatement.execute();
        return result.rows;
    }
    /**
     * Executes a raw SQL update query.
     * @param {string} query - The raw SQL update query
     * @param {SqlParameters[]} [params] - Optional SQL parameters
     * @returns {Promise<UpdateQueryResponse>} The update response containing affected rows
     */
    async executeRawUpdateSQL(query, params) {
        const sqlStatement = sql_1.sql.prepare(query);
        if (params) {
            sqlStatement.bindParams(...params);
        }
        if (this.options.logRawSqlQuery) {
            // eslint-disable-next-line no-console
            console.debug(`Executing Update with SQL ${query}` +
                (params ? `, with params: ${JSON.stringify(params)}` : ""));
        }
        const updateQueryResponseResults = await sqlStatement.execute();
        return updateQueryResponseResults.rows;
    }
}
exports.ForgeSQLSelectOperations = ForgeSQLSelectOperations;
//# sourceMappingURL=ForgeSQLSelectOperations.js.map