Update guides, examples, and README for 1.0 (#486)

Author: kmahar

Examples/Docs/Sources/AsyncExamples/main.swift

@@ -17,7 +17,7 @@ private func causalConsistency() throws {
     // Start Causal Consistency Example 1
     let s1 = client1.startSession(options: ClientSessionOptions(causalConsistency: true))
     let currentDate = Date()
-    var dbOptions = DatabaseOptions(
+    var dbOptions = MongoDatabaseOptions(
         readConcern: .majority,
         writeConcern: try .majority(wtimeoutMS: 1000)
     )
@@ -126,19 +126,19 @@ private func changeStreams() throws {
 
     do {
         // Start Changestream Example 4
-        let pipeline: [Document] = [
+        let pipeline: [BSONDocument] = [
             ["$match": ["fullDocument.username": "alice"]],
             ["$addFields": ["newField": "this is an added field!"]]
         ]
         let inventory = db.collection("inventory")
 
         // Option 1: use next() to iterate
-        let next = inventory.watch(pipeline, withEventType: Document.self).flatMap { changeStream in
+        let next = inventory.watch(pipeline, withEventType: BSONDocument.self).flatMap { changeStream in
             changeStream.next()
         }
 
         // Option 2: register a callback to execute for each document
-        let result = inventory.watch(pipeline, withEventType: Document.self).flatMap { changeStream in
+        let result = inventory.watch(pipeline, withEventType: BSONDocument.self).flatMap { changeStream in
             changeStream.forEach { event in
                 // process event
                 print(event)

Examples/Docs/Sources/SyncExamples/main.swift

@@ -11,7 +11,7 @@ private func causalConsistency() throws {
     // Start Causal Consistency Example 1
     let s1 = client1.startSession(options: ClientSessionOptions(causalConsistency: true))
     let currentDate = Date()
-    var dbOptions = DatabaseOptions(
+    var dbOptions = MongoDatabaseOptions(
         readConcern: .majority,
         writeConcern: try .majority(wtimeoutMS: 1000)
     )
@@ -80,12 +80,12 @@ private func changeStreams() throws {
 
     do {
         // Start Changestream Example 4
-        let pipeline: [Document] = [
+        let pipeline: [BSONDocument] = [
             ["$match": ["fullDocument.username": "alice"]],
             ["$addFields": ["newField": "this is an added field!"]]
         ]
         let inventory = db.collection("inventory")
-        let changeStream = try inventory.watch(pipeline, withEventType: Document.self)
+        let changeStream = try inventory.watch(pipeline, withEventType: BSONDocument.self)
         let next = changeStream.next()
         // End Changestream Example 4
     }

Examples/KituraExample/Package.swift

@@ -5,7 +5,7 @@ let package = Package(
     name: "KituraExample",
     dependencies: [
         .package(url: "https://github.com/IBM-Swift/Kitura", .upToNextMajor(from: "2.9.1")),
-        .package(url: "https://github.com/mongodb/mongo-swift-driver", .upToNextMajor(from: "1.0.0-rc0")),
+        .package(url: "https://github.com/mongodb/mongo-swift-driver", .upToNextMajor(from: "1.0.0")),
         .package(url: "https://github.com/apple/swift-nio", .upToNextMajor(from: "2.14.0"))
     ],
     targets: [

Examples/PerfectExample/Package.swift

@@ -5,7 +5,7 @@ let package = Package(
     name: "PerfectExample",
     dependencies: [
         .package(url: "https://github.com/PerfectlySoft/Perfect-HTTPServer.git", from: "3.0.0"),
-        .package(url: "https://github.com/mongodb/mongo-swift-driver", .upToNextMajor(from: "1.0.0-rc0")),
+        .package(url: "https://github.com/mongodb/mongo-swift-driver", .upToNextMajor(from: "1.0.0")),
         .package(url: "https://github.com/apple/swift-nio", .upToNextMajor(from: "2.14.0"))
     ],
     targets: [

Examples/VaporExample/Package.swift

@@ -9,7 +9,7 @@ let package = Package(
     dependencies: [
         // The driver depends on SwiftNIO 2 and therefore is only compatible with Vapor 4.
         .package(url: "https://github.com/vapor/vapor.git", from: "4.2.1"),
-        .package(url: "https://github.com/mongodb/mongo-swift-driver", .upToNextMajor(from: "1.0.0-rc0"))
+        .package(url: "https://github.com/mongodb/mongo-swift-driver", .upToNextMajor(from: "1.0.0"))
     ],
     targets: [
         .target(name: "VaporExample", dependencies: [

Guides/BSON.md

@@ -12,9 +12,9 @@ let elg = MultiThreadedEventLoopGroup(numberOfThreads: 4)
 let client = try MongoClient(using: elg)
 let inventory = client.db("example").collection("inventory")
 
-inventory.watch().flatMap { stream in // a `ChangeStream<ChangeStreamEvent<Document>>`
+inventory.watch().flatMap { stream in // a `ChangeStream<ChangeStreamEvent<BSONDocument>>`
     stream.forEach { event in
-        // process `ChangeStreamEvent<Document>` here
+        // process `ChangeStreamEvent<BSONDocument>` here
     }
 }.whenFailure { error in
     // handle error
@@ -80,9 +80,9 @@ let elg = MultiThreadedEventLoopGroup(numberOfThreads: 4)
 let client = try MongoClient(using: elg)
 let db = client.db("example")
 
-db.watch().flatMap { stream in // a `ChangeStream<ChangeStreamEvent<Document>>`
+db.watch().flatMap { stream in // a `ChangeStream<ChangeStreamEvent<BSONDocument>>`
     stream.forEach { event in
-        // process `ChangeStreamEvent<Document>` here
+        // process `ChangeStreamEvent<BSONDocument>` here
     }
 }.whenFailure { error in
     // handle error
@@ -98,9 +98,9 @@ Note: the types of the `fullDocument` property, as well as the return type of `C
 let elg = MultiThreadedEventLoopGroup(numberOfThreads: 4)
 let client = try MongoClient(using: elg)
 
-client.watch().flatMap { stream in // a `ChangeStream<ChangeStreamEvent<Document>>`
+client.watch().flatMap { stream in // a `ChangeStream<ChangeStreamEvent<BSONDocument>>`
     stream.forEach { event in
-        // process `ChangeStreamEvent<Document>` here
+        // process `ChangeStreamEvent<BSONDocument>` here
     }
 }.whenFailure { error in
     // handle error
@@ -117,7 +117,7 @@ let elg = MultiThreadedEventLoopGroup(numberOfThreads: 4)
 let client = try MongoClient(using: elg)
 let inventory = client.db("example").collection("inventory")
 
-inventory.watch().flatMap { stream -> EventLoopFuture<ChangeStream<ChangeStreamEvent<Document>>> in
+inventory.watch().flatMap { stream -> EventLoopFuture<ChangeStream<ChangeStreamEvent<BSONDocument>>> in
     // read the first change event
     stream.next().flatMap { _ in
         // simulate an error by killing the stream
@@ -129,7 +129,7 @@ inventory.watch().flatMap { stream -> EventLoopFuture<ChangeStream<ChangeStreamE
     }
 }.flatMap { resumedStream in
     resumedStream.forEach { event in
-        // process `ChangeStreamEvent<Document>` here
+        // process `ChangeStreamEvent<BSONDocument>` here
     }
 }.whenFailure { error in
     // handle error
@@ -145,13 +145,13 @@ let client = try MongoClient(using: elg)
 let inventory = client.db("example").collection("inventory")
 
 // Only include events where the changed document's username = "alice"
-let pipeline: [Document] = [
-    ["$match": ["fullDocument.username": "alice"] as Document]
+let pipeline: [BSONDocument] = [
+    ["$match": ["fullDocument.username": "alice"]]
 ]
 
-inventory.watch(pipeline).flatMap { stream in // a `ChangeStream<ChangeStreamEvent<Document>>`
+inventory.watch(pipeline).flatMap { stream in // a `ChangeStream<ChangeStreamEvent<BSONDocument>>`
     stream.forEach { event in
-        // process `ChangeStreamEvent<Document>` here
+        // process `ChangeStreamEvent<BSONDocument>` here
     }
 }.whenFailure { error in
     // handle error

Guides/Change-Streams.md

@@ -27,24 +27,24 @@ macOS 10.13 (High Sierra) and newer support TLS 1.1+.
 
 ## Basic Configuration
 
-To require that connections to MongoDB made by the driver use TLS/SSL, simply specify `tls: true` in the `ClientOptions` passed to a `MongoClient`'s initializer:
+To require that connections to MongoDB made by the driver use TLS/SSL, specify `tls: true` in the `MongoClientOptions` passed to a `MongoClient`'s initializer:
 ```swift
-let client = try MongoClient("mongodb://example.com", using: elg, options: ClientOptions(tls: true))
+let client = try MongoClient("mongodb://example.com", using: elg, options: MongoClientOptions(tls: true))
 ```
 
 Alternatively, `tls=true` can be specified in the [MongoDB Connection String](https://docs.mongodb.com/manual/reference/connection-string/) passed to the initializer:
 ```swift
 let client = try MongoClient("mongodb://example.com/?tls=true", using: elg)
 ```
-**Note:** Specifying any `tls`-prefixed option in the connection string or `ClientOptions` will require all connections made by the driver to use TLS/SSL.
+**Note:** Specifying any `tls`-prefixed option in the connection string or `MongoClientOptions` will require all connections made by the driver to use TLS/SSL.
 
 ## Specifying a CA File
 
 The driver can be configured to use a specific set of CA certificates. This is most often used with "self-signed" server certificates. 
 
-A path to a file with either a single or bundle of certificate authorities to be considered trusted when making a TLS connection can be specified via the `tlsCAFile` option on `ClientOptions`:
+A path to a file with either a single or bundle of certificate authorities to be considered trusted when making a TLS connection can be specified via the `tlsCAFile` option on `MongoClientOptions`:
 ```swift
-let client = try MongoClient("mongodb://example.com", using: elg, options: ClientOptions(tlsCAFile: URL(string: "/path/to/ca.pem")))
+let client = try MongoClient("mongodb://example.com", using: elg, options: MongoClientOptions(tlsCAFile: URL(string: "/path/to/ca.pem")))
 ```
 
 Alternatively, the path can be specified via the `tlsCAFile` option in the [MongoDB Connection String](https://docs.mongodb.com/manual/reference/connection-string/) passed to the client's initializer:
@@ -55,16 +55,16 @@ let client = try MongoClient("mongodb://example.com/?tlsCAFile=\(caFile)", using
 
 ## Specifying a Client Certificate or Private Key File
 
-The driver can be configured to present the client certificate file or the client private key file via the `tlsCertificateKeyFile` option on `ClientOptions`:
+The driver can be configured to present the client certificate file or the client private key file via the `tlsCertificateKeyFile` option on `MongoClientOptions`:
 ```swift
-let client = try MongoClient("mongodb://example.com", using: elg, options: ClientOptions(tlsCertificateKeyFile: URL(string: "/path/to/cert.pem")))
+let client = try MongoClient("mongodb://example.com", using: elg, options: MongoClientOptions(tlsCertificateKeyFile: URL(string: "/path/to/cert.pem")))
 ```
-If the private key is password protected, a password can be supplied via `tlsCertificateKeyFilePassword` on `ClientOptions`:
+If the private key is password protected, a password can be supplied via `tlsCertificateKeyFilePassword` on `MongoClientOptions`:
 ```swift
 let client = try MongoClient(
     "mongodb://example.com",
     using: elg,
-    options: ClientOptions(tlsCertificateKeyFile: URL(string: "/path/to/cert.pem"), tlsCertificateKeyFilePassword: <password>)
+    options: MongoClientOptions(tlsCertificateKeyFile: URL(string: "/path/to/cert.pem"), tlsCertificateKeyFilePassword: <password>)
 )
 ```
 
@@ -73,7 +73,7 @@ Alternatively, these options can be set via the `tlsCertificateKeyFile` and `tls
 let certificatePath = "/path/to/cert.pem".addingPercentEncoding(withAllowedCharacters: .urlHostAllowed)!
 let password = "not a secure password".addingPercentEncoding(withAllowedCharacters: .urlHostAllowed)!
 let client = try MongoClient(
-    "mongodb://example.com/?tlsCertificateKeyFile=\(certificatePath)&tlsCertificateKeyFilePassword=\(password)"
+    "mongodb://example.com/?tlsCertificateKeyFile=\(certificatePath)&tlsCertificateKeyFilePassword=\(password)",
     using: elg
 )
 ```

Guides/TLS.md

@@ -119,23 +119,23 @@ Note: we have included the client `connectionString` parameter for clarity, but
 ### Create and Insert a Document
 **Async**:
 ```swift
-let doc: Document = ["_id": 100, "a": 1, "b": 2, "c": 3]
+let doc: BSONDocument = ["_id": 100, "a": 1, "b": 2, "c": 3]
 collection.insertOne(doc).whenSuccess { result in
     print(result?.insertedId ?? "") // prints `.int64(100)`
 }
 ```
 
 **Sync**:
 ```swift
-let doc: Document = ["_id": 100, "a": 1, "b": 2, "c": 3]
+let doc: BSONDocument = ["_id": 100, "a": 1, "b": 2, "c": 3]
 let result = try collection.insertOne(doc)
 print(result?.insertedId ?? "") // prints `.int64(100)`
 ```
 
 ### Find Documents
 **Async**:
 ```swift
-let query: Document = ["a": 1]
+let query: BSONDocument = ["a": 1]
 let result = collection.find(query).flatMap { cursor in
     cursor.forEach { doc in
         print(doc)
@@ -145,7 +145,7 @@ let result = collection.find(query).flatMap { cursor in
 
 **Sync**:
 ```swift
-let query: Document = ["a": 1]
+let query: BSONDocument = ["a": 1]
 let documents = try collection.find(query)
 for d in documents {
     print(try d.get())
@@ -154,7 +154,7 @@ for d in documents {
 
 ### Work With and Modify Documents
 ```swift
-var doc: Document = ["a": 1, "b": 2, "c": 3]
+var doc: BSONDocument = ["a": 1, "b": 2, "c": 3]
 
 print(doc) // prints `{"a" : 1, "b" : 2, "c" : 3}`
 print(doc["a"] ?? "") // prints `.int64(1)`
@@ -182,7 +182,7 @@ let doubled = doc.map { elem -> Int in
 print(doubled) // prints `[2, 4, 6, 8]`
 ```
 
-Note that `Document` conforms to `Collection`, so useful methods from
+Note that `BSONDocument` conforms to `Collection`, so useful methods from
 [`Sequence`](https://developer.apple.com/documentation/swift/sequence) and
 [`Collection`](https://developer.apple.com/documentation/swift/collection) are
 all available. However, runtime guarantees are not yet met for many of these