diff --git a/source/agg-exp-ops.txt b/source/agg-exp-ops.txt index ed87ef0d..d47a4cc9 100644 --- a/source/agg-exp-ops.txt +++ b/source/agg-exp-ops.txt @@ -111,8 +111,7 @@ how to include your expression in common aggregates builder methods: - ``project(fields(computed("", )))`` - ``group()`` -.. TODO To learn more about these methods, see the -.. :ref:`kotlin-sync-aggregation`. +To learn more about these methods, see the :ref:`kotlin-sync-aggregation` guide. Constructor Methods ------------------- @@ -208,7 +207,8 @@ pipeline to the ``aggregate()`` method of ``MongoCollection``. aggregation, you must define the entire expression using the BSON ``Document`` type. -.. TODO add to note To learn more about the ``Document`` type, see :ref:``. +.. TODO Add to note once Kotlin Sync Document ata format page is written: +.. To learn more about the ``Document`` type, see the :ref:`` guide. Arithmetic Operations ~~~~~~~~~~~~~~~~~~~~~ diff --git a/source/compatibility.txt b/source/compatibility.txt index 02dac3cf..c931f398 100644 --- a/source/compatibility.txt +++ b/source/compatibility.txt @@ -27,7 +27,7 @@ The first column lists the driver version. .. sharedinclude:: dbx/lifecycle-schedule-callout.rst -.. include:: /includes/mongodb-compatibility-table-kotlin-sync.rst +.. sharedinclude:: dbx/mongodb-compatibility-table-kotlin.rst The driver does not support older versions of MongoDB. @@ -37,7 +37,7 @@ For more information on how to read the compatibility table, see our guide on Language Compatibility ---------------------- -The MongoDB Kotlin Sync driver requires Kotlin 1.8 or later. +The {+driver-long+} requires Kotlin 1.8 or later. How to Get Help --------------- diff --git a/source/connect/stable-api.txt b/source/connect/stable-api.txt index f3c28fe5..463fb7ce 100644 --- a/source/connect/stable-api.txt +++ b/source/connect/stable-api.txt @@ -28,10 +28,8 @@ In this guide, you can learn how to specify **{+stable-api+}** compatibility whe connecting to a MongoDB deployment. The {+stable-api+} feature forces the server to run operations with behaviors compatible -with the API version you specify. When you update either your driver or server, -the API version changes, which can change the way these operations behave. -Using the {+stable-api+} ensures consistent responses from the server and -provides long-term API stability for your application. +with the API version you specify. Using the {+stable-api+} ensures consistent responses +from the server and provides long-term API stability for your application. The following sections describe how you can enable and customize {+stable-api+} for your MongoDB client. For more information about the {+stable-api+}, including a list of @@ -122,7 +120,7 @@ option to ``False`` when constructing your ``ServerApi`` object. API Documentation ----------------- -For more information about using the {+stable-api+} with {+driver-short+}, see the +For more information about using the {+stable-api+} with the {+driver-short+}, see the following API documentation: - `ServerApi <{+core-api+}/com/mongodb/ServerApi.html>`__ diff --git a/source/data-formats/bson.txt b/source/data-formats/bson.txt index afa1a43a..cab2bfef 100644 --- a/source/data-formats/bson.txt +++ b/source/data-formats/bson.txt @@ -56,10 +56,9 @@ your project. project, then you can skip this step. This is because the BSON library is already included as a required dependency of the driver. -.. TODO: For instructions on how to add the -.. MongoDB Kotlin driver as a dependency to your project, see the -.. :ref:`driver installation ` section of our Get Started -.. guide. +For instructions on how to add the {+driver-long+} as a dependency to your project, see the +:ref:`driver installation ` section of our Get Started +guide. We recommend that you use the `Maven `__ or `Gradle `__ build automation tool to manage your {+language+} diff --git a/source/data-formats/serialization.txt b/source/data-formats/serialization.txt index a043600c..7bfb3d89 100644 --- a/source/data-formats/serialization.txt +++ b/source/data-formats/serialization.txt @@ -36,7 +36,7 @@ We recommend installing the ``bson-kotlinx`` library to support custom codecs that have configurations to encode defaults, nulls, and define class discriminators. -.. TODO fix the link in the following note +.. TODO fix the link in the following note about Codecs (page soon coming) .. note:: diff --git a/source/data-formats/time-series.txt b/source/data-formats/time-series.txt index e3185279..b3a82bf8 100644 --- a/source/data-formats/time-series.txt +++ b/source/data-formats/time-series.txt @@ -46,7 +46,7 @@ series data: - Monthly rent price - Location, currency -.. _cpp-time-series-create: +.. _kotlin-sync-time-series-create: Create a Time Series Collection ------------------------------- @@ -119,11 +119,10 @@ You can insert data into a time series collection by using the ``insertOne()`` or ``insertMany()`` methods and specifying the measurement, timestamp, and metadata in each inserted document. -.. TODO: Uncomment when insert guide is created -.. .. tip:: +.. tip:: -.. To learn more about inserting documents into a collection, see the :ref:`kotlin-sync-write-insert` -.. guide. + To learn more about inserting documents into a collection, see the :ref:`kotlin-sync-write-insert` + guide. Example ~~~~~~~ @@ -166,8 +165,8 @@ following {+mdb-server+} manual entries: To learn more about performing read operations, see :ref:`kotlin-sync-read`. -.. TODO: To learn more about performing aggregation operations, see the :ref:`kotlin-sync-aggregation` -.. guide. +To learn more about performing aggregation operations, see the :ref:`kotlin-sync-aggregation` +guide. API Documentation ~~~~~~~~~~~~~~~~~ diff --git a/source/get-started/create-a-connection-string.txt b/source/get-started/create-a-connection-string.txt index be132969..47392bc1 100644 --- a/source/get-started/create-a-connection-string.txt +++ b/source/get-started/create-a-connection-string.txt @@ -13,8 +13,7 @@ The connection string includes the hostname or IP address and port of your deployment, the authentication mechanism, user credentials when applicable, and connection options. -.. TODO To connect to an instance or deployment not hosted on Atlas, see -.. :ref:`kotlin-sync-connection-targets`. +To connect to an instance or deployment not hosted on Atlas, see the :ref:`kotlin-sync-connection-targets` guide. .. procedure:: :style: connected diff --git a/source/get-started/next-steps.txt b/source/get-started/next-steps.txt index a75f0572..fc8f66c4 100644 --- a/source/get-started/next-steps.txt +++ b/source/get-started/next-steps.txt @@ -14,4 +14,4 @@ Learn more about the {+driver-short+} from the following resources: - Learn how to perform read operations in the :ref:`` section. -.. TODO - Learn how to perform write operations in the :ref:`` section. +- Learn how to perform write operations in the :ref:`` section. diff --git a/source/indexes.txt b/source/indexes.txt index 078da717..09242301 100644 --- a/source/indexes.txt +++ b/source/indexes.txt @@ -30,12 +30,11 @@ Overview On this page, you can see copyable code examples that show how to manage different types of indexes by using the {+driver-short+}. -.. TODO -.. .. tip:: +.. tip:: -.. To learn more about working with indexes, see the :ref:`kotlin-sync-work-with-indexes` -.. guide. To learn more about any of the indexes shown on this page, see the link -.. provided in each section. + To learn more about working with indexes, see the :ref:`kotlin-sync-work-with-indexes` + guide. To learn more about any of the indexes shown on this page, see the link + provided in each section. To use an example from this page, copy the code example into the :ref:`sample application ` or your own application. @@ -78,8 +77,7 @@ The following example creates a compound index on the specified fields: :copyable: :dedent: -.. TODO: To learn more about compound indexes, see the :ref:`kotlin-sync-compound-index` -.. guide. +To learn more about compound indexes, see the :ref:`kotlin-sync-compound-index` guide. Multikey Index -------------- @@ -155,7 +153,7 @@ field: :copyable: :dedent: -.. TODO: To learn more about wildcard indexes, see the :ref:`kotlin-sync-clustered-index` +.. TODO: To learn more about clustered indexes, see the :ref:`kotlin-sync-clustered-index` .. guide. Atlas Search Index Management @@ -164,13 +162,13 @@ Atlas Search Index Management The following sections contain code examples that describe how to manage Atlas Search indexes. -.. TODO: To learn more about Atlas search indexes, see the :ref:`kotlin-sync-atlas-search-index` -.. guide. +To learn more about Atlas Search indexes, see the :ref:`kotlin-sync-atlas-search-index` +guide. Create Search Index ~~~~~~~~~~~~~~~~~~~ -The following example creates an Atlas search index on the specified field: +The following example creates an Atlas Search index on the specified field: .. literalinclude:: /includes/usage-examples/index-code-examples.kt :start-after: start-search-create @@ -179,13 +177,13 @@ The following example creates an Atlas search index on the specified field: :copyable: :dedent: -.. TODO: To learn more about creating serach indexes, see the :ref:`kotlin-sync-atlas-search-index-create` -.. guide. +To learn more about creating serach indexes, see the :ref:`kotlin-sync-atlas-search-index-create` +guide. List Search Indexes ~~~~~~~~~~~~~~~~~~~ -The following example prints a list of Atlas search indexes in the specified collection: +The following example prints a list of Atlas Search indexes in the specified collection: .. literalinclude:: /includes/usage-examples/index-code-examples.kt :start-after: start-search-list @@ -194,13 +192,13 @@ The following example prints a list of Atlas search indexes in the specified col :copyable: :dedent: -.. TODO: To learn more about listing search indexes, see the :ref:`kotlin-sync-atlas-search-index-list` -.. guide. +To learn more about listing search indexes, see the :ref:`kotlin-sync-atlas-search-index-list` +guide. Update Search Indexes ~~~~~~~~~~~~~~~~~~~~~ -The following example updates an existing Atlas search index with the specified +The following example updates an existing Atlas Search index with the specified new index definition: .. literalinclude:: /includes/usage-examples/index-code-examples.kt @@ -210,13 +208,13 @@ new index definition: :copyable: :dedent: -.. TODO: To learn more about updating search indexes, see the :ref:`kotlin-sync-atlas-search-index-update` -.. guide. +To learn more about updating search indexes, see the :ref:`kotlin-sync-atlas-search-index-update` +guide. Delete Search Indexes ~~~~~~~~~~~~~~~~~~~~~ -The following example deletes an Atlas search index with the specified name: +The following example deletes an Atlas Search index with the specified name: .. literalinclude:: /includes/usage-examples/index-code-examples.kt :start-after: start-search-delete @@ -225,8 +223,8 @@ The following example deletes an Atlas search index with the specified name: :copyable: :dedent: -.. TODO: To learn more about deleting search indexes, see the :ref:`kotlin-sync-atlas-search-index-drop` -.. guide. +To learn more about deleting search indexes, see the :ref:`kotlin-sync-atlas-search-index-drop` +guide. Text Index ---------- diff --git a/source/read/retrieve.txt b/source/read/retrieve.txt index 3106b079..5c88e6f6 100644 --- a/source/read/retrieve.txt +++ b/source/read/retrieve.txt @@ -50,7 +50,7 @@ method takes a **query filter** and returns all matching documents. A query filt document that specifies the criteria that the driver uses to match documents from the collection. -.. TODO: To learn more about query filters, see :ref:`kotlin-sync-specify-query`. +To learn more about query filters, see the :ref:`kotlin-sync-specify-query` guide. Find Documents Example ~~~~~~~~~~~~~~~~~~~~~~ @@ -157,7 +157,7 @@ for the ``FindIterable`` class. Additional Information ---------------------- -.. TODO: To learn more about query filters, see :ref:`kotlin-sync-specify-query`. +To learn more about query filters, see :ref:`kotlin-sync-specify-query`. To view runnable code examples that retrieve documents by using the {+driver-short+}, see :ref:`kotlin-sync-read`. diff --git a/source/read/specify-documents-to-return.txt b/source/read/specify-documents-to-return.txt index 0bed8014..3f2a5043 100644 --- a/source/read/specify-documents-to-return.txt +++ b/source/read/specify-documents-to-return.txt @@ -182,7 +182,7 @@ The following example returns documents with the ``cuisine`` field value of Additional Information ---------------------- -.. TODO: For more information about specifying a query, see :ref:`kotlin-sync-specify-query`. +For more information about specifying a query, see :ref:`kotlin-sync-specify-query`. For more information about retrieving documents, see :ref:`kotlin-sync-retrieve`. diff --git a/source/write/bulk-write.txt b/source/write/bulk-write.txt index 6995d233..220ffed8 100644 --- a/source/write/bulk-write.txt +++ b/source/write/bulk-write.txt @@ -209,7 +209,7 @@ The following example performs multiple write operations by using the modifiedCount=2, upserts=[], inserts=[BulkWriteInsert{index=0, id=BsonObjectId{value=...}}]} -If any of the write operations fail, {+driver-short+} raises a +If any of the write operations fail, the {+driver-short+} raises a ``BulkWriteError`` and does not perform any further operations. ``BulkWriteError`` provides a ``details`` item that includes the operation that failed, and details about the exception.