SQLiteConnection

public class SQLiteConnection: Connection

An implementation of SwiftKuery.Connection protocol for SQLite. Please see SQLite manual for details.

  • An indication whether there is a connection to the database.

    Declaration

    Swift

    public var isConnected: Bool

  • The QueryBuilder with SQLite specific substitutions.

    Declaration

    Swift

    public var queryBuilder: QueryBuilder

  • Initialiser to create a SwiftKuerySQLite instance.

    Declaration

    Swift

    public init(_ location: Location = .inMemory)

    Parameters

    location

    Describes where the database is stored.

    Return Value

    An instance of SQLiteConnection.

  • Initialiser with a path to where the database is stored.

    Declaration

    Swift

    public convenience init(filename: String)

    Parameters

    filename

    The path where the database is stored.

    Return Value

    An instance of SQLiteConnection.

  • Create a connection pool for SQLiteConnection’s.

    Declaration

    Swift

    public static func createPool(_ location: Location = .inMemoryShared, poolOptions: ConnectionPoolOptions) -> ConnectionPool

    Parameters

    location

    Describes where the database is stored.

    Return Value

    The ConnectionPool of SQLiteConnection.

  • Create a connection pool for SQLiteConnection’s.

    Declaration

    Swift

    public static func createPool(filename: String, poolOptions: ConnectionPoolOptions) -> ConnectionPool

    Parameters

    filename

    The path where the database is stored.

    Return Value

    The ConnectionPool of SQLiteConnection.

  • 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.

  • Establish a connection with the database.

    Declaration

    Swift

    public func connectSync() -> QueryResult

    Return Value

    A QueryError if the connection cannot connect, otherwise nil

  • 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.

  • Close the connection to the database.

    Declaration

    Swift

    public func closeConnection()

  • 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 a raw query.

    Declaration

    Swift

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

    Parameters

    query

    A String with the query to execute.
    onCompletion

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

  • 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 a raw query with parameters.

    Declaration

    Swift

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

    Parameters

    query

    A String with 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 a query with parameters.

    Declaration

    Swift

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

    Parameters

    query

    The 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.

  • Execute a raw query with parameters.

    Declaration

    Swift

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

    Parameters

    query

    A String with the 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.

  • 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 statementhas been prepared.

  • 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 statementhas been prepared.

  • 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 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 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 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.

  • 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 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 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 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 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 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.