Class SqlLoggingOptions

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

Constructors

constructor

Properties

batchSeparator? description? filterByUserId? formatAsMigration? logRecordChangeMetadata? prettyPrint? retainEmptyLogFiles? sessionName? statementTypes?

Constructors

constructor

Properties

Optional batchSeparator

batchSeparator?: string

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

Optional description

description?: string

Optional description or notes for this logging configuration

Optional filterByUserId

filterByUserId?: string

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

Optional formatAsMigration

formatAsMigration?: boolean

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

Optional logRecordChangeMetadata

logRecordChangeMetadata?: boolean

Whether to include metadata about record changes in the log output

Optional prettyPrint

prettyPrint?: boolean

Whether to format SQL with proper indentation and line breaks

Optional retainEmptyLogFiles

retainEmptyLogFiles?: boolean

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

Optional sessionName

sessionName?: string

Human-readable name for the logging session

Optional statementTypes

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

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

Settings

Member Visibility

Theme

On This Page

constructorbatchSeparatordescriptionfilterByUserIdformatAsMigrationlogRecordChangeMetadataprettyPrintretainEmptyLogFilessessionNamestatementTypes