Skip to content

DOCSP-47058: Shift TOC #251

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
May 21, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 34 additions & 1 deletion config/redirects
Original file line number Diff line number Diff line change
Expand Up @@ -59,4 +59,37 @@ raw: ${prefix}/stable -> ${base}/current/
[*-v1.19]: ${prefix}/${version}/tutorial/example-data/ -> ${base}/v1.x/
[*-v1.19]: ${prefix}/${version}/tutorial/modeling-bson-data/ -> ${base}/v1.x/data-formats/modeling-bson-data/
[*-v1.19]: ${prefix}/${version}/tutorial/stable-api/ -> ${base}/v1.x/stable-api/
[*-v1.19]: ${prefix}/${version}/tutorial/aws-lambda/ -> ${base}/v1.x/aws-lambda/
[*-v1.19]: ${prefix}/${version}/tutorial/aws-lambda/ -> ${base}/v1.x/aws-lambda/

# comprehensive coverage redirects
[*-master]: ${prefix}/${version}/aggregation/atlas-search/ -> ${base}/${version}/atlas-search/
[*-master]: ${prefix}/${version}/aws-lambda/ -> ${base}/${version}/connect/aws-lambda/
[*-master]: ${prefix}/${version}/connect/stable-api/ -> ${base}/${version}/connect/connection-options/stable-api/
[*-master]: ${prefix}/${version}/builders/ -> ${base}/${version}/crud/builders/
[*-master]: ${prefix}/${version}/write/bulk-write/ -> ${base}/${version}/crud/bulk-write/
[*-master]: ${prefix}/${version}/write/delete/ -> ${base}/${version}/crud/delete/
[*-master]: ${prefix}/${version}/write/gridfs/ -> ${base}/${version}/crud/gridfs/
[*-master]: ${prefix}/${version}/write/insert/ -> ${base}/${version}/crud/insert/
[*-master]: ${prefix}/${version}/read/count/ -> ${base}/${version}/crud/query/count/
[*-master]: ${prefix}/${version}/read/cursor/ -> ${base}/${version}/crud/query/cursor/
[*-master]: ${prefix}/${version}/read/distinct/ -> ${base}/${version}/crud/query/distinct/
[*-master]: ${prefix}/${version}/read/project/ -> ${base}/${version}/crud/query/project/
[*-master]: ${prefix}/${version}/read/retrieve/ -> ${base}/${version}/crud/query/retrieve/
[*-master]: ${prefix}/${version}/read/specify-a-query/ -> ${base}/${version}/crud/query/specify-a-query/
[*-master]: ${prefix}/${version}/read/specify-documents-to-return/ -> ${base}/${version}/crud/query/specify-documents-to-return/
[*-master]: ${prefix}/${version}/read-write-pref/ -> ${base}/${version}/crud/read-write-pref/
[*-master]: ${prefix}/${version}/write/replace/ -> ${base}/${version}/crud/replace/
[*-master]: ${prefix}/${version}/write/transaction/ -> ${base}/${version}/crud/transaction/
[*-master]: ${prefix}/${version}/write/update/ -> ${base}/${version}/crud/update/
[*-master]: ${prefix}/${version}/data-formats/codecs/ -> ${base}/${version}/data-formats/custom-types/codecs/
[*-master]: ${prefix}/${version}/databases-collections/time-series/ -> ${base}/${version}/data-formats/time-series/
[*-master]: ${prefix}/${version}/read/change-streams/ -> ${base}/${version}/monitoring-logging/change-streams/
[*-master]: ${prefix}/${version}/monitoring/cluster-monitoring/ -> ${base}/${version}/monitoring-logging/cluster-monitoring/
[*-master]: ${prefix}/${version}/compatibility/ -> ${base}/${version}/references/compatibility/
[*-master]: ${prefix}/${version}/whats-new/ -> ${base}/${version}/references/release-notes/
[*-master]: ${prefix}/${version}/upgrade/ -> ${base}/${version}/references/upgrade/
[*-master]: ${prefix}/${version}/connect/tls/ -> ${base}/${version}/security/tls/
[*-master]: ${prefix}/${version}/aggregation/vector-search/ -> ${base}/${version}/vector-search/
[*-master]: ${prefix}/${version}/monitoring/ -> ${base}/${version}/monitoring-logging/
[*-master]: ${prefix}/${version}/read/ -> ${base}/${version}/crud/
[*-master]: ${prefix}/${version}/write/ -> ${base}/${version}/crud/
9 changes: 4 additions & 5 deletions snooty.toml
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,13 @@ toc_landing_pages = [
"/reference/class/MongoDBModelDatabaseInfo",
"/reference/class/MongoDBModelIndexInfo",
"/connect",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

S: add /connect/connection-options/

"/read",
"/databases-collections",
"/write",
"/connect/connection-options/",
"/aggregation",
"/data-formats",
"/data-formats/custom-types",
"/indexes",
"/security",
"/data-formats",
"/upgrade",
"/aggregation",
]

sharedinclude_root = "https://raw.githubusercontent.com/10gen/docs-shared/main/"
Expand Down
7 changes: 0 additions & 7 deletions source/aggregation.txt
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,6 @@ Transform Your Data with Aggregation
:depth: 2
:class: singlecol

.. toctree::
:titlesonly:
:maxdepth: 1

Atlas Search </aggregation/atlas-search>
Atlas Vector Search </aggregation/vector-search>

Overview
--------

Expand Down
File renamed without changes.
8 changes: 5 additions & 3 deletions source/connect.txt
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,12 @@ Connect to MongoDB
:maxdepth: 1

Create a Client </connect/client>
Specify Connection Options </connect/connection-options>
Choose a Connection Target </connect/connection-targets>
Configure TLS </connect/tls>
Stable API </connect/stable-api>
Connection Options </connect/connection-options>
Connect with AWS Lambda </connect/aws-lambda>

.. TODO:
Connection Troubleshooting </connect/connection-troubleshooting>

Overview
--------
Expand Down
File renamed without changes.
8 changes: 8 additions & 0 deletions source/connect/connection-options.txt
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,14 @@ Specify Connection Options
.. meta::
:keywords: connection string, URI, server, Atlas, settings, configure

.. toctree::

Stable API </connect/connection-options/stable-api>

.. TODO:
Compress Network Traffic </connect/connection-options/network-compression>
Connection Pools </connect/connection-options/connection-pools>

Overview
--------

Expand Down
49 changes: 49 additions & 0 deletions source/crud.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
.. _php-crud-operations:

===============
CRUD Operations
===============

.. contents:: On this page
:local:
:backlinks: none
:depth: 2
:class: singlecol

.. facet::
:name: genre
:values: reference

.. meta::
:description: Learn how to use the {+library-short+} to read and write MongoDB data.
:keywords: usage examples, query, find, code example, save, create

.. toctree::
:titlesonly:
:maxdepth: 1

Insert Documents </crud/insert>
Query Documents </crud/query>
Update Documents </crud/update>
Replace Documents </crud/replace>
Delete Documents </crud/delete>
Bulk Write Operations </crud/bulk-write>
Transactions </crud/transaction>
Configure CRUD Operations </crud/read-write-pref>
Store Large Files </crud/gridfs>
Operations with Builders </crud/builders>

CRUD (Create, Read, Update, Delete) operations enable you to work with
data stored in MongoDB. To learn more about running CRUD operations on
your data, visit the following guides:

- :ref:`php-write-insert`
- :ref:`php-query`
- :ref:`php-write-update`
- :ref:`php-write-replace`
- :ref:`php-write-delete`
- :ref:`php-bulk-write`
- :ref:`php-transactions`
- :ref:`php-read-write-pref`
- :ref:`php-gridfs`
- :ref:`php-builders`
File renamed without changes.
2 changes: 1 addition & 1 deletion source/write/bulk-write.txt → source/crud/bulk-write.txt
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ specify the write operations:
.. tip::

For more information about delete, insert, replace, and update
operations, see the :ref:`Write operation guides <php-write>`.
operations, see the :ref:`php-crud-operations` guides.

When you call the ``bulkWrite()`` method, the library automatically runs the
write operations in the order they're specified in the array. To learn how to
Expand Down
File renamed without changes.
File renamed without changes.
3 changes: 0 additions & 3 deletions source/write/insert.txt → source/crud/insert.txt
Original file line number Diff line number Diff line change
Expand Up @@ -158,9 +158,6 @@ insert operation bypasses document-level validation:
Additional Information
----------------------

To view runnable code examples of inserting documents with the {+php-library+}, see
:ref:`php-write`.

API Documentation
~~~~~~~~~~~~~~~~~

Expand Down
37 changes: 37 additions & 0 deletions source/crud/query.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
.. _php-query:

================
Query Operations
================

.. meta::
:description: Learn how to use the {+library-short+} to read data from MongoDB.
:keywords: usage examples, query, find, code example

.. facet::
:name: genre
:values: reference

.. meta::
:keywords: code example, node.js, sample dataset

.. toctree::
:maxdepth: 1

Find Documents </crud/query/retrieve>
Specify Documents to Return </crud/query/specify-documents-to-return>
Specify Fields to Return </crud/query/project>
Specify a Query </crud/query/specify-a-query>
Count Documents </crud/query/count>
Distinct Field Values </crud/query/distinct>
Access Data from a Cursor </crud/query/cursor>

To learn more about querying data stored in MongoDB collections,
visit the following guides:

- :ref:`php-retrieve`
- :ref:`php-specify-documents-to-return`
- :ref:`php-project`
- :ref:`php-count`
- :ref:`php-distinct`
- :ref:`php-cursors`
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
3 changes: 0 additions & 3 deletions source/read/retrieve.txt → source/crud/query/retrieve.txt
Original file line number Diff line number Diff line change
Expand Up @@ -240,9 +240,6 @@ Additional Information

To learn more about query filters, see the :ref:`php-specify-query` guide.

To view code examples of retrieving documents with the {+php-library+},
see :ref:`php-read`.

API Documentation
~~~~~~~~~~~~~~~~~

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 2 additions & 0 deletions source/write/transaction.txt → source/crud/transaction.txt
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,8 @@ completes the following actions:

.. sharedinclude:: dbx/transactions-parallelism.rst

.. replacement:: driver-specific-content

Additional Information
----------------------

Expand Down
File renamed without changes.
6 changes: 3 additions & 3 deletions source/data-formats.txt
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@ Specialized Data Formats
:maxdepth: 1

Custom Data Types </data-formats/custom-types>
Codecs </data-formats/codecs>
Decimal128 </data-formats/decimal128>
BSON </data-formats/modeling-bson-data>
Time Series </data-formats/time-series>

Overview
--------
Expand All @@ -34,6 +34,6 @@ application. To learn how to work with these data formats, see the following
guides:

- :ref:`php-custom-types`
- :ref:`php-codecs`
- :ref:`php-decimal128`
- :ref:`php-bson`
- :ref:`php-bson`
- :ref:`php-time-series`
10 changes: 10 additions & 0 deletions source/data-formats/custom-types.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,16 @@
Custom Data-Types
=================

.. contents:: On this page
:local:
:backlinks: none
:depth: 2
:class: singlecol

.. toctree::
:maxdepth: 1

Codecs </data-formats/custom-types/codecs>

.. note::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
Codecs
======


.. contents:: On this page
:local:
:backlinks: none
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@ following Server manual entries:
- :manual:`Create and Query a Time Series Collection </core/timeseries/timeseries-procedures/>`
- :manual:`Set Granularity for Time Series Data </core/timeseries/timeseries-granularity/>`

To learn more about performing read operations, see :ref:`php-read`.
To learn more about performing query operations, see :ref:`php-query`.

To learn more about performing aggregation operations, see the :ref:`php-aggregation`
guide.
Expand Down
6 changes: 0 additions & 6 deletions source/databases-collections.txt
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,6 @@ Databases and Collections
.. meta::
:keywords: table, row, organize, storage, code example

.. toctree::
:titlesonly:
:maxdepth: 1

Time Series </databases-collections/time-series>

Overview
--------

Expand Down
4 changes: 2 additions & 2 deletions source/get-started.txt
Original file line number Diff line number Diff line change
Expand Up @@ -344,5 +344,5 @@ and retrieves a document that matches a query.

Learn more about the {+php-library+} from the following resources:

- Learn how to perform read operations in the :ref:`<php-read>` section.
- Learn how to perform write operations in the :ref:`<php-write>` section.
- Learn how to configure your MongoDB connection in the :ref:`php-connect` section.
- Learn how to perform read and write operations in the :ref:`php-crud-operations` section.
2 changes: 1 addition & 1 deletion source/includes/extracts-bucket-option.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
ref: bucket-option-codec
content: |
The :doc:`codec </data-formats/codecs>` to use for encoding or decoding documents.
The :ref:`php-codecs` to use for encoding or decoding documents.
This option is mutually exclusive with the ``typeMap`` option.

Defaults to the bucket's codec. Inheritance for a default ``codec`` option
Expand Down
2 changes: 1 addition & 1 deletion source/includes/extracts-collection-option.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
ref: collection-option-codec
content: |
The :doc:`codec </data-formats/codecs>` to use for encoding or decoding documents.
The :ref:`php-codecs` to use for encoding or decoding documents.
This option is mutually exclusive with the ``typeMap`` option.

Defaults to the collection's codec. Inheritance for a default ``codec`` option
Expand Down
2 changes: 1 addition & 1 deletion source/includes/extracts-common-option.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
ref: common-option-codec
content: |
The :doc:`codec </data-formats/codecs>` to use for encoding or decoding documents.
The :ref:`php-codecs` to use for encoding or decoding documents.
This option is mutually exclusive with the ``typeMap`` option.
---
ref: common-option-collation
Expand Down
Loading
Loading