Skip to content

Enumeration

SQLJoinMethod

The method used by a table join clause.
enum SQLJoinMethod

Overview

Used by SQLJoin and SQLJoinBuilder.

The set of joins expressible with this type is known to be very limited. This is partly on purpose, given the relatively large number of join types that exist across the various SQL dialects, the relatively few of those types which are supported by more than one dialect, and the ability to specify join methods as arbitrary SQLExpressions. It is also, however, a side effect of yet another of SQLKit’s current API design flaws, in this case the choice to have SQLJoinMethod serialize only to the join type, not even including the JOIN keyword, which makes it that much more difficult to express nontrivial join methods syntactically correctly.

Topics

Enumeration Cases

Instance Methods

  • serialize(to:)
    Invoked when a request is made to serialize the expression to raw SQL.

Relationships

Conforms To

  • SQLExpression
  • Swift.Equatable
  • Swift.Hashable
  • Swift.Sendable
  • Swift.SendableMetatype

See Also

Clause Expressions

  • SQLAlterColumnDefinitionType
    A clause specifying a new data type to be applied to an existing column.
  • SQLColumnAssignment
    Encapsulates a column_name=value expression in the context of an UPDATE query’s value assignment list. This is distinct from an SQLBinaryExpression using the .equal operator in that the left side must be an unqualified column name, the operator must be =, and the right side may use SQLExcludedColumn when the assignment appears in the assignments list of a SQLConflictAction.update(assignments:predicate:) specification.
  • SQLColumnConstraintAlgorithm
    Column-level data constraints.
  • SQLColumnDefinition
    A clause expressing a column definition, for use when creating and altering tables.
  • SQLConflictAction
    An action to take when an INSERT query encounters a unique constraint violation.
  • SQLConflictResolutionStrategy
    Specifies a conflict resolution strategy and associated conditions for an INSERT query. An INSERT with a conflict strategy is often refered to as an UPSERT (“insert or update”). Databases are not required to support any given subset of upsert functionality, or any at all.
  • SQLDropBehavior
    Specifies a behavior when performing a DROP operation on a database object which is referenced by other objects.
  • SQLEnumDataType
    Represents a data type which specifies an enumeration in the database.
  • SQLExcludedColumn
    An expression appearing on the right side of a column assignment which, when the assignment list is part of an upsert’s update acion, refers to the value which was originally to be inserted for the given column.
  • SQLForeignKey
    A complete FOREIGN KEY constraint specification.
  • SQLInsertModifier
    Simple helper for working around MySQL’s refusal to implement standard SQL. Only emits SQL when needed.
  • SQLJoin
    Encapsulates a single SQL JOIN, specifying the join type, the right-side table, and condition.
  • SQLLockingClause
    An SQL locking clause.
  • SQLOrderBy
    A pair of expressions, one describing a query sort key and the other a directionality for that key.
  • SQLReturning
    A clause describing a list of values to be returned from a data-modifying query.