Merge pull request #23 from mongodben/DOCSP-29142

(DOCSP-29142): Kotlin Driver Quick Start page

Author: mongodben

examples/build.gradle.kts

@@ -1,3 +1,5 @@
+val kotlin_mongodb_version: String by project
+
 plugins {
     kotlin("jvm") version "1.8.0"
     id("com.google.osdetector") version "1.7.3"
@@ -13,6 +15,8 @@ repositories {
 }
 
 dependencies {
+    implementation("org.mongodb:mongodb-driver-kotlin-coroutine:$kotlin_mongodb_version")
+    implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.6.4")
     testImplementation(kotlin("test"))
     implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.7.0-Beta")
     implementation("org.mongodb:mongodb-driver-kotlin-coroutine:4.10.0-SNAPSHOT")

examples/gradle.properties

@@ -1 +1,2 @@
 kotlin.code.style=official
+kotlin_mongodb_version=4.10.0-SNAPSHOT

examples/src/main/kotlin/QuickStartDataClassExample.kt

@@ -0,0 +1,38 @@
+package org.mongodb.docs.kotlin
+// :snippet-start: quick-start-data-class
+import com.mongodb.client.model.Filters.eq
+import com.mongodb.kotlin.client.coroutine.MongoClient
+import io.github.cdimascio.dotenv.dotenv
+import kotlinx.coroutines.flow.firstOrNull
+import kotlinx.coroutines.runBlocking
+
+// Create data class to represent a MongoDB document
+data class Movie(val title: String, val year: Int, val cast: List<String>)
+
+fun main() {
+    // :remove-start:
+    val dotenv = dotenv()
+    val CONNECTION_STRING_URI_PLACEHOLDER = dotenv["MONGODB_CONNECTION_URI"]
+    // :remove-end:
+
+    // Replace the placeholder with your MongoDB deployment's connection string
+    val uri = CONNECTION_STRING_URI_PLACEHOLDER
+
+    val mongoClient = MongoClient.create(uri)
+    val database = mongoClient.getDatabase("sample_mflix")
+    // Get a collection of documents of type Movie
+    val collection = database.getCollection<Movie>("movies")
+
+    runBlocking {
+        val doc = collection.find(eq("title", "Back to the Future")).firstOrNull()
+        if (doc != null) {
+            println(doc)
+        } else {
+            println("No matching documents found.")
+        }
+    }
+
+    mongoClient.close()
+}
+
+// :snippet-end:

examples/src/main/kotlin/QuickStartDocumentExample.kt

@@ -0,0 +1,35 @@
+package org.mongodb.docs.kotlin
+// :snippet-start: quick-start-document
+import com.mongodb.client.model.Filters.eq
+import com.mongodb.kotlin.client.coroutine.MongoClient
+import io.github.cdimascio.dotenv.dotenv
+import kotlinx.coroutines.flow.firstOrNull
+import kotlinx.coroutines.runBlocking
+import org.bson.Document
+
+fun main() {
+    // :remove-start:
+    val dotenv = dotenv()
+    val CONNECTION_STRING_URI_PLACEHOLDER = dotenv["MONGODB_CONNECTION_URI"]
+    // :remove-end:
+
+    // Replace the placeholder with your MongoDB deployment's connection string
+    val uri = CONNECTION_STRING_URI_PLACEHOLDER
+
+    val mongoClient = MongoClient.create(uri)
+    val database = mongoClient.getDatabase("sample_mflix")
+    val collection = database.getCollection<Document>("movies")
+
+    runBlocking {
+        val doc = collection.find(eq("title", "Back to the Future")).firstOrNull()
+        if (doc != null) {
+            println(doc.toJson())
+        } else {
+            println("No matching documents found.")
+        }
+    }
+
+    mongoClient.close()
+}
+
+// :snippet-end:

snooty.toml

@@ -21,6 +21,7 @@ version = "4.9"
 full-version = "{+version+}.1"
 version-next = "4.10"
 mdb-server = "MongoDB server"
+kotlin-docs = "https://kotlinlang.org/docs"
 
 package-name-org = "mongodb-org"
 api = "https://mongodb.github.io/mongo-java-driver/{+version+}"

source/examples/generated/QuickStartDataClassExample.snippet.quick-start-data-class.kt

@@ -0,0 +1,31 @@
+import com.mongodb.client.model.Filters.eq
+import com.mongodb.kotlin.client.coroutine.MongoClient
+import io.github.cdimascio.dotenv.dotenv
+import kotlinx.coroutines.flow.firstOrNull
+import kotlinx.coroutines.runBlocking
+
+// Create data class to represent a MongoDB document
+data class Movie(val title: String, val year: Int, val cast: List<String>)
+
+fun main() {
+
+    // Replace the placeholder with your MongoDB deployment's connection string
+    val uri = CONNECTION_STRING_URI_PLACEHOLDER
+
+    val mongoClient = MongoClient.create(uri)
+    val database = mongoClient.getDatabase("sample_mflix")
+    // Get a collection of documents of type Movie
+    val collection = database.getCollection<Movie>("movies")
+
+    runBlocking {
+        val doc = collection.find(eq("title", "Back to the Future")).firstOrNull()
+        if (doc != null) {
+            println(doc)
+        } else {
+            println("No matching documents found.")
+        }
+    }
+
+    mongoClient.close()
+}
+

source/examples/generated/QuickStartDocumentExample.snippet.quick-start-document.kt

@@ -0,0 +1,28 @@
+import com.mongodb.client.model.Filters.eq
+import com.mongodb.kotlin.client.coroutine.MongoClient
+import io.github.cdimascio.dotenv.dotenv
+import kotlinx.coroutines.flow.firstOrNull
+import kotlinx.coroutines.runBlocking
+import org.bson.Document
+
+fun main() {
+
+    // Replace the placeholder with your MongoDB deployment's connection string
+    val uri = CONNECTION_STRING_URI_PLACEHOLDER
+
+    val mongoClient = MongoClient.create(uri)
+    val database = mongoClient.getDatabase("sample_mflix")
+    val collection = database.getCollection<Document>("movies")
+
+    runBlocking {
+        val doc = collection.find(eq("title", "Back to the Future")).firstOrNull()
+        if (doc != null) {
+            println(doc.toJson())
+        } else {
+            println("No matching documents found.")
+        }
+    }
+
+    mongoClient.close()
+}
+

source/fundamentals/data-formats/document-data-format-data-class.txt

@@ -0,0 +1,18 @@
+.. _fundamentals-data-classes:
+
+==================================
+Document Data Format: Data Classes
+==================================
+
+.. default-domain:: mongodb
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 2
+   :class: singlecol
+
+Overview
+--------
+
+TODO: add content. right now making a container page for the ref used in the quickstart