Member Junction
    Preparing search index...

    Interface ExecuteSQLOptions

    Configuration options for SQL execution with logging support

    interface ExecuteSQLOptions {
        connectionSource?: ConnectionPool | Transaction;
        description?: string;
        ignoreAmbientTransaction?: boolean;
        ignoreLogging?: boolean;
        isMutation?: boolean;
        literalSQL?: string;
        simpleSQLFallback?: string;
        timeoutMs?: number;
    }
    Index

    Properties

    connectionSource? description? ignoreAmbientTransaction? ignoreLogging? isMutation? literalSQL? simpleSQLFallback? timeoutMs?

    Properties

    connectionSource?: ConnectionPool | Transaction

    Optional connection source to use instead of the default pool. Used by IS-A chain orchestration to execute SPs on a shared transaction. Should be a sql.Transaction or sql.ConnectionPool instance.

    description?: string

    Optional description for this SQL operation

    ignoreAmbientTransaction?: boolean

    Run on the pool even while an ambient transaction is open. For reads that are not part of any caller's unit of work — the metadata dataset a background refresh loads — so they never land on the transaction's connection beside its COMMIT. A pool read sees committed data only (#4514).

    ignoreLogging?: boolean

    If true, this statement will not be logged to any logging session

    isMutation?: boolean

    Whether this is a data mutation operation (INSERT/UPDATE/DELETE)

    literalSQL?: string

    The statement with its parameter values written in as literals. Set for saves and deletes, which run with typed parameters: logged in place of the query, and shown in error messages.

    simpleSQLFallback?: string

    Simple SQL fallback for loggers with logRecordChangeMetadata=false (only for Save/Delete operations)

    timeoutMs?: number

    The longest the statement may run, in milliseconds. When it is exceeded the request is cancelled on the server and the call rejects with Query timeout exceeded. Ignored inside a transaction.

    Settings

    Member Visibility

    On This Page

    Properties