Structure
SQLFunction
A call to a function available in SQL, expressed as a name and a (possibly empty) list of arguments.
struct SQLFunctionOverview
Example usage:
try await sqlDatabase.select()
.column(SQLFunction("coalesce", args: SQlColumn("col1"), SQlColumn("col2"), SQLBind(defaultValue)))
.from("table")
.all()Note
SQLFunction is permitted to substitute function names during serialization based on the current dialect if a known, unambiguous replacement for an unavailable name is available. At the time of this writing, no such substitutions take place in practice, but it would be of obvious utility in certain common cases, such as SQLite’s lack of support for the NOW() function.
Topics
Initializers
init(_:args:)Create a function from a name and list of arguments.
Instance Properties
let args: [any SQLExpression]The list of function arguments. May be empty.let name: StringThe function’s name.
Instance Methods
func serialize(to: inout SQLSerializer)Invoked when a request is made to serialize the expression to raw SQL.
Type Methods
static coalesce(_:)A factory method to simplify use of the standardCOALESCE()function.
Relationships
Conforms To
SQLExpressionSwift.SendableSwift.SendableMetatype
See Also
Syntactic Expressions
struct SQLBinaryExpressionA fundamental syntactical expression - a left and right operand joined by an infix operator.enum SQLBinaryOperatorSQL binary expression operators.struct SQLBindA parameterizied value bound to the SQL query.struct SQLGroupExpressionA fundamental syntactical expression - an arbitrary expression or list of expressions, surroudned by parenthesis.struct SQLIdentifierA fundamental syntactical expression - a quoted identifier (also often referred to as a “name” or “object name”).struct SQLListA fundamental syntactical expression - a list of subexpresions with a specified “separator” subexpression.enum SQLLiteralA fundamental syntactical expression - one of several various kinds of literal SQL expressions.struct SQLRawA fundamental syntactical expression - an arbitrary string of raw SQL with no escaping or formating of any kind.