Skip to content

[Backport v1.18] DOCSP-42966 - Remove nested components #122

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 1 commit into from
Sep 3, 2024
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: 10 additions & 25 deletions source/includes/extracts-watch-option.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,10 @@ content: |
the maximum number of change events to return in each response from the
server.

.. note::

Irrespective of the ``batchSize`` option, the initial ``aggregate`` command
response for a change stream generally does not include any documents
unless another option is used to configure its starting point (e.g.
``startAfter``).
Irrespective of the ``batchSize`` option, the initial ``aggregate`` command
response for a change stream generally does not include any documents
unless another option is used to configure its starting point (e.g.
``startAfter``).
---
ref: watch-option-fullDocument
content: |
Expand All @@ -37,9 +35,7 @@ content: |
- ``MongoDB\Operation\Watch::FULL_DOCUMENT_WHEN_AVAILABLE``
- ``MongoDB\Operation\Watch::FULL_DOCUMENT_REQUIRED``

.. note::

This is an option of the ``$changeStream`` pipeline stage.
This is an option of the ``$changeStream`` pipeline stage.
---
ref: watch-option-fullDocumentBeforeChange
content: |
Expand All @@ -57,9 +53,7 @@ content: |
- ``MongoDB\Operation\Watch::FULL_DOCUMENT_BEFORE_CHANGE_WHEN_AVAILABLE``
- ``MongoDB\Operation\Watch::FULL_DOCUMENT_BEFORE_CHANGE_REQUIRED``

.. note::

This is an option of the ``$changeStream`` pipeline stage.
This is an option of the ``$changeStream`` pipeline stage.

.. versionadded:: 1.13
---
Expand All @@ -77,9 +71,7 @@ content: |
``startAtOperationTime`` will result in a server error. The options are
mutually exclusive.

.. note::

This is an option of the ``$changeStream`` pipeline stage.
This is an option of the ``$changeStream`` pipeline stage.
---
ref: watch-option-showExpandedEvents
content: |
Expand All @@ -97,9 +89,7 @@ content: |
This is not supported for server versions prior to 6.0 and will result in an
exception at execution time if used.

.. note::

This is an option of the ``$changeStream`` pipeline stage.
This is an option of the ``$changeStream`` pipeline stage.

.. versionadded:: 1.13
---
Expand All @@ -117,9 +107,7 @@ content: |
This is not supported for server versions prior to 4.2 and will result in an
exception at execution time if used.

.. note::

This is an option of the ``$changeStream`` pipeline stage.
This is an option of the ``$changeStream`` pipeline stage.

.. versionadded:: 1.5
---
Expand All @@ -137,7 +125,4 @@ content: |
This is not supported for server versions prior to 4.0 and will result in an
exception at execution time if used.

.. note::

This is an option of the ``$changeStream`` pipeline stage.
...
This is an option of the ``$changeStream`` pipeline stage.
10 changes: 4 additions & 6 deletions source/reference/method/MongoDBClient__construct.txt
Original file line number Diff line number Diff line change
Expand Up @@ -96,12 +96,10 @@ Parameters
'platform' => 'some-platform',
]

.. note::

This feature is primarily designed for custom drivers and ODMs,
which may want to identify themselves to the server for diagnostic
purposes. Applications wishing to identify themselves should use the
``appName`` URI option instead of this option.
This feature is primarily designed for custom drivers and ODMs,
which may want to identify themselves to the server for diagnostic
purposes. Applications wishing to identify themselves should use the
``appName`` URI option instead of this option.

.. versionadded:: 1.7

Expand Down
10 changes: 4 additions & 6 deletions source/reference/method/MongoDBCollection-drop.txt
Original file line number Diff line number Diff line change
Expand Up @@ -54,12 +54,10 @@ Parameters
`Field Encryption and Queryability <https://www.mongodb.com/docs/manual/core/queryable-encryption/fundamentals/encrypt-and-query/>`_
in the MongoDB manual for more information.

.. note::

This option is not passed to the
:manual:`drop </reference/command/drop>` command. The library uses
it to determine related metadata collections that should be dropped
in addition to an encrypted collection.
This option is not passed to the
:manual:`drop </reference/command/drop>` command. The library uses
it to determine related metadata collections that should be dropped
in addition to an encrypted collection.

.. versionadded:: 1.13

Expand Down
6 changes: 2 additions & 4 deletions source/reference/method/MongoDBCollection-mapReduce.txt
Original file line number Diff line number Diff line change
Expand Up @@ -92,10 +92,8 @@ Parameters
- :php:`MongoDB\BSON\Javascript <class.mongodb-bson-javascript>`
- Follows the reduce method and modifies the output.

.. note::

Passing a Javascript instance with a scope is deprecated. Put all
scope variables in the ``scope`` option of the MapReduce operation.
Passing a Javascript instance with a scope is deprecated. Put all
scope variables in the ``scope`` option of the MapReduce operation.

* - jsMode
- boolean
Expand Down
32 changes: 13 additions & 19 deletions source/reference/method/MongoDBDatabase-createCollection.txt
Original file line number Diff line number Diff line change
Expand Up @@ -148,12 +148,10 @@ Parameters

Defaults to ``1``.

.. note::

MongoDB 3.0 and later ignores the ``usePowerOf2Sizes`` flag. See
:manual:`collMod </reference/command/collMod>` and
:manual:`db.createCollection()
</reference/method/db.createCollection>` for more information.
MongoDB 3.0 and later ignores the ``usePowerOf2Sizes`` flag. See
:manual:`collMod </reference/command/collMod>` and
:manual:`db.createCollection()
</reference/method/db.createCollection>` for more information.

* - indexOptionDefaults
- array|object
Expand Down Expand Up @@ -299,27 +297,23 @@ Parameters
exception of :query:`$near`, :query:`$nearSphere`,
:query:`$text`, and :query:`$where`.

.. note::

- Validation occurs during updates and inserts. Existing documents
do not undergo validation checks until modification.
Validation occurs during updates and inserts. Existing documents
do not undergo validation checks until modification.

- You cannot specify a validator for collections in the ``admin``,
``local``, and ``config`` databases.
You cannot specify a validator for collections in the ``admin``,
``local``, and ``config`` databases.

- You cannot specify a validator for ``system.*`` collections.
You cannot specify a validator for ``system.*`` collections.

* - viewOn
- string
- The name of the source collection or view from which to create the view.

.. note::
The name is not the full namespace of the collection or view (i.e.
it does not include the database name). Views must be created in the
same databases as the source collection or view.

The name is not the full namespace of the collection or view (i.e.
it does not include the database name). Views must be created in the
same databases as the source collection or view.

.. versionadded:: 1.13
.. versionadded:: 1.13

* - writeConcern
- :php:`MongoDB\Driver\WriteConcern <class.mongodb-driver-writeconcern>`
Expand Down
10 changes: 4 additions & 6 deletions source/reference/method/MongoDBDatabase-dropCollection.txt
Original file line number Diff line number Diff line change
Expand Up @@ -60,12 +60,10 @@ Parameters
`Field Encryption and Queryability <https://www.mongodb.com/docs/manual/core/queryable-encryption/fundamentals/encrypt-and-query/>`_
in the MongoDB manual for more information.

.. note::

This option is not passed to the
:manual:`drop </reference/command/drop>` command. The library uses
it to determine related metadata collections that should be dropped
in addition to an encrypted collection.
This option is not passed to the
:manual:`drop </reference/command/drop>` command. The library uses
it to determine related metadata collections that should be dropped
in addition to an encrypted collection.

.. versionadded:: 1.13

Expand Down