From 1c8268c68abb7ee68ae7955ea2774dcfaa9493c8 Mon Sep 17 00:00:00 2001 From: Mike Woofter <108414937+mongoKart@users.noreply.github.com> Date: Thu, 27 Mar 2025 10:01:50 -0500 Subject: [PATCH 1/4] source constants --- snooty.toml | 6 +- source/agg-exp-ops.txt | 278 +++++++++--------- source/aggregation.txt | 4 +- source/api.txt | 12 +- source/builders.txt | 14 +- source/connect/connection-options.txt | 12 +- source/connect/mongoclient.txt | 2 +- source/connect/stable-api.txt | 16 +- source/connect/tls.txt | 4 +- source/data-formats/bson.txt | 10 +- source/data-formats/codecs.txt | 28 +- .../data-formats/data-format-data-class.txt | 2 +- source/data-formats/serialization.txt | 14 +- source/data-formats/time-series.txt | 12 +- source/indexes/atlas-search-index.txt | 12 +- source/indexes/compound-index.txt | 6 +- source/indexes/single-field-index.txt | 6 +- source/monitoring.txt | 44 +-- source/read/change-streams.txt | 10 +- source/read/count.txt | 4 +- source/read/cursors.txt | 8 +- source/read/distinct.txt | 6 +- source/read/project.txt | 4 +- source/read/retrieve.txt | 6 +- source/read/specify-a-query.txt | 2 +- source/read/specify-documents-to-return.txt | 8 +- source/run-command.txt | 2 +- source/security/authentication.txt | 16 +- source/security/enterprise-auth.txt | 18 +- source/whats-new.txt | 8 +- source/work-with-indexes.txt | 8 +- source/write/bulk-write.txt | 34 +-- source/write/delete.txt | 6 +- source/write/insert.txt | 12 +- source/write/replace.txt | 4 +- source/write/transactions.txt | 10 +- source/write/update.txt | 8 +- 37 files changed, 328 insertions(+), 328 deletions(-) diff --git a/snooty.toml b/snooty.toml index 1c85394d..d9cc772e 100644 --- a/snooty.toml +++ b/snooty.toml @@ -30,9 +30,9 @@ full-version = "{+version-number+}.0" version = "v{+version-number+}" mdb-server = "MongoDB Server" stable-api = "Stable API" -api = "https://mongodb.github.io/mongo-java-driver/{+version-number+}/apidocs/mongodb-driver-kotlin-sync/mongodb-driver-kotlin-sync" -java-api = "https://mongodb.github.io/mongo-java-driver/{+version-number+}" -core-api = "{+java-api+}/apidocs/mongodb-driver-core" +api-root = "https://mongodb.github.io/mongo-java-driver/{+version-number+}/apidocs" +driver-api = "{+api-root+}/mongodb-driver-kotlin-sync/mongodb-driver-kotlin-sync/com.mongodb.kotlin.client" +core-api = "{+api-root+}/mongodb-driver-core/com/mongodb" kotlin-docs = "https://kotlinlang.org" serialization-version = "1.6.0" kotlinx-dt-version = "0.6.1" diff --git a/source/agg-exp-ops.txt b/source/agg-exp-ops.txt index d47a4cc9..c422e55a 100644 --- a/source/agg-exp-ops.txt +++ b/source/agg-exp-ops.txt @@ -28,7 +28,7 @@ pattern, you can chain aggregation operations together to create code that is compact and naturally readable. The operations in this guide use methods from the -`com.mongodb.client.model.mql <{+core-api+}/com/mongodb/client/model/mql/package-summary.html>`__ package. +`com.mongodb.client.model.mql <{+core-api+}/client/model/mql/package-summary.html>`__ package. These methods provide an idiomatic way to use the Query API, the mechanism by which the driver interacts with a MongoDB deployment. To learn more about the Query API, see the :manual:`Server manual documentation `. @@ -126,41 +126,41 @@ expressions. * - Method - Description - * - `current() <{+core-api+}/com/mongodb/client/model/mql/MqlValues.html#current()>`__ + * - `current() <{+core-api+}/client/model/mql/MqlValues.html#current()>`__ - References the current document being processed by the aggregation pipeline. - * - `currentAsMap() <{+core-api+}/com/mongodb/client/model/mql/MqlValues.html#currentAsMap()>`__ + * - `currentAsMap() <{+core-api+}/client/model/mql/MqlValues.html#currentAsMap()>`__ - References the current document being processed by the aggregation pipeline as a map value. - * - | `of() for MqlBoolean <{+core-api+}/com/mongodb/client/model/mql/MqlValues.html#of(boolean)>`__ - | `of() for MqlNumber (double) <{+core-api+}/com/mongodb/client/model/mql/MqlValues.html#of(double)>`__ - | `of() for MqlNumber (Decimal128) <{+core-api+}/com/mongodb/client/model/mql/MqlValues.html#of(org.bson.types.Decimal128)>`__ - | `of() for MqlInteger (int) <{+core-api+}/com/mongodb/client/model/mql/MqlValues.html#of(int)>`__ - | `of() for MqlInteger (long) <{+core-api+}/com/mongodb/client/model/mql/MqlValues.html#of(long)>`__ - | `of() for MqlString <{+core-api+}/com/mongodb/client/model/mql/MqlValues.html#of(java.lang.String)>`__ - | `of() for MqlDate <{+core-api+}/com/mongodb/client/model/mql/MqlValues.html#of(java.time.Instant)>`__ - | `of() for MqlDocument <{+core-api+}/com/mongodb/client/model/mql/MqlValues.html#of(org.bson.conversions.Bson)>`__ + * - | `of() for MqlBoolean <{+core-api+}/client/model/mql/MqlValues.html#of(boolean)>`__ + | `of() for MqlNumber (double) <{+core-api+}/client/model/mql/MqlValues.html#of(double)>`__ + | `of() for MqlNumber (Decimal128) <{+core-api+}/client/model/mql/MqlValues.html#of(org.bson.types.Decimal128)>`__ + | `of() for MqlInteger (int) <{+core-api+}/client/model/mql/MqlValues.html#of(int)>`__ + | `of() for MqlInteger (long) <{+core-api+}/client/model/mql/MqlValues.html#of(long)>`__ + | `of() for MqlString <{+core-api+}/client/model/mql/MqlValues.html#of(java.lang.String)>`__ + | `of() for MqlDate <{+core-api+}/client/model/mql/MqlValues.html#of(java.time.Instant)>`__ + | `of() for MqlDocument <{+core-api+}/client/model/mql/MqlValues.html#of(org.bson.conversions.Bson)>`__ - Returns an ``MqlValue`` type corresponding to the provided primitive. - * - `ofArray() <{+core-api+}/com/mongodb/client/model/mql/MqlValues.html#ofArray(T...)>`__ + * - `ofArray() <{+core-api+}/client/model/mql/MqlValues.html#ofArray(T...)>`__ | **Typed Variants**: - | `ofBooleanArray() <{+core-api+}/com/mongodb/client/model/mql/MqlValues.html#ofBooleanArray(boolean...)>`__ - | `ofDateArray() <{+core-api+}/com/mongodb/client/model/mql/MqlValues.html#ofDateArray(java.time.Instant...)>`__ - | `ofIntegerArray() <{+core-api+}/com/mongodb/client/model/mql/MqlValues.html#ofIntegerArray(int...)>`__ - | `ofNumberArray() <{+core-api+}/com/mongodb/client/model/mql/MqlValues.html#ofNumberArray(double...)>`__ - | `ofStringArray() <{+core-api+}/com/mongodb/client/model/mql/MqlValues.html#ofStringArray(java.lang.String...)>`__ + | `ofBooleanArray() <{+core-api+}/client/model/mql/MqlValues.html#ofBooleanArray(boolean...)>`__ + | `ofDateArray() <{+core-api+}/client/model/mql/MqlValues.html#ofDateArray(java.time.Instant...)>`__ + | `ofIntegerArray() <{+core-api+}/client/model/mql/MqlValues.html#ofIntegerArray(int...)>`__ + | `ofNumberArray() <{+core-api+}/client/model/mql/MqlValues.html#ofNumberArray(double...)>`__ + | `ofStringArray() <{+core-api+}/client/model/mql/MqlValues.html#ofStringArray(java.lang.String...)>`__ - Returns an array of ``MqlValue`` types corresponding to the provided array of primitives. - * - `ofEntry() <{+core-api+}/com/mongodb/client/model/mql/MqlValues.html#ofEntry(com.mongodb.client.model.mql.MqlString,T)>`__ + * - `ofEntry() <{+core-api+}/client/model/mql/MqlValues.html#ofEntry(com.mongodb.client.model.mql.MqlString,T)>`__ - Returns an entry value. - * - `ofMap() <{+core-api+}/com/mongodb/client/model/mql/MqlValues.html#ofMap()>`__ + * - `ofMap() <{+core-api+}/client/model/mql/MqlValues.html#ofMap()>`__ - Returns an empty map value. - * - `ofNull() <{+core-api+}/com/mongodb/client/model/mql/MqlValues.html#ofNull()>`__ + * - `ofNull() <{+core-api+}/client/model/mql/MqlValues.html#ofNull()>`__ - Returns the null value as exists in the Query API. .. important:: @@ -223,29 +223,29 @@ You can perform an arithmetic operation on a value of type ``MqlInteger`` or * - Method - Aggregation Pipeline Operator - * - | `abs() for MqlInteger <{+core-api+}/com/mongodb/client/model/mql/MqlInteger.html#abs()>`__ - | `abs() for MqlNumber <{+core-api+}/com/mongodb/client/model/mql/MqlNumber.html#abs()>`__ + * - | `abs() for MqlInteger <{+core-api+}/client/model/mql/MqlInteger.html#abs()>`__ + | `abs() for MqlNumber <{+core-api+}/client/model/mql/MqlNumber.html#abs()>`__ - :manual:`$abs ` - * - | `add() for MqlInteger <{+core-api+}/com/mongodb/client/model/mql/MqlInteger.html#add(int)>`__ - | `add() for MqlNumber <{+core-api+}/com/mongodb/client/model/mql/MqlNumber.html#add(com.mongodb.client.model.mql.MqlNumber)>`__ + * - | `add() for MqlInteger <{+core-api+}/client/model/mql/MqlInteger.html#add(int)>`__ + | `add() for MqlNumber <{+core-api+}/client/model/mql/MqlNumber.html#add(com.mongodb.client.model.mql.MqlNumber)>`__ - :manual:`$add ` - * - `divide() <{+core-api+}/com/mongodb/client/model/mql/MqlNumber.html#divide(com.mongodb.client.model.mql.MqlNumber)>`__ + * - `divide() <{+core-api+}/client/model/mql/MqlNumber.html#divide(com.mongodb.client.model.mql.MqlNumber)>`__ - :manual:`$divide ` - * - | `multiply() for MqlInteger <{+core-api+}/com/mongodb/client/model/mql/MqlInteger.html#multiply(int)>`__ - | `multiply() for MqlNumber <{+core-api+}/com/mongodb/client/model/mql/MqlNumber.html#multiply(com.mongodb.client.model.mql.MqlNumber)>`__ + * - | `multiply() for MqlInteger <{+core-api+}/client/model/mql/MqlInteger.html#multiply(int)>`__ + | `multiply() for MqlNumber <{+core-api+}/client/model/mql/MqlNumber.html#multiply(com.mongodb.client.model.mql.MqlNumber)>`__ - :manual:`$multiply ` - * - `round() <{+core-api+}/com/mongodb/client/model/mql/MqlNumber.html#round()>`__ + * - `round() <{+core-api+}/client/model/mql/MqlNumber.html#round()>`__ - :manual:`$round ` - * - | `subtract() for MqlInteger <{+core-api+}/com/mongodb/client/model/mql/MqlInteger.html#subtract(int)>`__ - | `subtract() for MqlNumber <{+core-api+}/com/mongodb/client/model/mql/MqlNumber.html#subtract(com.mongodb.client.model.mql.MqlNumber)>`__ + * - | `subtract() for MqlInteger <{+core-api+}/client/model/mql/MqlInteger.html#subtract(int)>`__ + | `subtract() for MqlNumber <{+core-api+}/client/model/mql/MqlNumber.html#subtract(com.mongodb.client.model.mql.MqlNumber)>`__ - :manual:`$subtract ` @@ -292,70 +292,70 @@ using the methods described in this section. * - Method - Aggregation Pipeline Operator - * - `all() <{+core-api+}/com/mongodb/client/model/mql/MqlArray.html#all(java.util.function.Function)>`__ + * - `all() <{+core-api+}/client/model/mql/MqlArray.html#all(java.util.function.Function)>`__ - :manual:`$allElementsTrue ` - * - `any() <{+core-api+}/com/mongodb/client/model/mql/MqlArray.html#any(java.util.function.Function)>`__ + * - `any() <{+core-api+}/client/model/mql/MqlArray.html#any(java.util.function.Function)>`__ - :manual:`$anyElementTrue ` - * - `concat() <{+core-api+}/com/mongodb/client/model/mql/MqlArray.html#concat(com.mongodb.client.model.mql.MqlArray)>`__ + * - `concat() <{+core-api+}/client/model/mql/MqlArray.html#concat(com.mongodb.client.model.mql.MqlArray)>`__ - :manual:`$concatArrays ` - * - `concatArrays() <{+core-api+}/com/mongodb/client/model/mql/MqlArray.html#concatArrays(java.util.function.Function)>`__ + * - `concatArrays() <{+core-api+}/client/model/mql/MqlArray.html#concatArrays(java.util.function.Function)>`__ - :manual:`$concatArrays ` - * - `contains() <{+core-api+}/com/mongodb/client/model/mql/MqlArray.html#contains(T)>`__ + * - `contains() <{+core-api+}/client/model/mql/MqlArray.html#contains(T)>`__ - :manual:`$in ` - * - `distinct() <{+core-api+}/com/mongodb/client/model/mql/MqlArray.html#distinct()>`__ + * - `distinct() <{+core-api+}/client/model/mql/MqlArray.html#distinct()>`__ - :manual:`$setUnion ` - * - `elementAt() <{+core-api+}/com/mongodb/client/model/mql/MqlArray.html#elementAt(int)>`__ + * - `elementAt() <{+core-api+}/client/model/mql/MqlArray.html#elementAt(int)>`__ - :manual:`$arrayElemAt ` - * - `filter() <{+core-api+}/com/mongodb/client/model/mql/MqlArray.html#filter(java.util.function.Function)>`__ + * - `filter() <{+core-api+}/client/model/mql/MqlArray.html#filter(java.util.function.Function)>`__ - :manual:`$filter ` - * - `first() <{+core-api+}/com/mongodb/client/model/mql/MqlArray.html#first()>`__ + * - `first() <{+core-api+}/client/model/mql/MqlArray.html#first()>`__ - :manual:`$first ` - * - `joinStrings() <{+core-api+}/com/mongodb/client/model/mql/MqlArray.html#joinStrings(java.util.function.Function)>`__ + * - `joinStrings() <{+core-api+}/client/model/mql/MqlArray.html#joinStrings(java.util.function.Function)>`__ - :manual:`$concat ` - * - `last() <{+core-api+}/com/mongodb/client/model/mql/MqlArray.html#last()>`__ + * - `last() <{+core-api+}/client/model/mql/MqlArray.html#last()>`__ - :manual:`$last ` - * - `map() <{+core-api+}/com/mongodb/client/model/mql/MqlArray.html#map(java.util.function.Function)>`__ + * - `map() <{+core-api+}/client/model/mql/MqlArray.html#map(java.util.function.Function)>`__ - :manual:`$map ` - * - `max() <{+core-api+}/com/mongodb/client/model/mql/MqlArray.html#max(T)>`__ + * - `max() <{+core-api+}/client/model/mql/MqlArray.html#max(T)>`__ - :manual:`$max ` - * - `maxN() <{+core-api+}/com/mongodb/client/model/mql/MqlArray.html#maxN(com.mongodb.client.model.mql.MqlInteger)>`__ + * - `maxN() <{+core-api+}/client/model/mql/MqlArray.html#maxN(com.mongodb.client.model.mql.MqlInteger)>`__ - :manual:`$maxN ` - * - `min() <{+core-api+}/com/mongodb/client/model/mql/MqlArray.html#min(T)>`__ + * - `min() <{+core-api+}/client/model/mql/MqlArray.html#min(T)>`__ - :manual:`$min ` - * - `minN() <{+core-api+}/com/mongodb/client/model/mql/MqlArray.html#minN(com.mongodb.client.model.mql.MqlInteger)>`__ + * - `minN() <{+core-api+}/client/model/mql/MqlArray.html#minN(com.mongodb.client.model.mql.MqlInteger)>`__ - :manual:`$minN ` - * - `multiply() <{+core-api+}/com/mongodb/client/model/mql/MqlArray.html#multiply(java.util.function.Function)>`__ + * - `multiply() <{+core-api+}/client/model/mql/MqlArray.html#multiply(java.util.function.Function)>`__ - :manual:`$multiply ` - * - `size() <{+core-api+}/com/mongodb/client/model/mql/MqlArray.html#size()>`__ + * - `size() <{+core-api+}/client/model/mql/MqlArray.html#size()>`__ - :manual:`$size ` - * - `slice() <{+core-api+}/com/mongodb/client/model/mql/MqlArray.html#slice(int,int)>`__ + * - `slice() <{+core-api+}/client/model/mql/MqlArray.html#slice(int,int)>`__ - :manual:`$slice ` - * - `sum() <{+core-api+}/com/mongodb/client/model/mql/MqlArray.html#sum(java.util.function.Function)>`__ + * - `sum() <{+core-api+}/client/model/mql/MqlArray.html#sum(java.util.function.Function)>`__ - :manual:`$sum ` - * - `union() <{+core-api+}/com/mongodb/client/model/mql/MqlArray.html#union(com.mongodb.client.model.mql.MqlArray)>`__ + * - `union() <{+core-api+}/client/model/mql/MqlArray.html#union(com.mongodb.client.model.mql.MqlArray)>`__ - :manual:`$setUnion ` - * - `unionArrays() <{+core-api+}/com/mongodb/client/model/mql/MqlArray.html#unionArrays(java.util.function.Function)>`__ + * - `unionArrays() <{+core-api+}/client/model/mql/MqlArray.html#unionArrays(java.util.function.Function)>`__ - :manual:`$setUnion ` Suppose you have a collection of movies, each of which contains an array @@ -448,13 +448,13 @@ using the methods described in this section. * - Method - Aggregation Pipeline Operator - * - `and() <{+core-api+}/com/mongodb/client/model/mql/MqlBoolean.html#and(com.mongodb.client.model.mql.MqlBoolean)>`__ + * - `and() <{+core-api+}/client/model/mql/MqlBoolean.html#and(com.mongodb.client.model.mql.MqlBoolean)>`__ - :manual:`$and ` - * - `not() <{+core-api+}/com/mongodb/client/model/mql/MqlBoolean.html#not()>`__ + * - `not() <{+core-api+}/client/model/mql/MqlBoolean.html#not()>`__ - :manual:`$not ` - * - `or() <{+core-api+}/com/mongodb/client/model/mql/MqlBoolean.html#or(com.mongodb.client.model.mql.MqlBoolean)>`__ + * - `or() <{+core-api+}/client/model/mql/MqlBoolean.html#or(com.mongodb.client.model.mql.MqlBoolean)>`__ - :manual:`$or ` Suppose you want to classify very low or high weather temperature @@ -505,32 +505,32 @@ using the methods described in this section. * - Method - Aggregation Pipeline Operator - * - `eq() <{+core-api+}/com/mongodb/client/model/mql/MqlValue.html#eq(com.mongodb.client.model.mql.MqlValue)>`__ + * - `eq() <{+core-api+}/client/model/mql/MqlValue.html#eq(com.mongodb.client.model.mql.MqlValue)>`__ - :manual:`$eq ` - * - `gt() <{+core-api+}/com/mongodb/client/model/mql/MqlValue.html#gt(com.mongodb.client.model.mql.MqlValue)>`__ + * - `gt() <{+core-api+}/client/model/mql/MqlValue.html#gt(com.mongodb.client.model.mql.MqlValue)>`__ - :manual:`$gt ` - * - `gte() <{+core-api+}/com/mongodb/client/model/mql/MqlValue.html#gte(com.mongodb.client.model.mql.MqlValue)>`__ + * - `gte() <{+core-api+}/client/model/mql/MqlValue.html#gte(com.mongodb.client.model.mql.MqlValue)>`__ - :manual:`$gte ` - * - `lt() <{+core-api+}/com/mongodb/client/model/mql/MqlValue.html#lt(com.mongodb.client.model.mql.MqlValue)>`__ + * - `lt() <{+core-api+}/client/model/mql/MqlValue.html#lt(com.mongodb.client.model.mql.MqlValue)>`__ - :manual:`$lt ` - * - `lte() <{+core-api+}/com/mongodb/client/model/mql/MqlValue.html#lte(com.mongodb.client.model.mql.MqlValue)>`__ + * - `lte() <{+core-api+}/client/model/mql/MqlValue.html#lte(com.mongodb.client.model.mql.MqlValue)>`__ - :manual:`$lte ` - * - | `max() for MqlInteger <{+core-api+}/com/mongodb/client/model/mql/MqlInteger.html#max(com.mongodb.client.model.mql.MqlInteger)>`__ - | `max() for MqlNumber <{+core-api+}/com/mongodb/client/model/mql/MqlNumber.html#max(com.mongodb.client.model.mql.MqlNumber)>`__ + * - | `max() for MqlInteger <{+core-api+}/client/model/mql/MqlInteger.html#max(com.mongodb.client.model.mql.MqlInteger)>`__ + | `max() for MqlNumber <{+core-api+}/client/model/mql/MqlNumber.html#max(com.mongodb.client.model.mql.MqlNumber)>`__ - :manual:`$max ` - * - | `min() for MqlInteger <{+core-api+}/com/mongodb/client/model/mql/MqlInteger.html#min(com.mongodb.client.model.mql.MqlInteger)>`__ - | `min() for MqlNumber <{+core-api+}/com/mongodb/client/model/mql/MqlNumber.html#min(com.mongodb.client.model.mql.MqlNumber)>`__ + * - | `min() for MqlInteger <{+core-api+}/client/model/mql/MqlInteger.html#min(com.mongodb.client.model.mql.MqlInteger)>`__ + | `min() for MqlNumber <{+core-api+}/client/model/mql/MqlNumber.html#min(com.mongodb.client.model.mql.MqlNumber)>`__ - :manual:`$min ` - * - `ne() <{+core-api+}/com/mongodb/client/model/mql/MqlValue.html#ne(com.mongodb.client.model.mql.MqlValue)>`__ + * - `ne() <{+core-api+}/client/model/mql/MqlValue.html#ne(com.mongodb.client.model.mql.MqlValue)>`__ - :manual:`$ne ` The following example shows a pipeline that matches all the documents @@ -564,20 +564,20 @@ this section. * - Method - Aggregation Pipeline Operator - * - `cond() <{+core-api+}/com/mongodb/client/model/mql/MqlBoolean.html#cond(T,T)>`__ + * - `cond() <{+core-api+}/client/model/mql/MqlBoolean.html#cond(T,T)>`__ - :manual:`$cond ` - * - `switchOn() <{+core-api+}/com/mongodb/client/model/mql/MqlValue.html#switchOn(java.util.function.Function)>`__ + * - `switchOn() <{+core-api+}/client/model/mql/MqlValue.html#switchOn(java.util.function.Function)>`__ | **Typed Variants**: - | `switchArrayOn() <{+core-api+}/com/mongodb/client/model/mql/MqlArray.html#switchArrayOn(java.util.function.Function)>`__ - | `switchBooleanOn() <{+core-api+}/com/mongodb/client/model/mql/MqlBoolean.html#switchBooleanOn(java.util.function.Function)>`__ - | `switchDateOn() <{+core-api+}/com/mongodb/client/model/mql/MqlDate.html#switchDateOn(java.util.function.Function)>`__ - | `switchDocumentOn() <{+core-api+}/com/mongodb/client/model/mql/MqlDocument.html#switchDocumentOn(java.util.function.Function)>`__ - | `switchIntegerOn() <{+core-api+}/com/mongodb/client/model/mql/MqlInteger.html#switchIntegerOn(java.util.function.Function)>`__ - | `switchMapOn() <{+core-api+}/com/mongodb/client/model/mql/MqlMap.html#switchMapOn(java.util.function.Function)>`__ - | `switchNumberOn() <{+core-api+}/com/mongodb/client/model/mql/MqlNumber.html#switchNumberOn(java.util.function.Function)>`__ - | `switchStringOn() <{+core-api+}/com/mongodb/client/model/mql/MqlString.html#switchStringOn(java.util.function.Function)>`__ + | `switchArrayOn() <{+core-api+}/client/model/mql/MqlArray.html#switchArrayOn(java.util.function.Function)>`__ + | `switchBooleanOn() <{+core-api+}/client/model/mql/MqlBoolean.html#switchBooleanOn(java.util.function.Function)>`__ + | `switchDateOn() <{+core-api+}/client/model/mql/MqlDate.html#switchDateOn(java.util.function.Function)>`__ + | `switchDocumentOn() <{+core-api+}/client/model/mql/MqlDocument.html#switchDocumentOn(java.util.function.Function)>`__ + | `switchIntegerOn() <{+core-api+}/client/model/mql/MqlInteger.html#switchIntegerOn(java.util.function.Function)>`__ + | `switchMapOn() <{+core-api+}/client/model/mql/MqlMap.html#switchMapOn(java.util.function.Function)>`__ + | `switchNumberOn() <{+core-api+}/client/model/mql/MqlNumber.html#switchNumberOn(java.util.function.Function)>`__ + | `switchStringOn() <{+core-api+}/client/model/mql/MqlString.html#switchStringOn(java.util.function.Function)>`__ - :manual:`$switch ` @@ -643,17 +643,17 @@ into custom static methods. * - Method - Aggregation Pipeline Operator - * - `passTo() <{+core-api+}/com/mongodb/client/model/mql/MqlValue.html#passTo(java.util.function.Function)>`__ + * - `passTo() <{+core-api+}/client/model/mql/MqlValue.html#passTo(java.util.function.Function)>`__ | **Typed Variants**: - | `passArrayTo() <{+core-api+}/com/mongodb/client/model/mql/MqlArray.html#passArrayTo(java.util.function.Function)>`__ - | `passBooleanTo() <{+core-api+}/com/mongodb/client/model/mql/MqlBoolean.html#passBooleanTo(java.util.function.Function)>`__ - | `passDateTo() <{+core-api+}/com/mongodb/client/model/mql/MqlDate.html#passDateTo(java.util.function.Function)>`__ - | `passDocumentTo() <{+core-api+}/com/mongodb/client/model/mql/MqlDocument.html#passDocumentTo(java.util.function.Function)>`__ - | `passIntegerTo() <{+core-api+}/com/mongodb/client/model/mql/MqlInteger.html#passIntegerTo(java.util.function.Function)>`__ - | `passMapTo() <{+core-api+}/com/mongodb/client/model/mql/MqlMap.html#passMapTo(java.util.function.Function)>`__ - | `passNumberTo() <{+core-api+}/com/mongodb/client/model/mql/MqlNumber.html#passNumberTo(java.util.function.Function)>`__ - | `passStringTo() <{+core-api+}/com/mongodb/client/model/mql/MqlString.html#passStringTo(java.util.function.Function)>`__ + | `passArrayTo() <{+core-api+}/client/model/mql/MqlArray.html#passArrayTo(java.util.function.Function)>`__ + | `passBooleanTo() <{+core-api+}/client/model/mql/MqlBoolean.html#passBooleanTo(java.util.function.Function)>`__ + | `passDateTo() <{+core-api+}/client/model/mql/MqlDate.html#passDateTo(java.util.function.Function)>`__ + | `passDocumentTo() <{+core-api+}/client/model/mql/MqlDocument.html#passDocumentTo(java.util.function.Function)>`__ + | `passIntegerTo() <{+core-api+}/client/model/mql/MqlInteger.html#passIntegerTo(java.util.function.Function)>`__ + | `passMapTo() <{+core-api+}/client/model/mql/MqlMap.html#passMapTo(java.util.function.Function)>`__ + | `passNumberTo() <{+core-api+}/client/model/mql/MqlNumber.html#passNumberTo(java.util.function.Function)>`__ + | `passStringTo() <{+core-api+}/client/model/mql/MqlString.html#passStringTo(java.util.function.Function)>`__ - *No corresponding operator* @@ -732,25 +732,25 @@ types using the methods described in this section. * - Method - Aggregation Pipeline Operator - * - `asDocument() <{+core-api+}/com/mongodb/client/model/mql/MqlMap.html#asDocument()>`__ + * - `asDocument() <{+core-api+}/client/model/mql/MqlMap.html#asDocument()>`__ - *No corresponding operator* - * - `asMap() <{+core-api+}/com/mongodb/client/model/mql/MqlDocument.html#asMap()>`__ + * - `asMap() <{+core-api+}/client/model/mql/MqlDocument.html#asMap()>`__ - *No corresponding operator* - * - `asString() for MqlDate <{+core-api+}/com/mongodb/client/model/mql/MqlDate.html#asString(com.mongodb.client.model.mql.MqlString,com.mongodb.client.model.mql.MqlString)>`__ + * - `asString() for MqlDate <{+core-api+}/client/model/mql/MqlDate.html#asString(com.mongodb.client.model.mql.MqlString,com.mongodb.client.model.mql.MqlString)>`__ - :manual:`$dateToString ` - * - `asString() for MqlValue <{+core-api+}/com/mongodb/client/model/mql/MqlValue.html#asString()>`__ + * - `asString() for MqlValue <{+core-api+}/client/model/mql/MqlValue.html#asString()>`__ - :manual:`$toString ` - * - `millisecondsAsDate() <{+core-api+}/com/mongodb/client/model/mql/MqlInteger.html#millisecondsAsDate()>`__ + * - `millisecondsAsDate() <{+core-api+}/client/model/mql/MqlInteger.html#millisecondsAsDate()>`__ - :manual:`$toDate ` - * - `parseDate() <{+core-api+}/com/mongodb/client/model/mql/MqlString.html#parseDate()>`__ + * - `parseDate() <{+core-api+}/client/model/mql/MqlString.html#parseDate()>`__ - :manual:`$dateFromString ` - * - `parseInteger() <{+core-api+}/com/mongodb/client/model/mql/MqlString.html#parseInteger()>`__ + * - `parseInteger() <{+core-api+}/client/model/mql/MqlString.html#parseInteger()>`__ - :manual:`$toInt ` Suppose you want to have a collection of student data that includes @@ -795,34 +795,34 @@ using the methods described in this section. * - Method - Aggregation Pipeline Operator - * - `dayOfMonth() <{+core-api+}/com/mongodb/client/model/mql/MqlDate.html#dayOfMonth(com.mongodb.client.model.mql.MqlString)>`__ + * - `dayOfMonth() <{+core-api+}/client/model/mql/MqlDate.html#dayOfMonth(com.mongodb.client.model.mql.MqlString)>`__ - :manual:`$dayOfMonth ` - * - `dayOfWeek() <{+core-api+}/com/mongodb/client/model/mql/MqlDate.html#dayOfWeek(com.mongodb.client.model.mql.MqlString)>`__ + * - `dayOfWeek() <{+core-api+}/client/model/mql/MqlDate.html#dayOfWeek(com.mongodb.client.model.mql.MqlString)>`__ - :manual:`$dayOfWeek ` - * - `dayOfYear() <{+core-api+}/com/mongodb/client/model/mql/MqlDate.html#dayOfYear(com.mongodb.client.model.mql.MqlString)>`__ + * - `dayOfYear() <{+core-api+}/client/model/mql/MqlDate.html#dayOfYear(com.mongodb.client.model.mql.MqlString)>`__ - :manual:`$dayOfYear ` - * - `hour() <{+core-api+}/com/mongodb/client/model/mql/MqlDate.html#hour(com.mongodb.client.model.mql.MqlString)>`__ + * - `hour() <{+core-api+}/client/model/mql/MqlDate.html#hour(com.mongodb.client.model.mql.MqlString)>`__ - :manual:`$hour ` - * - `millisecond() <{+core-api+}/com/mongodb/client/model/mql/MqlDate.html#millisecond(com.mongodb.client.model.mql.MqlString)>`__ + * - `millisecond() <{+core-api+}/client/model/mql/MqlDate.html#millisecond(com.mongodb.client.model.mql.MqlString)>`__ - :manual:`$millisecond ` - * - `minute() <{+core-api+}/com/mongodb/client/model/mql/MqlDate.html#minute(com.mongodb.client.model.mql.MqlString)>`__ + * - `minute() <{+core-api+}/client/model/mql/MqlDate.html#minute(com.mongodb.client.model.mql.MqlString)>`__ - :manual:`$minute ` - * - `month() <{+core-api+}/com/mongodb/client/model/mql/MqlDate.html#month(com.mongodb.client.model.mql.MqlString)>`__ + * - `month() <{+core-api+}/client/model/mql/MqlDate.html#month(com.mongodb.client.model.mql.MqlString)>`__ - :manual:`$month ` - * - `second() <{+core-api+}/com/mongodb/client/model/mql/MqlDate.html#second(com.mongodb.client.model.mql.MqlString)>`__ + * - `second() <{+core-api+}/client/model/mql/MqlDate.html#second(com.mongodb.client.model.mql.MqlString)>`__ - :manual:`$second ` - * - `week() <{+core-api+}/com/mongodb/client/model/mql/MqlDate.html#week(com.mongodb.client.model.mql.MqlString)>`__ + * - `week() <{+core-api+}/client/model/mql/MqlDate.html#week(com.mongodb.client.model.mql.MqlString)>`__ - :manual:`$week ` - * - `year() <{+core-api+}/com/mongodb/client/model/mql/MqlDate.html#year(com.mongodb.client.model.mql.MqlString)>`__ + * - `year() <{+core-api+}/client/model/mql/MqlDate.html#year(com.mongodb.client.model.mql.MqlString)>`__ - :manual:`$year ` Suppose you have data about package deliveries and want to match @@ -877,27 +877,27 @@ using the methods described in this section. * - Method - Aggregation Pipeline Operator - * - | `getArray() <{+core-api+}/com/mongodb/client/model/mql/MqlDocument.html#getArray(java.lang.String)>`__ - | `getBoolean() <{+core-api+}/com/mongodb/client/model/mql/MqlDocument.html#getBoolean(java.lang.String)>`__ - | `getDate() <{+core-api+}/com/mongodb/client/model/mql/MqlDocument.html#getDate(java.lang.String)>`__ - | `getDocument() <{+core-api+}/com/mongodb/client/model/mql/MqlDocument.html#getDocument(java.lang.String)>`__ - | `getField() <{+core-api+}/com/mongodb/client/model/mql/MqlDocument.html#getField(java.lang.String)>`__ - | `getInteger() <{+core-api+}/com/mongodb/client/model/mql/MqlDocument.html#getInteger(java.lang.String)>`__ - | `getMap() <{+core-api+}/com/mongodb/client/model/mql/MqlDocument.html#getMap(java.lang.String)>`__ - | `getNumber() <{+core-api+}/com/mongodb/client/model/mql/MqlDocument.html#getNumber(java.lang.String)>`__ - | `getString() <{+core-api+}/com/mongodb/client/model/mql/MqlDocument.html#getString(java.lang.String)>`__ + * - | `getArray() <{+core-api+}/client/model/mql/MqlDocument.html#getArray(java.lang.String)>`__ + | `getBoolean() <{+core-api+}/client/model/mql/MqlDocument.html#getBoolean(java.lang.String)>`__ + | `getDate() <{+core-api+}/client/model/mql/MqlDocument.html#getDate(java.lang.String)>`__ + | `getDocument() <{+core-api+}/client/model/mql/MqlDocument.html#getDocument(java.lang.String)>`__ + | `getField() <{+core-api+}/client/model/mql/MqlDocument.html#getField(java.lang.String)>`__ + | `getInteger() <{+core-api+}/client/model/mql/MqlDocument.html#getInteger(java.lang.String)>`__ + | `getMap() <{+core-api+}/client/model/mql/MqlDocument.html#getMap(java.lang.String)>`__ + | `getNumber() <{+core-api+}/client/model/mql/MqlDocument.html#getNumber(java.lang.String)>`__ + | `getString() <{+core-api+}/client/model/mql/MqlDocument.html#getString(java.lang.String)>`__ - :manual:`$getField ` - * - `hasField() <{+core-api+}/com/mongodb/client/model/mql/MqlDocument.html#hasField(java.lang.String)>`__ + * - `hasField() <{+core-api+}/client/model/mql/MqlDocument.html#hasField(java.lang.String)>`__ - *No corresponding operator* - * - `merge() <{+core-api+}/com/mongodb/client/model/mql/MqlDocument.html#merge(com.mongodb.client.model.mql.MqlDocument)>`__ + * - `merge() <{+core-api+}/client/model/mql/MqlDocument.html#merge(com.mongodb.client.model.mql.MqlDocument)>`__ - :manual:`$mergeObjects ` - * - `setField() <{+core-api+}/com/mongodb/client/model/mql/MqlDocument.html#setField(java.lang.String,com.mongodb.client.model.mql.MqlValue)>`__ + * - `setField() <{+core-api+}/client/model/mql/MqlDocument.html#setField(java.lang.String,com.mongodb.client.model.mql.MqlValue)>`__ - :manual:`$setField ` - * - `unsetField() <{+core-api+}/com/mongodb/client/model/mql/MqlDocument.html#unsetField(java.lang.String)>`__ + * - `unsetField() <{+core-api+}/client/model/mql/MqlDocument.html#unsetField(java.lang.String)>`__ - :manual:`$unsetField ` Suppose you have a collection of legacy customer data which includes @@ -963,34 +963,34 @@ You can perform a map operation on a value of either type ``MqlMap`` or * - Method - Aggregation Pipeline Operator - * - `entries() <{+core-api+}/com/mongodb/client/model/mql/MqlMap.html#entries()>`__ + * - `entries() <{+core-api+}/client/model/mql/MqlMap.html#entries()>`__ - :manual:`$objectToArray ` - * - `get() <{+core-api+}/com/mongodb/client/model/mql/MqlMap.html#get(com.mongodb.client.model.mql.MqlString)>`__ + * - `get() <{+core-api+}/client/model/mql/MqlMap.html#get(com.mongodb.client.model.mql.MqlString)>`__ - *No corresponding operator* - * - `getKey() <{+core-api+}/com/mongodb/client/model/mql/MqlEntry.html#getKey()>`__ + * - `getKey() <{+core-api+}/client/model/mql/MqlEntry.html#getKey()>`__ - *No corresponding operator* - * - `getValue() <{+core-api+}/com/mongodb/client/model/mql/MqlEntry.html#getValue()>`__ + * - `getValue() <{+core-api+}/client/model/mql/MqlEntry.html#getValue()>`__ - *No corresponding operator* - * - `has() <{+core-api+}/com/mongodb/client/model/mql/MqlMap.html#has(com.mongodb.client.model.mql.MqlString)>`__ + * - `has() <{+core-api+}/client/model/mql/MqlMap.html#has(com.mongodb.client.model.mql.MqlString)>`__ - *No corresponding operator* - * - `merge() <{+core-api+}/com/mongodb/client/model/mql/MqlMap.html#merge(com.mongodb.client.model.mql.MqlMap)>`__ + * - `merge() <{+core-api+}/client/model/mql/MqlMap.html#merge(com.mongodb.client.model.mql.MqlMap)>`__ - *No corresponding operator* - * - `set() <{+core-api+}/com/mongodb/client/model/mql/MqlMap.html#set(com.mongodb.client.model.mql.MqlString,T)>`__ + * - `set() <{+core-api+}/client/model/mql/MqlMap.html#set(com.mongodb.client.model.mql.MqlString,T)>`__ - *No corresponding operator* - * - `setKey() <{+core-api+}/com/mongodb/client/model/mql/MqlEntry.html#setKey(com.mongodb.client.model.mql.MqlString)>`__ + * - `setKey() <{+core-api+}/client/model/mql/MqlEntry.html#setKey(com.mongodb.client.model.mql.MqlString)>`__ - *No corresponding operator* - * - `setValue() <{+core-api+}/com/mongodb/client/model/mql/MqlEntry.html#setValue(T)>`__ + * - `setValue() <{+core-api+}/client/model/mql/MqlEntry.html#setValue(T)>`__ - *No corresponding operator* - * - `unset() <{+core-api+}/com/mongodb/client/model/mql/MqlMap.html#unset(com.mongodb.client.model.mql.MqlString)>`__ + * - `unset() <{+core-api+}/client/model/mql/MqlMap.html#unset(com.mongodb.client.model.mql.MqlString)>`__ - *No corresponding operator* Suppose you have a collection of inventory data where each document represents @@ -1055,25 +1055,25 @@ using the methods described in this section. * - Method - Aggregation Pipeline Operator - * - `append() <{+core-api+}/com/mongodb/client/model/mql/MqlString.html#append(com.mongodb.client.model.mql.MqlString)>`__ + * - `append() <{+core-api+}/client/model/mql/MqlString.html#append(com.mongodb.client.model.mql.MqlString)>`__ - :manual:`$concat ` - * - `length() <{+core-api+}/com/mongodb/client/model/mql/MqlString.html#length()>`__ + * - `length() <{+core-api+}/client/model/mql/MqlString.html#length()>`__ - :manual:`$strLenCP ` - * - `lengthBytes() <{+core-api+}/com/mongodb/client/model/mql/MqlString.html#lengthBytes()>`__ + * - `lengthBytes() <{+core-api+}/client/model/mql/MqlString.html#lengthBytes()>`__ - :manual:`$strLenBytes ` - * - `substr() <{+core-api+}/com/mongodb/client/model/mql/MqlString.html#substr(int,int)>`__ + * - `substr() <{+core-api+}/client/model/mql/MqlString.html#substr(int,int)>`__ - :manual:`$substrCP ` - * - `substrBytes() <{+core-api+}/com/mongodb/client/model/mql/MqlString.html#substrBytes(int,int)>`__ + * - `substrBytes() <{+core-api+}/client/model/mql/MqlString.html#substrBytes(int,int)>`__ - :manual:`$substrBytes ` - * - `toLower() <{+core-api+}/com/mongodb/client/model/mql/MqlString.html#toLower()>`__ + * - `toLower() <{+core-api+}/client/model/mql/MqlString.html#toLower()>`__ - :manual:`$toLower ` - * - `toUpper() <{+core-api+}/com/mongodb/client/model/mql/MqlString.html#toUpper()>`__ + * - `toUpper() <{+core-api+}/client/model/mql/MqlString.html#toUpper()>`__ - :manual:`$toUpper ` Suppose you want to generate lowercase usernames for employees of a @@ -1123,28 +1123,28 @@ data type, see ``switchOn()``. * - Method - Aggregation Pipeline Operator - * - `isArrayOr() <{+core-api+}/com/mongodb/client/model/mql/MqlValue.html#isArrayOr(com.mongodb.client.model.mql.MqlArray)>`__ + * - `isArrayOr() <{+core-api+}/client/model/mql/MqlValue.html#isArrayOr(com.mongodb.client.model.mql.MqlArray)>`__ - *No corresponding operator* - * - `isBooleanOr() <{+core-api+}/com/mongodb/client/model/mql/MqlValue.html#isBooleanOr(com.mongodb.client.model.mql.MqlBoolean)>`__ + * - `isBooleanOr() <{+core-api+}/client/model/mql/MqlValue.html#isBooleanOr(com.mongodb.client.model.mql.MqlBoolean)>`__ - *No corresponding operator* - * - `isDateOr() <{+core-api+}/com/mongodb/client/model/mql/MqlValue.html#isDateOr(com.mongodb.client.model.mql.MqlDate)>`__ + * - `isDateOr() <{+core-api+}/client/model/mql/MqlValue.html#isDateOr(com.mongodb.client.model.mql.MqlDate)>`__ - *No corresponding operator* - * - `isDocumentOr() <{+core-api+}/com/mongodb/client/model/mql/MqlValue.html#isDocumentOr(T)>`__ + * - `isDocumentOr() <{+core-api+}/client/model/mql/MqlValue.html#isDocumentOr(T)>`__ - *No corresponding operator* - * - `isIntegerOr() <{+core-api+}/com/mongodb/client/model/mql/MqlValue.html#isIntegerOr(com.mongodb.client.model.mql.MqlInteger)>`__ + * - `isIntegerOr() <{+core-api+}/client/model/mql/MqlValue.html#isIntegerOr(com.mongodb.client.model.mql.MqlInteger)>`__ - *No corresponding operator* - * - `isMapOr() <{+core-api+}/com/mongodb/client/model/mql/MqlValue.html#isMapOr(com.mongodb.client.model.mql.MqlMap)>`__ + * - `isMapOr() <{+core-api+}/client/model/mql/MqlValue.html#isMapOr(com.mongodb.client.model.mql.MqlMap)>`__ - *No corresponding operator* - * - `isNumberOr() <{+core-api+}/com/mongodb/client/model/mql/MqlValue.html#isNumberOr(com.mongodb.client.model.mql.MqlNumber)>`__ + * - `isNumberOr() <{+core-api+}/client/model/mql/MqlValue.html#isNumberOr(com.mongodb.client.model.mql.MqlNumber)>`__ - *No corresponding operator* - * - `isStringOr() <{+core-api+}/com/mongodb/client/model/mql/MqlValue.html#isStringOr(com.mongodb.client.model.mql.MqlString)>`__ + * - `isStringOr() <{+core-api+}/client/model/mql/MqlValue.html#isStringOr(com.mongodb.client.model.mql.MqlString)>`__ - *No corresponding operator* Suppose you have a collection of rating data. An early version of the review diff --git a/source/aggregation.txt b/source/aggregation.txt index c865c9c1..79d11014 100644 --- a/source/aggregation.txt +++ b/source/aggregation.txt @@ -216,5 +216,5 @@ API Documentation For more information about executing aggregation operations with the {+driver-short+}, see the following API documentation: -- `aggregate() <{+api+}/com.mongodb.kotlin.client/-mongo-collection/aggregate.html>`__ -- `AggregateIterable <{+api+}/com.mongodb.kotlin.client/-aggregate-iterable/index.html>`__ \ No newline at end of file +- `aggregate() <{+driver-api+}/-mongo-collection/aggregate.html>`__ +- `AggregateIterable <{+driver-api+}/-aggregate-iterable/index.html>`__ \ No newline at end of file diff --git a/source/api.txt b/source/api.txt index 1296bdf8..a54a7e13 100644 --- a/source/api.txt +++ b/source/api.txt @@ -8,18 +8,18 @@ API Documentation :titlesonly: :maxdepth: 1 - {+language+} Sync Driver <{+java-api+}/apidocs/mongodb-driver-kotlin-sync/index.html> - BSON kotlinx.serialization <{+java-api+}/apidocs/bson-kotlinx/index.html> - {+language+} Driver Extensions <{+java-api+}/apidocs/mongodb-driver-kotlin-extensions/index.html> + {+language+} Sync Driver <{+api-root+}/mongodb-driver-kotlin-sync/index.html> + BSON kotlinx.serialization <{+api-root+}/bson-kotlinx/index.html> + {+language+} Driver Extensions <{+api-root+}/mongodb-driver-kotlin-extensions/index.html> Driver Core <{+core-api+}/index.html> -- `{+language+} Sync Driver <{+java-api+}/apidocs/mongodb-driver-kotlin-sync/index.html>`__ - +- `{+language+} Sync Driver <{+api-root+}/mongodb-driver-kotlin-sync/index.html>`__ - classes for the current synchronous driver API. -- `BSON kotlinx.serialization <{+java-api+}/apidocs/bson-kotlinx/index.html>`__ - +- `BSON kotlinx.serialization <{+api-root+}/bson-kotlinx/index.html>`__ - classes for encoding and decoding between Kotlin data classes and the BSON data format using :github:`kotlinx.serialization `. - `{+language+} Driver Extensions - <{+java-api+}/apidocs/mongodb-driver-kotlin-extensions/index.html>`__ - + <{+api-root+}/mongodb-driver-kotlin-extensions/index.html>`__ - classes that extend the core builder classes to support :ref:`data classes `. - `Driver Core <{+core-api+}/index.html>`__ - classes that diff --git a/source/builders.txt b/source/builders.txt index f71c55c1..69e879f1 100644 --- a/source/builders.txt +++ b/source/builders.txt @@ -33,13 +33,13 @@ efficiently build queries and aggregations. To learn more about the available builder classes and methods, see the following API documentation sections: -- `Accumulators <{+core-api+}/com/mongodb/client/model/Accumulators.html>`__ -- `Aggregates <{+core-api+}/com/mongodb/client/model/Aggregates.html>`__ -- `Filters <{+core-api+}/com/mongodb/client/model/Filters.html>`__ -- `Indexes <{+core-api+}/com/mongodb/client/model/Indexes.html>`__ -- `Projections <{+core-api+}/com/mongodb/client/model/Projections.html>`__ -- `Sorts <{+core-api+}/com/mongodb/client/model/Sorts.html>`__ -- `Updates <{+core-api+}/com/mongodb/client/model/Updates.html>`__ +- `Accumulators <{+core-api+}/client/model/Accumulators.html>`__ +- `Aggregates <{+core-api+}/client/model/Aggregates.html>`__ +- `Filters <{+core-api+}/client/model/Filters.html>`__ +- `Indexes <{+core-api+}/client/model/Indexes.html>`__ +- `Projections <{+core-api+}/client/model/Projections.html>`__ +- `Sorts <{+core-api+}/client/model/Sorts.html>`__ +- `Updates <{+core-api+}/client/model/Updates.html>`__ Why Use Builders? ----------------- diff --git a/source/connect/connection-options.txt b/source/connect/connection-options.txt index 863194a6..0b54f269 100644 --- a/source/connect/connection-options.txt +++ b/source/connect/connection-options.txt @@ -341,9 +341,9 @@ API Documentation To learn more about the classes and methods mentioned in this guide, see the following API documentation: -- `MongoClientSettings <{+java-api+}/apidocs/mongodb-driver-core/com/mongodb/MongoClientSettings.html>`__ -- `MongoClientSettings.Builder <{+java-api+}/apidocs/mongodb-driver-core/com/mongodb/MongoClientSettings.Builder.html>`__ -- `ConnectionString <{+java-api+}/apidocs/mongodb-driver-core/com/mongodb/ConnectionString.html>`__ -- `SocketSettings <{+java-api+}/apidocs/mongodb-driver-core/com/mongodb/connection/SocketSettings.html>`__ -- `ClusterSettings <{+java-api+}/apidocs/mongodb-driver-core/com/mongodb/connection/ClusterSettings.html>`__ -- `MongoCredential <{+java-api+}/apidocs/mongodb-driver-core/com/mongodb/MongoCredential.html>`__ +- `MongoClientSettings <{+api-root+}/mongodb-driver-core/com/mongodb/MongoClientSettings.html>`__ +- `MongoClientSettings.Builder <{+api-root+}/mongodb-driver-core/com/mongodb/MongoClientSettings.Builder.html>`__ +- `ConnectionString <{+api-root+}/mongodb-driver-core/com/mongodb/ConnectionString.html>`__ +- `SocketSettings <{+api-root+}/mongodb-driver-core/com/mongodb/connection/SocketSettings.html>`__ +- `ClusterSettings <{+api-root+}/mongodb-driver-core/com/mongodb/connection/ClusterSettings.html>`__ +- `MongoCredential <{+api-root+}/mongodb-driver-core/com/mongodb/MongoCredential.html>`__ diff --git a/source/connect/mongoclient.txt b/source/connect/mongoclient.txt index 8bb3103f..e761ae02 100644 --- a/source/connect/mongoclient.txt +++ b/source/connect/mongoclient.txt @@ -126,5 +126,5 @@ API Documentation For more information about creating a ``MongoClient`` object with the {+driver-short+}, see the following API documentation: -- `MongoClient <{+api+}/mongodb-driver-kotlin-sync/com.mongodb.kotlin.client/-mongo-client/index.html>`__ +- `MongoClient <{+driver-api+}/-mongo-client/index.html>`__ - `MongoClientSettings <{+core-api+}com/mongodb/MongoClientSettings.html>`__ diff --git a/source/connect/stable-api.txt b/source/connect/stable-api.txt index 463fb7ce..f7484c31 100644 --- a/source/connect/stable-api.txt +++ b/source/connect/stable-api.txt @@ -123,11 +123,11 @@ API Documentation For more information about using the {+stable-api+} with the {+driver-short+}, see the following API documentation: -- `ServerApi <{+core-api+}/com/mongodb/ServerApi.html>`__ -- `ServerApi.Builder <{+core-api+}/com/mongodb/ServerApi.Builder.html>`__ -- `ServerApiVersion <{+core-api+}/com/mongodb/ServerApiVersion.html>`__ -- `ServerAddress <{+core-api+}/com/mongodb/ServerAddress.html>`__ -- `MongoClientSettings <{+core-api+}/com/mongodb/MongoClientSettings.html>`__ -- `MongoClientSettings.Builder <{+core-api+}/com/mongodb/MongoClientSettings.Builder.html>`__ -- `MongoClient <{+api+}/com.mongodb.kotlin.client/-mongo-client/index.html>`__ -- `MongoClient.create() <{+api+}/com.mongodb.kotlin.client/-mongo-client/-factory/create.html>`__ +- `ServerApi <{+core-api+}/ServerApi.html>`__ +- `ServerApi.Builder <{+core-api+}/ServerApi.Builder.html>`__ +- `ServerApiVersion <{+core-api+}/ServerApiVersion.html>`__ +- `ServerAddress <{+core-api+}/ServerAddress.html>`__ +- `MongoClientSettings <{+core-api+}/MongoClientSettings.html>`__ +- `MongoClientSettings.Builder <{+core-api+}/MongoClientSettings.Builder.html>`__ +- `MongoClient <{+driver-api+}/-mongo-client/index.html>`__ +- `MongoClient.create() <{+driver-api+}/-mongo-client/-factory/create.html>`__ diff --git a/source/connect/tls.txt b/source/connect/tls.txt index 9e9556c9..3bb8aebf 100644 --- a/source/connect/tls.txt +++ b/source/connect/tls.txt @@ -325,5 +325,5 @@ API Documentation For more information about any of the methods or types discussed in this guide, see the following API documentation: -- `ConnectionString <{+core-api+}/com/mongodb/ConnectionString.html>`__ -- `MongoClientSettings <{+core-api+}/com/mongodb/MongoClientSettings.html>`__ \ No newline at end of file +- `ConnectionString <{+core-api+}/ConnectionString.html>`__ +- `MongoClientSettings <{+core-api+}/MongoClientSettings.html>`__ \ No newline at end of file diff --git a/source/data-formats/bson.txt b/source/data-formats/bson.txt index cab2bfef..e6045af9 100644 --- a/source/data-formats/bson.txt +++ b/source/data-formats/bson.txt @@ -35,12 +35,12 @@ MongoDB and BSON ---------------- You can work with BSON data in your {+driver-short+} application by using one of the -following object types that implements the `BSON interface <{+java-api+}/apidocs/bson/org/bson/conversions/Bson.html>`__: +following object types that implements the `BSON interface <{+api-root+}/bson/org/bson/conversions/Bson.html>`__: -- `Document <{+java-api+}/apidocs/bson/org/bson/Document.html>`__ (BSON library package) -- `BsonDocument <{+java-api+}/apidocs/bson/org/bson/BsonDocument.html>`__ (BSON library package) -- `RawBsonDocument <{+java-api+}/apidocs/bson/org/bson/RawBsonDocument.html>`__ (BSON library package) -- `JsonObject <{+java-api+}/apidocs/bson/org/bson/json/JsonObject.html>`__ (BSON library package) +- `Document <{+api-root+}/bson/org/bson/Document.html>`__ (BSON library package) +- `BsonDocument <{+api-root+}/bson/org/bson/BsonDocument.html>`__ (BSON library package) +- `RawBsonDocument <{+api-root+}/bson/org/bson/RawBsonDocument.html>`__ (BSON library package) +- `JsonObject <{+api-root+}/bson/org/bson/json/JsonObject.html>`__ (BSON library package) .. _install-bson-library: diff --git a/source/data-formats/codecs.txt b/source/data-formats/codecs.txt index 785c835d..fa6edebf 100644 --- a/source/data-formats/codecs.txt +++ b/source/data-formats/codecs.txt @@ -142,13 +142,13 @@ your ``Codec`` in your registry. To learn more about the classes and interfaces mentioned in this section, see the following API documentation: -- `Codec <{+java-api+}/apidocs/bson/org/bson/codecs/Codec.html>`__ -- `BsonWriter <{+java-api+}/apidocs/bson/org/bson/BsonWriter.html>`__ -- `BsonBinaryWriter <{+java-api+}/apidocs/bson/org/bson/BsonBinaryWriter.html>`__ -- `EncoderContext <{+java-api+}/apidocs/bson/org/bson/codecs/EncoderContext.html>`__ -- `BsonReader <{+java-api+}/apidocs/bson/org/bson/BsonReader.html>`__ -- `DecoderContext <{+java-api+}/apidocs/bson/org/bson/codecs/DecoderContext.html>`__ -- `BsonBinaryReader <{+java-api+}/apidocs/bson/org/bson/BsonBinaryReader.html>`__ +- `Codec <{+api-root+}/bson/org/bson/codecs/Codec.html>`__ +- `BsonWriter <{+api-root+}/bson/org/bson/BsonWriter.html>`__ +- `BsonBinaryWriter <{+api-root+}/bson/org/bson/BsonBinaryWriter.html>`__ +- `EncoderContext <{+api-root+}/bson/org/bson/codecs/EncoderContext.html>`__ +- `BsonReader <{+api-root+}/bson/org/bson/BsonReader.html>`__ +- `DecoderContext <{+api-root+}/bson/org/bson/codecs/DecoderContext.html>`__ +- `BsonBinaryReader <{+api-root+}/bson/org/bson/BsonBinaryReader.html>`__ .. _kotlin-sync-codecregistry: @@ -195,8 +195,8 @@ registered, the ``codecRegistry.get()`` method raises a For more information about the classes and interfaces in this section, see the following API documentation: -- `CodecRegistries <{+java-api+}/apidocs/bson/org/bson/codecs/configuration/CodecRegistries.html>`__ -- `IntegerCodec <{+java-api+}/apidocs/bson/org/bson/codecs/IntegerCodec.html>`__ +- `CodecRegistries <{+api-root+}/bson/org/bson/codecs/configuration/CodecRegistries.html>`__ +- `IntegerCodec <{+api-root+}/bson/org/bson/codecs/IntegerCodec.html>`__ .. _kotlin-sync-codecprovider: @@ -251,8 +251,8 @@ following example: For more information about the classes and interfaces in this section, see the following API documentation: -- `CodecProvider <{+java-api+}/apidocs/bson/org/bson/codecs/configuration/CodecProvider.html>`__ -- `getCodecRegistry() <{+java-api+}/apidocs/mongodb-driver-sync/com/mongodb/client/MongoCollection.html#getCodecRegistry()>`__ +- `CodecProvider <{+api-root+}/bson/org/bson/codecs/configuration/CodecProvider.html>`__ +- `getCodecRegistry() <{+api-root+}/mongodb-driver-sync/com/mongodb/client/MongoCollection.html#getCodecRegistry()>`__ BsonTypeClassMap ~~~~~~~~~~~~~~~~ @@ -306,7 +306,7 @@ instance with the ``Set`` class: For a complete list of the default mappings, view the `BsonTypeClassMap -<{+java-api+}/apidocs/bson/org/bson/codecs/BsonTypeClassMap.html>`__ API +<{+api-root+}/bson/org/bson/codecs/BsonTypeClassMap.html>`__ API documentation. .. _kotlin-sync-codec-custom-example: @@ -386,5 +386,5 @@ retrieves data by using the ``Monolight`` class: For more information about the methods and classes mentioned in this section, see the following API documentation: -- `withCodecRegistry() <{+java-api+}/apidocs/mongodb-driver-sync/com/mongodb/client/MongoCollection.html#withCodecRegistry(org.bson.codecs.configuration.CodecRegistry)>`__ -- `fromRegistries() <{+java-api+}/apidocs/bson/org/bson/codecs/configuration/CodecRegistries.html#fromRegistries(org.bson.codecs.configuration.CodecRegistry...)>`__ \ No newline at end of file +- `withCodecRegistry() <{+api-root+}/mongodb-driver-sync/com/mongodb/client/MongoCollection.html#withCodecRegistry(org.bson.codecs.configuration.CodecRegistry)>`__ +- `fromRegistries() <{+api-root+}/bson/org/bson/codecs/configuration/CodecRegistries.html#fromRegistries(org.bson.codecs.configuration.CodecRegistry...)>`__ \ No newline at end of file diff --git a/source/data-formats/data-format-data-class.txt b/source/data-formats/data-format-data-class.txt index 5651f999..0df73e68 100644 --- a/source/data-formats/data-format-data-class.txt +++ b/source/data-formats/data-format-data-class.txt @@ -133,7 +133,7 @@ You can use the following annotations on data classes: To learn more these property annotations, see to the `org.bson.codecs.pojo.annotations -<{+java-api+}/apidocs/bson/org/bson/codecs/pojo/annotations/package-summary.html>`__ +<{+api-root+}/bson/org/bson/codecs/pojo/annotations/package-summary.html>`__ Package API documentation. Annotated Data Class Example diff --git a/source/data-formats/serialization.txt b/source/data-formats/serialization.txt index fd114cf7..fda712d0 100644 --- a/source/data-formats/serialization.txt +++ b/source/data-formats/serialization.txt @@ -96,7 +96,7 @@ dependencies to your project by using either :guilabel:`Gradle` or and the codec registry to support {+language+} data classes, but it does not support certain POJO annotations such as ``BsonDiscriminator``, ``BsonExtraElements``, and ``BsonConstructor``. To learn more, see - the `bson-kotlin API documentation <{+java-api+}/apidocs/bson-kotlin/index.html>`__. + the `bson-kotlin API documentation <{+api-root+}/bson-kotlin/index.html>`__. Generally, we recommend that you install and use the faster ``bson-kotlinx`` library for codec configuration. @@ -188,10 +188,10 @@ see the following API documentation: <{+kotlin-docs+}/api/kotlinx-datetime/kotlinx-datetime/kotlinx.datetime/-instant/>`__ in the {+language+} documentation - `BsonEncoder - <{+java-api+}/apidocs/bson-kotlinx/bson-kotlinx/org.bson.codecs.kotlinx/-bson-encoder/index.html>`__ + <{+api-root+}/bson-kotlinx/bson-kotlinx/org.bson.codecs.kotlinx/-bson-encoder/index.html>`__ - `BsonDecoder - <{+java-api+}/apidocs/bson-kotlinx/bson-kotlinx/org.bson.codecs.kotlinx/-bson-decoder/index.html>`__ + <{+api-root+}/bson-kotlinx/bson-kotlinx/org.bson.codecs.kotlinx/-bson-decoder/index.html>`__ .. _kotlin-sync-custom-codec: @@ -211,7 +211,7 @@ dependency. See the :ref:`kotlin-sync-add-serialization` section of this guide for installation instructions. You can define your codec by using the `KotlinSerializerCodec.create() -<{+java-api+}/apidocs/bson-kotlinx/bson-kotlinx/org.bson.codecs.kotlinx/-kotlin-serializer-codec/-companion/index.html>`__ +<{+api-root+}/bson-kotlinx/bson-kotlinx/org.bson.codecs.kotlinx/-kotlin-serializer-codec/-companion/index.html>`__ method, then you can add the codec to the registry. Custom Codec Example @@ -231,13 +231,13 @@ To learn more about the methods and classes mentioned in this section, see the following API documentation: - `KotlinSerializerCodec - <{+java-api+}/apidocs/bson-kotlinx/bson-kotlinx/org.bson.codecs.kotlinx/-kotlin-serializer-codec/index.html>`__ + <{+api-root+}/bson-kotlinx/bson-kotlinx/org.bson.codecs.kotlinx/-kotlin-serializer-codec/index.html>`__ - `KotlinSerializerCodec.create() - <{+java-api+}/apidocs/bson-kotlinx/bson-kotlinx/org.bson.codecs.kotlinx/-kotlin-serializer-codec/-companion/create.html>`__ + <{+api-root+}/bson-kotlinx/bson-kotlinx/org.bson.codecs.kotlinx/-kotlin-serializer-codec/-companion/create.html>`__ - `BsonConfiguration - <{+java-api+}/apidocs/bson-kotlinx/bson-kotlinx/org.bson.codecs.kotlinx/-bson-configuration/index.html>`__ + <{+api-root+}/bson-kotlinx/bson-kotlinx/org.bson.codecs.kotlinx/-bson-configuration/index.html>`__ .. _kotlin-sync-polymorphic: diff --git a/source/data-formats/time-series.txt b/source/data-formats/time-series.txt index b3a82bf8..09321d12 100644 --- a/source/data-formats/time-series.txt +++ b/source/data-formats/time-series.txt @@ -62,8 +62,8 @@ To create a time series collection, pass the following parameters to the - The name of the new collection to create -- A `CreateCollectionOptions <{+core-api+}/com/mongodb/client/model/CreateCollectionOptions.html>`__ - object with the `TimeSeriesOptions <{+core-api+}/com/mongodb/client/model/TimeSeriesOptions.html>`__ set +- A `CreateCollectionOptions <{+core-api+}/client/model/CreateCollectionOptions.html>`__ + object with the `TimeSeriesOptions <{+core-api+}/client/model/TimeSeriesOptions.html>`__ set using the ``timeSeriesOptions()`` method .. _kotlin-sync-time-series-create-example: @@ -174,7 +174,7 @@ API Documentation To learn more about the methods mentioned in this guide, see the following API documentation: -- `createCollection() <{+api+}/com.mongodb.kotlin.client/-mongo-database/create-collection.html>`__ -- `listCollections() <{+api+}/com.mongodb.kotlin.client/-mongo-database/list-collections.html>`__ -- `insertOne() <{+api+}/com.mongodb.kotlin.client/-mongo-collection/insert-one.html>`__ -- `insertMany() <{+api+}/com.mongodb.kotlin.client/-mongo-collection/insert-many.html>`__ \ No newline at end of file +- `createCollection() <{+driver-api+}/-mongo-database/create-collection.html>`__ +- `listCollections() <{+driver-api+}/-mongo-database/list-collections.html>`__ +- `insertOne() <{+driver-api+}/-mongo-collection/insert-one.html>`__ +- `insertMany() <{+driver-api+}/-mongo-collection/insert-many.html>`__ \ No newline at end of file diff --git a/source/indexes/atlas-search-index.txt b/source/indexes/atlas-search-index.txt index 23bd5260..98cb2af3 100644 --- a/source/indexes/atlas-search-index.txt +++ b/source/indexes/atlas-search-index.txt @@ -62,15 +62,15 @@ Create a Search Index --------------------- You can use the `createSearchIndex() -<{+api+}/com.mongodb.kotlin.client/-mongo-collection/create-search-index.html>`__ +<{+driver-api+}/-mongo-collection/create-search-index.html>`__ method to create a single Atlas Search index. You *cannot* use this method to create a Vector Search index. You can use the `createSearchIndexes() -<{+api+}/com.mongodb.kotlin.client/-mongo-collection/create-search-indexes.html>`__ +<{+driver-api+}/-mongo-collection/create-search-indexes.html>`__ method to create multiple Atlas Search or Vector Search indexes. You must create a `SearchIndexModel -<{+core-api+}/com/mongodb/client/model/SearchIndexModel.html>`__ +<{+core-api+}/client/model/SearchIndexModel.html>`__ instance for each index, then pass a list of ``SearchIndexModel`` instances to the ``createSearchIndexes()`` method. @@ -101,7 +101,7 @@ List Search Indexes ------------------- You can use the -`listSearchIndexes() <{+api+}/com.mongodb.kotlin.client/-mongo-collection/list-search-indexes.html>`__ +`listSearchIndexes() <{+driver-api+}/-mongo-collection/list-search-indexes.html>`__ method to return all Atlas Search indexes in a collection. The following code example shows how to print a list of the search indexes in @@ -119,7 +119,7 @@ Update a Search Index --------------------- You can use the -`updateSearchIndex() <{+api+}/com.mongodb.kotlin.client/-mongo-collection/update-search-index.html>`__ +`updateSearchIndex() <{+driver-api+}/-mongo-collection/update-search-index.html>`__ method to update an Atlas Search index. The following code shows how to update a search index: @@ -136,7 +136,7 @@ Delete a Search Index --------------------- You can use the -`dropSearchIndex() <{+api+}/com.mongodb.kotlin.client/-mongo-collection/drop-search-index.html>`__ +`dropSearchIndex() <{+driver-api+}/-mongo-collection/drop-search-index.html>`__ method to delete an Atlas Search index. The following code shows how to delete a search index from a collection: diff --git a/source/indexes/compound-index.txt b/source/indexes/compound-index.txt index 845c24fb..4259112b 100644 --- a/source/indexes/compound-index.txt +++ b/source/indexes/compound-index.txt @@ -93,6 +93,6 @@ API Documentation To learn more about any of the methods discussed in this guide, see the following API documentation: -- `find() <{+api+}/com.mongodb.kotlin.client/-mongo-collection/find.html>`__ -- `filter() <{+api+}/com.mongodb.kotlin.client/-find-iterable/filter.html>`__ -- `sort() <{+api+}/com.mongodb.kotlin.client/-find-iterable/sort.html>`__ \ No newline at end of file +- `find() <{+driver-api+}/-mongo-collection/find.html>`__ +- `filter() <{+driver-api+}/-find-iterable/filter.html>`__ +- `sort() <{+driver-api+}/-find-iterable/sort.html>`__ \ No newline at end of file diff --git a/source/indexes/single-field-index.txt b/source/indexes/single-field-index.txt index c36e0e5f..f89daa61 100644 --- a/source/indexes/single-field-index.txt +++ b/source/indexes/single-field-index.txt @@ -91,6 +91,6 @@ API Documentation To learn more about any of the methods discussed in this guide, see the following API documentation: -- `find() <{+api+}/com.mongodb.kotlin.client/-mongo-collection/find.html>`__ -- `filter() <{+api+}/com.mongodb.kotlin.client/-find-iterable/filter.html>`__ -- `sort() <{+api+}/com.mongodb.kotlin.client/-find-iterable/sort.html>`__ \ No newline at end of file +- `find() <{+driver-api+}/-mongo-collection/find.html>`__ +- `filter() <{+driver-api+}/-find-iterable/filter.html>`__ +- `sort() <{+driver-api+}/-find-iterable/sort.html>`__ \ No newline at end of file diff --git a/source/monitoring.txt b/source/monitoring.txt index 76cc0b8f..d400b1ff 100644 --- a/source/monitoring.txt +++ b/source/monitoring.txt @@ -57,7 +57,7 @@ The {+driver-short+} organizes the events it defines into three categories: The following sections show how to monitor each event category. For a full list of the events you can monitor, `see the Java event package -<{+core-api+}/com/mongodb/event/package-summary.html>`__. +<{+core-api+}/event/package-summary.html>`__. .. _command-events-kotlin: @@ -123,12 +123,12 @@ The following code implements these steps: For more information on the classes and methods mentioned in this section, see the following API documentation: -- `CommandListener <{+core-api+}/com/mongodb/event/CommandListener.html>`__ -- `MongoClientSettings <{+core-api+}/com/mongodb/MongoClientSettings.html>`__ -- `MongoClient <{+api+}/com.mongodb.kotlin.client/-mongo-client/index.html>`__ -- `CommandStartedEvent <{+core-api+}/com/mongodb/event/CommandStartedEvent.html>`__ -- `CommandSucceededEvent <{+core-api+}/com/mongodb/event/CommandSucceededEvent.html>`__ -- `CommandFailedEvent <{+core-api+}/com/mongodb/event/CommandFailedEvent.html>`__ +- `CommandListener <{+core-api+}/event/CommandListener.html>`__ +- `MongoClientSettings <{+core-api+}/MongoClientSettings.html>`__ +- `MongoClient <{+driver-api+}/-mongo-client/index.html>`__ +- `CommandStartedEvent <{+core-api+}/event/CommandStartedEvent.html>`__ +- `CommandSucceededEvent <{+core-api+}/event/CommandSucceededEvent.html>`__ +- `CommandFailedEvent <{+core-api+}/event/CommandFailedEvent.html>`__ Server Discovery and Monitoring Events ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -139,9 +139,9 @@ in the state of the MongoDB instance or cluster you have connected the driver to The driver defines nine SDAM events and provides the following listener interfaces, which listen for three SDAM events each: -- `ClusterListener <{+core-api+}/com/mongodb/event/ClusterListener.html>`__ : Listens for topology-related events -- `ServerListener <{+core-api+}/com/mongodb/event/ServerListener.html>`__ : Listens for events related to ``mongod`` or ``mongos`` processes -- `ServerMonitorListener <{+core-api+}/com/mongodb/event/ServerMonitorListener.html>`__ : Listens for heartbeat-related events +- `ClusterListener <{+core-api+}/event/ClusterListener.html>`__ : Listens for topology-related events +- `ServerListener <{+core-api+}/event/ServerListener.html>`__ : Listens for events related to ``mongod`` or ``mongos`` processes +- `ServerMonitorListener <{+core-api+}/event/ServerMonitorListener.html>`__ : Listens for heartbeat-related events To monitor a type of SDAM event, create a class that implements one of the three preceding interfaces and register an instance of that class with your @@ -178,12 +178,12 @@ The following code implements these steps: For more information on the classes and methods mentioned in this section, see the following API documentation: -- `ClusterListener <{+core-api+}/com/mongodb/event/ClusterListener.html>`__ -- `ServerListener <{+core-api+}/com/mongodb/event/ServerListener.html>`__ -- `ServerMonitorListener <{+core-api+}/com/mongodb/event/ServerMonitorListener.html>`__ -- `MongoClientSettings <{+core-api+}/com/mongodb/MongoClientSettings.html>`__ -- `MongoClient <{+api+}/com.mongodb.kotlin.client/-mongo-client/index.html>`__ -- `ClusterDescriptionChangedEvent <{+core-api+}/com/mongodb/event/ClusterDescriptionChangedEvent.html>`__ +- `ClusterListener <{+core-api+}/event/ClusterListener.html>`__ +- `ServerListener <{+core-api+}/event/ServerListener.html>`__ +- `ServerMonitorListener <{+core-api+}/event/ServerMonitorListener.html>`__ +- `MongoClientSettings <{+core-api+}/MongoClientSettings.html>`__ +- `MongoClient <{+driver-api+}/-mongo-client/index.html>`__ +- `ClusterDescriptionChangedEvent <{+core-api+}/event/ClusterDescriptionChangedEvent.html>`__ Connection Pool Events ~~~~~~~~~~~~~~~~~~~~~~ @@ -226,11 +226,11 @@ The following code implements these steps: For more information on the classes and methods mentioned in this section, see the following API documentation: -- `ConnectionPoolListener <{+core-api+}/com/mongodb/event/ConnectionPoolListener.html>`__ -- `MongoClientSettings <{+core-api+}/com/mongodb/MongoClientSettings.html>`__ -- `MongoClient <{+api+}/com.mongodb.kotlin.client/-mongo-client/index.html>`__ -- `ConnectionCheckedOutEvent <{+core-api+}/com/mongodb/event/ConnectionCheckedOutEvent.html>`__ -- `ConnectionCheckOutFailedEvent <{+core-api+}/com/mongodb/event/ConnectionCheckOutFailedEvent.html>`__ +- `ConnectionPoolListener <{+core-api+}/event/ConnectionPoolListener.html>`__ +- `MongoClientSettings <{+core-api+}/MongoClientSettings.html>`__ +- `MongoClient <{+driver-api+}/-mongo-client/index.html>`__ +- `ConnectionCheckedOutEvent <{+core-api+}/event/ConnectionCheckedOutEvent.html>`__ +- `ConnectionCheckOutFailedEvent <{+core-api+}/event/ConnectionCheckOutFailedEvent.html>`__ .. _monitoring-jmx: @@ -357,7 +357,7 @@ Oracle: For more information on the ``JMXConnectionPoolListener`` class, see the API documentation for -`JMXConnectionPoolListener <{+core-api+}/com/mongodb/management/JMXConnectionPoolListener.html>`__. +`JMXConnectionPoolListener <{+core-api+}/management/JMXConnectionPoolListener.html>`__. Include the Driver in Your Distributed Tracing System ----------------------------------------------------- diff --git a/source/read/change-streams.txt b/source/read/change-streams.txt index 3cd7fb59..7d293f91 100644 --- a/source/read/change-streams.txt +++ b/source/read/change-streams.txt @@ -181,7 +181,7 @@ of ``watch()``: milliseconds. For a complete list of methods you can use to configure the ``watch()`` method, see -the `ChangeStreamIterable <{+api+}/com.mongodb.kotlin.client/-change-stream-iterable/index.html>`__ +the `ChangeStreamIterable <{+driver-api+}/-change-stream-iterable/index.html>`__ API documentation. .. _kotlin-sync-change-stream-pre-post-image: @@ -263,7 +263,7 @@ API Documentation To learn more about any of the methods or types discussed in this guide, see the following API documentation: -- `MongoClient.watch() <{+api+}/com.mongodb.kotlin.client/-mongo-client/watch.html>`__ -- `MongoDatabase.watch() <{+api+}/com.mongodb.kotlin.client/-mongo-database/watch.html>`__ -- `MongoCollection.watch() <{+api+}/com.mongodb.kotlin.client/-mongo-collection/watch.html>`__ -- `ChangeStreamIterable <{+api+}/com.mongodb.kotlin.client/-change-stream-iterable/index.html>`__ \ No newline at end of file +- `MongoClient.watch() <{+driver-api+}/-mongo-client/watch.html>`__ +- `MongoDatabase.watch() <{+driver-api+}/-mongo-database/watch.html>`__ +- `MongoCollection.watch() <{+driver-api+}/-mongo-collection/watch.html>`__ +- `ChangeStreamIterable <{+driver-api+}/-change-stream-iterable/index.html>`__ \ No newline at end of file diff --git a/source/read/count.txt b/source/read/count.txt index 4f8365b1..190ae28e 100644 --- a/source/read/count.txt +++ b/source/read/count.txt @@ -201,5 +201,5 @@ API Documentation To learn more about any of the methods or types discussed in this guide, see the following API documentation: -- `countDocuments() <{+api+}/com.mongodb.kotlin.client/-mongo-collection/count-documents.html>`__ -- `estimatedDocumentCount() <{+api+}/com.mongodb.kotlin.client/-mongo-collection/estimated-document-count.html>`__ \ No newline at end of file +- `countDocuments() <{+driver-api+}/-mongo-collection/count-documents.html>`__ +- `estimatedDocumentCount() <{+driver-api+}/-mongo-collection/estimated-document-count.html>`__ \ No newline at end of file diff --git a/source/read/cursors.txt b/source/read/cursors.txt index c373a865..8b3bbb53 100644 --- a/source/read/cursors.txt +++ b/source/read/cursors.txt @@ -167,7 +167,7 @@ API Documentation To learn more about any of the methods or types discussed in this guide, see the following API documentation: -- `find() <{+api+}/mongodb-driver-kotlin-sync/com.mongodb.kotlin.client/-mongo-collection/find.html>`__ -- `FindIterable <{+api+}/mongodb-driver-kotlin-sync/com.mongodb.kotlin.client/-find-iterable/index.html>`__ -- `MongoCursor <{+api+}/mongodb-driver-kotlin-sync/com.mongodb.kotlin.client/-mongo-cursor/index.html>`__ -- `CursorType <{+core-api+}/com/mongodb/CursorType.html>`__ \ No newline at end of file +- `find() <{+driver-api+}/-mongo-collection/find.html>`__ +- `FindIterable <{+driver-api+}/-find-iterable/index.html>`__ +- `MongoCursor <{+driver-api+}/-mongo-cursor/index.html>`__ +- `CursorType <{+core-api+}/CursorType.html>`__ \ No newline at end of file diff --git a/source/read/distinct.txt b/source/read/distinct.txt index 0781bd19..5dc1c0c4 100644 --- a/source/read/distinct.txt +++ b/source/read/distinct.txt @@ -141,7 +141,7 @@ The following table describes some methods you can use to customize the - | Sets the maximum amount of time to allow the operation to run, in milliseconds. For a complete list of methods you can use to modify the ``distinct()`` method, see -the `DistinctIterable <{+api+}/mongodb-driver-kotlin-sync/com.mongodb.kotlin.client/-distinct-iterable/index.html>`__ API documentation. +the `DistinctIterable <{+driver-api+}/-distinct-iterable/index.html>`__ API documentation. The following example retrieves the distinct values of the ``name`` field for all documents that have a ``borough`` field value of ``"Bronx"`` and a @@ -178,5 +178,5 @@ API Documentation To learn more about any of the methods or types discussed in this guide, see the following API documentation: -- `distinct() <{+api+}/mongodb-driver-kotlin-sync/com.mongodb.kotlin.client/-mongo-collection/distinct.html>`__ -- `DistinctIterable <{+api+}/mongodb-driver-kotlin-sync/com.mongodb.kotlin.client/-distinct-iterable/index.html>`__ \ No newline at end of file +- `distinct() <{+driver-api+}/-mongo-collection/distinct.html>`__ +- `DistinctIterable <{+driver-api+}/-distinct-iterable/index.html>`__ \ No newline at end of file diff --git a/source/read/project.txt b/source/read/project.txt index 40f4abfc..d25dd90f 100644 --- a/source/read/project.txt +++ b/source/read/project.txt @@ -123,5 +123,5 @@ API Documentation To learn more about any of the methods or types discussed in this guide, see the following API Documentation: -- `find() <{+api+}/com.mongodb.kotlin.client/-mongo-collection/find.html>`__ -- `projection() <{+api+}/com.mongodb.kotlin.client/-find-iterable/projection.html>`__ \ No newline at end of file +- `find() <{+driver-api+}/-mongo-collection/find.html>`__ +- `projection() <{+driver-api+}/-find-iterable/projection.html>`__ \ No newline at end of file diff --git a/source/read/retrieve.txt b/source/read/retrieve.txt index 458eba8d..f97b3307 100644 --- a/source/read/retrieve.txt +++ b/source/read/retrieve.txt @@ -149,7 +149,7 @@ number of documents returned by the query to ``10`` and set a maximum execution :copyable: :dedent: -For a full list of methods that modify the behavior of ``find()``, see the `API documentation <{+api+}/com.mongodb.kotlin.client/-find-iterable/index.html>`__ +For a full list of methods that modify the behavior of ``find()``, see the `API documentation <{+driver-api+}/-find-iterable/index.html>`__ for the ``FindIterable`` class. Additional Information @@ -166,6 +166,6 @@ API Documentation To learn more about any of the methods or types discussed in this guide, see the following API documentation: -- `find() <{+api+}/com.mongodb.kotlin.client/-mongo-collection/find.html>`__ +- `find() <{+driver-api+}/-mongo-collection/find.html>`__ - `FindIterable - <{+api+}/com.mongodb.kotlin.client/-find-iterable/index.html>`__ + <{+driver-api+}/-find-iterable/index.html>`__ diff --git a/source/read/specify-a-query.txt b/source/read/specify-a-query.txt index 02464f5d..6ff2fcdd 100644 --- a/source/read/specify-a-query.txt +++ b/source/read/specify-a-query.txt @@ -263,4 +263,4 @@ API Documentation To learn more about any of the methods or types discussed in this guide, see the following API documentation: -- `find() <{+api+}/com.mongodb.kotlin.client/-mongo-collection/find.html>`__ +- `find() <{+driver-api+}/-mongo-collection/find.html>`__ diff --git a/source/read/specify-documents-to-return.txt b/source/read/specify-documents-to-return.txt index 3f2a5043..49ad4bc3 100644 --- a/source/read/specify-documents-to-return.txt +++ b/source/read/specify-documents-to-return.txt @@ -192,7 +192,7 @@ API Documentation To learn more about any of the methods or types discussed in this guide, see the following API documentation: -- `find() <{+api+}/com.mongodb.kotlin.client/-mongo-collection/find.html>`__ -- `limit() <{+api+}/com.mongodb.kotlin.client/-find-iterable/limit.html>`__ -- `sort() <{+api+}/com.mongodb.kotlin.client/-find-iterable/sort.html>`__ -- `skip() <{+api+}/com.mongodb.kotlin.client/-find-iterable/skip.html>`__ +- `find() <{+driver-api+}/-mongo-collection/find.html>`__ +- `limit() <{+driver-api+}/-find-iterable/limit.html>`__ +- `sort() <{+driver-api+}/-find-iterable/sort.html>`__ +- `skip() <{+driver-api+}/-find-iterable/skip.html>`__ diff --git a/source/run-command.txt b/source/run-command.txt index 8a8beae5..cae850da 100644 --- a/source/run-command.txt +++ b/source/run-command.txt @@ -155,7 +155,7 @@ Additional Information For more information about the concepts in this guide, see the following documentation: -- `Kotlin Sync API runCommand() <{+api+}/com.mongodb.kotlin.client/-mongo-database/run-command.html>`__ +- `Kotlin Sync API runCommand() <{+driver-api+}/-mongo-database/run-command.html>`__ - :manual:`Database Commands ` - :manual:`explain Command ` - :manual:`hello Command ` diff --git a/source/security/authentication.txt b/source/security/authentication.txt index cfff1983..8db7a340 100644 --- a/source/security/authentication.txt +++ b/source/security/authentication.txt @@ -147,7 +147,7 @@ mechanism: To specify the default authentication mechanism by using the ``MongoCredential`` class, use the - `createScramSha256Credential() <{+core-api+}/com/mongodb/MongoCredential.html#createScramSha256Credential(java.lang.String,java.lang.String,char[])>`__ + `createScramSha256Credential() <{+core-api+}/MongoCredential.html#createScramSha256Credential(java.lang.String,java.lang.String,char[])>`__ method. Your code to instantiate a ``MongoClient`` should resemble the following: .. literalinclude:: /includes/security/authentication.kt @@ -206,7 +206,7 @@ mechanism: To specify the default authentication mechanism by using the ``MongoCredential`` class, use the - `createScramSha1Credential() <{+core-api+}/com/mongodb/MongoCredential.html#createScramSha1Credential(java.lang.String,java.lang.String,char[])>`__ + `createScramSha1Credential() <{+core-api+}/MongoCredential.html#createScramSha1Credential(java.lang.String,java.lang.String,char[])>`__ method. Your code to instantiate a ``MongoClient`` should resemble the following: .. literalinclude:: /includes/security/authentication.kt @@ -261,11 +261,11 @@ mechanism: To specify the ``X.509`` authentication mechanism by using the ``MongoCredential`` class, use the - `createMongoX509Credential() <{+core-api+}/com/mongodb/MongoCredential.html#createMongoX509Credential(java.lang.String)>`__ + `createMongoX509Credential() <{+core-api+}/MongoCredential.html#createMongoX509Credential(java.lang.String)>`__ method. Also, enable TLS by calling the - `applyToSslSettings() <{+core-api+}/com/mongodb/MongoClientSettings.Builder.html#applyToSslSettings(com.mongodb.Block)>`__ + `applyToSslSettings() <{+core-api+}/MongoClientSettings.Builder.html#applyToSslSettings(com.mongodb.Block)>`__ method and setting the ``enabled`` property to ``true`` in the - `SslSettings.Builder <{+core-api+}/com/mongodb/connection/SslSettings.Builder.html>`__ + `SslSettings.Builder <{+core-api+}/connection/SslSettings.Builder.html>`__ block. Your code to instantiate a ``MongoClient`` should resemble the following: .. literalinclude:: /includes/security/authentication.kt @@ -477,7 +477,7 @@ Specify Your Credentials in a MongoCredential You can supply your AWS IAM credentials to a ``MongoClient`` by using a ``MongoCredential`` instance. To construct the ``MongoCredential`` instance for ``MONGODB-AWS`` authentication, call the -`createAwsCredential() <{+core-api+}/com/mongodb/MongoCredential.html#createAwsCredential(java.lang.String,char%5B%5D)>`__ +`createAwsCredential() <{+core-api+}/MongoCredential.html#createAwsCredential(java.lang.String,char%5B%5D)>`__ factory method. You can supply only programmatic access keys to the @@ -504,7 +504,7 @@ in the following example: :emphasize-lines: 1, 9 If you need to specify an AWS session token, pass it to the -`withMechanismProperty() <{+core-api+}/com/mongodb/MongoCredential.html#withMechanismProperty(java.lang.String,T)>`__ +`withMechanismProperty() <{+core-api+}/MongoCredential.html#withMechanismProperty(java.lang.String,T)>`__ method, as shown in the following example: .. literalinclude:: /includes/security/authentication.kt @@ -525,7 +525,7 @@ that returns new credentials, as shown in the following example: :emphasize-lines: 4-6, 9 If you must provide AWS IAM credentials in a connection string, you can add -it to your ``MongoClientSettings`` object by calling the `applyConnectionString() <{+core-api+}/com/mongodb/MongoClientSettings.Builder.html#applyConnectionString(com.mongodb.ConnectionString)>`__ +it to your ``MongoClientSettings`` object by calling the `applyConnectionString() <{+core-api+}/MongoClientSettings.Builder.html#applyConnectionString(com.mongodb.ConnectionString)>`__ method: .. literalinclude:: /includes/security/authentication.kt diff --git a/source/security/enterprise-auth.txt b/source/security/enterprise-auth.txt index b47fb495..e6f58a03 100644 --- a/source/security/enterprise-auth.txt +++ b/source/security/enterprise-auth.txt @@ -157,11 +157,11 @@ You may need to specify one or more of the following additional instance and pass the property name and value as parameters. Use the property name constants defined in the ``MongoCredential`` class: - - `SERVICE_NAME_KEY <{+core-api+}/com/mongodb/MongoCredential.html#SERVICE_NAME_KEY>`__ - - `CANONICALIZE_HOST_NAME_KEY <{+core-api+}/com/mongodb/MongoCredential.html#CANONICALIZE_HOST_NAME_KEY>`__ - - `JAVA_SUBJECT_KEY <{+core-api+}/com/mongodb/MongoCredential.html#JAVA_SUBJECT_KEY>`__ - - `JAVA_SASL_CLIENT_PROPERTIES_KEY <{+core-api+}/com/mongodb/MongoCredential.html#JAVA_SASL_CLIENT_PROPERTIES_KEY>`__ - - `JAVA_SUBJECT_PROVIDER_KEY <{+core-api+}/com/mongodb/MongoCredential.html#JAVA_SUBJECT_PROVIDER_KEY>`__ + - `SERVICE_NAME_KEY <{+core-api+}/MongoCredential.html#SERVICE_NAME_KEY>`__ + - `CANONICALIZE_HOST_NAME_KEY <{+core-api+}/MongoCredential.html#CANONICALIZE_HOST_NAME_KEY>`__ + - `JAVA_SUBJECT_KEY <{+core-api+}/MongoCredential.html#JAVA_SUBJECT_KEY>`__ + - `JAVA_SASL_CLIENT_PROPERTIES_KEY <{+core-api+}/MongoCredential.html#JAVA_SASL_CLIENT_PROPERTIES_KEY>`__ + - `JAVA_SUBJECT_PROVIDER_KEY <{+core-api+}/MongoCredential.html#JAVA_SUBJECT_PROVIDER_KEY>`__ Select the **SERVICE_NAME_KEY** or **JAVA_SUBJECT_KEY** tab to see sample code to instantiate a ``MongoCredential`` that uses GSSAPI and @@ -499,7 +499,7 @@ API Documentation To learn more about the classes and methods for authenticating your application with {+driver-short+}, see the following API documentation: -- `MongoClient.create() <{+api+}/com.mongodb.kotlin.client/-mongo-client/-factory/index.html>`__ -- `MongoClient <{+api+}/com.mongodb.kotlin.client/-mongo-client/index.html>`__ -- `MongoClientSettings.Builder <{+java-api+}/apidocs/mongodb-driver-core/com/mongodb/MongoClientSettings.Builder.html>`__ -- `MongoCredential <{+java-api+}/apidocs/mongodb-driver-core/com/mongodb/MongoCredential.html>`__ +- `MongoClient.create() <{+driver-api+}/-mongo-client/-factory/index.html>`__ +- `MongoClient <{+driver-api+}/-mongo-client/index.html>`__ +- `MongoClientSettings.Builder <{+api-root+}/mongodb-driver-core/com/mongodb/MongoClientSettings.Builder.html>`__ +- `MongoCredential <{+api-root+}/mongodb-driver-core/com/mongodb/MongoCredential.html>`__ diff --git a/source/whats-new.txt b/source/whats-new.txt index 81d46655..63fb0a15 100644 --- a/source/whats-new.txt +++ b/source/whats-new.txt @@ -44,7 +44,7 @@ and features: .. replacement:: atlas-query-operators - the `SearchOperator <{+core-api+}/com/mongodb/client/model/search/SearchOperator.html>`__ + the `SearchOperator <{+core-api+}/client/model/search/SearchOperator.html>`__ interface API documentation .. _kotlin-sync-version-5.3: @@ -60,7 +60,7 @@ improvements, and fixes: .. replacement:: vector-type-example-link To learn about this type, see the - `BinaryVector <{+java-api+}/apidocs/bson/org/bson/BinaryVector.html>`__ + `BinaryVector <{+api-root+}/bson/org/bson/BinaryVector.html>`__ API documentation. .. replacement:: update-replace-example-link @@ -72,7 +72,7 @@ improvements, and fixes: - Support for using builders class methods directly with data class properties. To learn more, see the :ref:`kotlin-sync-builders-data-classes` guide. This functionality is supported by the `{+driver-short+} - Extensions package <{+java-api+}/apidocs/mongodb-driver-kotlin-extensions/index.html>`__ + Extensions package <{+api-root+}/mongodb-driver-kotlin-extensions/index.html>`__ published with this release. - Implements a *client* bulk write API that allows you to perform write @@ -99,7 +99,7 @@ improvements, and fixes: .. replacement:: csot-link the `MongoClientSettings.Builder.timeout() - <{+core-api+}/com/mongodb/MongoClientSettings.Builder.html#timeout(long,java.util.concurrent.TimeUnit)>`__ + <{+core-api+}/MongoClientSettings.Builder.html#timeout(long,java.util.concurrent.TimeUnit)>`__ API documentation .. replacement:: avs-index-link diff --git a/source/work-with-indexes.txt b/source/work-with-indexes.txt index ee4a2863..1b4d5e2e 100644 --- a/source/work-with-indexes.txt +++ b/source/work-with-indexes.txt @@ -118,7 +118,7 @@ API Documentation To learn more about any of the methods or types discussed in this guide, see the following API documentation: -- `createIndex() <{+api+}/com.mongodb.kotlin.client/-mongo-collection/create-index.html>`__ -- `createIndexes() <{+api+}/com.mongodb.kotlin.client/-mongo-collection/create-indexes.html>`__ -- `dropIndex() <{+api+}/com.mongodb.kotlin.client/-mongo-collection/drop-index.html>`__ -- `dropIndexes() <{+api+}/com.mongodb.kotlin.client/-mongo-collection/drop-indexes.html>`__ +- `createIndex() <{+driver-api+}/-mongo-collection/create-index.html>`__ +- `createIndexes() <{+driver-api+}/-mongo-collection/create-indexes.html>`__ +- `dropIndex() <{+driver-api+}/-mongo-collection/drop-index.html>`__ +- `dropIndexes() <{+driver-api+}/-mongo-collection/drop-indexes.html>`__ diff --git a/source/write/bulk-write.txt b/source/write/bulk-write.txt index 9b8f7f18..83f5c2e3 100644 --- a/source/write/bulk-write.txt +++ b/source/write/bulk-write.txt @@ -504,7 +504,7 @@ in the ``movies`` collection. If multiple documents match the query filter specified in a ``ClientNamespacedUpdateOneModel`` instance, the operation updates the first result. You can specify a sort order in a `ClientUpdateOneOptions -<{+core-api+}/com/mongodb/client/model/bulk/ClientUpdateOneOptions.html>`__ +<{+core-api+}/client/model/bulk/ClientUpdateOneOptions.html>`__ instance to apply an order to matched documents before the server performs the update operation, as shown in the following code: @@ -538,7 +538,7 @@ is also replaced with a new document. If multiple documents match the query filter specified in a ``ClientNamespacedReplaceOneModel`` instance, the operation replaces the first result. You can specify a sort order in a `ClientReplaceOneOptions -<{+core-api+}/com/mongodb/client/model/bulk/ClientReplaceOneOptions.html>`__ +<{+core-api+}/client/model/bulk/ClientReplaceOneOptions.html>`__ instance to apply an order to matched documents before the driver performs the replace operation, as shown in the following code: @@ -635,22 +635,22 @@ guide, see the following API Documentation: - Collection Bulk Write - - `bulkWrite() <{+api+}/com.mongodb.kotlin.client/-mongo-collection/bulk-write.html>`__ - - `InsertOneModel <{+core-api+}/com/mongodb/client/model/InsertOneModel.html>`__ - - `UpdateOneModel <{+core-api+}/com/mongodb/client/model/UpdateOneModel.html>`__ - - `UpdateManyModel <{+core-api+}/com/mongodb/client/model/UpdateManyModel.html>`__ - - `ReplaceOneModel <{+core-api+}/com/mongodb/client/model/ReplaceOneModel.html>`__ - - `DeleteOneModel <{+core-api+}/com/mongodb/client/model/DeleteOneModel.html>`__ - - `DeleteManyModel <{+core-api+}/com/mongodb/client/model/DeleteManyModel.html>`__ - - `BulkWriteResult <{+core-api+}/com/mongodb/bulk/BulkWriteResult.html>`__ - - `BulkWriteError <{+core-api+}/com/mongodb/bulk/BulkWriteError.html>`__ - - `MongoBulkWriteException <{+core-api+}/com/mongodb/MongoBulkWriteException.html>`__ + - `bulkWrite() <{+driver-api+}/-mongo-collection/bulk-write.html>`__ + - `InsertOneModel <{+core-api+}/client/model/InsertOneModel.html>`__ + - `UpdateOneModel <{+core-api+}/client/model/UpdateOneModel.html>`__ + - `UpdateManyModel <{+core-api+}/client/model/UpdateManyModel.html>`__ + - `ReplaceOneModel <{+core-api+}/client/model/ReplaceOneModel.html>`__ + - `DeleteOneModel <{+core-api+}/client/model/DeleteOneModel.html>`__ + - `DeleteManyModel <{+core-api+}/client/model/DeleteManyModel.html>`__ + - `BulkWriteResult <{+core-api+}/bulk/BulkWriteResult.html>`__ + - `BulkWriteError <{+core-api+}/bulk/BulkWriteError.html>`__ + - `MongoBulkWriteException <{+core-api+}/MongoBulkWriteException.html>`__ - Client Bulk Write - - `bulkWrite() <{+api+}/com.mongodb.kotlin.client/-mongo-cluster/bulk-write.html>`__ + - `bulkWrite() <{+driver-api+}/-mongo-cluster/bulk-write.html>`__ - `ClientNamespacedWriteModel - <{+core-api+}/com/mongodb/client/model/bulk/ClientNamespacedWriteModel.html>`__ - - `MongoNamespace <{+core-api+}/com/mongodb/MongoNamespace.html>`__ - - `ClientBulkWriteOptions <{+core-api+}/com/mongodb/client/model/bulk/ClientBulkWriteOptions.html>`__ - - `ClientBulkWriteResult <{+core-api+}/com/mongodb/client/model/bulk/ClientBulkWriteResult.html>`__ + <{+core-api+}/client/model/bulk/ClientNamespacedWriteModel.html>`__ + - `MongoNamespace <{+core-api+}/MongoNamespace.html>`__ + - `ClientBulkWriteOptions <{+core-api+}/client/model/bulk/ClientBulkWriteOptions.html>`__ + - `ClientBulkWriteResult <{+core-api+}/client/model/bulk/ClientBulkWriteResult.html>`__ diff --git a/source/write/delete.txt b/source/write/delete.txt index 4225f1f7..1e0e25b0 100644 --- a/source/write/delete.txt +++ b/source/write/delete.txt @@ -190,9 +190,9 @@ API Documentation To learn more about any of the methods or types discussed in this guide, see the following API documentation: -- `deleteOne() <{+api+}/com.mongodb.kotlin.client/-mongo-collection/delete-one.html>`__ -- `deleteMany() <{+api+}/com.mongodb.kotlin.client/-mongo-collection/delete-many.html>`__ -- `DeleteResult <{+core-api+}/com/mongodb/client/result/DeleteResult.html>`__ +- `deleteOne() <{+driver-api+}/-mongo-collection/delete-one.html>`__ +- `deleteMany() <{+driver-api+}/-mongo-collection/delete-many.html>`__ +- `DeleteResult <{+core-api+}/client/result/DeleteResult.html>`__ .. .. _kotlin-sync-delete-instruqt-lab: diff --git a/source/write/insert.txt b/source/write/insert.txt index d08a9b87..ae35f6e0 100644 --- a/source/write/insert.txt +++ b/source/write/insert.txt @@ -240,12 +240,12 @@ API Documentation To learn more about any of the methods or types discussed in this guide, see the following API documentation: -- `insertOne() <{+api+}/com.mongodb.kotlin.client/-mongo-collection/insert-one.html>`__ -- `insertMany() <{+api+}/com.mongodb.kotlin.client/-mongo-collection/insert-many.html>`__ -- `InsertOneOptions <{+core-api+}/com/mongodb/client/model/InsertOneOptions.html>`__ -- `InsertManyOptions <{+core-api+}/com/mongodb/client/model/InsertManyOptions.html>`__ -- `InsertOneResult <{+core-api+}/com/mongodb/client/result/InsertOneResult.html>`__ -- `InsertManyResult <{+core-api+}/com/mongodb/client/result/InsertManyResult.html>`__ +- `insertOne() <{+driver-api+}/-mongo-collection/insert-one.html>`__ +- `insertMany() <{+driver-api+}/-mongo-collection/insert-many.html>`__ +- `InsertOneOptions <{+core-api+}/client/model/InsertOneOptions.html>`__ +- `InsertManyOptions <{+core-api+}/client/model/InsertManyOptions.html>`__ +- `InsertOneResult <{+core-api+}/client/result/InsertOneResult.html>`__ +- `InsertManyResult <{+core-api+}/client/result/InsertManyResult.html>`__ .. .. instruqt:: .. :title: insertOne() Lesson diff --git a/source/write/replace.txt b/source/write/replace.txt index be189645..0f11ffbb 100644 --- a/source/write/replace.txt +++ b/source/write/replace.txt @@ -201,5 +201,5 @@ API Documentation To learn more about any of the methods or types discussed in this guide, see the following API documentation: -- `replaceOne() <{+api+}/mongodb-driver-kotlin-sync/com.mongodb.kotlin.client/-mongo-collection/replace-one.html>`__ -- `UpdateResult <{+core-api+}/com/mongodb/client/result/UpdateResult.html>`__ +- `replaceOne() <{+driver-api+}/-mongo-collection/replace-one.html>`__ +- `UpdateResult <{+core-api+}/client/result/UpdateResult.html>`__ diff --git a/source/write/transactions.txt b/source/write/transactions.txt index 9e373fa4..393386e4 100644 --- a/source/write/transactions.txt +++ b/source/write/transactions.txt @@ -168,8 +168,8 @@ API Documentation To learn more about any of the types or methods discussed in this guide, see the following API documentation: -- `ClientSession <{+api+}/com.mongodb.kotlin.client/-client-session/index.html>`_ -- `abortTransaction() <{+api+}/com.mongodb.kotlin.client/-client-session/abort-transaction.html>`_ -- `commitTransaction() <{+api+}/com.mongodb.kotlin.client/-client-session/commit-transaction.html>`_ -- `startTransaction() <{+api+}/com.mongodb.kotlin.client/-client-session/start-transaction.html>`_ -- `withTransaction() <{+api+}/com.mongodb.kotlin.client/-client-session/with-transaction.html>`_ +- `ClientSession <{+driver-api+}/-client-session/index.html>`_ +- `abortTransaction() <{+driver-api+}/-client-session/abort-transaction.html>`_ +- `commitTransaction() <{+driver-api+}/-client-session/commit-transaction.html>`_ +- `startTransaction() <{+driver-api+}/-client-session/start-transaction.html>`_ +- `withTransaction() <{+driver-api+}/-client-session/with-transaction.html>`_ diff --git a/source/write/update.txt b/source/write/update.txt index 2f7a628f..4ab6dc7a 100644 --- a/source/write/update.txt +++ b/source/write/update.txt @@ -225,7 +225,7 @@ API Documentation To learn more about any of the methods or types discussed in this guide, see the following API documentation: -- `updateOne() <{+api+}/com.mongodb.kotlin.client/-mongo-collection/update-one.html>`__ -- `updateMany() <{+api+}/com.mongodb.kotlin.client/-mongo-collection/update-many.html>`__ -- `UpdateOptions <{+core-api+}/com/mongodb/client/model/UpdateOptions.html>`__ -- `UpdateResult <{+core-api+}/com/mongodb/client/result/UpdateResult.html>`__ +- `updateOne() <{+driver-api+}/-mongo-collection/update-one.html>`__ +- `updateMany() <{+driver-api+}/-mongo-collection/update-many.html>`__ +- `UpdateOptions <{+core-api+}/client/model/UpdateOptions.html>`__ +- `UpdateResult <{+core-api+}/client/result/UpdateResult.html>`__ From 7fad4610f6df05453d7b86537bf44c6e7d162abc Mon Sep 17 00:00:00 2001 From: Mike Woofter <108414937+mongoKart@users.noreply.github.com> Date: Thu, 27 Mar 2025 10:59:32 -0500 Subject: [PATCH 2/4] rr feedback + forgot to commit --- source/api.txt | 2 +- source/connect/connection-options.txt | 12 ++++++------ source/security/enterprise-auth.txt | 4 ++-- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/source/api.txt b/source/api.txt index a54a7e13..9cc1d409 100644 --- a/source/api.txt +++ b/source/api.txt @@ -22,5 +22,5 @@ API Documentation <{+api-root+}/mongodb-driver-kotlin-extensions/index.html>`__ - classes that extend the core builder classes to support :ref:`data classes `. -- `Driver Core <{+core-api+}/index.html>`__ - classes that +- `Driver Core <{+api-root+}/index.html>`__ - classes that contain essential driver functionality. diff --git a/source/connect/connection-options.txt b/source/connect/connection-options.txt index 0b54f269..4b132c52 100644 --- a/source/connect/connection-options.txt +++ b/source/connect/connection-options.txt @@ -341,9 +341,9 @@ API Documentation To learn more about the classes and methods mentioned in this guide, see the following API documentation: -- `MongoClientSettings <{+api-root+}/mongodb-driver-core/com/mongodb/MongoClientSettings.html>`__ -- `MongoClientSettings.Builder <{+api-root+}/mongodb-driver-core/com/mongodb/MongoClientSettings.Builder.html>`__ -- `ConnectionString <{+api-root+}/mongodb-driver-core/com/mongodb/ConnectionString.html>`__ -- `SocketSettings <{+api-root+}/mongodb-driver-core/com/mongodb/connection/SocketSettings.html>`__ -- `ClusterSettings <{+api-root+}/mongodb-driver-core/com/mongodb/connection/ClusterSettings.html>`__ -- `MongoCredential <{+api-root+}/mongodb-driver-core/com/mongodb/MongoCredential.html>`__ +- `MongoClientSettings <{+core-api+}/MongoClientSettings.html>`__ +- `MongoClientSettings.Builder <{+core-api+}/MongoClientSettings.Builder.html>`__ +- `ConnectionString <{+core-api+}/ConnectionString.html>`__ +- `SocketSettings <{+core-api+}/connection/SocketSettings.html>`__ +- `ClusterSettings <{+core-api+}/connection/ClusterSettings.html>`__ +- `MongoCredential <{+core-api+}/MongoCredential.html>`__ diff --git a/source/security/enterprise-auth.txt b/source/security/enterprise-auth.txt index e6f58a03..ecc0d042 100644 --- a/source/security/enterprise-auth.txt +++ b/source/security/enterprise-auth.txt @@ -501,5 +501,5 @@ with {+driver-short+}, see the following API documentation: - `MongoClient.create() <{+driver-api+}/-mongo-client/-factory/index.html>`__ - `MongoClient <{+driver-api+}/-mongo-client/index.html>`__ -- `MongoClientSettings.Builder <{+api-root+}/mongodb-driver-core/com/mongodb/MongoClientSettings.Builder.html>`__ -- `MongoCredential <{+api-root+}/mongodb-driver-core/com/mongodb/MongoCredential.html>`__ +- `MongoClientSettings.Builder <{+core-api+}/MongoClientSettings.Builder.html>`__ +- `MongoCredential <{+core-api+}/MongoCredential.html>`__ From b9d55e1e190f751de11f6ce2a3b2d2562cd664a2 Mon Sep 17 00:00:00 2001 From: Mike Woofter <108414937+mongoKart@users.noreply.github.com> Date: Thu, 27 Mar 2025 11:07:14 -0500 Subject: [PATCH 3/4] fixes --- source/api.txt | 2 +- source/builders/builders-data-classes.txt | 2 +- source/connect/mongoclient.txt | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/source/api.txt b/source/api.txt index 9cc1d409..1014b85e 100644 --- a/source/api.txt +++ b/source/api.txt @@ -11,7 +11,7 @@ API Documentation {+language+} Sync Driver <{+api-root+}/mongodb-driver-kotlin-sync/index.html> BSON kotlinx.serialization <{+api-root+}/bson-kotlinx/index.html> {+language+} Driver Extensions <{+api-root+}/mongodb-driver-kotlin-extensions/index.html> - Driver Core <{+core-api+}/index.html> + Driver Core <{+api-root+}/index.html> - `{+language+} Sync Driver <{+api-root+}/mongodb-driver-kotlin-sync/index.html>`__ - classes for the current synchronous driver API. diff --git a/source/builders/builders-data-classes.txt b/source/builders/builders-data-classes.txt index 48af645a..5f7474cf 100644 --- a/source/builders/builders-data-classes.txt +++ b/source/builders/builders-data-classes.txt @@ -259,4 +259,4 @@ API Documentation ----------------- - `{+driver-short+} Extensions - <{+core-api+}/apidocs/mongodb-driver-kotlin-extensions/index.html>`__ + <{+api-root+}/mongodb-driver-kotlin-extensions/index.html>`__ diff --git a/source/connect/mongoclient.txt b/source/connect/mongoclient.txt index e761ae02..cc271cf6 100644 --- a/source/connect/mongoclient.txt +++ b/source/connect/mongoclient.txt @@ -127,4 +127,4 @@ For more information about creating a ``MongoClient`` object with the {+driver-short+}, see the following API documentation: - `MongoClient <{+driver-api+}/-mongo-client/index.html>`__ -- `MongoClientSettings <{+core-api+}com/mongodb/MongoClientSettings.html>`__ +- `MongoClientSettings <{+core-api+}/MongoClientSettings.html>`__ From 8f52028dc9a5f1ef27d88a9a31b0790ba658c684 Mon Sep 17 00:00:00 2001 From: Mike Woofter <108414937+mongoKart@users.noreply.github.com> Date: Thu, 27 Mar 2025 11:15:07 -0500 Subject: [PATCH 4/4] fix --- source/api.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/api.txt b/source/api.txt index 1014b85e..afced3bb 100644 --- a/source/api.txt +++ b/source/api.txt @@ -11,7 +11,7 @@ API Documentation {+language+} Sync Driver <{+api-root+}/mongodb-driver-kotlin-sync/index.html> BSON kotlinx.serialization <{+api-root+}/bson-kotlinx/index.html> {+language+} Driver Extensions <{+api-root+}/mongodb-driver-kotlin-extensions/index.html> - Driver Core <{+api-root+}/index.html> + Driver Core <{+api-root+}/mongodb-driver-core/index.html> - `{+language+} Sync Driver <{+api-root+}/mongodb-driver-kotlin-sync/index.html>`__ - classes for the current synchronous driver API. @@ -22,5 +22,5 @@ API Documentation <{+api-root+}/mongodb-driver-kotlin-extensions/index.html>`__ - classes that extend the core builder classes to support :ref:`data classes `. -- `Driver Core <{+api-root+}/index.html>`__ - classes that +- `Driver Core <{+api-root+}/mongodb-driver-core/index.html>`__ - classes that contain essential driver functionality.