DOCSP-17443: versioned api client instantiation snippets - Part 2 (#743)

* DOCSP-17443: versioned api client instantiation snippets for PyMongo, Scala, and Reactive Streams

Author: Chris Cho

source/includes/versioned-api-snippets/java-rs-client.java

@@ -0,0 +1,22 @@
+import com.mongodb.ConnectionString;
+import com.mongodb.MongoClientSettings;
+import com.mongodb.ServerApi;
+import com.mongodb.ServerApiVersion;
+import com.mongodb.reactivestreams.client.MongoClient;
+import com.mongodb.reactivestreams.client.MongoClients;
+
+// ...
+
+// Replace <connection string> with your MongoDB deployment's connection string.
+ConnectionString connString = new ConnectionString("<connection string>");
+
+// Set the version of the Versioned API on the client.
+ServerApi serverApi = ServerApi.builder()
+        .version(ServerApiVersion.V1)
+         .build();
+
+MongoClientSettings settings = MongoClientSettings.builder()
+         .applyConnectionString(connString)
+         .serverApi(serverApi)
+         .build();
+MongoClient mongoClient = MongoClients.create(settings);

source/includes/versioned-api-snippets/pymongo-client.py

@@ -0,0 +1,8 @@
+from pymongo.mongo_client import MongoClient
+from pymongo.server_api import ServerApi
+
+# Replace <connection string> with your MongoDB deployment's connection string.
+conn_str = "<connection string>"
+
+# Set the version of the Versioned API on the client.
+client = pymongo.MongoClient(conn_str, server_api=ServerApi('1'), serverSelectionTimeoutMS=5000)

source/includes/versioned-api-snippets/scala-client.scala

@@ -0,0 +1,14 @@
+import com.mongodb.{ServerApi, ServerApiVersion}
+import org.mongodb.scala._
+
+// ...
+
+// Replace <connection string> with your MongoDB deployment's connection string.
+val uri = "<connection string>"
+
+// Set the version of the Versioned API on the client.
+val mongoClientSettings = MongoClientSettings.builder().applyConnectionString(ConnectionString(uri))
+    .serverApi(ServerApi.builder().version(ServerApiVersion.V1).build())
+    .build()
+
+val mongoClient = MongoClient(mongoClientSettings)

source/pymongo.txt

@@ -75,8 +75,8 @@ Connect to MongoDB Atlas
 
    import pymongo
 
-   # replace this with your MongoDB connection string
-   conn_str = "<your MongoDB Atlas connection string>"
+   # Replace the uri string with your MongoDB deployment's connection string.
+   conn_str = "mongodb+srv://<username>:<password>@<cluster-address>/test?retryWrites=true&w=majority"
 
    # set a 5-second connection timeout
    client = pymongo.MongoClient(conn_str, serverSelectionTimeoutMS=5000)
@@ -101,6 +101,19 @@ If the connection fails, you should see the following message:
 For more information on the connection string, see the MongoDB Server
 Manual entry on :manual:`Connection String URI Format </reference/connection-string/>`.
 
+Versioned API
+-------------
+
+You can use the `Versioned API <https://docs.mongodb.com/v5.0/reference/versioned-api/>`__ 
+feature starting with MongoDB Server version 5.0 and PyMongo Driver
+version 3.12. When you use the Versioned API feature, you can update your 
+driver or server without worrying about backward compatibility issues with any 
+commands covered by the Versioned API. To use this feature, construct a 
+MongoDB client instance, specifying a version of the Versioned API:
+
+.. literalinclude:: /includes/versioned-api-snippets/pymongo-client.py
+   :language: python
+
 Connect to ``localhost``
 ------------------------
 

source/reactive-streams.txt

@@ -50,6 +50,8 @@ Connect to MongoDB Atlas
    import com.mongodb.MongoClientSettings;
 
    // ...
+
+   // Replace the uri string with your MongoDB deployment's connection string.
    ConnectionString connString = new ConnectionString(
        "mongodb+srv://<username>:<password>@<cluster-address>/test?w=majority"
    );
@@ -65,6 +67,19 @@ Connect to MongoDB Atlas
 See :java-docs:`Connect to MongoDB <driver-reactive/tutorials/connect-to-mongodb/>`
 for more ways to connect.
 
+Versioned API
+-------------
+
+You can use the `Versioned API <https://docs.mongodb.com/v5.0/reference/versioned-api/>`__
+feature starting with MongoDB Server version 5.0 and Java Reactive Streams
+Driver version 4.3. When you use the Versioned API feature, you can update your
+driver or server without worrying about backward compatibility issues with any
+commands covered by the Versioned API. To use this feature, construct a
+MongoDB client instance, specifying a version of the Versioned API:
+
+.. literalinclude:: /includes/versioned-api-snippets/java-rs-client.java
+   :language: java
+
 Connect to ``localhost``
 ------------------------
 

source/scala.txt

@@ -23,7 +23,7 @@ It's a modern idiomatic Scala driver with asynchronous and non-blocking IO.
 
 
 - :java-docs:`Reference Documentation <driver-scala/>`
-  
+
 - :java-docs:`Tutorials <driver-scala/tutorials/>`
 
 - :java-docs:`API Documentation <apidocs/>`
@@ -53,6 +53,7 @@ Connect to MongoDB Atlas
 
    // ...
 
+   // Replace the uri string with your MongoDB deployment's connection string.
    val uri: String = "mongodb+srv://<username>:<password>@<cluster-address>/test?retryWrites=true&w=majority"
    System.setProperty("org.mongodb.async.type", "netty")
    val client: MongoClient = MongoClient(uri)
@@ -63,6 +64,19 @@ Connect to MongoDB Atlas
 See our guide on :java-docs:`Connecting <driver-scala/tutorials/connect-to-mongodb/>`
 for more ways to connect.
 
+Versioned API
+-------------
+
+You can use the `Versioned API <https://docs.mongodb.com/v5.0/reference/versioned-api/>`__
+feature starting with MongoDB Server version 5.0 and Scala Driver version 4.3.
+When you use the Versioned API feature, you can update your driver or server
+without worrying about backward compatibility issues with any commands covered
+by the Versioned API. To use this feature, construct a MongoDB client
+instance, specifying a version of the Versioned API:
+
+.. literalinclude:: /includes/versioned-api-snippets/scala-client.scala
+   :language: scala
+
 Connect to ``localhost``
 ------------------------
 

source/swift.txt

@@ -53,8 +53,12 @@ Connect to MongoDB Atlas
              cleanupMongoSwift()
          }
 
-         let client = try MongoClient("mongodb+srv://<username>:<password>@<cluster-url>/test?retryWrites=true&w=majority")
-         let db = client.db("myDB")
+         // replace the following string with your connection uri
+         let uri = "mongodb+srv://<username>:<password>@<cluster-address>/test?w=majority"
+         let client = try MongoClient(uri)
+
+         // print a list of database names
+         print (try client.listDatabaseNames())
 
          // your application logic
 
@@ -67,8 +71,12 @@ Connect to MongoDB Atlas
          import NIO
 
          let elg = MultiThreadedEventLoopGroup(numberOfThreads: 4)
+
+         // replace the following string with your connection uri
+         let uri = "mongodb+srv://<username>:<password>@<cluster-address>/test?w=majority"
+
          let client = try MongoClient(
-             "mongodb+srv://<username>:<password>@<cluster-url>/test?retryWrites=true&w=majority",
+             uri,
              using: elg
          )
 
@@ -81,7 +89,8 @@ Connect to MongoDB Atlas
              try? elg.syncShutdownGracefully()
          }
 
-         let db = client.db("myDB")
+         // print a list of database names
+         print(try client.listDatabaseNames().wait())
 
          // your application logic