diff --git a/source/includes/reference/find-one-parameters.rst b/source/includes/reference/find-one-parameters.rst new file mode 100644 index 00000000..0030c4e9 --- /dev/null +++ b/source/includes/reference/find-one-parameters.rst @@ -0,0 +1,119 @@ +``$filter`` : array|object + The filter criteria that specifies the documents to query. + +``$options`` : array + An array specifying the desired options. + + .. list-table:: + :header-rows: 1 + :widths: 20 20 80 + + * - Name + - Type + - Description + + * - allowDiskUse + - boolean + - Enables writing to temporary files. When set to ``true``, queries can + write data to the ``_tmp`` sub-directory in the ``dbPath`` directory. + + * - allowPartialResults + - boolean + - For queries against a sharded collection, returns partial results from + the :program:`mongos` if some shards are unavailable instead of + throwing an error. + + * - codec + - MongoDB\\Codec\\DocumentCodec + - .. include:: /includes/extracts/collection-option-codec.rst + + .. versionadded:: 1.17 + + * - collation + - array|object + - .. include:: /includes/extracts/collection-option-collation.rst + + * - comment + - mixed + - .. include:: /includes/extracts/common-option-comment.rst + + .. include:: /includes/extracts/common-option-comment-string-before-4.4.rst + + * - hint + - string|array|object + - .. include:: /includes/extracts/common-option-hint.rst + + .. versionadded:: 1.2 + + * - let + - array|object + - .. include:: /includes/extracts/common-option-let.rst + + .. versionadded:: 1.13 + + * - max + - array|object + - The exclusive upper bound for a specific index. + + .. versionadded:: 1.2 + + * - maxTimeMS + - integer + - .. include:: /includes/extracts/common-option-maxTimeMS.rst + + * - min + - array|object + - The inclusive lower bound for a specific index. + + .. versionadded:: 1.2 + + * - projection + - array|object + - The :ref:`projection specification ` to determine which + fields to include in the returned documents. See + :manual:`Project Fields to Return from Query ` + and :manual:`Projection Operators ` in + the MongoDB manual. + + * - readConcern + - :php:`MongoDB\Driver\ReadConcern ` + - .. include:: /includes/extracts/collection-option-readConcern.rst + + .. include:: /includes/extracts/common-option-readConcern-transaction.rst + + * - readPreference + - :php:`MongoDB\Driver\ReadPreference ` + - .. include:: /includes/extracts/collection-option-readPreference.rst + + * - returnKey + - boolean + - If true, returns only the index keys in the resulting documents. + + .. versionadded:: 1.2 + + * - session + - :php:`MongoDB\Driver\Session ` + - .. include:: /includes/extracts/common-option-session.rst + + .. versionadded:: 1.3 + + * - showRecordId + - boolean + - Determines whether to return the record identifier for each document. + If true, adds a field ``$recordId`` to the returned documents. + + .. versionadded:: 1.2 + + * - skip + - integer + - Number of documents to skip. Defaults to ``0``. + + * - sort + - array|object + - The sort specification for the ordering of the results. + + * - typeMap + - array + - .. include:: /includes/extracts/collection-option-typeMap.rst + + This will be used for the returned result document. diff --git a/source/includes/reference/find-parameters.rst b/source/includes/reference/find-parameters.rst new file mode 100644 index 00000000..3acee60b --- /dev/null +++ b/source/includes/reference/find-parameters.rst @@ -0,0 +1,160 @@ +``$filter`` : array|object + The filter criteria that specifies the documents to query. + +``$options`` : array + An array specifying the desired options. + + .. list-table:: + :header-rows: 1 + :widths: 20 20 80 + + * - Name + - Type + - Description + + * - allowDiskUse + - boolean + - Enables writing to temporary files. When set to ``true``, queries can + write data to the ``_tmp`` sub-directory in the ``dbPath`` directory. + + * - allowPartialResults + - boolean + - For queries against a sharded collection, returns partial results from + the :program:`mongos` if some shards are unavailable instead of + throwing an error. + + * - batchSize + - integer + - The number of documents to return in the first batch. Defaults to + ``101``. A batchSize of ``0`` means that the cursor will be + established, but no documents will be returned in the first batch. + + Unlike the previous wire protocol version, a batchSize of ``1`` for the + :dbcommand:`find` command does not close the cursor. + + * - codec + - MongoDB\\Codec\\DocumentCodec + - .. include:: /includes/extracts/collection-option-codec.rst + + .. versionadded:: 1.17 + + * - collation + - array|object + - .. include:: /includes/extracts/collection-option-collation.rst + + * - comment + - mixed + - .. include:: /includes/extracts/common-option-comment.rst + + .. include:: /includes/extracts/common-option-comment-string-before-4.4.rst + + * - cursorType + - integer + - Indicates the type of cursor to use. ``cursorType`` supports the + following values: + + - ``MongoDB\Operation\Find::NON_TAILABLE`` (*default*) + - ``MongoDB\Operation\Find::TAILABLE`` + + * - hint + - string|array|object + - .. include:: /includes/extracts/common-option-hint.rst + + .. versionadded:: 1.2 + + * - let + - array|object + - .. include:: /includes/extracts/common-option-let.rst + + .. versionadded:: 1.13 + + * - limit + - integer + - The maximum number of documents to return. If unspecified, then + defaults to no limit. A limit of ``0`` is equivalent to setting no + limit. + + A negative limit is similar to a positive limit but closes the cursor + after returning a single batch of results. As such, with a negative + limit, if the limited result set does not fit into a single batch, the + number of documents received will be less than the specified limit. By + passing a negative limit, the client indicates to the server that it + will not ask for a subsequent batch via getMore. + + * - max + - array|object + - The exclusive upper bound for a specific index. + + .. versionadded:: 1.2 + + * - maxAwaitTimeMS + - integer + - Positive integer denoting the time limit in milliseconds for the server + to block a getMore operation if no data is available. This option + should only be used if cursorType is ``TAILABLE_AWAIT``. + + .. versionadded:: 1.2 + + * - maxTimeMS + - integer + - .. include:: /includes/extracts/common-option-maxTimeMS.rst + + * - min + - array|object + - The inclusive lower bound for a specific index. + + .. versionadded:: 1.2 + + * - noCursorTimeout + - boolean + - Prevents the server from timing out idle cursors after an inactivity + period (10 minutes). + + * - projection + - array|object + - The :ref:`projection specification ` to determine which + fields to include in the returned documents. See + :manual:`Project Fields to Return from Query ` + and :manual:`Projection Operators ` in + the MongoDB manual. + + * - readConcern + - :php:`MongoDB\Driver\ReadConcern ` + - .. include:: /includes/extracts/collection-option-readConcern.rst + + .. include:: /includes/extracts/common-option-readConcern-transaction.rst + + * - readPreference + - :php:`MongoDB\Driver\ReadPreference ` + - .. include:: /includes/extracts/collection-option-readPreference.rst + + * - returnKey + - boolean + - If true, returns only the index keys in the resulting documents. + + .. versionadded:: 1.2 + + * - session + - :php:`MongoDB\Driver\Session ` + - .. include:: /includes/extracts/common-option-session.rst + + .. versionadded:: 1.3 + + * - showRecordId + - boolean + - Determines whether to return the record identifier for each document. + If true, adds a field ``$recordId`` to the returned documents. + + .. versionadded:: 1.2 + + * - skip + - integer + - Number of documents to skip. Defaults to ``0``. + + * - sort + - array|object + - The sort specification for the ordering of the results. + + * - typeMap + - array + - .. include:: /includes/extracts/collection-option-typeMap.rst diff --git a/source/reference/method/MongoDBCollection-find.txt b/source/reference/method/MongoDBCollection-find.txt index d6e5a74d..9468a679 100644 --- a/source/reference/method/MongoDBCollection-find.txt +++ b/source/reference/method/MongoDBCollection-find.txt @@ -2,8 +2,6 @@ MongoDB\\Collection::find() =========================== -.. default-domain:: mongodb - .. contents:: On this page :local: :backlinks: none @@ -27,203 +25,7 @@ Definition Parameters ---------- -``$filter`` : array|object - The filter criteria that specifies the documents to query. - -``$options`` : array - An array specifying the desired options. - - .. list-table:: - :header-rows: 1 - :widths: 20 20 80 - - * - Name - - Type - - Description - - * - allowDiskUse - - boolean - - Enables writing to temporary files. When set to ``true``, queries can - write data to the ``_tmp`` sub-directory in the ``dbPath`` directory. - - * - allowPartialResults - - boolean - - For queries against a sharded collection, returns partial results from - the :program:`mongos` if some shards are unavailable instead of - throwing an error. - - * - batchSize - - integer - - The number of documents to return in the first batch. Defaults to - ``101``. A batchSize of ``0`` means that the cursor will be - established, but no documents will be returned in the first batch. - - Unlike the previous wire protocol version, a batchSize of ``1`` for the - :dbcommand:`find` command does not close the cursor. - - * - codec - - MongoDB\\Codec\\DocumentCodec - - .. include:: /includes/extracts/collection-option-codec.rst - - .. versionadded:: 1.17 - - * - collation - - array|object - - .. include:: /includes/extracts/collection-option-collation.rst - - * - comment - - mixed - - .. include:: /includes/extracts/common-option-comment.rst - - .. include:: /includes/extracts/common-option-comment-string-before-4.4.rst - - * - cursorType - - integer - - Indicates the type of cursor to use. ``cursorType`` supports the - following values: - - - ``MongoDB\Operation\Find::NON_TAILABLE`` (*default*) - - ``MongoDB\Operation\Find::TAILABLE`` - - * - hint - - string|array|object - - .. include:: /includes/extracts/common-option-hint.rst - - .. versionadded:: 1.2 - - * - let - - array|object - - .. include:: /includes/extracts/common-option-let.rst - - .. versionadded:: 1.13 - - * - limit - - integer - - The maximum number of documents to return. If unspecified, then - defaults to no limit. A limit of ``0`` is equivalent to setting no - limit. - - A negative limit is similar to a positive limit but closes the cursor - after returning a single batch of results. As such, with a negative - limit, if the limited result set does not fit into a single batch, the - number of documents received will be less than the specified limit. By - passing a negative limit, the client indicates to the server that it - will not ask for a subsequent batch via getMore. - - * - max - - array|object - - The exclusive upper bound for a specific index. - - .. versionadded:: 1.2 - - * - maxAwaitTimeMS - - integer - - Positive integer denoting the time limit in milliseconds for the server - to block a getMore operation if no data is available. This option - should only be used if cursorType is TAILABLE_AWAIT. - - .. versionadded:: 1.2 - - * - maxScan - - integer - - Maximum number of documents or index keys to scan when executing the - query. - - .. deprecated:: 1.4 - .. versionadded:: 1.2 - - * - maxTimeMS - - integer - - .. include:: /includes/extracts/common-option-maxTimeMS.rst - - * - min - - array|object - - The inclusive lower bound for a specific index. - - .. versionadded:: 1.2 - - * - modifiers - - array|object - - :manual:`Meta operators ` that - modify the output or behavior of a query. Use of these operators is - deprecated in favor of named options. - - * - noCursorTimeout - - boolean - - Prevents the server from timing out idle cursors after an inactivity - period (10 minutes). - - * - oplogReplay - - boolean - - Internal use for replica sets. To use ``oplogReplay``, you must include - the following condition in the filter: - - .. code-block:: javascript - - { ts: { $gte: } } - - The :php:`MongoDB\BSON\Timestamp ` - class reference describes how to represent MongoDB's BSON timestamp - type with PHP. - - .. deprecated:: 1.7 - - * - projection - - array|object - - The :ref:`projection specification ` to determine which - fields to include in the returned documents. See - :manual:`Project Fields to Return from Query ` - and :manual:`Projection Operators ` in - the MongoDB manual. - - * - readConcern - - :php:`MongoDB\Driver\ReadConcern ` - - .. include:: /includes/extracts/collection-option-readConcern.rst - - .. include:: /includes/extracts/common-option-readConcern-transaction.rst - - * - readPreference - - :php:`MongoDB\Driver\ReadPreference ` - - .. include:: /includes/extracts/collection-option-readPreference.rst - - * - returnKey - - boolean - - If true, returns only the index keys in the resulting documents. - - .. versionadded:: 1.2 - - * - session - - :php:`MongoDB\Driver\Session ` - - .. include:: /includes/extracts/common-option-session.rst - - .. versionadded:: 1.3 - - * - showRecordId - - boolean - - Determines whether to return the record identifier for each document. - If true, adds a field ``$recordId`` to the returned documents. - - .. versionadded:: 1.2 - - * - skip - - integer - - Number of documents to skip. Defaults to ``0``. - - * - sort - - array|object - - The sort specification for the ordering of the results. - - * - snapshot - - boolean - - Prevents the cursor from returning a document more than once because of - an intervening write operation. - - .. deprecated:: 1.4 - .. versionadded:: 1.2 - - * - typeMap - - array - - .. include:: /includes/extracts/collection-option-typeMap.rst +.. include:: /includes/reference/find-parameters.rst Return Values ------------- diff --git a/source/reference/method/MongoDBCollection-findOne.txt b/source/reference/method/MongoDBCollection-findOne.txt index 269d81eb..38e67c57 100644 --- a/source/reference/method/MongoDBCollection-findOne.txt +++ b/source/reference/method/MongoDBCollection-findOne.txt @@ -2,8 +2,6 @@ MongoDB\\Collection::findOne() ============================== -.. default-domain:: mongodb - .. contents:: On this page :local: :backlinks: none @@ -27,154 +25,7 @@ Definition Parameters ---------- -``$filter`` : array|object - The filter criteria that specifies the documents to query. - -``$options`` : array - An array specifying the desired options. - - .. list-table:: - :header-rows: 1 - :widths: 20 20 80 - - * - Name - - Type - - Description - - * - allowDiskUse - - boolean - - Enables writing to temporary files. When set to ``true``, queries can - write data to the ``_tmp`` sub-directory in the ``dbPath`` directory. - - * - allowPartialResults - - boolean - - For queries against a sharded collection, returns partial results from - the :program:`mongos` if some shards are unavailable instead of - throwing an error. - - * - codec - - MongoDB\\Codec\\DocumentCodec - - .. include:: /includes/extracts/collection-option-codec.rst - - .. versionadded:: 1.17 - - * - collation - - array|object - - .. include:: /includes/extracts/collection-option-collation.rst - - * - comment - - mixed - - .. include:: /includes/extracts/common-option-comment.rst - - .. include:: /includes/extracts/common-option-comment-string-before-4.4.rst - - * - hint - - string|array|object - - .. include:: /includes/extracts/common-option-hint.rst - - .. versionadded:: 1.2 - - * - let - - array|object - - .. include:: /includes/extracts/common-option-let.rst - - .. versionadded:: 1.13 - - * - max - - array|object - - The exclusive upper bound for a specific index. - - .. versionadded:: 1.2 - - * - maxScan - - integer - - Maximum number of documents or index keys to scan when executing the - query. - - .. deprecated:: 1.4 - .. versionadded:: 1.2 - - * - maxTimeMS - - integer - - .. include:: /includes/extracts/common-option-maxTimeMS.rst - - * - min - - array|object - - The inclusive lower bound for a specific index. - - .. versionadded:: 1.2 - - * - modifiers - - array|object - - :manual:`Meta operators ` that - modify the output or behavior of a query. Use of these operators is - deprecated in favor of named options. - - * - oplogReplay - - boolean - - Internal use for replica sets. To use ``oplogReplay``, you must include - the following condition in the filter: - - .. code-block:: javascript - - { ts: { $gte: } } - - The :php:`MongoDB\BSON\Timestamp ` - class reference describes how to represent MongoDB's BSON timestamp - type with PHP. - - .. deprecated:: 1.7 - - * - projection - - array|object - - The :ref:`projection specification ` to determine which - fields to include in the returned documents. See - :manual:`Project Fields to Return from Query ` - and :manual:`Projection Operators ` in - the MongoDB manual. - - * - readConcern - - :php:`MongoDB\Driver\ReadConcern ` - - .. include:: /includes/extracts/collection-option-readConcern.rst - - .. include:: /includes/extracts/common-option-readConcern-transaction.rst - - * - readPreference - - :php:`MongoDB\Driver\ReadPreference ` - - .. include:: /includes/extracts/collection-option-readPreference.rst - - * - returnKey - - boolean - - If true, returns only the index keys in the resulting documents. - - .. versionadded:: 1.2 - - * - session - - :php:`MongoDB\Driver\Session ` - - .. include:: /includes/extracts/common-option-session.rst - - .. versionadded:: 1.3 - - * - showRecordId - - boolean - - Determines whether to return the record identifier for each document. - If true, adds a field ``$recordId`` to the returned documents. - - .. versionadded:: 1.2 - - * - skip - - integer - - Number of documents to skip. Defaults to ``0``. - - * - sort - - array|object - - The sort specification for the ordering of the results. - - * - typeMap - - array - - .. include:: /includes/extracts/collection-option-typeMap.rst - - This will be used for the returned result document. +.. include:: /includes/reference/find-one-parameters.rst Return Values ------------- diff --git a/source/reference/method/MongoDBGridFSBucket-find.txt b/source/reference/method/MongoDBGridFSBucket-find.txt index 85344f7a..ccc53eb7 100644 --- a/source/reference/method/MongoDBGridFSBucket-find.txt +++ b/source/reference/method/MongoDBGridFSBucket-find.txt @@ -27,203 +27,7 @@ Definition Parameters ---------- -``$filter`` : array|object - The filter criteria that specifies the documents to query. - -``$options`` : array - An array specifying the desired options. - - .. list-table:: - :header-rows: 1 - :widths: 20 20 80 - - * - Name - - Type - - Description - - * - allowDiskUse - - boolean - - Enables writing to temporary files. When set to ``true``, queries can - write data to the ``_tmp`` sub-directory in the ``dbPath`` directory. - - * - allowPartialResults - - boolean - - For queries against a sharded collection, returns partial results from - the :program:`mongos` if some shards are unavailable instead of - throwing an error. - - * - batchSize - - integer - - The number of documents to return in the first batch. Defaults to - ``101``. A batchSize of ``0`` means that the cursor will be - established, but no documents will be returned in the first batch. - - Unlike the previous wire protocol version, a batchSize of ``1`` for the - :dbcommand:`find` command does not close the cursor. - - * - codec - - MongoDB\\Codec\\DocumentCodec - - .. include:: /includes/extracts/bucket-option-codec.rst - - .. versionadded:: 1.17 - - * - collation - - array|object - - .. include:: /includes/extracts/common-option-collation.rst - - * - comment - - mixed - - .. include:: /includes/extracts/common-option-comment.rst - - .. include:: /includes/extracts/common-option-comment-string-before-4.4.rst - - * - cursorType - - integer - - Indicates the type of cursor to use. ``cursorType`` supports the - following values: - - - ``MongoDB\Operation\Find::NON_TAILABLE`` (*default*) - - ``MongoDB\Operation\Find::TAILABLE`` - - * - hint - - string|array|object - - .. include:: /includes/extracts/common-option-hint.rst - - .. versionadded:: 1.2 - - * - let - - array|object - - .. include:: /includes/extracts/common-option-let.rst - - .. versionadded:: 1.13 - - * - limit - - integer - - The maximum number of documents to return. If unspecified, then - defaults to no limit. A limit of ``0`` is equivalent to setting no - limit. - - A negative limit is similar to a positive limit but closes the cursor - after returning a single batch of results. As such, with a negative - limit, if the limited result set does not fit into a single batch, the - number of documents received will be less than the specified limit. By - passing a negative limit, the client indicates to the server that it - will not ask for a subsequent batch via getMore. - - * - max - - array|object - - The exclusive upper bound for a specific index. - - .. versionadded:: 1.2 - - * - maxAwaitTimeMS - - integer - - Positive integer denoting the time limit in milliseconds for the server - to block a getMore operation if no data is available. This option - should only be used if cursorType is TAILABLE_AWAIT. - - .. versionadded:: 1.2 - - * - maxScan - - integer - - Maximum number of documents or index keys to scan when executing the - query. - - .. deprecated:: 1.4 - .. versionadded:: 1.2 - - * - maxTimeMS - - integer - - .. include:: /includes/extracts/common-option-maxTimeMS.rst - - * - min - - array|object - - The inclusive lower bound for a specific index. - - .. versionadded:: 1.2 - - * - modifiers - - array|object - - :manual:`Meta operators ` that - modify the output or behavior of a query. Use of these operators is - deprecated in favor of named options. - - * - noCursorTimeout - - boolean - - Prevents the server from timing out idle cursors after an inactivity - period (10 minutes). - - * - oplogReplay - - boolean - - Internal use for replica sets. To use ``oplogReplay``, you must include - the following condition in the filter: - - .. code-block:: javascript - - { ts: { $gte: } } - - The :php:`MongoDB\BSON\Timestamp ` - class reference describes how to represent MongoDB's BSON timestamp - type with PHP. - - .. deprecated:: 1.7 - - * - projection - - array|object - - The :ref:`projection specification ` to determine which - fields to include in the returned documents. See - :manual:`Project Fields to Return from Query ` - and :manual:`Projection Operators ` in - the MongoDB manual. - - * - readConcern - - :php:`MongoDB\Driver\ReadConcern ` - - .. include:: /includes/extracts/bucket-option-readConcern.rst - - .. include:: /includes/extracts/common-option-readConcern-transaction.rst - - * - readPreference - - :php:`MongoDB\Driver\ReadPreference ` - - .. include:: /includes/extracts/bucket-option-readPreference.rst - - * - returnKey - - boolean - - If true, returns only the index keys in the resulting documents. - - .. versionadded:: 1.2 - - * - session - - :php:`MongoDB\Driver\Session ` - - .. include:: /includes/extracts/common-option-session.rst - - .. versionadded:: 1.3 - - * - showRecordId - - boolean - - Determines whether to return the record identifier for each document. - If true, adds a field ``$recordId`` to the returned documents. - - .. versionadded:: 1.2 - - * - skip - - integer - - Number of documents to skip. Defaults to ``0``. - - * - sort - - array|object - - The sort specification for the ordering of the results. - - * - snapshot - - boolean - - Prevents the cursor from returning a document more than once because of - an intervening write operation. - - .. deprecated:: 1.4 - .. versionadded:: 1.2 - - * - typeMap - - array - - .. include:: /includes/extracts/bucket-option-typeMap.rst +.. include:: /includes/reference/find-parameters.rst Return Values ------------- diff --git a/source/reference/method/MongoDBGridFSBucket-findOne.txt b/source/reference/method/MongoDBGridFSBucket-findOne.txt index 7bcc6860..fd96da56 100644 --- a/source/reference/method/MongoDBGridFSBucket-findOne.txt +++ b/source/reference/method/MongoDBGridFSBucket-findOne.txt @@ -28,154 +28,7 @@ Definition Parameters ---------- -``$filter`` : array|object - The filter criteria that specifies the documents to query. - -``$options`` : array - An array specifying the desired options. - - .. list-table:: - :header-rows: 1 - :widths: 20 20 80 - - * - Name - - Type - - Description - - * - allowDiskUse - - boolean - - Enables writing to temporary files. When set to ``true``, queries can - write data to the ``_tmp`` sub-directory in the ``dbPath`` directory. - - * - allowPartialResults - - boolean - - For queries against a sharded collection, returns partial results from - the :program:`mongos` if some shards are unavailable instead of - throwing an error. - - * - codec - - MongoDB\\Codec\\DocumentCodec - - .. include:: /includes/extracts/bucket-option-codec.rst - - .. versionadded:: 1.17 - - * - collation - - array|object - - .. include:: /includes/extracts/common-option-collation.rst - - * - comment - - mixed - - .. include:: /includes/extracts/common-option-comment.rst - - .. include:: /includes/extracts/common-option-comment-string-before-4.4.rst - - * - hint - - string|array|object - - .. include:: /includes/extracts/common-option-hint.rst - - .. versionadded:: 1.2 - - * - let - - array|object - - .. include:: /includes/extracts/common-option-let.rst - - .. versionadded:: 1.13 - - * - max - - array|object - - The exclusive upper bound for a specific index. - - .. versionadded:: 1.2 - - * - maxScan - - integer - - Maximum number of documents or index keys to scan when executing the - query. - - .. deprecated:: 1.4 - .. versionadded:: 1.2 - - * - maxTimeMS - - integer - - .. include:: /includes/extracts/common-option-maxTimeMS.rst - - * - min - - array|object - - The inclusive lower bound for a specific index. - - .. versionadded:: 1.2 - - * - modifiers - - array|object - - :manual:`Meta operators ` that - modify the output or behavior of a query. Use of these operators is - deprecated in favor of named options. - - * - oplogReplay - - boolean - - Internal use for replica sets. To use ``oplogReplay``, you must include - the following condition in the filter: - - .. code-block:: javascript - - { ts: { $gte: } } - - The :php:`MongoDB\BSON\Timestamp ` - class reference describes how to represent MongoDB's BSON timestamp - type with PHP. - - .. deprecated:: 1.7 - - * - projection - - array|object - - The :ref:`projection specification ` to determine which - fields to include in the returned documents. See - :manual:`Project Fields to Return from Query ` - and :manual:`Projection Operators ` in - the MongoDB manual. - - * - readConcern - - :php:`MongoDB\Driver\ReadConcern ` - - .. include:: /includes/extracts/bucket-option-readConcern.rst - - .. include:: /includes/extracts/common-option-readConcern-transaction.rst - - * - readPreference - - :php:`MongoDB\Driver\ReadPreference ` - - .. include:: /includes/extracts/bucket-option-readPreference.rst - - * - returnKey - - boolean - - If true, returns only the index keys in the resulting documents. - - .. versionadded:: 1.2 - - * - session - - :php:`MongoDB\Driver\Session ` - - .. include:: /includes/extracts/common-option-session.rst - - .. versionadded:: 1.3 - - * - showRecordId - - boolean - - Determines whether to return the record identifier for each document. - If true, adds a field ``$recordId`` to the returned documents. - - .. versionadded:: 1.2 - - * - skip - - integer - - Number of documents to skip. Defaults to ``0``. - - * - sort - - array|object - - The sort specification for the ordering of the results. - - * - typeMap - - array - - .. include:: /includes/extracts/bucket-option-typeMap.rst - - This will be used for the returned result document. +.. include:: /includes/reference/find-one-parameters.rst Return Values ------------- diff --git a/source/whats-new.txt b/source/whats-new.txt index b0e5f6c6..9cc1af4b 100644 --- a/source/whats-new.txt +++ b/source/whats-new.txt @@ -54,6 +54,17 @@ improvements, and fixes: information, you must store it in metadata. To learn mor about GridFS, see the :ref:`php-gridfs` guide. +- Removes the following deprecated options for find operations: + + - ``maxScan`` + - ``modifiers`` + - ``oplogReplay`` + - ``snapshot`` + + To learn about supported options for find operations, see the + :phpmethod:`MongoDB\Collection::find()` or + :phpmethod:`MongoDB\Collection::findOne()` API documentation. + - Removal of the deprecated ``IndexInfo::isGeoHaystack()`` method. .. _php-lib-version-1.20: