Member Junction
    Preparing search index...

    Class SqlLoggingOptions

    Configuration options for SQL logging sessions. These options control how SQL statements are captured, formatted, and saved.

    Index

    Constructors

    constructor

    Properties

    batchSeparator? defaultSchemaName? description? filterByUserId? filterPatterns? filterType? formatAsMigration? logRecordChangeMetadata? prettyPrint? retainEmptyLogFiles? sessionName? statementTypes? verboseOutput?

    Constructors

    Properties

    batchSeparator?: string

    String separator to use between SQL statements (e.g., 'GO' for SQL Server)

    defaultSchemaName?: string

    Default schema name for Flyway migration placeholder replacement

    description?: string

    Optional description or notes for this logging configuration

    filterByUserId?: string

    Email address to filter SQL statements by user (when filtering is enabled)

    filterPatterns?: string[]

    Array of regex/wildcard patterns to filter SQL statements

    filterType?: "include" | "exclude"

    How to apply patterns: 'include' or 'exclude' (default: exclude)

    formatAsMigration?: boolean

    Whether to format SQL output as a database migration file with proper headers

    logRecordChangeMetadata?: boolean

    Whether to include metadata about record changes in the log output

    prettyPrint?: boolean

    Whether to format SQL with proper indentation and line breaks

    retainEmptyLogFiles?: boolean

    Whether to keep log files even if they contain no SQL statements

    sessionName?: string

    Human-readable name for the logging session

    statementTypes?: "queries" | "mutations" | "both"

    Types of SQL statements to capture: 'queries', 'mutations', or 'both'

    verboseOutput?: boolean

    Whether to output verbose debug information to console

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties