Skip to content

Commit 298b164

Browse files
authored
(DOCSP-30689): Update Kotlin version source constant (#102)
# Pull Request Info [PR Reviewing Guidelines](https://github.com/mongodb/docs-java/blob/master/REVIEWING.md) After Java v4.10 is released, Java and Kotlin will be versioned together, so the extra source constant is unneeded. This PR updates the following: - Remove `api-kotlin` source constant - Update all links to use `api` constant that points to version 4.10 - Remove `version-next` constant - Increment `version` to `4.10` To be merged and deployed after Java v4.10 is released and API docs are updated (i.e. Java API ref links point to v4.10 URL) JIRA - https://jira.mongodb.org/browse/DOCSP-30689 Staging - https://docs-mongodbcom-staging.corp.mongodb.com/kotlin/docsworker-xlarge/docsp-30689-constant/ ## Self-Review Checklist - [ ] Is this free of any warnings or errors in the RST? - [ ] Did you run a spell-check? - [ ] Did you run a grammar-check? - [ ] Are all the links working?
1 parent da04cc3 commit 298b164

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+122
-126
lines changed

examples/build.gradle.kts

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,6 @@ dependencies {
1919
implementation("org.mongodb:mongodb-driver-kotlin-coroutine:$kotlin_mongodb_version")
2020
implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.7.1")
2121
testImplementation(kotlin("test"))
22-
implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.7.0-Beta")
23-
implementation("org.mongodb:mongodb-driver-kotlin-coroutine:4.10.0-SNAPSHOT")
2422
implementation("org.slf4j:slf4j-api:2.0.5")
2523
implementation("ch.qos.logback:logback-classic:1.4.7")
2624
implementation("io.github.cdimascio:dotenv-kotlin:6.4.1")

examples/gradle.properties

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
kotlin.code.style=official
2-
kotlin_mongodb_version=4.10.0-SNAPSHOT
2+
kotlin_mongodb_version=4.10.0

snooty.toml

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,13 @@ sharedinclude_root = "https://raw.githubusercontent.com/10gen/docs-shared/main/"
1818
[constants]
1919
driver = "kotlin"
2020
driver-long = "MongoDB Kotlin Driver"
21-
version = "4.9"
22-
version-next = "4.10"
21+
version = "4.10"
2322
full-version = "4.10.0"
2423
mdb-server = "MongoDB server"
2524
kotlin-docs = "https://kotlinlang.org/docs"
2625

2726
package-name-org = "mongodb-org"
2827
api = "https://mongodb.github.io/mongo-java-driver/{+version+}"
29-
api-kotlin = "https://mongodb.github.io/mongo-java-driver/{+version-next+}"
3028
stable-api = "Stable API"
3129
mongocrypt-version = "1.7.3"
3230
nettyVersion = "io.netty:netty-all:4.1.79.Final"

source/api-documentation.txt

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,17 @@ API Documentation
88
:titlesonly:
99
:maxdepth: 1
1010

11-
BSON kotlinx.serialization <{+api-kotlin+}/apidocs/bson-kotlinx/index.html>
11+
BSON kotlinx.serialization <{+api+}/apidocs/bson-kotlinx/index.html>
1212
Core <{+api+}/apidocs/mongodb-driver-core/index.html>
13-
Kotlin Coroutine Driver <{+api-kotlin+}/apidocs/mongodb-driver-kotlin-coroutine/index.html>
14-
Kotlin Sync Driver <{+api-kotlin+}/apidocs/mongodb-driver-kotlin-sync/index.html>
13+
Kotlin Coroutine Driver <{+api+}/apidocs/mongodb-driver-kotlin-coroutine/index.html>
14+
Kotlin Sync Driver <{+api+}/apidocs/mongodb-driver-kotlin-sync/index.html>
1515

16-
- `BSON kotlinx.serialization <{+api-kotlin+}/apidocs/bson-kotlinx/index.html>`__ -
16+
- `BSON kotlinx.serialization <{+api+}/apidocs/bson-kotlinx/index.html>`__ -
1717
classes for encoding and decoding between Kotlin data classes and the BSON data
1818
format using :github:`kotlinx.serialization <Kotlin/kotlinx.serialization>`.
1919
- `Core <{+api+}/apidocs/mongodb-driver-core/index.html>`__ - classes that
2020
contain essential driver functionality.
21-
- `Kotlin Coroutine Driver <{+api-kotlin+}/apidocs/mongodb-driver-kotlin-coroutine/index.html>`__ -
21+
- `Kotlin Coroutine Driver <{+api+}/apidocs/mongodb-driver-kotlin-coroutine/index.html>`__ -
2222
classes for the current driver API using coroutines.
23-
- `Kotlin Sync Driver <{+api-kotlin+}/apidocs/mongodb-driver-kotlin-sync/index.html>`__ -
23+
- `Kotlin Sync Driver <{+api+}/apidocs/mongodb-driver-kotlin-sync/index.html>`__ -
2424
classes for the current synchronous driver API.

source/fundamentals/aggregation.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ Aggregation operations have some :manual:`limitations </core/aggregation-pipelin
5252

5353
- Pipeline stages have a memory limit of 100 megabytes by default. If required,
5454
you may exceed this limit by using the
55-
`allowDiskUse <{+api-kotlin+}/apidocs/mongodb-driver-kotlin-coroutine/mongodb-driver-kotlin-coroutine/com.mongodb.kotlin.client.coroutine/-aggregate-flow/allow-disk-use.html>`__
55+
`allowDiskUse <{+api+}/apidocs/mongodb-driver-kotlin-coroutine/mongodb-driver-kotlin-coroutine/com.mongodb.kotlin.client.coroutine/-aggregate-flow/allow-disk-use.html>`__
5656
method.
5757

5858
.. important:: ``$graphLookup`` exception
@@ -129,7 +129,7 @@ In the following example, the aggregation pipeline:
129129
For more information about the methods and classes mentioned in this section,
130130
see the following API Documentation:
131131

132-
- `MongoCollection.aggregate() <{+api-kotlin+}/apidocs/mongodb-driver-kotlin-coroutine/mongodb-driver-kotlin-coroutine/com.mongodb.kotlin.client.coroutine/-mongo-collection/aggregate.html>`__
132+
- `MongoCollection.aggregate() <{+api+}/apidocs/mongodb-driver-kotlin-coroutine/mongodb-driver-kotlin-coroutine/com.mongodb.kotlin.client.coroutine/-mongo-collection/aggregate.html>`__
133133
- `Aggregates.match <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/Aggregates.html#match(org.bson.conversions.Bson)>`__
134134

135135
Explain Aggregation
@@ -172,8 +172,8 @@ following resources:
172172
- :manual:`Explain Output </reference/explain-results/>` Server Manual Entry
173173
- :manual:`Query Plans </core/query-plans/>` Server Manual Entry
174174
- `ExplainVerbosity <{+api+}/apidocs/mongodb-driver-core/com/mongodb/ExplainVerbosity>`__ API Documentation
175-
- `explain() <{+api-kotlin+}/apidocs/mongodb-driver-kotlin-coroutine/mongodb-driver-kotlin-coroutine/com.mongodb.kotlin.client.coroutine/-aggregate-flow/explain.html>`__ API Documentation
176-
- `AggregateFlow <{+api-kotlin+}/apidocs/mongodb-driver-kotlin-coroutine/mongodb-driver-kotlin-coroutine/com.mongodb.kotlin.client.coroutine/-aggregate-flow/index.html>`__ API Documentation
175+
- `explain() <{+api+}/apidocs/mongodb-driver-kotlin-coroutine/mongodb-driver-kotlin-coroutine/com.mongodb.kotlin.client.coroutine/-aggregate-flow/explain.html>`__ API Documentation
176+
- `AggregateFlow <{+api+}/apidocs/mongodb-driver-kotlin-coroutine/mongodb-driver-kotlin-coroutine/com.mongodb.kotlin.client.coroutine/-aggregate-flow/index.html>`__ API Documentation
177177

178178
Aggregation Expressions
179179
~~~~~~~~~~~~~~~~~~~~~~~

source/fundamentals/builders/indexes.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ examples of queries covered by indexes.
3535
The ``Indexes`` class provides static factory methods for all the MongoDB index types.
3636
Each method returns a `BSON <{+api+}/apidocs/bson/org/bson/conversions/Bson.html>`__
3737
instance, which you can pass to
38-
`createIndex() <{+api-kotlin+}/apidocs/mongodb-driver-kotlin-coroutine/mongodb-driver-kotlin-coroutine/com.mongodb.kotlin.client.coroutine/-mongo-collection/create-index.html>`__.
38+
`createIndex() <{+api+}/apidocs/mongodb-driver-kotlin-coroutine/mongodb-driver-kotlin-coroutine/com.mongodb.kotlin.client.coroutine/-mongo-collection/create-index.html>`__.
3939

4040
.. tip::
4141

source/fundamentals/builders/sort.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ following API Documentation:
7070

7171
- `Sorts <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/Sorts.html>`__
7272
- `BSON <{+api+}/apidocs/bson/org/bson/conversions/Bson.html>`__
73-
- `FindFlow <{+api-kotlin+}/apidocs/mongodb-driver-kotlin-coroutine/mongodb-driver-kotlin-coroutine/com.mongodb.kotlin.client.coroutine/-find-flow/index.html>`__
73+
- `FindFlow <{+api+}/apidocs/mongodb-driver-kotlin-coroutine/mongodb-driver-kotlin-coroutine/com.mongodb.kotlin.client.coroutine/-find-flow/index.html>`__
7474
- `Aggregates <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/Aggregates.html>`__
7575

7676
Ascending

source/fundamentals/collations.txt

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -358,8 +358,8 @@ the output should resemble the following:
358358
For more information about the methods and classes mentioned in this section,
359359
see the following API Documentation:
360360

361-
- `find() <{+api-kotlin+}/apidocs/mongodb-driver-kotlin-coroutine/mongodb-driver-kotlin-coroutine/com.mongodb.kotlin.client.coroutine/-mongo-collection/find.html>`__
362-
- `sort() <{+api-kotlin+}/apidocs/mongodb-driver-kotlin-coroutine/mongodb-driver-kotlin-coroutine/com.mongodb.kotlin.client.coroutine/-find-flow/sort.html>`__
361+
- `find() <{+api+}/apidocs/mongodb-driver-kotlin-coroutine/mongodb-driver-kotlin-coroutine/com.mongodb.kotlin.client.coroutine/-mongo-collection/find.html>`__
362+
- `sort() <{+api+}/apidocs/mongodb-driver-kotlin-coroutine/mongodb-driver-kotlin-coroutine/com.mongodb.kotlin.client.coroutine/-find-flow/sort.html>`__
363363
- `Sorts <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/Sorts.html>`__
364364

365365
findOneAndUpdate() Example
@@ -402,7 +402,7 @@ returns "Günter" before "Gunter" in the results:
402402
For more information about the methods and classes mentioned in this section,
403403
see the following API Documentation:
404404

405-
- `findOneAndUpdate <{+api-kotlin+}/apidocs/mongodb-driver-kotlin-coroutine/mongodb-driver-kotlin-coroutine/com.mongodb.kotlin.client.coroutine/-mongo-collection/find-one-and-update.html>`__
405+
- `findOneAndUpdate <{+api+}/apidocs/mongodb-driver-kotlin-coroutine/mongodb-driver-kotlin-coroutine/com.mongodb.kotlin.client.coroutine/-mongo-collection/find-one-and-update.html>`__
406406
- `findOneAndUpdateOptions <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/FindOneAndUpdateOptions.html>`__
407407
- `Filters <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/Filters.html>`__
408408
- `Updates <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/Updates.html>`__
@@ -463,7 +463,7 @@ by binary collation.
463463
For more information about the methods and classes mentioned in this section,
464464
see the following API Documentation:
465465

466-
- `findOneAndDelete <{+api-kotlin+}/apidocs/mongodb-driver-kotlin-coroutine/mongodb-driver-kotlin-coroutine/com.mongodb.kotlin.client.coroutine/-mongo-collection/find-one-and-delete.html>`__
466+
- `findOneAndDelete <{+api+}/apidocs/mongodb-driver-kotlin-coroutine/mongodb-driver-kotlin-coroutine/com.mongodb.kotlin.client.coroutine/-mongo-collection/find-one-and-delete.html>`__
467467
- `FindOneAndDeleteOptions <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/FindOneAndDeleteOptions.html>`__
468468
- `Filters <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/Filters.html>`__
469469
- `Sorts <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/Sorts.html>`__
@@ -512,8 +512,8 @@ a collation by specifying the following:
512512
For more information about the methods and classes mentioned in this section,
513513
see the following API Documentation:
514514

515-
- `aggregate() <{+api-kotlin+}/apidocs/mongodb-driver-kotlin-coroutine/mongodb-driver-kotlin-coroutine/com.mongodb.kotlin.client.coroutine/-mongo-collection/aggregate.html>`__
516-
- `AggregateFlow <{+api-kotlin+}/apidocs/mongodb-driver-kotlin-coroutine/mongodb-driver-kotlin-coroutine/com.mongodb.kotlin.client.coroutine/-aggregate-flow/index.html>`__
515+
- `aggregate() <{+api+}/apidocs/mongodb-driver-kotlin-coroutine/mongodb-driver-kotlin-coroutine/com.mongodb.kotlin.client.coroutine/-mongo-collection/aggregate.html>`__
516+
- `AggregateFlow <{+api+}/apidocs/mongodb-driver-kotlin-coroutine/mongodb-driver-kotlin-coroutine/com.mongodb.kotlin.client.coroutine/-aggregate-flow/index.html>`__
517517
- `CollationStrength <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/CollationStrength.html>`__
518518
- `Accumulators <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/Accumulators.html>`__
519519
- `Aggregates <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/Aggregates.html>`__

source/fundamentals/connection/mongoclientsettings.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ MongoClient Settings
3434

3535
You can control the behavior of your ``MongoClient`` by creating and passing
3636
in a `MongoClientSettings <{+api+}/apidocs/mongodb-driver-core/com/mongodb/MongoClientSettings.html>`__
37-
object to the `MongoClient.create() <{+api-kotlin+}/apidocs/mongodb-driver-kotlin-coroutine/mongodb-driver-kotlin-coroutine/com.mongodb.kotlin.client.coroutine/-mongo-client/-factory/create.html>`__
37+
object to the `MongoClient.create() <{+api+}/apidocs/mongodb-driver-kotlin-coroutine/mongodb-driver-kotlin-coroutine/com.mongodb.kotlin.client.coroutine/-mongo-client/-factory/create.html>`__
3838
method.
3939

4040
To create a ``MongoClientSettings`` object, use the

source/fundamentals/crud/compound-operations.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ For more information on the upsert operation, see our
108108
For more information about the methods and classes mentioned in this section,
109109
see the following API Documentation:
110110

111-
- `findOneAndUpdate() <{+api-kotlin+}/apidocs/mongodb-driver-kotlin-coroutine/mongodb-driver-kotlin-coroutine/com.mongodb.kotlin.client.coroutine/-mongo-collection/find-one-and-update.html>`__
111+
- `findOneAndUpdate() <{+api+}/apidocs/mongodb-driver-kotlin-coroutine/mongodb-driver-kotlin-coroutine/com.mongodb.kotlin.client.coroutine/-mongo-collection/find-one-and-update.html>`__
112112
- `FindOneAndUpdateOptions <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/FindOneAndUpdateOptions.html>`__
113113
- `MongoExecutionTimeoutException <{+api+}/apidocs/mongodb-driver-core/com/mongodb/MongoExecutionTimeoutException.html>`__
114114

@@ -149,7 +149,7 @@ the returned document should be in the state after our replace operation.
149149
For more information about the methods and classes mentioned in this section,
150150
see the following API Documentation:
151151

152-
- `findOneAndReplace() <{+api-kotlin+}/apidocs/mongodb-driver-kotlin-coroutine/mongodb-driver-kotlin-coroutine/com.mongodb.kotlin.client.coroutine/-mongo-collection/find-one-and-replace.html>`__
152+
- `findOneAndReplace() <{+api+}/apidocs/mongodb-driver-kotlin-coroutine/mongodb-driver-kotlin-coroutine/com.mongodb.kotlin.client.coroutine/-mongo-collection/find-one-and-replace.html>`__
153153
- `FindOneAndReplaceOptions <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/FindOneAndReplaceOptions.html>`__
154154

155155
Find and Delete
@@ -184,7 +184,7 @@ For more information on the ``Sorts`` class, see our
184184
For more information about the methods and classes mentioned in this section,
185185
see the following API Documentation:
186186

187-
- `findOneAndDelete() <{+api-kotlin+}/apidocs/mongodb-driver-kotlin-coroutine/mongodb-driver-kotlin-coroutine/com.mongodb.kotlin.client.coroutine/-mongo-collection/find-one-and-delete.html>`__
187+
- `findOneAndDelete() <{+api+}/apidocs/mongodb-driver-kotlin-coroutine/mongodb-driver-kotlin-coroutine/com.mongodb.kotlin.client.coroutine/-mongo-collection/find-one-and-delete.html>`__
188188
- `FindOneAndDeleteOptions <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/FindOneAndDeleteOptions.html>`__
189189

190190
Avoiding a Race Condition
@@ -313,4 +313,4 @@ For more information of the ``Filters`` class, see our
313313
:doc:`guide on the Filters builder </fundamentals/builders/filters/>`.
314314

315315
For more information on the ``findOneAndUpdate()`` method, see
316-
the API Documentation for the `MongoCollection class <{+api-kotlin+}/apidocs/mongodb-driver-kotlin-coroutine/mongodb-driver-kotlin-coroutine/com.mongodb.kotlin.client.coroutine/-mongo-collection/index.html>`__.
316+
the API Documentation for the `MongoCollection class <{+api+}/apidocs/mongodb-driver-kotlin-coroutine/mongodb-driver-kotlin-coroutine/com.mongodb.kotlin.client.coroutine/-mongo-collection/index.html>`__.

0 commit comments

Comments
 (0)