Class SqlLoggingSessionImplInternal

constructor

• new SqlLoggingSessionImpl(
      id: string,
      filePath: string,
      options?: SqlLoggingOptions,
      dialect?: SQLDialect,
  ): SqlLoggingSessionImpl

  Parameters

  • id: string
  • filePath: string
  • options: SqlLoggingOptions = {}
  • dialect: SQLDialect = ...

    The SQL dialect to use for platform-specific SQL emission (e.g. Flyway placeholder escaping, batch separators). Defaults to SQL Server when not provided so existing callers and tests keep working without immediately threading a dialect through every call site.

  Returns SqlLoggingSessionImpl

ReadonlyfilePath

Readonlyid

Readonlyoptions

ReadonlystartTime

statementCount

• get statementCount(): number

  Gets the count of SQL statements actually written to the log file

  Returns number

  The number of emitted statements (after filtering)

dispose

• dispose(): Promise<void>

  Disposes of the logging session, writes the footer, closes the file, and optionally deletes empty files

  Returns Promise<void>

initialize

• initialize(): Promise<void>

  Initializes the logging session by creating the log file and writing the header

  Returns Promise<void>

  Throws

  Error if file creation fails

logSqlStatement

• logSqlStatement(
      query: string,
      parameters?: unknown,
      description?: string,
      isMutation?: boolean,
      simpleSQLFallback?: string,
  ): Promise<void>

  Logs a SQL statement to the file, applying filtering and formatting based on session options

  Parameters

  • query: string

    The SQL query to log

  • Optionalparameters: unknown

    Optional parameters for the query

  • Optionaldescription: string

    Optional description for this operation

  • isMutation: boolean = false

    Whether this is a data mutation operation

  • OptionalsimpleSQLFallback: string

    Optional simple SQL to use if logRecordChangeMetadata=false

  Returns Promise<void>