From 91847e40a2d24aaff243b983c44a51a5458820f6 Mon Sep 17 00:00:00 2001 From: Angela Date: Thu, 3 Jul 2025 11:37:35 -0400 Subject: [PATCH 01/12] reorg toc --- config/redirects | 21 ++ source/aggregation.txt | 14 +- source/{ => aggregation}/agg-exp-ops.txt | 0 source/atlas-search.txt | 1 + source/atlas-vector-search.txt | 1 + source/connect.txt | 8 +- source/connect/connection-options.txt | 10 + source/crud.txt | 49 +++++ source/{write => crud}/bulk-write.txt | 0 source/crud/configure.txt | 1 + source/{write => crud}/delete.txt | 0 source/crud/gridfs.txt | 1 + source/{write => crud}/insert.txt | 0 source/crud/query.txt | 35 ++++ source/{read => crud/query}/count.txt | 0 source/{read => crud/query}/cursors.txt | 0 source/{read => crud/query}/distinct.txt | 6 +- .../retrieve.txt => crud/query/find.txt} | 7 +- source/crud/query/geospatial.txt | 0 source/{read => crud/query}/project.txt | 0 .../{read => crud/query}/specify-a-query.txt | 0 .../query}/specify-documents-to-return.txt | 0 source/{write => crud}/replace.txt | 0 source/{write => crud}/transactions.txt | 0 source/{write => crud}/update.txt | 0 source/data-formats.txt | 3 +- source/data-formats/custom-types.txt | 26 +++ source/index.txt | 108 +++++----- source/indexes.txt | 6 +- source/monitoring-and-logging.txt | 24 +++ .../change-streams.txt | 0 source/monitoring-and-logging/logging.txt | 0 .../monitoring.txt | 0 source/read.txt | 156 --------------- source/reference.txt | 13 ++ source/{ => reference}/compatibility.txt | 0 source/reference/upgrade.txt | 1 + source/{ => reference}/whats-new.txt | 7 +- source/run-command.txt | 6 +- source/security.txt | 3 + source/{connect => security}/tls.txt | 0 source/{ => security}/validate-signatures.txt | 0 source/write-operations.txt | 188 ------------------ 43 files changed, 273 insertions(+), 422 deletions(-) rename source/{ => aggregation}/agg-exp-ops.txt (100%) create mode 100644 source/atlas-search.txt create mode 100644 source/atlas-vector-search.txt create mode 100644 source/crud.txt rename source/{write => crud}/bulk-write.txt (100%) create mode 100644 source/crud/configure.txt rename source/{write => crud}/delete.txt (100%) create mode 100644 source/crud/gridfs.txt rename source/{write => crud}/insert.txt (100%) create mode 100644 source/crud/query.txt rename source/{read => crud/query}/count.txt (100%) rename source/{read => crud/query}/cursors.txt (100%) rename source/{read => crud/query}/distinct.txt (98%) rename source/{read/retrieve.txt => crud/query/find.txt} (98%) create mode 100644 source/crud/query/geospatial.txt rename source/{read => crud/query}/project.txt (100%) rename source/{read => crud/query}/specify-a-query.txt (100%) rename source/{read => crud/query}/specify-documents-to-return.txt (100%) rename source/{write => crud}/replace.txt (100%) rename source/{write => crud}/transactions.txt (100%) rename source/{write => crud}/update.txt (100%) create mode 100644 source/data-formats/custom-types.txt create mode 100644 source/monitoring-and-logging.txt rename source/{read => monitoring-and-logging}/change-streams.txt (100%) create mode 100644 source/monitoring-and-logging/logging.txt rename source/{ => monitoring-and-logging}/monitoring.txt (100%) delete mode 100644 source/read.txt create mode 100644 source/reference.txt rename source/{ => reference}/compatibility.txt (100%) create mode 100644 source/reference/upgrade.txt rename source/{ => reference}/whats-new.txt (99%) rename source/{connect => security}/tls.txt (100%) rename source/{ => security}/validate-signatures.txt (100%) delete mode 100644 source/write-operations.txt diff --git a/config/redirects b/config/redirects index 9544ef3f..776dbb9d 100644 --- a/config/redirects +++ b/config/redirects @@ -10,3 +10,24 @@ symlink: current -> v5.5 raw: ${prefix}/ -> ${base}/current/ raw: ${prefix}/master -> ${base}/upcoming/ [v5.1-*]: ${prefix}/${version}/get-started/connect-to-mongodb -> ${base}/${version}/get-started/run-sample-query/ + +[*-master]: ${prefix}/${version}/connect/tls -> ${base}/${version}/security/tls +[*-master]: ${prefix}/${version}/write/insert -> ${base}/${version}/crud/insert +[*-master]: ${prefix}/${version}/write/update -> ${base}/${version}/crud/update +[*-master]: ${prefix}/${version}/write/delete -> ${base}/${version}/crud/delete +[*-master]: ${prefix}/${version}/write/bulk-write -> ${base}/${version}/crud/bulk-write +[*-master]: ${prefix}/${version}/write/replace -> ${base}/${version}/crud/replace +[*-master]: ${prefix}/${version}/write/transactions -> ${base}/${version}/crud/transactions +[*-master]: ${prefix}/${version}/read/specify-a-query -> ${base}/${version}/crud/query/specify-a-query +[*-master]: ${prefix}/${version}/read/retrieve -> ${base}/${version}/crud/query/find +[*-master]: ${prefix}/${version}/read/specify-documents-to-return -> ${base}/${version}/crud/query/specify-documents-to-return +[*-master]: ${prefix}/${version}/read/project -> ${base}/${version}/crud/query/project +[*-master]: ${prefix}/${version}/read/count -> ${base}/${version}/crud/query/count +[*-master]: ${prefix}/${version}/read/distinct -> ${base}/${version}/crud/query/distinct +[*-master]: ${prefix}/${version}/read/cursors -> ${base}/${version}/crud/query/cursors +[*-master]: ${prefix}/${version}/monitoring -> ${base}/${version}/monitoring-and-logging/monitoring +[*-master]: ${prefix}/${version}/read/change-streams -> ${base}/${version}/monitoring-and-logging/change-streams +[*-master]: ${prefix}/${version}/whats-new -> ${base}/${version}/reference/whats-new +[*-master]: ${prefix}/${version}/compatibility -> ${base}/${version}/reference/compatibility +[*-master]: ${prefix}/${version}/validate-signatures -> ${base}/${version}/security/validate-signatures +[*-master]: ${prefix}/${version}/agg-exp-ops -> ${base}/${version}/aggregation/agg-exp-ops \ No newline at end of file diff --git a/source/aggregation.txt b/source/aggregation.txt index 34592cf2..9fefce6b 100644 --- a/source/aggregation.txt +++ b/source/aggregation.txt @@ -1,8 +1,8 @@ .. _kotlin-sync-aggregation: -==================================== -Transform Your Data with Aggregation -==================================== +====================== +Aggregation Operations +====================== .. facet:: :name: genre @@ -18,9 +18,11 @@ Transform Your Data with Aggregation :depth: 2 :class: singlecol -.. .. toctree:: -.. :titlesonly: -.. :maxdepth: 1 +.. toctree:: + :titlesonly: + :maxdepth: 1 + + Aggregation Expressions .. /aggregation/aggregation-tutorials diff --git a/source/agg-exp-ops.txt b/source/aggregation/agg-exp-ops.txt similarity index 100% rename from source/agg-exp-ops.txt rename to source/aggregation/agg-exp-ops.txt diff --git a/source/atlas-search.txt b/source/atlas-search.txt new file mode 100644 index 00000000..bd2e9640 --- /dev/null +++ b/source/atlas-search.txt @@ -0,0 +1 @@ +.. _kotlin-sync-atlas-search: \ No newline at end of file diff --git a/source/atlas-vector-search.txt b/source/atlas-vector-search.txt new file mode 100644 index 00000000..42e94554 --- /dev/null +++ b/source/atlas-vector-search.txt @@ -0,0 +1 @@ +.. kotlin-sync-atlas-vector-search: \ No newline at end of file diff --git a/source/connect.txt b/source/connect.txt index 326c008d..5aa0d4ff 100644 --- a/source/connect.txt +++ b/source/connect.txt @@ -24,14 +24,10 @@ Connect to MongoDB Create a MongoClient Choose a Connection Target - Connection Options - Limit Execution Time - Enable TLS - Stable API + Connection Options AWS Lambda -.. /connect/network-compression -.. /connect/server-selection +.. /connect/connection-troubleshooting Overview -------- diff --git a/source/connect/connection-options.txt b/source/connect/connection-options.txt index 3551bfe5..2cf6c5f5 100644 --- a/source/connect/connection-options.txt +++ b/source/connect/connection-options.txt @@ -17,6 +17,16 @@ Specify Connection Options .. meta:: :keywords: connection string, URI, server, Atlas, settings, configure +.. toctree:: + :titlesonly: + :maxdepth: 1 + + Connect with Stable API + Limit Server Execution Time + +.. /connect/network-compression +.. /connect/server-selection + Overview -------- diff --git a/source/crud.txt b/source/crud.txt new file mode 100644 index 00000000..869d8e21 --- /dev/null +++ b/source/crud.txt @@ -0,0 +1,49 @@ +.. _kotlin-sync-crud-landing: +.. _kotlin-sync-crud-operations: +.. _kotlin-sync-write: +.. _kotlin-sync-read: + +=============== +CRUD Operations +=============== + +.. contents:: On this page + :local: + :backlinks: none + :depth: 2 + :class: singlecol + +.. facet:: + :name: genre + :values: reference + +.. meta:: + :description: Learn how to use {+driver-short+} to read and write MongoDB data. + :keywords: usage examples, query, find, code example, save, create + +.. toctree:: + :titlesonly: + :maxdepth: 1 + + Insert Documents + Query Documents + Update Documents + Replace Documents + Delete Documents + Bulk Write Operations + Transactions + Configure CRUD Operations + Store Large Files + +CRUD (Create, Read, Update, Delete) operations enable you to work with +data stored in MongoDB. + +- :ref:`kotlin-sync-write-insert` +- :ref:`kotlin-sync-query` +- :ref:`kotlin-sync-write-update` +- :ref:`kotlin-sync-write-replace` +- :ref:`kotlin-sync-write-delete` +- :ref:`kotlin-sync-bulk-write` +- :ref:`kotlin-sync-write-transactions` +- :ref:`kotlin-sync-configure` +- :ref:`kotlin-sync-gridfs` \ No newline at end of file diff --git a/source/write/bulk-write.txt b/source/crud/bulk-write.txt similarity index 100% rename from source/write/bulk-write.txt rename to source/crud/bulk-write.txt diff --git a/source/crud/configure.txt b/source/crud/configure.txt new file mode 100644 index 00000000..e07d18e0 --- /dev/null +++ b/source/crud/configure.txt @@ -0,0 +1 @@ +.. _kotlin-sync-configure: \ No newline at end of file diff --git a/source/write/delete.txt b/source/crud/delete.txt similarity index 100% rename from source/write/delete.txt rename to source/crud/delete.txt diff --git a/source/crud/gridfs.txt b/source/crud/gridfs.txt new file mode 100644 index 00000000..e7e846d3 --- /dev/null +++ b/source/crud/gridfs.txt @@ -0,0 +1 @@ +.. _kotlin-sync-gridfs: \ No newline at end of file diff --git a/source/write/insert.txt b/source/crud/insert.txt similarity index 100% rename from source/write/insert.txt rename to source/crud/insert.txt diff --git a/source/crud/query.txt b/source/crud/query.txt new file mode 100644 index 00000000..5132f641 --- /dev/null +++ b/source/crud/query.txt @@ -0,0 +1,35 @@ +.. _kotlin-sync-query: + +=============== +Query Documents +=============== + +.. meta:: + :description: Learn how to use {+driver-short+} to read data from MongoDB. + :keywords: usage examples, query, find, code example + +.. facet:: + :name: genre + :values: reference + +.. meta:: + :keywords: code example, kotlin, sample dataset + +.. toctree:: + :maxdepth: 1 + + Find Documents + Specify Documents to Return + Specify Fields to Return + Specify a Query + Count Documents + Distinct Field Values + Access Data from a Cursor + +- :ref:`kotlin-sync-find` +- :ref:`kotlin-sync-specify-documents-to-return` +- :ref:`kotlin-sync-project` +- :ref:`kotlin-sync-specify-a-query` +- :ref:`kotlin-sync-count` +- :ref:`kotlin-sync-distinct` +- :ref:`kotlin-sync-cursors` \ No newline at end of file diff --git a/source/read/count.txt b/source/crud/query/count.txt similarity index 100% rename from source/read/count.txt rename to source/crud/query/count.txt diff --git a/source/read/cursors.txt b/source/crud/query/cursors.txt similarity index 100% rename from source/read/cursors.txt rename to source/crud/query/cursors.txt diff --git a/source/read/distinct.txt b/source/crud/query/distinct.txt similarity index 98% rename from source/read/distinct.txt rename to source/crud/query/distinct.txt index fbb0f834..6f510318 100644 --- a/source/read/distinct.txt +++ b/source/crud/query/distinct.txt @@ -1,8 +1,8 @@ .. _kotlin-sync-distinct: -============================== -Retrieve Distinct Field Values -============================== +===================== +Distinct Field Values +===================== .. contents:: On this page :local: diff --git a/source/read/retrieve.txt b/source/crud/query/find.txt similarity index 98% rename from source/read/retrieve.txt rename to source/crud/query/find.txt index ff5f73db..e51ae9b5 100644 --- a/source/read/retrieve.txt +++ b/source/crud/query/find.txt @@ -1,8 +1,9 @@ .. _kotlin-sync-retrieve: +.. _kotlin-sync-find: -============= -Retrieve Data -============= +============== +Find Documents +============== .. contents:: On this page :local: diff --git a/source/crud/query/geospatial.txt b/source/crud/query/geospatial.txt new file mode 100644 index 00000000..e69de29b diff --git a/source/read/project.txt b/source/crud/query/project.txt similarity index 100% rename from source/read/project.txt rename to source/crud/query/project.txt diff --git a/source/read/specify-a-query.txt b/source/crud/query/specify-a-query.txt similarity index 100% rename from source/read/specify-a-query.txt rename to source/crud/query/specify-a-query.txt diff --git a/source/read/specify-documents-to-return.txt b/source/crud/query/specify-documents-to-return.txt similarity index 100% rename from source/read/specify-documents-to-return.txt rename to source/crud/query/specify-documents-to-return.txt diff --git a/source/write/replace.txt b/source/crud/replace.txt similarity index 100% rename from source/write/replace.txt rename to source/crud/replace.txt diff --git a/source/write/transactions.txt b/source/crud/transactions.txt similarity index 100% rename from source/write/transactions.txt rename to source/crud/transactions.txt diff --git a/source/write/update.txt b/source/crud/update.txt similarity index 100% rename from source/write/update.txt rename to source/crud/update.txt diff --git a/source/data-formats.txt b/source/data-formats.txt index 14b9b934..9f2326c9 100644 --- a/source/data-formats.txt +++ b/source/data-formats.txt @@ -21,9 +21,8 @@ Specialized Data Formats :titlesonly: :maxdepth: 1 + Custom Types Data Classes - Kotlin Serialization - Codecs BSON Time Series diff --git a/source/data-formats/custom-types.txt b/source/data-formats/custom-types.txt new file mode 100644 index 00000000..a2b61fab --- /dev/null +++ b/source/data-formats/custom-types.txt @@ -0,0 +1,26 @@ +.. _kotlin-sync-custom-types: + +============ +Custom Types +============ + +.. contents:: On this page + :local: + :backlinks: none + :depth: 2 + :class: singlecol + +.. facet:: + :name: genre + :values: reference + +.. meta:: + :keywords: bson, uuid, date, time + :description: Learn how to use the Kotlin Sync driver to encode and decode custom types, including defining type codecs, using type registries, and implementing fallback encoders. + +.. toctree:: + :titlesonly: + :maxdepth: 1 + + Serialization + Type Codecs \ No newline at end of file diff --git a/source/index.txt b/source/index.txt index e76b60ce..a0b427f6 100644 --- a/source/index.txt +++ b/source/index.txt @@ -15,22 +15,20 @@ Get Started Connect - Write Data - Read Data - Indexes - Data Aggregation - Aggregation Operations - Specialized Data Formats + CRUD Operations + Aggregation Builders - Run a Command - Monitoring + Data Formats + Indexes + Run a Database Command + Atlas Search + Atlas Vector Search + Monitoring and Logging Security - Compatibility - Validate Driver Signatures - What's New + Reference + API Documentation Issues & Help View the Source - API Documentation Introduction ------------ @@ -58,67 +56,79 @@ Connect to MongoDB Learn how to create and configure a connection to a MongoDB deployment in the :ref:`kotlin-sync-connect` section. -Write Data to MongoDB ---------------------- +Read and Write Data +------------------- -Learn how you can write data to MongoDB in the :ref:`kotlin-sync-write` section. +Learn how to find, update, and delete data in the :ref:`kotlin-sync-crud-landing` section. -Read Data ---------- +Transform Your Data with Aggregation +------------------------------------- + +Learn how to use the {+driver-short+} to perform aggregation operations in the +:ref:`kotlin-sync-aggregation` section. + +Builders +-------- + +Learn how to use builder classes to efficiently build queries and aggregations in the +:ref:`kotlin-sync-builders` section. + +Data Formats +------------ -Learn how you can retrieve data from MongoDB in the :ref:`kotlin-sync-read` section. +Learn how to work with BSON and other data formats in the +:ref:`kotlin-sync-data-formats` section. Optimize Queries with Indexes ----------------------------- -Learn how to work with common types of indexes in the :ref:`kotlin-sync-indexes` -section. +Learn how to work with common types of indexes in the :ref:`kotlin-sync-indexes` section. -Transform Your Data with Aggregation ------------------------------------- +Run a Database Command +---------------------- -Learn how to use the {+driver-short+} to perform aggregation operations in the -:ref:`kotlin-sync-aggregation` section. +Learn how to run a database command in the :ref:`kotlin-run-command` section. + +Atlas Search +------------ -Learn how to use aggregation expression operations to build -aggregation stages in the :ref:`kotlin-sync-aggregation-expression-operations` section. +Learn how to run Atlas Search queries in the :ref:`kotlin-sync-atlas-search` section. -Specialized Data Formats ------------------------- +Atlas Vector Search +------------------- -Learn how to work with specialized data formats and custom types in the -:ref:`kotlin-sync-data-formats` section. +Learn how to run Atlas Vector Search queries in the :ref:`kotlin-sync-atlas-vector-search` section. -Use Builders API ----------------- +Monitoring and Logging +---------------------- -Learn how to work with the builder operation helpers in the :ref:`kotlin-sync-builders` section. +Learn how to monitor changes to your application and write them to logs in the +:ref:`kotlin-sync-monitoring-logging` section. -Compatibility -------------- +Secure Your Data +---------------- -For the compatibility charts that show the recommended {+driver-short+} version for each -MongoDB Server version, see the :ref:`Compatibility -` section. +Learn about ways you can authenticate your application and encrypt your data in +the :ref:`kotlin-sync-security` section. -Validate Driver Artifact Signatures ------------------------------------ +Reference +--------- -Learn about how to validate signatures of {+driver-short+} artifacts -published on Maven in the :ref:`Validate Driver Artifact Signatures ` section. +Find more information about {+driver-short+} versions, compatibility, and third-party tools in the +:ref:`kotlin-sync-reference` section. -What's New ----------- +API Documentation +----------------- -For a list of new features and changes in each version, see the -:ref:`What's New ` section. +For detailed information about classes and methods in the MongoDB +Node.js driver, see the `{+driver-long+} API documentation +<{+driver-api+}>`__. Issues & Help ------------- -Learn how to report bugs, contribute to the driver, and find more resources for -asking questions and receiving help in the :ref:`Issues & Help -` section. +Learn how to report bugs, contribute to the driver, and to find help in the +:ref:`kotlin-sync-issues-and-help` section. Learn ------ diff --git a/source/indexes.txt b/source/indexes.txt index 7a1bf0b3..9e866d92 100644 --- a/source/indexes.txt +++ b/source/indexes.txt @@ -1,8 +1,8 @@ .. _kotlin-sync-indexes: -================================= -Optimize Queries by Using Indexes -================================= +============================== +Indexes for Query Optimization +============================== .. contents:: On this page :local: diff --git a/source/monitoring-and-logging.txt b/source/monitoring-and-logging.txt new file mode 100644 index 00000000..c3ce2849 --- /dev/null +++ b/source/monitoring-and-logging.txt @@ -0,0 +1,24 @@ +.. _kotlin-sync-monitoring-logging: + +====================== +Monitoring and Logging +====================== + +.. facet:: + :name: programming_language + :values: kotlin + +.. meta:: + :keywords: event + +.. toctree:: + + Monitoring + Logging + Change Streams + +Overview +-------- + +On this page, you can see copyable code examples that show common +methods you can use to monitor and log events with {+driver-short+}. \ No newline at end of file diff --git a/source/read/change-streams.txt b/source/monitoring-and-logging/change-streams.txt similarity index 100% rename from source/read/change-streams.txt rename to source/monitoring-and-logging/change-streams.txt diff --git a/source/monitoring-and-logging/logging.txt b/source/monitoring-and-logging/logging.txt new file mode 100644 index 00000000..e69de29b diff --git a/source/monitoring.txt b/source/monitoring-and-logging/monitoring.txt similarity index 100% rename from source/monitoring.txt rename to source/monitoring-and-logging/monitoring.txt diff --git a/source/read.txt b/source/read.txt deleted file mode 100644 index 615a73a6..00000000 --- a/source/read.txt +++ /dev/null @@ -1,156 +0,0 @@ -.. _kotlin-sync-read: - -========= -Read Data -========= - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - -.. facet:: - :name: genre - :values: reference - -.. meta:: - :description: Learn how to use the Kotlin Sync Driver to read data from MongoDB. - :keywords: usage examples, query, find, code example - -.. toctree:: - :titlesonly: - :maxdepth: 1 - - Specify a Query - Retrieve Data - Specify Fields to Return - Specify Documents to Return - Count Documents - Distinct Field Values - Data Cursors - Monitor Data Changes - -Overview --------- - -On this page, you can see copyable code examples that show common -methods you can use to retrieve documents by using the {+driver-short+}. - -.. tip:: - - To learn more about any of the methods shown on this page, see the link - to a relevant guide provided in each section. - -To use an example from this page, copy the code example into the -:ref:`sample application ` or your own application. -Be sure to replace all placeholders in the code examples, such as ````, with -the relevant values for your MongoDB deployment. - -.. _kotlin-sync-read-sample: - -.. include:: /includes/usage-examples/sample-app-intro.rst - -.. literalinclude:: /includes/usage-examples/sample-app.kt - :language: kotlin - :copyable: - :linenos: - :emphasize-lines: 20-22 - -.. tip:: - - For instructions about how to install the {+driver-short+}, see :ref:``. - -Find Documents --------------- - -The following example retrieves a list of documents that match the criteria specified by the -given filter: - -.. literalinclude:: /includes/usage-examples/retrieve-code-examples.kt - :start-after: start-find - :end-before: end-find - :language: kotlin - :copyable: - :dedent: - -To learn more about the ``find()`` method, see the :ref:`kotlin-sync-retrieve-find` guide. - -Count Documents in a Collection -------------------------------- - -The following example returns the number of documents in the specified collection: - -.. literalinclude:: /includes/usage-examples/retrieve-code-examples.kt - :start-after: start-count-all - :end-before: end-count-all - :language: kotlin - :copyable: - :dedent: - -To learn more about the ``countDocuments()`` method, see the -:ref:`kotlin-sync-accurate-count` section of the Count Documents guide. - -Count Documents Returned from a Query -------------------------------------- - -The following example returns the number of documents that match the criteria specified by -the given filter: - -.. literalinclude:: /includes/usage-examples/retrieve-code-examples.kt - :start-after: start-count-query - :end-before: end-count-query - :language: kotlin - :copyable: - :dedent: - -To learn more about the ``countDocuments()`` method, see the -:ref:`kotlin-sync-accurate-count` section of the Count Documents guide. - -Estimated Document Count ------------------------- - -The following example returns an approximate number of documents in the specified -collection based on collection metadata: - -.. literalinclude:: /includes/usage-examples/retrieve-code-examples.kt - :start-after: start-estimated-count - :end-before: end-estimated-count - :language: kotlin - :copyable: - :dedent: - -To learn more about the ``estimatedDocumentCount()`` method, see the -:ref:`kotlin-sync-estimated-count` section of the Count Documents guide. - -Retrieve Distinct Values ------------------------- - -The following example returns all distinct values of the specified field name in a given -collection: - -.. literalinclude:: /includes/usage-examples/retrieve-code-examples.kt - :start-after: start-distinct - :end-before: end-distinct - :language: kotlin - :copyable: - :dedent: - -To learn more about the ``distinct()`` method, see the -:ref:`kotlin-sync-distinct` guide. - -Monitor Data Changes --------------------- - -The following example creates a change stream for a given collection and prints out -subsequent change events in that collection: - -.. literalinclude:: /includes/usage-examples/retrieve-code-examples.kt - :start-after: start-watch - :end-before: end-watch - :language: kotlin - :copyable: - :dedent: - -To learn more about the ``watch()`` method, see the -:ref:`kotlin-sync-change-streams` guide. \ No newline at end of file diff --git a/source/reference.txt b/source/reference.txt new file mode 100644 index 00000000..3ef97302 --- /dev/null +++ b/source/reference.txt @@ -0,0 +1,13 @@ +.. _kotlin-sync-reference: + +========== +Reference +========== + +.. toctree:: + :titlesonly: + :maxdepth: 1 + + Release Notes + Compatibility + Upgrade Guides \ No newline at end of file diff --git a/source/compatibility.txt b/source/reference/compatibility.txt similarity index 100% rename from source/compatibility.txt rename to source/reference/compatibility.txt diff --git a/source/reference/upgrade.txt b/source/reference/upgrade.txt new file mode 100644 index 00000000..22aad04f --- /dev/null +++ b/source/reference/upgrade.txt @@ -0,0 +1 @@ +.. _kotlin-sync-upgrade: \ No newline at end of file diff --git a/source/whats-new.txt b/source/reference/whats-new.txt similarity index 99% rename from source/whats-new.txt rename to source/reference/whats-new.txt index ca689dd1..73e9f230 100644 --- a/source/whats-new.txt +++ b/source/reference/whats-new.txt @@ -1,8 +1,9 @@ .. _kotlin-sync-whats-new: +.. _kotlin-sync-release-notes: -========== -What's New -========== +============= +Release Notes +============= .. contents:: On this page :local: diff --git a/source/run-command.txt b/source/run-command.txt index cae850da..0f0568ef 100644 --- a/source/run-command.txt +++ b/source/run-command.txt @@ -1,8 +1,8 @@ .. _kotlin-run-command: -============= -Run a Command -============= +====================== +Run a Database Command +====================== .. contents:: On this page :local: diff --git a/source/security.txt b/source/security.txt index 08969d5b..f80c3a23 100644 --- a/source/security.txt +++ b/source/security.txt @@ -1,3 +1,4 @@ +.. _kotlin-sync-security: ================ Secure Your Data @@ -10,5 +11,7 @@ Secure Your Data Authentication Enterprise Authentication In-Use Encryption + TLS Security Protocol + Validate Driver Artifact Signatures .. placeholder \ No newline at end of file diff --git a/source/connect/tls.txt b/source/security/tls.txt similarity index 100% rename from source/connect/tls.txt rename to source/security/tls.txt diff --git a/source/validate-signatures.txt b/source/security/validate-signatures.txt similarity index 100% rename from source/validate-signatures.txt rename to source/security/validate-signatures.txt diff --git a/source/write-operations.txt b/source/write-operations.txt deleted file mode 100644 index 6e2d02c0..00000000 --- a/source/write-operations.txt +++ /dev/null @@ -1,188 +0,0 @@ -.. _kotlin-sync-write: - -===================== -Write Data to MongoDB -===================== - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - -.. facet:: - :name: genre - :values: reference - -.. meta:: - :description: Learn how to use the Kotlin Sync driver to write data to MongoDB. - :keywords: usage examples, save, crud, create, code example - -.. toctree:: - :titlesonly: - :maxdepth: 1 - - Insert - Update - Replace - Delete - Bulk Write - Transactions - -.. - /write/gridfs - -Overview --------- - -On this page, you can see copyable code examples of common -methods that you can use to write data to MongoDB by using the -{+driver-short+}. - -.. tip:: - - To learn more about any of the methods 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. -Be sure to replace all placeholders in the code examples, such as ````, with -the relevant values for your MongoDB deployment. - -.. _kotlin-sync-write-sample: - -.. include:: /includes/usage-examples/sample-app-intro.rst - -.. literalinclude:: /includes/usage-examples/sample-app.kt - :language: kotlin - :copyable: - :linenos: - :emphasize-lines: 20-22 - -Insert One ----------- - -The following code shows how to insert a single document into a -collection: - -.. literalinclude:: /includes/usage-examples/write-code-examples.kt - :start-after: start-insert-one - :end-before: end-insert-one - :language: kotlin - :copyable: - :dedent: - -To learn more about the ``insertOne()`` method, see the :ref:`Insert Documents -` guide. - -Insert Multiple ---------------- - -The following code shows how to insert multiple documents into a -collection: - -.. literalinclude:: /includes/usage-examples/write-code-examples.kt - :start-after: start-insert-multiple - :end-before: end-insert-multiple - :language: kotlin - :copyable: - :dedent: - -To learn more about the ``insertMany()`` method, see the :ref:`Insert Documents -` guide. - -Update One ----------- - -The following code shows how to update a single document in a -collection by creating or editing a field: - -.. literalinclude:: /includes/usage-examples/write-code-examples.kt - :start-after: start-update-one - :end-before: end-update-one - :language: kotlin - :copyable: - :dedent: - -To learn more about the ``updateOne()`` method, see the -:ref:`Update Documents ` guide. - -Update Multiple ---------------- - -The following code shows how to update multiple documents in a -collection by creating or editing a field: - -.. literalinclude:: /includes/usage-examples/write-code-examples.kt - :start-after: start-update-multiple - :end-before: end-update-multiple - :language: kotlin - :copyable: - :dedent: - -To learn more about the ``updateMany()`` method, see the -:ref:`Update Documents ` guide. - -Replace One ------------ - -The following code shows how to replace a single document in a -collection with a new document: - -.. literalinclude:: /includes/usage-examples/write-code-examples.kt - :start-after: start-replace-one - :end-before: end-replace-one - :language: kotlin - :copyable: - :dedent: - -To learn more about the ``replaceOne()`` method, see the -:ref:`Replace Documents ` guide. - -Delete One ----------- - -The following code shows how to delete a single document in a -collection: - -.. literalinclude:: /includes/usage-examples/write-code-examples.kt - :start-after: start-delete-one - :end-before: end-delete-one - :language: kotlin - :copyable: - :dedent: - -To learn more about the ``deleteOne()`` method, see the -:ref:`Delete Documents ` guide. - -Delete Multiple ---------------- - -The following code shows how to delete multiple documents in a -collection: - -.. literalinclude:: /includes/usage-examples/write-code-examples.kt - :start-after: start-delete-multiple - :end-before: end-delete-multiple - :language: kotlin - :copyable: - :dedent: - -To learn more about the ``deleteMany()`` method, see the -:ref:`Delete Documents ` guide. - -Bulk Write ----------- - -The following code shows how to perform multiple write operations in a -single bulk operation: - -.. literalinclude:: /includes/usage-examples/write-code-examples.kt - :start-after: start-bulk-write - :end-before: end-bulk-write - :language: kotlin - :copyable: - :dedent: - -To learn more about the ``bulkWrite()`` method, see the -:ref:`Bulk Write ` guide. From 67dd38ea24c70b476d2901093e57dbd2eadacd7f Mon Sep 17 00:00:00 2001 From: Angela Date: Thu, 3 Jul 2025 11:47:11 -0400 Subject: [PATCH 02/12] Empty-Commit From 1187119627c6144b9d541ad549f8d201985332e7 Mon Sep 17 00:00:00 2001 From: Angela Date: Thu, 3 Jul 2025 13:59:42 -0400 Subject: [PATCH 03/12] fix links --- source/atlas-search.txt | 6 +++++- source/atlas-vector-search.txt | 6 +++++- source/crud/configure.txt | 12 +++++++++++- source/crud/gridfs.txt | 12 +++++++++++- source/crud/query.txt | 3 --- source/data-formats/custom-types.txt | 10 +++------- 6 files changed, 35 insertions(+), 14 deletions(-) diff --git a/source/atlas-search.txt b/source/atlas-search.txt index bd2e9640..60579663 100644 --- a/source/atlas-search.txt +++ b/source/atlas-search.txt @@ -1 +1,5 @@ -.. _kotlin-sync-atlas-search: \ No newline at end of file +.. _kotlin-sync-atlas-search: + +============ +Atlas Search +============ \ No newline at end of file diff --git a/source/atlas-vector-search.txt b/source/atlas-vector-search.txt index 42e94554..28a2c271 100644 --- a/source/atlas-vector-search.txt +++ b/source/atlas-vector-search.txt @@ -1 +1,5 @@ -.. kotlin-sync-atlas-vector-search: \ No newline at end of file +.. kotlin-sync-atlas-vector-search: + +=================== +Atlas Vector Search +=================== \ No newline at end of file diff --git a/source/crud/configure.txt b/source/crud/configure.txt index e07d18e0..78cbcf80 100644 --- a/source/crud/configure.txt +++ b/source/crud/configure.txt @@ -1 +1,11 @@ -.. _kotlin-sync-configure: \ No newline at end of file +.. _kotlin-sync-configure: + +============================== +Configure Custom CRUD Settings +============================== + +.. contents:: On this page + :local: + :backlinks: none + :depth: 2 + :class: singlecol \ No newline at end of file diff --git a/source/crud/gridfs.txt b/source/crud/gridfs.txt index e7e846d3..e9d2680b 100644 --- a/source/crud/gridfs.txt +++ b/source/crud/gridfs.txt @@ -1 +1,11 @@ -.. _kotlin-sync-gridfs: \ No newline at end of file +.. _kotlin-sync-gridfs: + +============================== +Large File Storage with GridFS +============================== + +.. contents:: On this page + :local: + :backlinks: none + :depth: 2 + :class: singlecol \ No newline at end of file diff --git a/source/crud/query.txt b/source/crud/query.txt index 5132f641..d451102b 100644 --- a/source/crud/query.txt +++ b/source/crud/query.txt @@ -12,9 +12,6 @@ Query Documents :name: genre :values: reference -.. meta:: - :keywords: code example, kotlin, sample dataset - .. toctree:: :maxdepth: 1 diff --git a/source/data-formats/custom-types.txt b/source/data-formats/custom-types.txt index a2b61fab..3622739d 100644 --- a/source/data-formats/custom-types.txt +++ b/source/data-formats/custom-types.txt @@ -4,19 +4,15 @@ Custom Types ============ -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - .. facet:: :name: genre :values: reference .. meta:: :keywords: bson, uuid, date, time - :description: Learn how to use the Kotlin Sync driver to encode and decode custom types, including defining type codecs, using type registries, and implementing fallback encoders. + :description: Learn how to use the Kotlin Sync driver to encode and decode custom + types, including defining type codecs, using type registries, and implementing fallback + encoders. .. toctree:: :titlesonly: From e717e826217c6c15c1958e661784142e1851c376 Mon Sep 17 00:00:00 2001 From: Angela Date: Thu, 3 Jul 2025 14:42:00 -0400 Subject: [PATCH 04/12] fix link --- source/atlas-vector-search.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/atlas-vector-search.txt b/source/atlas-vector-search.txt index 28a2c271..9d961f41 100644 --- a/source/atlas-vector-search.txt +++ b/source/atlas-vector-search.txt @@ -1,4 +1,4 @@ -.. kotlin-sync-atlas-vector-search: +.. _kotlin-sync-atlas-vector-search: =================== Atlas Vector Search From 184beb2ea152c31a09eabb7837e9c4e8390d18e2 Mon Sep 17 00:00:00 2001 From: Angela Date: Thu, 3 Jul 2025 14:58:58 -0400 Subject: [PATCH 05/12] Fix build errors --- source/crud/query.txt | 2 +- source/crud/query/geospatial.txt | 0 source/data-formats/custom-types.txt | 16 ++++++++++------ 3 files changed, 11 insertions(+), 7 deletions(-) delete mode 100644 source/crud/query/geospatial.txt diff --git a/source/crud/query.txt b/source/crud/query.txt index d451102b..4302e94d 100644 --- a/source/crud/query.txt +++ b/source/crud/query.txt @@ -26,7 +26,7 @@ Query Documents - :ref:`kotlin-sync-find` - :ref:`kotlin-sync-specify-documents-to-return` - :ref:`kotlin-sync-project` -- :ref:`kotlin-sync-specify-a-query` +- :ref:`kotlin-sync-specify-query` - :ref:`kotlin-sync-count` - :ref:`kotlin-sync-distinct` - :ref:`kotlin-sync-cursors` \ No newline at end of file diff --git a/source/crud/query/geospatial.txt b/source/crud/query/geospatial.txt deleted file mode 100644 index e69de29b..00000000 diff --git a/source/data-formats/custom-types.txt b/source/data-formats/custom-types.txt index 3622739d..e6847f38 100644 --- a/source/data-formats/custom-types.txt +++ b/source/data-formats/custom-types.txt @@ -4,19 +4,23 @@ Custom Types ============ +.. contents:: On this page + :local: + :backlinks: none + :depth: 2 + :class: singlecol + .. facet:: :name: genre :values: reference .. meta:: - :keywords: bson, uuid, date, time - :description: Learn how to use the Kotlin Sync driver to encode and decode custom - types, including defining type codecs, using type registries, and implementing fallback - encoders. + :description: Learn how to use the Kotlin Sync driver to encode and decode custom types, including defining type codecs, using type registries, and implementing fallback encoders. + :keywords: bson, uuid, date, time .. toctree:: :titlesonly: :maxdepth: 1 - Serialization - Type Codecs \ No newline at end of file + Serialization + Type Codecs \ No newline at end of file From 2534632e374ff6d1b6a1dd309a8dd453debb8637 Mon Sep 17 00:00:00 2001 From: Angela Date: Mon, 7 Jul 2025 11:26:17 -0400 Subject: [PATCH 06/12] nr feedback --- source/connect/connection-options.txt | 2 +- source/connect/stable-api.txt | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/source/connect/connection-options.txt b/source/connect/connection-options.txt index 2cf6c5f5..2c065e10 100644 --- a/source/connect/connection-options.txt +++ b/source/connect/connection-options.txt @@ -21,7 +21,7 @@ Specify Connection Options :titlesonly: :maxdepth: 1 - Connect with Stable API + Stable API Limit Server Execution Time .. /connect/network-compression diff --git a/source/connect/stable-api.txt b/source/connect/stable-api.txt index f7484c31..b58c0157 100644 --- a/source/connect/stable-api.txt +++ b/source/connect/stable-api.txt @@ -1,8 +1,8 @@ .. _kotlin-sync-stable-api: -============== -{+stable-api+} -============== +=========================== +Connect With {+stable-api+} +=========================== .. contents:: On this page :local: From e64ac77d0b0dc2a47a0ad4f098ed1cf79a69beb9 Mon Sep 17 00:00:00 2001 From: Angela Date: Mon, 7 Jul 2025 14:31:11 -0400 Subject: [PATCH 07/12] align with toc spreadsheet --- config/redirects | 4 ++-- source/atlas-search.txt | 6 +++--- source/atlas-vector-search.txt | 6 +++--- source/connect.txt | 6 +++--- source/crud/configure.txt | 6 +++--- source/crud/gridfs.txt | 6 +++--- source/crud/transactions.txt | 6 +++--- source/data-formats/custom-types.txt | 6 +++--- source/data-formats/serialization.txt | 6 +++--- source/data-formats/time-series.txt | 6 +++--- source/get-started.txt | 6 +++--- source/index.txt | 4 ++-- source/issues-and-help.txt | 6 +++--- ...ng-and-logging.txt => logging-and-monitoring.txt} | 8 ++++---- .../change-streams.txt | 6 +++--- .../logging.txt | 0 .../monitoring.txt | 6 +++--- source/reference.txt | 2 +- source/reference/compatibility.txt | 6 +++--- source/reference/upgrade.txt | 12 +++++++++++- source/security.txt | 2 +- source/security/tls.txt | 6 +++--- 22 files changed, 66 insertions(+), 56 deletions(-) rename source/{monitoring-and-logging.txt => logging-and-monitoring.txt} (65%) rename source/{monitoring-and-logging => logging-and-monitoring}/change-streams.txt (98%) rename source/{monitoring-and-logging => logging-and-monitoring}/logging.txt (100%) rename source/{monitoring-and-logging => logging-and-monitoring}/monitoring.txt (99%) diff --git a/config/redirects b/config/redirects index 776dbb9d..b2477918 100644 --- a/config/redirects +++ b/config/redirects @@ -25,8 +25,8 @@ raw: ${prefix}/master -> ${base}/upcoming/ [*-master]: ${prefix}/${version}/read/count -> ${base}/${version}/crud/query/count [*-master]: ${prefix}/${version}/read/distinct -> ${base}/${version}/crud/query/distinct [*-master]: ${prefix}/${version}/read/cursors -> ${base}/${version}/crud/query/cursors -[*-master]: ${prefix}/${version}/monitoring -> ${base}/${version}/monitoring-and-logging/monitoring -[*-master]: ${prefix}/${version}/read/change-streams -> ${base}/${version}/monitoring-and-logging/change-streams +[*-master]: ${prefix}/${version}/monitoring -> ${base}/${version}/logging-and-monitoring/monitoring +[*-master]: ${prefix}/${version}/read/change-streams -> ${base}/${version}/logging-and-monitoring/change-streams [*-master]: ${prefix}/${version}/whats-new -> ${base}/${version}/reference/whats-new [*-master]: ${prefix}/${version}/compatibility -> ${base}/${version}/reference/compatibility [*-master]: ${prefix}/${version}/validate-signatures -> ${base}/${version}/security/validate-signatures diff --git a/source/atlas-search.txt b/source/atlas-search.txt index 60579663..e0501710 100644 --- a/source/atlas-search.txt +++ b/source/atlas-search.txt @@ -1,5 +1,5 @@ .. _kotlin-sync-atlas-search: -============ -Atlas Search -============ \ No newline at end of file +================================ +Run an Atlas Vector Search Query +================================ \ No newline at end of file diff --git a/source/atlas-vector-search.txt b/source/atlas-vector-search.txt index 9d961f41..cf6585fe 100644 --- a/source/atlas-vector-search.txt +++ b/source/atlas-vector-search.txt @@ -1,5 +1,5 @@ .. _kotlin-sync-atlas-vector-search: -=================== -Atlas Vector Search -=================== \ No newline at end of file +================================ +Run an Atlas Vector Search Query +================================ \ No newline at end of file diff --git a/source/connect.txt b/source/connect.txt index 5aa0d4ff..cc47d76d 100644 --- a/source/connect.txt +++ b/source/connect.txt @@ -1,8 +1,8 @@ .. _kotlin-sync-connect: -================== -Connect to MongoDB -================== +================ +Connection Guide +================ .. contents:: On this page :local: diff --git a/source/crud/configure.txt b/source/crud/configure.txt index 78cbcf80..f2e20e7b 100644 --- a/source/crud/configure.txt +++ b/source/crud/configure.txt @@ -1,8 +1,8 @@ .. _kotlin-sync-configure: -============================== -Configure Custom CRUD Settings -============================== +========================= +Configure CRUD Operations +========================= .. contents:: On this page :local: diff --git a/source/crud/gridfs.txt b/source/crud/gridfs.txt index e9d2680b..1dbb1b00 100644 --- a/source/crud/gridfs.txt +++ b/source/crud/gridfs.txt @@ -1,8 +1,8 @@ .. _kotlin-sync-gridfs: -============================== -Large File Storage with GridFS -============================== +================= +Store Large Files +================= .. contents:: On this page :local: diff --git a/source/crud/transactions.txt b/source/crud/transactions.txt index aa5fb55e..0bdd4178 100644 --- a/source/crud/transactions.txt +++ b/source/crud/transactions.txt @@ -1,8 +1,8 @@ .. _kotlin-sync-write-transactions: -============ -Transactions -============ +========================= +Transactions and Sessions +========================= .. contents:: On this page :local: diff --git a/source/data-formats/custom-types.txt b/source/data-formats/custom-types.txt index e6847f38..f63c08e7 100644 --- a/source/data-formats/custom-types.txt +++ b/source/data-formats/custom-types.txt @@ -1,8 +1,8 @@ .. _kotlin-sync-custom-types: -============ -Custom Types -============ +================= +Custom Data Types +================= .. contents:: On this page :local: diff --git a/source/data-formats/serialization.txt b/source/data-formats/serialization.txt index fd211fee..adac7f91 100644 --- a/source/data-formats/serialization.txt +++ b/source/data-formats/serialization.txt @@ -1,8 +1,8 @@ .. _kotlin-sync-serialization: -==================== -Kotlin Serialization -==================== +================== +Data Serialization +================== .. facet:: :name: genre diff --git a/source/data-formats/time-series.txt b/source/data-formats/time-series.txt index 09321d12..62894248 100644 --- a/source/data-formats/time-series.txt +++ b/source/data-formats/time-series.txt @@ -1,8 +1,8 @@ .. _kotlin-sync-time-series: -================ -Time Series Data -================ +======================= +Time Series Collections +======================= .. contents:: On this page :local: diff --git a/source/get-started.txt b/source/get-started.txt index a54c0c12..94ff61f6 100644 --- a/source/get-started.txt +++ b/source/get-started.txt @@ -1,8 +1,8 @@ .. _kotlin-sync-get-started: -======================================= -Get Started with the Kotlin Sync Driver -======================================= +=========== +Get Started +=========== .. contents:: On this page :local: diff --git a/source/index.txt b/source/index.txt index a0b427f6..0b33e297 100644 --- a/source/index.txt +++ b/source/index.txt @@ -13,7 +13,7 @@ .. toctree:: - Get Started + Getting Started Connect CRUD Operations Aggregation @@ -23,7 +23,7 @@ Run a Database Command Atlas Search Atlas Vector Search - Monitoring and Logging + Logging and Monitoring Security Reference API Documentation diff --git a/source/issues-and-help.txt b/source/issues-and-help.txt index 6f360e9d..9293b5d7 100644 --- a/source/issues-and-help.txt +++ b/source/issues-and-help.txt @@ -1,8 +1,8 @@ .. _kotlin-sync-issues-and-help: -============= -Issues & Help -============= +============================ +Report Issues & Request Help +============================ .. facet:: :name: genre diff --git a/source/monitoring-and-logging.txt b/source/logging-and-monitoring.txt similarity index 65% rename from source/monitoring-and-logging.txt rename to source/logging-and-monitoring.txt index c3ce2849..1476a79c 100644 --- a/source/monitoring-and-logging.txt +++ b/source/logging-and-monitoring.txt @@ -1,7 +1,7 @@ .. _kotlin-sync-monitoring-logging: ====================== -Monitoring and Logging +Logging and Monitoring ====================== .. facet:: @@ -13,9 +13,9 @@ Monitoring and Logging .. toctree:: - Monitoring - Logging - Change Streams + Monitoring + Logging + Change Streams Overview -------- diff --git a/source/monitoring-and-logging/change-streams.txt b/source/logging-and-monitoring/change-streams.txt similarity index 98% rename from source/monitoring-and-logging/change-streams.txt rename to source/logging-and-monitoring/change-streams.txt index 7d293f91..7d41df95 100644 --- a/source/monitoring-and-logging/change-streams.txt +++ b/source/logging-and-monitoring/change-streams.txt @@ -1,8 +1,8 @@ .. _kotlin-sync-change-streams: -==================== -Monitor Data Changes -==================== +================================ +Monitor Data with Change Streams +================================ .. contents:: On this page :local: diff --git a/source/monitoring-and-logging/logging.txt b/source/logging-and-monitoring/logging.txt similarity index 100% rename from source/monitoring-and-logging/logging.txt rename to source/logging-and-monitoring/logging.txt diff --git a/source/monitoring-and-logging/monitoring.txt b/source/logging-and-monitoring/monitoring.txt similarity index 99% rename from source/monitoring-and-logging/monitoring.txt rename to source/logging-and-monitoring/monitoring.txt index d400b1ff..3485417b 100644 --- a/source/monitoring-and-logging/monitoring.txt +++ b/source/logging-and-monitoring/monitoring.txt @@ -1,6 +1,6 @@ -========== -Monitoring -========== +========================== +Monitor Application Events +========================== .. contents:: On this page :local: diff --git a/source/reference.txt b/source/reference.txt index 3ef97302..fcc9dfe2 100644 --- a/source/reference.txt +++ b/source/reference.txt @@ -10,4 +10,4 @@ Reference Release Notes Compatibility - Upgrade Guides \ No newline at end of file + Upgrade \ No newline at end of file diff --git a/source/reference/compatibility.txt b/source/reference/compatibility.txt index c931f398..c3738226 100644 --- a/source/reference/compatibility.txt +++ b/source/reference/compatibility.txt @@ -1,8 +1,8 @@ .. _kotlin-sync-compatibility: -============= -Compatibility -============= +==================== +Driver Compatibility +==================== .. contents:: On this page :local: diff --git a/source/reference/upgrade.txt b/source/reference/upgrade.txt index 22aad04f..d1c97a35 100644 --- a/source/reference/upgrade.txt +++ b/source/reference/upgrade.txt @@ -1 +1,11 @@ -.. _kotlin-sync-upgrade: \ No newline at end of file +.. _kotlin-sync-upgrade: + +======================= +Upgrade Driver Versions +======================= + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol \ No newline at end of file diff --git a/source/security.txt b/source/security.txt index f80c3a23..5c605dcb 100644 --- a/source/security.txt +++ b/source/security.txt @@ -8,10 +8,10 @@ Secure Your Data :titlesonly: :maxdepth: 1 + TLS Authentication Enterprise Authentication In-Use Encryption - TLS Security Protocol Validate Driver Artifact Signatures .. placeholder \ No newline at end of file diff --git a/source/security/tls.txt b/source/security/tls.txt index 3bb8aebf..6c9dc453 100644 --- a/source/security/tls.txt +++ b/source/security/tls.txt @@ -1,8 +1,8 @@ .. _kotlin-sync-tls: -========================== -Enable TLS on a Connection -========================== +============================== +Enable TLS/SSL on a Connection +============================== .. facet:: :name: genre From 5e6912d3f5bcdb72b3bae63795b77e477d39b804 Mon Sep 17 00:00:00 2001 From: Angela Date: Mon, 7 Jul 2025 15:14:34 -0400 Subject: [PATCH 08/12] fix quick bugs --- source/index.txt | 4 ++-- source/logging-and-monitoring.txt | 2 +- source/logging-and-monitoring/logging.txt | 9 +++++++++ 3 files changed, 12 insertions(+), 3 deletions(-) diff --git a/source/index.txt b/source/index.txt index 0b33e297..7976b532 100644 --- a/source/index.txt +++ b/source/index.txt @@ -99,11 +99,11 @@ Atlas Vector Search Learn how to run Atlas Vector Search queries in the :ref:`kotlin-sync-atlas-vector-search` section. -Monitoring and Logging +Logging and Monitoring ---------------------- Learn how to monitor changes to your application and write them to logs in the -:ref:`kotlin-sync-monitoring-logging` section. +:ref:`kotlin-sync-logging-monitoring` section. Secure Your Data ---------------- diff --git a/source/logging-and-monitoring.txt b/source/logging-and-monitoring.txt index 1476a79c..16c8c6c9 100644 --- a/source/logging-and-monitoring.txt +++ b/source/logging-and-monitoring.txt @@ -1,4 +1,4 @@ -.. _kotlin-sync-monitoring-logging: +.. _kotlin-sync-logging-monitoring: ====================== Logging and Monitoring diff --git a/source/logging-and-monitoring/logging.txt b/source/logging-and-monitoring/logging.txt index e69de29b..5ad75e51 100644 --- a/source/logging-and-monitoring/logging.txt +++ b/source/logging-and-monitoring/logging.txt @@ -0,0 +1,9 @@ +================= +Log Driver Events +================= + +.. contents:: On this page + :local: + :backlinks: none + :depth: 2 + :class: singlecol \ No newline at end of file From ec339ed89bc4ad9cbb92bc9051fef808ec63d56b Mon Sep 17 00:00:00 2001 From: Angela Date: Mon, 7 Jul 2025 15:32:13 -0400 Subject: [PATCH 09/12] add db coll section --- source/databases-collections | 11 +++++++++++ source/index.txt | 7 +++++++ 2 files changed, 18 insertions(+) create mode 100644 source/databases-collections diff --git a/source/databases-collections b/source/databases-collections new file mode 100644 index 00000000..3f85571e --- /dev/null +++ b/source/databases-collections @@ -0,0 +1,11 @@ +.. _kotlin-sync-db-collections: + +========================= +Databases and Collections +========================= + +.. contents:: On this page + :local: + :backlinks: none + :depth: 2 + :class: singlecol \ No newline at end of file diff --git a/source/index.txt b/source/index.txt index 7976b532..7095168c 100644 --- a/source/index.txt +++ b/source/index.txt @@ -15,6 +15,7 @@ Getting Started Connect + Databases & Collections CRUD Operations Aggregation Builders @@ -56,6 +57,12 @@ Connect to MongoDB Learn how to create and configure a connection to a MongoDB deployment in the :ref:`kotlin-sync-connect` section. +Databases and Collections +------------------------- + +Learn how to interact wth MongoDB databases and collections in the +:ref:`kotlin-sync-db-collections` section. + Read and Write Data ------------------- From 36f824cdfdde0fdc009f45e5f83fbee1b6425295 Mon Sep 17 00:00:00 2001 From: Angela Date: Mon, 7 Jul 2025 15:44:02 -0400 Subject: [PATCH 10/12] fix file --- source/{databases-collections => databases-collections.txt} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename source/{databases-collections => databases-collections.txt} (100%) diff --git a/source/databases-collections b/source/databases-collections.txt similarity index 100% rename from source/databases-collections rename to source/databases-collections.txt From 551f22de3fd87d253dd1b38cab0e28bca77776a7 Mon Sep 17 00:00:00 2001 From: Angela Date: Mon, 7 Jul 2025 15:56:52 -0400 Subject: [PATCH 11/12] fix typo --- source/index.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/index.txt b/source/index.txt index 7095168c..f02e7482 100644 --- a/source/index.txt +++ b/source/index.txt @@ -60,7 +60,7 @@ in the :ref:`kotlin-sync-connect` section. Databases and Collections ------------------------- -Learn how to interact wth MongoDB databases and collections in the +Learn how to interact with MongoDB databases and collections in the :ref:`kotlin-sync-db-collections` section. Read and Write Data From ae0d5624cb4c0707842232b5224a3987f44908fe Mon Sep 17 00:00:00 2001 From: Angela Date: Mon, 7 Jul 2025 16:29:00 -0400 Subject: [PATCH 12/12] nr feedback --- source/atlas-search.txt | 6 +++--- source/data-formats.txt | 6 +++--- source/data-formats/bson.txt | 6 +++--- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/source/atlas-search.txt b/source/atlas-search.txt index e0501710..483dc91b 100644 --- a/source/atlas-search.txt +++ b/source/atlas-search.txt @@ -1,5 +1,5 @@ .. _kotlin-sync-atlas-search: -================================ -Run an Atlas Vector Search Query -================================ \ No newline at end of file +========================= +Run an Atlas Search Query +========================= \ No newline at end of file diff --git a/source/data-formats.txt b/source/data-formats.txt index 9f2326c9..b1cad2cd 100644 --- a/source/data-formats.txt +++ b/source/data-formats.txt @@ -1,8 +1,8 @@ .. _kotlin-sync-data-formats: -======================== -Specialized Data Formats -======================== +============ +Data Formats +============ .. contents:: On this page :local: diff --git a/source/data-formats/bson.txt b/source/data-formats/bson.txt index 86f882b8..c512f9c8 100644 --- a/source/data-formats/bson.txt +++ b/source/data-formats/bson.txt @@ -1,8 +1,8 @@ .. _kotlin-sync-bson: -==== -BSON -==== +=================== +Work with BSON Data +=================== .. contents:: On this page :local: