PostgreSQLConnection Class Reference


                    
                    
                    isConnected

An indication whether there is a connection to the database.

Declaration

Swift

public var isConnected: Bool { get }


                    
                    
                    queryBuilder

The QueryBuilder with PostgreSQL specific substitutions.

Declaration

Swift

public var queryBuilder: QueryBuilder


                    
                    
                    init(host:port:options:)

Initialize an instance of PostgreSQLConnection.

Declaration

Swift

public convenience init(host: String, port: Int32, options: [ConnectionOptions]?)

Parameters

`host`	The host of the PostgreSQL server to connect to.
`port`	The port of the PostgreSQL server to connect to.
`options`	A set of `ConnectionOptions` to pass to the PostgreSQL server.


                    
                    
                    init(url:)

Initialize an instance of PostgreSQLConnection.

Declaration

Swift

public convenience init(url: URL)

Parameters

url

A URL of the following form: Postgres://userid:pwd@host:port/db.


                    
                    
                    createPool(url:poolOptions:)

Create a connection pool for PostgreSQLConnection’s.

Declaration

Swift

public static func createPool(url: URL, poolOptions: ConnectionPoolOptions) -> ConnectionPool

Parameters

`url`	A URL of the PostgreSQL server of the following form: Postgres://userid:pwd@host:port/db.
`poolOptions`	A set of `ConnectionPoolOptions` to configure the created pool.

Return Value

The ConnectionPool of PostgreSQLConnection.


                    
                    
                    createPool(host:port:options:poolOptions:)

Create a connection pool for PostgreSQLConnection’s.

Declaration

Swift

public static func createPool(host: String, port: Int32, options: [ConnectionOptions]?, poolOptions: ConnectionPoolOptions) -> ConnectionPool

Parameters

`host`	The host of the PostgreSQL server to connect to.
`port`	The port of the PostgreSQL server to connect to.
`options`	A set of `ConnectionOptions` to pass to the PostgreSQL server.
`poolOptions`	A set of `ConnectionPoolOptions` to configure the created pool.

Return Value

The ConnectionPool of PostgreSQLConnection.


                    
                    
                    descriptionOf(query:)

Return a String representation of the query.

Throws

QueryError.syntaxError if query build fails.

Declaration

Swift

public func descriptionOf(query: Query) throws -> String

Parameters


                                query

The query.

Return Value

A String representation of the query.


                    
                    
                    connect(onCompletion:)

Establish a connection with the database.

Declaration

Swift

public func connect(onCompletion: @escaping (QueryResult) -> ())

Parameters


                                onCompletion

The function to be called when the connection is established.


                    
                    
                    connectSync()

Establish a connection with the database.

Declaration

Swift

public func connectSync() -> QueryResult

Return Value

QueryError or nil if connection is succesful.


                    
                    
                    closeConnection()

Close the connection to the database.

Declaration

Swift

public func closeConnection()


                    
                    
                    execute(query:parameters:onCompletion:)

Execute a query with parameters.

Declaration

Swift

public func execute(query: Query, parameters: [Any?], onCompletion: @escaping ((QueryResult) -> ()))

Parameters

`query`	The query to execute.
`parameters`	An array of the parameters.
`onCompletion`	The function to be called when the execution of the query has completed.


                    
                    
                    execute(query:onCompletion:)

Execute a query.

Declaration

Swift

public func execute(query: Query, onCompletion: @escaping ((QueryResult) -> ()))

Parameters

`query`	The query to execute.
`onCompletion`	The function to be called when the execution of the query has completed.


                    
                    
                    execute(_:onCompletion:)

Execute a raw query.

Declaration

Swift

public func execute(_ raw: String, onCompletion: @escaping ((QueryResult) -> ()))

Parameters

`raw`	A String with the raw query to execute.
`onCompletion`	The function to be called when the execution of the query has completed.


                    
                    
                    execute(_:parameters:onCompletion:)

Execute a raw query with parameters.

Declaration

Swift

public func execute(_ raw: String, parameters: [Any?], onCompletion: @escaping ((QueryResult) -> ()))

Parameters

`raw`	A String with the raw query to execute.
`parameters`	An array of the parameters.
`onCompletion`	The function to be called when the execution of the query has completed.


                    
                    
                    execute(_:parameters:onCompletion:)

Execute a raw query with parameters.

Declaration

Swift

public func execute(_ raw: String, parameters: [String : Any?], onCompletion: @escaping ((QueryResult) -> ()))

Parameters

`raw`	A String with the raw query to execute.
`parameters`	A dictionary of the parameters with parameter names as the keys.
`onCompletion`	The function to be called when the execution of the query has completed.


                    
                    
                    prepareStatement(_:onCompletion:)

Prepare statement.

Declaration

Swift

public func prepareStatement(_ query: Query, onCompletion: @escaping ((QueryResult) -> ()))

Parameters

`query`	The query to prepare statement for.
`onCompletion`	The function to be called when the statement has been prepared.


                    
                    
                    prepareStatement(_:onCompletion:)

Prepare statement.

Declaration

Swift

public func prepareStatement(_ raw: String, onCompletion: @escaping ((QueryResult) -> ()))

Parameters

`raw`	A String with the query to prepare statement for.
`onCompletion`	The function to be called when the statement has been prepared.


                    
                    
                    execute(preparedStatement:onCompletion:)

Execute a prepared statement.

Declaration

Swift

public func execute(preparedStatement: PreparedStatement, onCompletion: @escaping ((QueryResult) -> ()))

Parameters

`preparedStatement`	The prepared statement to execute.
`onCompletion`	The function to be called when the execution has completed.


                    
                    
                    execute(preparedStatement:parameters:onCompletion:)

Execute a prepared statement with parameters.

Declaration

Swift

public func execute(preparedStatement: PreparedStatement, parameters: [Any?], onCompletion: @escaping ((QueryResult) -> ()))

Parameters

`preparedStatement`	The prepared statement to execute.
`parameters`	An array of the parameters.
`onCompletion`	The function to be called when the execution has completed.


                    
                    
                    execute(preparedStatement:parameters:onCompletion:)

Execute a prepared statement with parameters.

Declaration

Swift

public func execute(preparedStatement: PreparedStatement, parameters: [String : Any?], onCompletion: @escaping ((QueryResult) -> ()))

Parameters

`preparedStatement`	The prepared statement to execute.
`parameters`	A dictionary of the parameters with parameter names as the keys.
`onCompletion`	The function to be called when the execution has completed.


                    
                    
                    release(preparedStatement:onCompletion:)

Release a prepared statement.

Declaration

Swift

public func release(preparedStatement: PreparedStatement, onCompletion: @escaping ((QueryResult) -> ()))

Parameters

`preparedStatement`	The prepared statement to release.
`onCompletion`	The function to be called when the execution has completed.


                    
                    
                    startTransaction(onCompletion:)

Start a transaction.

Declaration

Swift

public func startTransaction(onCompletion: @escaping ((QueryResult) -> ()))

Parameters


                                onCompletion

The function to be called when the execution of start transaction command has completed.


                    
                    
                    commit(onCompletion:)

Commit the current transaction.

Declaration

Swift

public func commit(onCompletion: @escaping ((QueryResult) -> ()))

Parameters


                                onCompletion

The function to be called when the execution of commit transaction command has completed.


                    
                    
                    rollback(onCompletion:)

Rollback the current transaction.

Declaration

Swift

public func rollback(onCompletion: @escaping ((QueryResult) -> ()))

Parameters


                                onCompletion

The function to be called when the execution of rolback transaction command has completed.


                    
                    
                    create(savepoint:onCompletion:)

Create a savepoint.

Declaration

Swift

public func create(savepoint: String, onCompletion: @escaping ((QueryResult) -> ()))

Parameters

`savepoint`	The name to be given to the created savepoint.
`onCompletion`	The function to be called when the execution of create savepoint command has completed.


                    
                    
                    rollback(to:onCompletion:)

Rollback the current transaction to the specified savepoint.

Declaration

Swift

public func rollback(to savepoint: String, onCompletion: @escaping ((QueryResult) -> ()))

Parameters


                                onCompletion

The function to be called when the execution of rolback transaction command has completed.


                    
                    
                    release(savepoint:onCompletion:)

Release a savepoint.

Declaration

Swift

public func release(savepoint: String, onCompletion: @escaping ((QueryResult) -> ()))

Parameters

`savepoint`	The name of the savepoint to release.
`onCompletion`	The function to be called when the execution of release savepoint command has completed.