diff --git a/config/redirects b/config/redirects index 9544ef3f..b2477918 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}/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 +[*-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..483dc91b --- /dev/null +++ b/source/atlas-search.txt @@ -0,0 +1,5 @@ +.. _kotlin-sync-atlas-search: + +========================= +Run an Atlas Search Query +========================= \ 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..cf6585fe --- /dev/null +++ b/source/atlas-vector-search.txt @@ -0,0 +1,5 @@ +.. _kotlin-sync-atlas-vector-search: + +================================ +Run an Atlas Vector Search Query +================================ \ No newline at end of file diff --git a/source/connect.txt b/source/connect.txt index 326c008d..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: @@ -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..2c065e10 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 + + Stable API + Limit Server Execution Time + +.. /connect/network-compression +.. /connect/server-selection + Overview -------- 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: 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..f2e20e7b --- /dev/null +++ b/source/crud/configure.txt @@ -0,0 +1,11 @@ +.. _kotlin-sync-configure: + +========================= +Configure CRUD Operations +========================= + +.. contents:: On this page + :local: + :backlinks: none + :depth: 2 + :class: singlecol \ 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..1dbb1b00 --- /dev/null +++ b/source/crud/gridfs.txt @@ -0,0 +1,11 @@ +.. _kotlin-sync-gridfs: + +================= +Store Large Files +================= + +.. contents:: On this page + :local: + :backlinks: none + :depth: 2 + :class: singlecol \ 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..4302e94d --- /dev/null +++ b/source/crud/query.txt @@ -0,0 +1,32 @@ +.. _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 + +.. 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-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/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 98% rename from source/write/transactions.txt rename to source/crud/transactions.txt index aa5fb55e..0bdd4178 100644 --- a/source/write/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/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..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: @@ -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/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: diff --git a/source/data-formats/custom-types.txt b/source/data-formats/custom-types.txt new file mode 100644 index 00000000..f63c08e7 --- /dev/null +++ b/source/data-formats/custom-types.txt @@ -0,0 +1,26 @@ +.. _kotlin-sync-custom-types: + +================= +Custom Data Types +================= + +.. 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 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 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/databases-collections.txt b/source/databases-collections.txt new file mode 100644 index 00000000..3f85571e --- /dev/null +++ b/source/databases-collections.txt @@ -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/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 e76b60ce..f02e7482 100644 --- a/source/index.txt +++ b/source/index.txt @@ -13,24 +13,23 @@ .. toctree:: - Get Started + Getting Started Connect - Write Data - Read Data - Indexes - Data Aggregation - Aggregation Operations - Specialized Data Formats + Databases & Collections + CRUD Operations + Aggregation Builders - Run a Command - Monitoring + Data Formats + Indexes + Run a Database Command + Atlas Search + Atlas Vector Search + Logging and Monitoring Security - Compatibility - Validate Driver Signatures - What's New + Reference + API Documentation Issues & Help View the Source - API Documentation Introduction ------------ @@ -58,67 +57,85 @@ 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 ---------------------- +Databases and Collections +------------------------- -Learn how you can write data to MongoDB in the :ref:`kotlin-sync-write` section. +Learn how to interact with MongoDB databases and collections in the +:ref:`kotlin-sync-db-collections` section. -Read Data ---------- +Read and Write Data +------------------- -Learn how you can retrieve data from MongoDB in the :ref:`kotlin-sync-read` section. - -Optimize Queries with Indexes ------------------------------ - -Learn how to work with common types of indexes in the :ref:`kotlin-sync-indexes` -section. +Learn how to find, update, and delete data in the :ref:`kotlin-sync-crud-landing` section. Transform Your Data with Aggregation ------------------------------------- +------------------------------------- Learn how to use the {+driver-short+} to perform aggregation operations in the :ref:`kotlin-sync-aggregation` section. -Learn how to use aggregation expression operations to build -aggregation stages in the :ref:`kotlin-sync-aggregation-expression-operations` section. +Builders +-------- + +Learn how to use builder classes to efficiently build queries and aggregations in the +:ref:`kotlin-sync-builders` section. -Specialized Data Formats ------------------------- +Data Formats +------------ -Learn how to work with specialized data formats and custom types in the +Learn how to work with BSON and other data formats in the :ref:`kotlin-sync-data-formats` section. -Use Builders API ----------------- +Optimize Queries with Indexes +----------------------------- -Learn how to work with the builder operation helpers in the :ref:`kotlin-sync-builders` section. +Learn how to work with common types of indexes in the :ref:`kotlin-sync-indexes` section. -Compatibility -------------- +Run a Database Command +---------------------- + +Learn how to run a database command in the :ref:`kotlin-run-command` section. + +Atlas Search +------------ + +Learn how to run Atlas Search queries in the :ref:`kotlin-sync-atlas-search` section. + +Atlas Vector Search +------------------- -For the compatibility charts that show the recommended {+driver-short+} version for each -MongoDB Server version, see the :ref:`Compatibility -` section. +Learn how to run Atlas Vector Search queries in the :ref:`kotlin-sync-atlas-vector-search` section. -Validate Driver Artifact Signatures ------------------------------------ +Logging and Monitoring +---------------------- + +Learn how to monitor changes to your application and write them to logs in the +:ref:`kotlin-sync-logging-monitoring` section. + +Secure Your Data +---------------- + +Learn about ways you can authenticate your application and encrypt your data in +the :ref:`kotlin-sync-security` section. + +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/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/logging-and-monitoring.txt b/source/logging-and-monitoring.txt new file mode 100644 index 00000000..16c8c6c9 --- /dev/null +++ b/source/logging-and-monitoring.txt @@ -0,0 +1,24 @@ +.. _kotlin-sync-logging-monitoring: + +====================== +Logging and Monitoring +====================== + +.. 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/logging-and-monitoring/change-streams.txt similarity index 98% rename from source/read/change-streams.txt rename to source/logging-and-monitoring/change-streams.txt index 7d293f91..7d41df95 100644 --- a/source/read/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/logging-and-monitoring/logging.txt b/source/logging-and-monitoring/logging.txt new file mode 100644 index 00000000..5ad75e51 --- /dev/null +++ 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 diff --git a/source/monitoring.txt b/source/logging-and-monitoring/monitoring.txt similarity index 99% rename from source/monitoring.txt rename to source/logging-and-monitoring/monitoring.txt index d400b1ff..3485417b 100644 --- a/source/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/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..fcc9dfe2 --- /dev/null +++ b/source/reference.txt @@ -0,0 +1,13 @@ +.. _kotlin-sync-reference: + +========== +Reference +========== + +.. toctree:: + :titlesonly: + :maxdepth: 1 + + Release Notes + Compatibility + Upgrade \ No newline at end of file diff --git a/source/compatibility.txt b/source/reference/compatibility.txt similarity index 95% rename from source/compatibility.txt rename to source/reference/compatibility.txt index c931f398..c3738226 100644 --- a/source/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 new file mode 100644 index 00000000..d1c97a35 --- /dev/null +++ b/source/reference/upgrade.txt @@ -0,0 +1,11 @@ +.. _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/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..5c605dcb 100644 --- a/source/security.txt +++ b/source/security.txt @@ -1,3 +1,4 @@ +.. _kotlin-sync-security: ================ Secure Your Data @@ -7,8 +8,10 @@ Secure Your Data :titlesonly: :maxdepth: 1 + TLS Authentication Enterprise Authentication In-Use Encryption + 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 99% rename from source/connect/tls.txt rename to source/security/tls.txt index 3bb8aebf..6c9dc453 100644 --- a/source/connect/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 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.