SQLDialect

Topics

Basics

• var name: String
  The name of the dialect.
• var identifierQuote: any SQLExpression
  An expression (usually an SQLRaw) giving the character(s) used to quote SQL identifiers, such as table and column names.
• var literalStringQuote: any SQLExpression
  An expression (usually an SQLRaw) giving the character(s) used to quote literal string values which appear in a query, such as enumerator names.
• func bindPlaceholder(at: Int) -> any SQLExpression
  A function which returns an expression to be used as the placeholder for the positionth bound parameter in a query.
• func literalBoolean(Bool) -> any SQLExpression
  A function which returns an SQL expression (usually an SQLRaw) representing the given literal boolean value.
• var literalDefault: any SQLExpression
  An expression (usually an SQLRaw) giving the syntax used to express both “use this as the default value” in a column definition and “use the default value for this column” in a value list.

Support Flags

• var supportsAutoIncrement: Bool
  true if the dialect supports auto-increment for primary key values when inserting new rows, false if not.
• var supportsIfExists: Bool
  true if the dialect supports the IF EXISTS modifier for all types of DROP queries (such as SQLDropEnum, SQLDropIndex, SQLDropTable, and SQLDropTrigger) and the IF NOT EXISTS modifier for SQLCreateTable queries.
• var supportsDropBehavior: Bool
  true if the dialect supports the behavior modifiers for DROPqueries,false` if not.
• var supportsReturning: Bool
  true if the dialect supports RETURNING syntax for retrieving output values from DML queries (INSERT, UPDATE, DELETE).
• var unionFeatures: SQLUnionFeatures
  A set of feature flags describing the dialect’s support for various forms of UNION with SELECT queries.

Syntax Indicators

• var enumSyntax: SQLEnumSyntax
  The syntax the dialect supports for strongly-typed enumerations.
• var triggerSyntax: SQLTriggerSyntax
  Various flags describing the dialect’s support for specific features of SQLCreateTrigger and SQLDropTrigger queries.
• var alterTableSyntax: SQLAlterTableSyntax
  A description of the syntax the dialect supports for SQLAlterTable queries.
• var autoIncrementClause: any SQLExpression
  An expression inserted in a column definition when a .primaryKey(autoincrement: true) constraint is specified for the column.
• var autoIncrementFunction: (any SQLExpression)?
  An expression inserted in a column definition when a SQLColumnConstraintAlgorithm.primaryKey(autoIncrement:) or SQLTableConstraintAlgorithm.primaryKey(columns:) constraint is specified for the column.
• var upsertSyntax: SQLUpsertSyntax
  The type of UPSERT syntax supported by the dialect.
• var sharedSelectLockExpression: (any SQLExpression)?
  A serialization for SQLLockingClause.share.
• var exclusiveSelectLockExpression: (any SQLExpression)?
  A serialization for SQLLockingClause.update.

Modifier Methods

• func customDataType(for: SQLDataType) -> (any SQLExpression)?
  A function which is consulted whenever an SQLDataType will be serialized into a query. The dialect may return an expression which will replace the default serialization of the given type. Returning nil causes the default to be used.
• func normalizeSQLConstraint(identifier: any SQLExpression) -> any SQLExpression
  A function which is consulted whenever a constraint name will be serialized into a query. The dialect must return an expression for an identifer which is unique to the input identifier and is a valid constraint name for the dialect.
• func nestedSubpathExpression(in: any SQLExpression, for: [String]) -> (any SQLExpression)?
  Given a column name and a path consisting of one or more elements, return an expression appropriate for accessing a value at the given JSON path.