Functions

The following functions are available globally.

AggregateColumnExpression


                    
                    
                    avg(_:)

Create an AggregateColumnExpression using the AVG function.

Declaration

Swift

public func avg(_ field: Field) -> AggregateColumnExpression

Parameters


                                field

The Field to apply the function on.

Return Value

An instance of AggregateColumnExpression.


                    
                    
                    max(_:)

Create an AggregateColumnExpression using the MAX function.

Declaration

Swift

public func max(_ field: Field) -> AggregateColumnExpression

Parameters


                                field

The Field to apply the function on.

Return Value

An instance of AggregateColumnExpression.


                    
                    
                    min(_:)

Create an AggregateColumnExpression using the MIN function.

Declaration

Swift

public func min(_ field: Field) -> AggregateColumnExpression

Parameters


                                field

The Field to apply the function on.

Return Value

An instance of AggregateColumnExpression.


                    
                    
                    sum(_:)

Create an AggregateColumnExpression using the SUM function.

Declaration

Swift

public func sum(_ field: Field) -> AggregateColumnExpression

Parameters


                                field

The Field to apply the function on.

Return Value

An instance of AggregateColumnExpression.


                    
                    
                    last(_:)

Create an AggregateColumnExpression using the LAST function.

Declaration

Swift

public func last(_ field: Field) -> AggregateColumnExpression

Parameters


                                field

The Field to apply the function on.

Return Value

An instance of AggregateColumnExpression.


                    
                    
                    first(_:)

Create an AggregateColumnExpression using the FIRST function.

Declaration

Swift

public func first(_ field: Field) -> AggregateColumnExpression

Parameters


                                field

The Field to apply the function on.

Return Value

An instance of AggregateColumnExpression.


                    
                    
                    count(_:)

Create an AggregateColumnExpression using the COUNT function.

Declaration

Swift

public func count(_ field: Field) -> AggregateColumnExpression

Parameters


                                field

The Field to apply the function on.

Return Value

An instance of AggregateColumnExpression.


                    
                    
                    countDistinct(_:)

Create an AggregateColumnExpression using the COUNT DISTINCT function.

Declaration

Swift

public func countDistinct(_ field: Field) -> AggregateColumnExpression

Parameters


                                field

The Field to apply the function on.

Return Value

An instance of AggregateColumnExpression.


                    
                    
                    len(_:)

Create a AggregateColumnExpression using the LEN function.

Declaration

Swift

public func len(_ field: AggregateColumnExpression) -> AggregateColumnExpression

Parameters


                                field

The AggregateColumnExpression to apply the function on.

Return Value

An instance of AggregateColumnExpression.


                    
                    
                    ucase(_:)

Create a AggregateColumnExpression the using UCASE function.

Declaration

Swift

public func ucase(_ field: AggregateColumnExpression) -> AggregateColumnExpression

Parameters


                                field

The AggregateColumnExpression to apply the function on.

Return Value

An instance of AggregateColumnExpression.


                    
                    
                    lcase(_:)

Create a AggregateColumnExpression using the LCASE function.

Declaration

Swift

public func lcase(_ field: AggregateColumnExpression) -> AggregateColumnExpression

Parameters


                                field

The AggregateColumnExpression to apply the function on.

Return Value

An instance of AggregateColumnExpression.


                    
                    
                    round(_:to:)

Create a AggregateColumnExpression using the ROUND function.

Declaration

Swift

public func round(_ field: AggregateColumnExpression, to decimal: Int) -> AggregateColumnExpression

Parameters

`field`	The `AggregateColumnExpression` to apply the function on.
`to`	The decimal to round the values to.

Return Value

An instance of AggregateColumnExpression.


                    
                    
                    mid(_:start:length:)

Create a AggregateColumnExpression using the MID function.

Declaration

Swift

public func mid(_ field: AggregateColumnExpression, start: Int, length: Int) -> AggregateColumnExpression

Parameters

`field`	The `AggregateColumnExpression` to apply the function on.
`start`	The starting position for the text extraction.
`length`	The number of characters to return.

Return Value

An instance of AggregateColumnExpression.

QueryFilterProtocol


                    
                    
                    ||(_:_:)

Create a Filter clause using the OR operator.

Declaration

Swift

public func || (lhs: Filter, rhs: Filter) -> Filter

Parameters

`lhs`	A `Filter` - the left hand side of the clause.
`rhs`	A `Filter` - the right hand side of the clause.

Return Value

A Filter containing the clause.


                    
                    
                    &&(_:_:)

Create a Filter clause using the AND operator.

Declaration

Swift

public func && (lhs: Filter, rhs: Filter) -> Filter

Parameters

`lhs`	A `Filter` - the left hand side of the clause.
`rhs`	A `Filter` - the right hand side of the clause.

Return Value

A Filter containing the clause.


                    
                    
                    exists(_:)

Create a Filter clause using the EXISTS operator.

Declaration

Swift

public func exists(_ query: Select) -> Filter

Parameters


                                query

The Select query to apply EXISTS on.

Return Value

A Filter containing the clause.


                    
                    
                    notExists(_:)

Create a Filter clause using the NOT EXISTS operator.

Declaration

Swift

public func notExists(_ query: Select) -> Filter

Parameters


                                query

The Select query to apply NOT EXISTS on.

Return Value

A Filter containing the clause.


                    
                    
                    any(_:)

Create a FilterPredicate using the ANY operator.

Declaration

Swift

public func any(_ query: Select) -> Predicate<Filter, ScalarColumnExpression>

Parameters


                                query

The Select query to apply ANY on.

Return Value

A Predicate<Filter, ScalarColumnExpression> containing the anySubquery.


                    
                    
                    all(_:)

Create a FilterPredicate using the ALL operator.

Declaration

Swift

public func all(_ query: Select) -> Predicate<Filter, ScalarColumnExpression>

Parameters


                                query

The Select query to apply ALL on.

Return Value

A Predicate<Filter, ScalarColumnExpression> containing the allSubquery.

QueryHavingProtocol


                    
                    
                    ||(_:_:)

Create a Having clause using the OR operator.

Declaration

Swift

public func || (lhs: Having, rhs: Having) -> Having

Parameters

`lhs`	A `Having` - the left hand side of the clause.
`rhs`	A `Having` - the right hand side of the clause.

Return Value

A Having containing the clause.


                    
                    
                    &&(_:_:)

Create a Having clause using the AND operator.

Declaration

Swift

public func && (lhs: Having, rhs: Having) -> Having

Parameters

`lhs`	A `Having` - the left hand side of the clause.
`rhs`	A `Having` - the right hand side of the clause.

Return Value

A Having containing the clause.


                    
                    
                    exists(_:)

Create a Having clause using the EXISTS operator.

Declaration

Swift

public func exists(_ query: Select) -> Having

Parameters


                                query

The Select query to apply EXISTS on.

Return Value

A Having containing the clause.


                    
                    
                    notExists(_:)

Create a Having clause using the NOT EXISTS operator.

Declaration

Swift

public func notExists(_ query: Select) -> Having

Parameters


                                query

The Select query to apply NOT EXISTS on.

Return Value

A Having containing the clause.


                    
                    
                    any(_:)

Create a HavingPredicate using the ANY operator.

Declaration

Swift

public func any(_ query: Select) -> Predicate<Having, AggregateColumnExpression>

Parameters


                                query

The Select query to apply ANY on.

Return Value

A Predicate<Having, AggregateColumnExpression> containing the anySubquery.


                    
                    
                    all(_:)

Create a HavingPredicate using the ALL operator.

Declaration

Swift

public func all(_ query: Select) -> Predicate<Having, AggregateColumnExpression>

Parameters


                                query

The Select query to apply ALL on.

Return Value

A Predicate<Having, AggregateColumnExpression> containing the allSubquery.

IndexColumnOrdered


                    
                    
                    asc(_:)

Create a IndexColumnOrdered.ASC for the column.

Declaration

Swift

public func asc(_ column: Column) -> IndexColumnOrdered

Parameters


                                column

The column to apply IndexColumnOrdered.ASC.

Return Value

IndexColumnOrdered.ASC for the column.


                    
                    
                    desc(_:)

Create a IndexColumnOrdered.DESC for the column.

Declaration

Swift

public func desc(_ column: Column) -> IndexColumnOrdered

Parameters


                                column

The column to apply IndexColumnOrdered.ASC.

Return Value

IndexColumnOrdered.DESC for the column.

ScalarColumnExpression

now()
Create a ScalarColumnExpression using the NOW function.
Declaration
Swift

public func now() -> ScalarColumnExpression
Return Value

An instance of ScalarColumnExpression.


                    
                    
                    len(_:)

Create a ScalarColumnExpression using the LEN function.

Declaration

Swift

public func len(_ field: ScalarColumnExpression) -> ScalarColumnExpression

Parameters


                                field

The ScalarColumnExpression to apply the function on.

Return Value

An instance of ScalarColumnExpression.


                    
                    
                    ucase(_:)

Create a ScalarColumnExpression using the UCASE function.

Declaration

Swift

public func ucase(_ field: ScalarColumnExpression) -> ScalarColumnExpression

Parameters


                                field

The ScalarColumnExpression to apply the function on.

Return Value

An instance of ScalarColumnExpression.


                    
                    
                    lcase(_:)

Create a ScalarColumnExpression using the LCASE function.

Declaration

Swift

public func lcase(_ field: ScalarColumnExpression) -> ScalarColumnExpression

Parameters


                                field

The ScalarColumnExpression to apply the function on.

Return Value

An instance of ScalarColumnExpression.


                    
                    
                    round(_:to:)

Create a ScalarColumnExpression using the ROUND function.

Declaration

Swift

public func round(_ field: ScalarColumnExpression, to decimal: Int) -> ScalarColumnExpression

Parameters

`field`	The `ScalarColumnExpression` to apply the function on.
`to`	The decimal to round the values to.

Return Value

An instance of ScalarColumnExpression.


                    
                    
                    mid(_:start:length:)

Create a ScalarColumnExpression using the MID function.

Declaration

Swift

public func mid(_ field: ScalarColumnExpression, start: Int, length: Int) -> ScalarColumnExpression

Parameters

`field`	The `ScalarColumnExpression` to apply the function on.
`start`	The starting position for the text extraction.
`length`	The number of characters to return.

Return Value

An instance of ScalarColumnExpression.


                    
                    
                    len(_:)

Create a ScalarColumnExpression using the LEN function.

Declaration

Swift

public func len(_ field: Column) -> ScalarColumnExpression

Parameters


                                field

The Column to apply the function on.

Return Value

An instance of ScalarColumnExpression.


                    
                    
                    ucase(_:)

Create a ScalarColumnExpression using the UCASE function.

Declaration

Swift

public func ucase(_ field: Column) -> ScalarColumnExpression

Parameters


                                field

The Column to apply the function on.

Return Value

An instance of ScalarColumnExpression.


                    
                    
                    lcase(_:)

Create a ScalarColumnExpression using the LCASE function.

Declaration

Swift

public func lcase(_ field: Column) -> ScalarColumnExpression

Parameters


                                field

The Column to apply the function on.

Return Value

An instance of ScalarColumnExpression.


                    
                    
                    round(_:to:)

Create a ScalarColumnExpression using the ROUND function.

Declaration

Swift

public func round(_ field: Column, to decimal: Int) -> ScalarColumnExpression

Parameters

`field`	The `Column` to apply the function on.
`to`	The decimal to round the values to.

Return Value

An instance of ScalarColumnExpression.


                    
                    
                    mid(_:start:length:)

Create a ScalarColumnExpression using the MID function.

Declaration

Swift

public func mid(_ field: Column, start: Int, length: Int) -> ScalarColumnExpression

Parameters

`field`	The `Column` to apply the function on.
`start`	The starting position for the text extraction.
`length`	The number of characters to return.

Return Value

An instance of ScalarColumnExpression.

With


                    
                    
                    with(_:_:)

Create a query with a WITH clause.

Declaration

Swift

public func with(_ table: AuxiliaryTable, _ query: Select) -> Select

Parameters

`table`	A table for a WITH clause.
`query`	A SELECT query that will use the table from the WITH clause.


                    
                    
                    with(_:_:)

Create a query with a WITH clause.

Declaration

Swift

public func with(_ tables: [AuxiliaryTable], _ query: Select) -> Select

Parameters

`tables`	An array of tables for a WITH clause.
`query`	A SELECT query that will use the table from the WITH clause.


                    
                    
                    with(_:_:)

Create a query with a WITH clause.

Declaration

Swift

public func with(_ table: AuxiliaryTable, _ query: Insert) -> Insert

Parameters

`table`	A table for a WITH clause.
`query`	An INSERT query that will use the table from the WITH clause.


                    
                    
                    with(_:_:)

Create a query with a WITH clause.

Declaration

Swift

public func with(_ tables: [AuxiliaryTable], _ query: Insert) -> Insert

Parameters

`tables`	An array of tables for a WITH clause.
`query`	An INSERT query that will use the table from the WITH clause.


                    
                    
                    with(_:_:)

Create a query with a WITH clause.

Declaration

Swift

public func with(_ table: AuxiliaryTable, _ query: Update) -> Update

Parameters

`table`	A table for a WITH clause.
`query`	An UPDATE query that will use the table from the WITH clause.


                    
                    
                    with(_:_:)

Create a query with a WITH clause.

Declaration

Swift

public func with(_ tables: [AuxiliaryTable], _ query: Update) -> Update

Parameters

`tables`	An array of tables for a WITH clause.
`query`	An UPDATE query that will use the table from the WITH clause.


                    
                    
                    with(_:_:)

Create a query with a WITH clause.

Declaration

Swift

public func with(_ table: AuxiliaryTable, _ query: Delete) -> Delete

Parameters

`table`	A table for a WITH clause.
`query`	A DELETE query that will use the table from the WITH clause.


                    
                    
                    with(_:_:)

Create a query with a WITH clause.

Declaration

Swift

public func with(_ tables: [AuxiliaryTable], _ query: Delete) -> Delete

Parameters

`tables`	An array of tables for a WITH clause.
`query`	A DELETE query that will use the table from the WITH clause.