Tighten naming conventions with SQLite

We should prefer, in the raw interface, at least, the same naming
conventions as SQLite. This should make it easier to transition with
less of a need to reference the documentation.

Signed-off-by: Stephen Celis <[email protected]>

Author: stephencelis

Documentation/Index.md

@@ -429,12 +429,12 @@ The `insert` function can return several different types that are useful in diff
     // COMMIT TRANSACTION;
     ```
 
-  - A tuple of the above [`ROWID`][ROWID] and statement: `(id: Int64?, statement: Statement)`, for flexibility.
+  - A tuple of the above [`ROWID`][ROWID] and statement: `(rowid: Int64?, statement: Statement)`, for flexibility.
 
     ``` swift
-    let (id, statement) = users.insert(email <- "[email protected]")
-    if let id = id {
-        println("inserted id: \(id)")
+    let (rowid, statement) = users.insert(email <- "[email protected]")
+    if let rowid = rowid {
+        println("inserted id: \(rowid)")
     } else if statement.failed {
         println("insertion failed: \(statement.reason)")
     }
@@ -898,11 +898,11 @@ Using the `transaction` and `savepoint` functions, we can run a series of statem
 ``` swift
 db.transaction()
     && users.insert(email <- "[email protected]")
-    && users.insert(email <- "[email protected]", manager_id <- db.lastId)
+    && users.insert(email <- "[email protected]", manager_id <- db.lastInsertRowid)
     && db.commit() || db.rollback()
 ```
 
-> _Note:_ Each statement is captured in an auto-closure and won’t execute till the preceding statement succeeds. This means we can use the `lastId` property on `Database` to reference the previous statement’s insert [`ROWID`][ROWID].
+> _Note:_ Each statement is captured in an auto-closure and won’t execute till the preceding statement succeeds. This means we can use the `lastInsertRowid` property on `Database` to reference the previous statement’s insert [`ROWID`][ROWID].
 
 
 ## Altering the Schema
@@ -1414,7 +1414,7 @@ Though we recommend you stick with SQLite.swift’s [type-safe system](#building
 
     ``` swift
     stmt.run("[email protected]")
-    db.lastChanges // -> {Some 1}
+    db.changes // -> {Some 1}
     ```
 
     Statements with results may be iterated over.

README.md

@@ -84,9 +84,9 @@ for email in ["[email protected]", "[email protected]"] {
     stmt.run(email)
 }
 
-db.totalChanges // 3
-db.lastChanges  // 1
-db.lastId       // 3
+db.totalChanges    // 3
+db.changes         // 1
+db.lastInsertRowid // 3
 
 for row in db.prepare("SELECT id, email FROM users") {
     println("id: \(row[0]), email: \(row[1])")

SQLite Tests/DatabaseTests.swift

@@ -18,24 +18,24 @@ class DatabaseTests: SQLiteTestCase {
         XCTAssert(db.readonly)
     }
 
-    func test_lastId_returnsNilOnNewConnections() {
-        XCTAssert(db.lastId == nil)
+    func test_lastInsertRowid_returnsNilOnNewConnections() {
+        XCTAssert(db.lastInsertRowid == nil)
     }
 
-    func test_lastId_returnsLastIdAfterInserts() {
+    func test_lastInsertRowid_returnsLastIdAfterInserts() {
         insertUser("alice")
-        XCTAssert(db.lastId! == 1)
+        XCTAssert(db.lastInsertRowid! == 1)
     }
 
-    func test_lastChanges_returnsZeroOnNewConnections() {
-        XCTAssertEqual(0, db.lastChanges)
+    func test_changes_returnsZeroOnNewConnections() {
+        XCTAssertEqual(0, db.changes)
     }
 
-    func test_lastChanges_returnsNumberOfChanges() {
+    func test_changes_returnsNumberOfChanges() {
         insertUser("alice")
-        XCTAssertEqual(1, db.lastChanges)
+        XCTAssertEqual(1, db.changes)
         insertUser("betsy")
-        XCTAssertEqual(1, db.lastChanges)
+        XCTAssertEqual(1, db.changes)
     }
 
     func test_totalChanges_returnsTotalNumberOfChanges() {

SQLite Tests/QueryTests.swift

@@ -296,11 +296,11 @@ class QueryTests: SQLiteTestCase {
     }
 
     func test_insert_insertsRows() {
-        XCTAssertEqual(1, users.insert(email <- "[email protected]", age <- 30).id!)
+        XCTAssertEqual(1, users.insert(email <- "[email protected]", age <- 30).rowid!)
 
         AssertSQL("INSERT INTO \"users\" (\"email\", \"age\") VALUES ('[email protected]', 30)")
 
-        XCTAssert(users.insert(email <- "[email protected]", age <- 30).id == nil)
+        XCTAssert(users.insert(email <- "[email protected]", age <- 30).rowid == nil)
     }
 
     func test_insert_withQuery_insertsRows() {
@@ -316,15 +316,15 @@ class QueryTests: SQLiteTestCase {
         db.execute("CREATE TABLE \"timestamps\" (\"id\" INTEGER PRIMARY KEY, \"timestamp\" TEXT DEFAULT CURRENT_DATETIME)")
         let table = db["timestamps"]
 
-        XCTAssertEqual(1, table.insert().id!)
+        XCTAssertEqual(1, table.insert().rowid!)
         AssertSQL("INSERT INTO \"timestamps\" DEFAULT VALUES")
     }
 
     func test_replace_replaceRows() {
-        XCTAssertEqual(1, users.replace(email <- "[email protected]", age <- 30).id!)
+        XCTAssertEqual(1, users.replace(email <- "[email protected]", age <- 30).rowid!)
         AssertSQL("INSERT OR REPLACE INTO \"users\" (\"email\", \"age\") VALUES ('[email protected]', 30)")
 
-        XCTAssertEqual(1, users.replace(id <- 1, email <- "[email protected]", age <- 30).id!)
+        XCTAssertEqual(1, users.replace(id <- 1, email <- "[email protected]", age <- 30).rowid!)
         AssertSQL("INSERT OR REPLACE INTO \"users\" (\"id\", \"email\", \"age\") VALUES (1, '[email protected]', 30)")
     }
 

SQLite/Database.swift

@@ -54,14 +54,14 @@ public final class Database {
     // MARK: -
 
     /// The last rowid inserted into the database via this connection.
-    public var lastId: Int64? {
-        let lastId = sqlite3_last_insert_rowid(handle)
-        return lastId == 0 ? nil : lastId
+    public var lastInsertRowid: Int64? {
+        let rowid = sqlite3_last_insert_rowid(handle)
+        return rowid == 0 ? nil : rowid
     }
 
     /// The last number of changes (inserts, updates, or deletes) made to the
     /// database via this connection.
-    public var lastChanges: Int {
+    public var changes: Int {
         return Int(sqlite3_changes(handle))
     }
 
@@ -363,7 +363,7 @@ public final class Database {
     /// Sets a busy timeout to retry after encountering a busy signal (lock).
     ///
     /// :param: ms Milliseconds to wait before retrying.
-    public func timeout(ms: Int) {
+    public func busyTimeout(ms: Int) {
         sqlite3_busy_timeout(handle, Int32(ms))
     }
 
@@ -374,17 +374,17 @@ public final class Database {
     ///                  number of times it’s been called for this lock. If it
     ///                  returns true, it will try again. If it returns false,
     ///                  no further attempts will be made.
-    public func busy(callback: ((tries: Int) -> Bool)?) {
+    public func busyHandler(callback: ((tries: Int) -> Bool)?) {
         try {
             if let callback = callback {
-                self.busy = { callback(tries: Int($0)) ? 1 : 0 }
+                self.busyHandler = { callback(tries: Int($0)) ? 1 : 0 }
             } else {
-                self.busy = nil
+                self.busyHandler = nil
             }
-            return _SQLiteBusyHandler(self.handle, self.busy)
+            return _SQLiteBusyHandler(self.handle, self.busyHandler)
         }
     }
-    private var busy: _SQLiteBusyHandlerCallback?
+    private var busyHandler: _SQLiteBusyHandlerCallback?
 
     /// Sets a handler to call when a statement is executed with the compiled
     /// SQL.

SQLite/Query.swift

@@ -444,14 +444,14 @@ public struct Query {
     /// :param: values A list of values to set.
     ///
     /// :returns: The rowid.
-    public func insert(value: Setter, _ more: Setter...) -> Int64? { return insert([value] + more).id }
+    public func insert(value: Setter, _ more: Setter...) -> Int64? { return insert([value] + more).rowid }
 
     /// Runs an INSERT statement against the query.
     ///
     /// :param: values A list of values to set.
     ///
     /// :returns: The rowid and statement.
-    public func insert(value: Setter, _ more: Setter...) -> (id: Int64?, statement: Statement) {
+    public func insert(value: Setter, _ more: Setter...) -> (rowid: Int64?, statement: Statement) {
         return insert([value] + more)
     }
 
@@ -460,16 +460,16 @@ public struct Query {
     /// :param: values An array of values to set.
     ///
     /// :returns: The rowid.
-    public func insert(values: [Setter]) -> Int64? { return insert(values).id }
+    public func insert(values: [Setter]) -> Int64? { return insert(values).rowid }
 
     /// Runs an INSERT statement against the query.
     ///
     /// :param: values An array of values to set.
     ///
     /// :returns: The rowid and statement.
-    public func insert(values: [Setter]) -> (id: Int64?, statement: Statement) {
+    public func insert(values: [Setter]) -> (rowid: Int64?, statement: Statement) {
         let statement = insertStatement(values).run()
-        return (statement.failed ? nil : database.lastId, statement)
+        return (statement.failed ? nil : database.lastInsertRowid, statement)
     }
 
     public func insert(query: Query) -> Int? { return insert(query).changes }
@@ -479,16 +479,16 @@ public struct Query {
     public func insert(query: Query) -> (changes: Int?, statement: Statement) {
         let expression = query.selectExpression
         let statement = database.run("INSERT INTO \(tableName.unaliased.SQL) \(expression.SQL)", expression.bindings)
-        return (statement.failed ? nil : database.lastChanges, statement)
+        return (statement.failed ? nil : database.changes, statement)
     }
 
-    public func insert() -> Int64? { return insert().id }
+    public func insert() -> Int64? { return insert().rowid }
 
     public func insert() -> Statement { return insert().statement }
 
-    public func insert() -> (id: Int64?, statement: Statement) {
+    public func insert() -> (rowid: Int64?, statement: Statement) {
         let statement = database.run("INSERT INTO \(tableName.unaliased.SQL) DEFAULT VALUES")
-        return (statement.failed ? nil : database.lastId, statement)
+        return (statement.failed ? nil : database.lastInsertRowid, statement)
     }
 
     /// Runs a REPLACE statement against the query.
@@ -503,14 +503,14 @@ public struct Query {
     /// :param: values A list of values to set.
     ///
     /// :returns: The rowid.
-    public func replace(values: Setter...) -> Int64? { return replace(values).id }
+    public func replace(values: Setter...) -> Int64? { return replace(values).rowid }
 
     /// Runs a REPLACE statement against the query.
     ///
     /// :param: values A list of values to set.
     ///
     /// :returns: The rowid and statement.
-    public func replace(values: Setter...) -> (id: Int64?, statement: Statement) {
+    public func replace(values: Setter...) -> (rowid: Int64?, statement: Statement) {
         return replace(values)
     }
 
@@ -519,16 +519,16 @@ public struct Query {
     /// :param: values An array of values to set.
     ///
     /// :returns: The rowid.
-    public func replace(values: [Setter]) -> Int64? { return replace(values).id }
+    public func replace(values: [Setter]) -> Int64? { return replace(values).rowid }
 
     /// Runs a REPLACE statement against the query.
     ///
     /// :param: values An array of values to set.
     ///
     /// :returns: The rowid and statement.
-    public func replace(values: [Setter]) -> (id: Int64?, statement: Statement) {
+    public func replace(values: [Setter]) -> (rowid: Int64?, statement: Statement) {
         let statement = insertStatement(values, or: .Replace).run()
-        return (statement.failed ? nil : database.lastId, statement)
+        return (statement.failed ? nil : database.lastInsertRowid, statement)
     }
 
     /// Runs an UPDATE statement against the query.
@@ -568,7 +568,7 @@ public struct Query {
     /// :returns: The number of updated rows and statement.
     public func update(values: [Setter]) -> (changes: Int?, statement: Statement) {
         let statement = updateStatement(values).run()
-        return (statement.failed ? nil : database.lastChanges, statement)
+        return (statement.failed ? nil : database.changes, statement)
     }
 
     /// Runs a DELETE statement against the query.
@@ -586,7 +586,7 @@ public struct Query {
     /// :returns: The number of deleted rows and statement.
     public func delete() -> (changes: Int?, statement: Statement) {
         let statement = deleteStatement.run()
-        return (statement.failed ? nil : database.lastChanges, statement)
+        return (statement.failed ? nil : database.changes, statement)
     }
 
     // MARK: - Aggregate Functions