ADSPONProvider

Provides access to a common, shared instance of the ADSPONProvider. For app’s that are working with a single SPON database, they can use this instance instead of creating their own instance of a ADSPONProvider.

Reference to the currently open database path or “” if no database is currently open.

The name of the currently open SPON database or “” if no database is currently open.

Gets the current user-defined version number for the database. This value can be useful in managing data migrations so that you can add new columns to your tables or massage your existing data to suit a new situation.

Returns true if a SPON data source is open in-memory, else returns false.

Returns true if the data provider can write to the currently open SPON database, else returns false.

An array of all tables that have been read from or written to the given data source.

Initializes a new instance of a ADSQLiteProvider.

Removes the given table from the list of known table names.

Example:

ADSQLiteProvider.shared.forgetTable("Category)

Opens the given SPON database file for the data provider from either the app’s Document or Bundle directories. If opening a database from the Document directory and it does not exist, the database will automatically be created. If opening a database from the Bundle directory for write access, the database will first be copied to the Document directory (if a copy doesn’t already exist there), and the Document directory copy of the database will be opened.

Example:

try ADSPONProvider.shared.openSource("MyData.spon")

Creates the given SPON database file for the data provider in the app’s Document directory. If the database file already exists, it will be opened instead.

Example:

try ADSPONProvider.shared.createSource("MyData.spon")

Saves the SPON database to the given filename.

Example:

try ADSPONProvider.shared.saveSource("MyData.spon")

Attempts to persist the in-memory data store to disk if the database is open, not read only and was origionally opened from a persistant source.

Example:

ADSPONProvider.shared.persist()

Attempts to persist and close the currently open SPON database.

Example:

ADSPONProvider.shared.closeSource()

For writable databases stored in the app’s document directory, delete the data source with the specified file name.

Example:

ADSPONProvider.deleteSource("MyDatabase.spon")

Execute SQL (non-query) command with (optional) parameters and return result code.

Example:

let sql = "CREATE TABLE IF NOT EXISTS Person (`ID` INTEGER, `Name` STRING)"
try ADSPONProvider.shared.execute(sql)

Run an SQL query with (parameters) parameters and returns an array of dictionaries where the keys are the column names.

Example:

let sql = "SELECT * FROM Person WHERE ID = ?"
let records = try ADSPONProvider.shared.query(sql, withParameters: [1])

Checks to see if the given table exists in the SPON database.

Example:

let exists = try ADSPONProvider.shared.tableExists("Person)

Counts the number of records in a given SPON database table, optionally filtered by a given set of contraints.

Example:

let count = try ADSPONProvider.shared.countRows(inTable: "Person", filteredBy: "ID = ?", withParameters: [1])

Gets the largest used number for the given integer primary key of the given table.

Example:

let lastID = try ADSPONProvider.shared.lastIntID(forTable: "Person", withKey: "ID")

Gets the last auto generated integer ID for the given table.

Example:

let lastID = ADSPONProvider.shared.lastAutoID(forTable: "Category")

Returns all information about a given table in the SPON database including all of the columns and their types.

Example:

let schema = try ADSPONProvider.shared.getTableSchema(forTableName: "Category")

Starts an explicit transaction to process a batch of database changes. Once started, the transaction will remain open until it is either committed (via endTransaction) or rolled-back (via rollbackTransaction).

Attempts to commit any chages to the database and close the current transaction that was opened using beginTransaction.

Ends the current transaction (opened using beginTransaction) and undoes any changes made to the database since the transaction was opened.

Registers the given ADDataTable class schema with the data provider and creates a table for the class if it doesn’t already exist.

Example:

try ADSPONProvider.shared.registerTableSchema(Category.self)

Attempts to modify the SPON database table schema to match the schema of the given ADDataTable class if the schema has changed. If the table does not exist, it will attempt to be registered with the database. If any new columns have been added, the default values will be set from the given defaults.

Example:

try ADSPONProvider.shared.updateTableSchema(Category.self)

Checks to see if a row matching the given primary key exists in the underlying SPON table.

Example:

let found = try ADSPONProvider.shared.hasRow(forType: Person.self, matchingPrimaryKey: 1)

Return the count of rows in the table, or the count of rows matching a specific filter criteria, if one was provided.

Example:

let count = try ADSPONProvider.shared.rowCount(forType: Person.self)

Creates an instance of the given ADDataTable class automatically setting the primaryKey field based on the value of the primaryKeyType.

Example:

var category = try ADSPONProvider.shared.make(Category.self)

Returns a value for the primaryKey field based on the value of the primaryKeyType for a class conforming to the ADDataTable protocol.

Example:

let id = ADSPONProvider.shared.makeID(Category.self) as! Int

Saves the given class conforming to the ADDataTable protocol to the database. If the SPON database does not contain a table named in the tableName property, one will be created first. If a record is not on file matching the primaryKey value, a new record will be created, else the existing record will be updated.

Example:

var category = Category()
try ADSPONProvider.shared.save(category)

Saves the given array of class instances conforming to the ADDataTable protocol to the database. If the SPON database does not contain a table named in the tableName property, one will be created first. If a record is not on file matching the primaryKey value, a new record will be created, else the existing record will be updated.

Example:

let c1 = Category()
let c2 = Category()
try ADSPONProvider.shared.save([c1, c2])

Returns rows from the SPON database of the given class type optionally filtered, sorted and limited to a specific range of results.

Example:

let records = try ADSPONProvider.shared.getRows(ofType: Person.self)

Returns rows from the SPON database of the given class type matching the given SQL statement.

Example:

let sql = "SELECT * FROM Person WHERE ID = ?"
let records = try ADSPONProvider.shared.getRows(ofType: Person.self, matchingSQL: sql, withParameters: [1])

Returns a row from the SPON database of the given class type matching the given primary key value.

Example:

let person = try ADSPONProvider.shared.getRow(ofType: Person.self, forPrimaryKeyValue: 1)

Returns a row from the SPON database of the given class type optionally filtered and limited to a specific range of results.

Example:

let category = try ADSPONProvider.shared.getRow(ofType: Category.self, atIndex: 10)

Deletes the row matching the given record from the SPON database.

Example:

let category = try ADSPONProvider.shared.getRow(ofType: Category.self, forPrimaryKeyValue: 10)
try ADSPONProvider.shared.delete(category)

Deletes the given set of records from the database.

Example:

let c1 = try ADSPONProvider.shared.getRow(ofType: Category.self, forPrimaryKeyValue: 10)
let c2 = try ADSPONProvider.shared.getRow(ofType: Category.self, forPrimaryKeyValue: 5)
try ADSPONProvider.shared.delete([c1, c2])

Drops the underlying table from the SPON database, completely removing all stored data in the table as well as the table itself.