Add documenation, update changelog

Author: jberkel

CHANGELOG.md

@@ -1,3 +1,15 @@
+0.14.0 (tbd), [diff][diff-0.14.0]
+========================================
+
+* Support ATTACH/DETACH ([#30][], [##1142][])
+* Support WITH clause ([#1139][])
+* Add value conformance for NSURL ([#1141][])
+* Add decoding for UUID ([#1137][])
+* Fix insertMany([Encodable]) ([#1130][], [#1138]][])
+* Fix incorrect spelling of 'remove_diacritics' ([#1128][])
+* Fix project build order ([#1131][])
+* Performance improvements ([#1109][], [#1115][], [#1132][])
+
 0.13.3 (25-01-2022), [diff][diff-0.13.3]
 ========================================
 
@@ -110,7 +122,9 @@
 [diff-0.13.1]: https://github.com/stephencelis/SQLite.swift/compare/0.13.0...0.13.1
 [diff-0.13.2]: https://github.com/stephencelis/SQLite.swift/compare/0.13.1...0.13.2
 [diff-0.13.3]: https://github.com/stephencelis/SQLite.swift/compare/0.13.2...0.13.3
+[diff-0.14.0]: https://github.com/stephencelis/SQLite.swift/compare/0.13.3...0.14.0
 
+[#30]: https://github.com/stephencelis/SQLite.swift/issues/30
 [#142]: https://github.com/stephencelis/SQLite.swift/issues/142
 [#315]: https://github.com/stephencelis/SQLite.swift/issues/315
 [#426]: https://github.com/stephencelis/SQLite.swift/pull/426
@@ -150,6 +164,16 @@
 [#1095]: https://github.com/stephencelis/SQLite.swift/pull/1095
 [#1100]: https://github.com/stephencelis/SQLite.swift/pull/1100
 [#1105]: https://github.com/stephencelis/SQLite.swift/pull/1105
+[#1109]: https://github.com/stephencelis/SQLite.swift/issues/1109
 [#1112]: https://github.com/stephencelis/SQLite.swift/pull/1112
+[#1115]: https://github.com/stephencelis/SQLite.swift/pull/1115
 [#1119]: https://github.com/stephencelis/SQLite.swift/pull/1119
 [#1121]: https://github.com/stephencelis/SQLite.swift/pull/1121
+[#1128]: https://github.com/stephencelis/SQLite.swift/issues/1128
+[#1130]: https://github.com/stephencelis/SQLite.swift/issues/1130
+[#1131]: https://github.com/stephencelis/SQLite.swift/pull/1131
+[#1132]: https://github.com/stephencelis/SQLite.swift/pull/1132
+[#1137]: https://github.com/stephencelis/SQLite.swift/pull/1137
+[#1138]: https://github.com/stephencelis/SQLite.swift/pull/1138
+[#1139]: https://github.com/stephencelis/SQLite.swift/pull/1139
+[#1142]: https://github.com/stephencelis/SQLite.swift/pull/1142

Documentation/Index.md

@@ -10,6 +10,7 @@
       - [Read-Write Databases](#read-write-databases)
       - [Read-Only Databases](#read-only-databases)
       - [In-Memory Databases](#in-memory-databases)
+      - [URI parameters](#uri-parameters)
       - [Thread-Safety](#thread-safety)
   - [Building Type-Safe SQL](#building-type-safe-sql)
     - [Expressions](#expressions)
@@ -61,9 +62,9 @@
   - [Custom Collations](#custom-collations)
   - [Full-text Search](#full-text-search)
   - [Executing Arbitrary SQL](#executing-arbitrary-sql)
+  - [Attaching and detaching databases](#attaching-and-detaching-databases)
   - [Logging](#logging)
 
-
 [↩]: #sqliteswift-documentation
 
 
@@ -334,6 +335,16 @@ let db = try Connection(.temporary)
 In-memory databases are automatically deleted when the database connection is
 closed.
 
+#### URI parameters
+
+We can pass `.uri` to the `Connection` initializer to control more aspects of
+the database connection with the help of `URIQueryParameter`s:
+
+```swift
+let db = try Connection(.uri("file.sqlite", parameters: [.cache(.private)], .noLock(true)]))
+```
+
+See [Uniform Resource Identifiers](https://www.sqlite.org/uri.html) for more details.
 
 #### Thread-Safety
 
@@ -2070,6 +2081,25 @@ let backup = try db.backup(usingConnection: target)
 try backup.step()
 ```
 
+## Attaching and detaching databases
+
+We can [ATTACH](https://www3.sqlite.org/lang_attach.html) and [DETACH](https://www3.sqlite.org/lang_detach.html)
+databases to an existing connection:
+
+```swift
+let db = try Connection("db.sqlite")
+
+try db.attach(.uri("external.sqlite", parameters: [.mode(.readOnly)), as: "external")
+// ATTACH DATABASE 'file:external.sqlite?mode=ro' AS 'external'
+
+let table = Table("table", database: "external")
+let count = try db.scalar(table.count)
+// SELECT count(*) FROM 'external.table'
+
+try db.detach("external")
+// DETACH DATABASE 'external'
+```
+
 ## Logging
 
 We can log SQL using the database’s `trace` function.

SQLite.xcodeproj/project.pbxproj

@@ -277,6 +277,7 @@
 		3DF7B78C28842C23005DD8CA /* ResultTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ResultTests.swift; sourceTree = "<group>"; };
 		3DF7B790288449BA005DD8CA /* URIQueryParameter.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = URIQueryParameter.swift; sourceTree = "<group>"; };
 		3DF7B79528846FCC005DD8CA /* Resources */ = {isa = PBXFileReference; lastKnownFileType = folder; path = Resources; sourceTree = "<group>"; };
+		3DF7B79A2884C353005DD8CA /* CHANGELOG.md */ = {isa = PBXFileReference; lastKnownFileType = net.daringfireball.markdown; path = CHANGELOG.md; sourceTree = "<group>"; };
 		49EB68C31F7B3CB400D89D40 /* Coding.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = Coding.swift; sourceTree = "<group>"; };
 		997DF2AD287FC06D00F8DF95 /* Query+with.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "Query+with.swift"; sourceTree = "<group>"; };
 		A121AC451CA35C79005A31D1 /* SQLite.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = SQLite.framework; sourceTree = BUILT_PRODUCTS_DIR; };
@@ -534,6 +535,7 @@
 			isa = PBXGroup;
 			children = (
 				EE247B771C3F40D700AE3E12 /* README.md */,
+				3DF7B79A2884C353005DD8CA /* CHANGELOG.md */,
 				EE247B8B1C3F820300AE3E12 /* CONTRIBUTING.md */,
 				EE247B931C3F826100AE3E12 /* SQLite.swift.podspec */,
 				EE247B8D1C3F821200AE3E12 /* Makefile */,

Sources/SQLite/Core/URIQueryParameter.swift

@@ -1,5 +1,6 @@
 import Foundation
 
+/// See https://www.sqlite.org/uri.html
 public enum URIQueryParameter: CustomStringConvertible {
     public enum FileMode: String {
         case readOnly = "ro", readWrite = "rw", readWriteCreate = "rwc", memory
@@ -29,7 +30,7 @@ public enum URIQueryParameter: CustomStringConvertible {
     case nolock(Bool)
 
     /// The psow query parameter overrides the `powersafe_overwrite` property of the database file being opened.
-    case psow(Bool)
+    case powersafeOverwrite(Bool)
 
     /// The vfs query parameter causes the database connection to be opened using the VFS called NAME.
     case vfs(String)
@@ -45,7 +46,7 @@ public enum URIQueryParameter: CustomStringConvertible {
         case .modeOf(let filename): return .init(name: "modeOf", value: filename)
         case .mode(let fileMode): return .init(name: "mode", value: fileMode.rawValue)
         case .nolock(let bool): return .init(name: "nolock", value: NSNumber(value: bool).description)
-        case .psow(let bool): return .init(name: "psow", value: NSNumber(value: bool).description)
+        case .powersafeOverwrite(let bool): return .init(name: "psow", value: NSNumber(value: bool).description)
         case .vfs(let name): return .init(name: "vfs", value: name)
         }
     }