Commit 83eb3980 authored by Jeremy Mikola's avatar Jeremy Mikola

Merge pull request #276

parents 6be57505 c63ca8d5
arg_name: option
name: typeMap
type: array
description: |
Default :php:`type map
<manual/en/mongodb.persistence.deserialization.php#mongodb.persistence.typemaps>`
to apply to cursors, which determines how BSON documents are converted to PHP
values. The |php-library| uses the following type map by default:
.. code-block:: php
[
'array' => 'MongoDB\Model\BSONArray',
'document' => 'MongoDB\Model\BSONDocument',
'root' => 'MongoDB\Model\BSONDocument',
]
interface: phpmethod
operation: ~
optional: true
...
...@@ -2,46 +2,41 @@ arg_name: param ...@@ -2,46 +2,41 @@ arg_name: param
name: $uri name: $uri
type: string type: string
description: | description: |
The URI of the standalone, replica set, or sharded cluster to which to connect. Refer The URI of the standalone, replica set, or sharded cluster to which to
to the :manual:`MongoDB connection string reference </reference/connection-string>` connect. Refer to the :manual:`MongoDB connection string reference
for formatting. </reference/connection-string>` for formatting.
Defaults to ``mongodb://localhost:27017`` if unspecified. Defaults to ``"mongodb://127.0.0.1:27017"`` if unspecified.
interface: phpmethod interface: phpmethod
operation: MongoDB\\Client::__construct operation: ~
optional: true optional: true
position: 1
--- ---
arg_name: param arg_name: param
name: $uriOptions name: $uriOptions
type: array type: array
description: | description: |
Specifies additional URI options, such as authentication credentials Specifies additional URI options, such as authentication credentials or query
or query string parameters. The options specified in ``$uriOptions`` string parameters. The options specified in ``$uriOptions`` take precedence
take precedence over any analogous options present in the over any analogous options present in the ``$uri`` string.
``$uri`` string.
post: |
Refer to the :php:`MongoDB\\Driver\\Manager::__construct() Refer to the :php:`MongoDB\\Driver\\Manager::__construct()
<mongodb-driver-manager.construct>` extension reference and <mongodb-driver-manager.construct>` extension reference and :manual:`MongoDB
:manual:`MongoDB connection string </reference/connection-string>` connection string </reference/connection-string>` documentation for accepted
documentation for valid options. options.
interface: phpmethod interface: phpmethod
operation: MongoDB\\Client::__construct operation: ~
optional: true optional: true
position: 2
--- ---
arg_name: param arg_name: param
name: $driverOptions name: $driverOptions
type: array type: array
description: | description: |
Specify driver-specific options. In addition to any Specify driver-specific options, such as SSL options. In addition to any
options supported by the :php:`extension <mongodb-driver-manager>`, options supported by the :php:`extension <mongodb-driver-manager>`, the
the |php-library| allows you to specify a default ``typeMap`` to |php-library| allows you to specify a default :php:`type map
apply to the cursors it creates. Refer to the driver's <manual/en/mongodb.persistence.deserialization.php#mongodb.persistence.typemaps>`
:php:`Persistence documentation <mongodb-persistence>` for more to apply to the cursors it creates.
about type maps.
interface: phpmethod interface: phpmethod
operation: MongoDB\\Client::__construct operation: ~
optional: true optional: true
position: 3 ...
...
\ No newline at end of file
arg_name: option
interface: phpmethod
operation: MongoDB\\Client::dropDatabase
source: source:
file: apiargs-common-option.yaml file: apiargs-common-option.yaml
ref: typeMap ref: typeMap
position: 1 post: |
This will be used for the returned command result document.
---
arg_name: option
name: writeConcern
type: :php:`MongoDB\\Driver\\WriteConcern <class.mongodb-driver-writeconcern>`
description: |
:manual:`Write concern </reference/write-concern>` to use for the operation.
Defaults to the client's write concern.
This is not supported for server versions prior to 3.4 and will result in an
exception at execution time if used.
interface: phpmethod
operation: ~
optional: true
... ...
source: source:
ref: $databaseName
file: apiargs-common-param.yaml file: apiargs-common-param.yaml
arg_name: param ref: $databaseName
interface: phpmethod replacement:
operation: MongoDB\\Client::dropDatabase action: " to drop"
--- ---
source: source:
ref: $options
file: apiargs-common-param.yaml file: apiargs-common-param.yaml
arg_name: param ref: $options
interface: phpmethod
operation: MongoDB\\Client::dropDatabase
position: 2
... ...
source: source:
ref: $databaseName
file: apiargs-common-param.yaml file: apiargs-common-param.yaml
arg_name: param ref: $databaseName
interface: phpmethod replacement:
operation: MongoDB\\Client::__get action: " to select"
... ...
source: source:
file: apiargs-common-option.yaml file: apiargs-common-option.yaml
ref: maxTimeMS ref: maxTimeMS
position: 1
... ...
source: source:
ref: $options
file: apiargs-common-param.yaml file: apiargs-common-param.yaml
arg_name: param ref: $options
interface: phpmethod
operation: MongoDB\\Client::listDatabases
position: 1
... ...
source:
file: apiargs-common-option.yaml
ref: readConcern
replacement:
resource: "collection"
parent: "client"
---
source:
file: apiargs-common-option.yaml
ref: readPreference
replacement:
resource: "collection"
parent: "client"
---
source:
file: apiargs-common-option.yaml
ref: typeMap
replacement:
parent: "client"
---
source:
file: apiargs-common-option.yaml
ref: writeConcern
replacement:
resource: "collection"
parent: "client"
...
source:
file: apiargs-common-param.yaml
ref: $databaseName
replacement:
action: " containing the collection to select"
---
source:
file: apiargs-common-param.yaml
ref: $collectionName
replacement:
action: " to select"
---
source:
file: apiargs-common-param.yaml
ref: $options
...
source: source:
ref: readConcern
file: apiargs-common-option.yaml file: apiargs-common-option.yaml
operation: MongoDB\\Client::selectDatabase ref: readConcern
replacement: replacement:
resource: "database" resource: "database"
parent: "client"
--- ---
source: source:
ref: readPreference
file: apiargs-common-option.yaml file: apiargs-common-option.yaml
operation: MongoDB\\Client::selectDatabase ref: readPreference
replacement: replacement:
resource: "database" resource: "database"
parent: "client"
--- ---
source: source:
ref: typeMap
file: apiargs-common-option.yaml file: apiargs-common-option.yaml
operation: MongoDB\\Client::selectDatabase ref: typeMap
replacement:
parent: "client"
--- ---
source: source:
ref: writeConcern
file: apiargs-common-option.yaml file: apiargs-common-option.yaml
operation: MongoDB\\Client::selectDatabase ref: writeConcern
replacement: replacement:
resource: "database" resource: "database"
... parent: "client"
\ No newline at end of file ...
source: source:
ref: $databaseName
file: apiargs-common-param.yaml file: apiargs-common-param.yaml
operation: MongoDB\\Client::selectDatabase ref: $databaseName
position: 1 replacement:
action: " to select"
--- ---
source: source:
ref: $options
file: apiargs-common-param.yaml file: apiargs-common-param.yaml
operation: MongoDB\\Client::selectDatabase ref: $options
position: 2
... ...
arg_name: option
name: bypassDocumentValidation
type: boolean
description: |
If ``true``, allows the write operation to circumvent document level
validation. Defaults to ``false``.
interface: phpmethod
operation: ~
optional: true
---
arg_name: option
name: collation
type: array|object
description: |
:manual:`Collation </reference/collation>` allows users to specify
language-specific rules for string comparison, such as rules for lettercase
and accent marks. When specifying collation, the ``locale`` field is
mandatory; all other collation fields are optional. For descriptions of the
fields, see :manual:`Collation Document
<reference/collation/#collation-document>`.
If the collation is unspecified but the collection has a default collation,
the operation uses the collation specified for the collection. If no
collation is specified for the collection or for the operation, MongoDB uses
the simple binary comparison used in prior versions for string comparisons.
This option is available in MongoDB 3.4+ and will result in an exception at
execution time if specified for an older server version.
interface: phpmethod
operation: ~
optional: true
---
arg_name: option
name: readConcern
type: :php:`MongoDB\\Driver\\ReadConcern <class.mongodb-driver-readconcern>`
description: |
:manual:`Read concern </reference/read-concern>` to use for the operation.
Defaults to the collection's read concern.
interface: phpmethod
operation: ~
optional: true
---
arg_name: option
name: readPreference
type: :php:`MongoDB\\Driver\\ReadPreference <class.mongodb-driver-readpreference>`
description: |
:manual:`Read preference </reference/read-preference>` to use for the
operation. Defaults to the collection's read preference.
interface: phpmethod
operation: ~
optional: true
---
source:
file: apiargs-common-option.yaml
ref: typeMap
replacement:
parent: "collection"
---
arg_name: option
name: writeConcern
type: :php:`MongoDB\\Driver\\WriteConcern <class.mongodb-driver-writeconcern>`
description: |
:manual:`Write concern </reference/write-concern>` to use for the operation.
Defaults to the collection's write concern.
interface: phpmethod
operation: ~
optional: true
---
arg_name: option
name: upsert
type: boolean
description: |
If set to ``true``, creates a new document when no document matches the query
criteria. The default value is ``false``, which does not insert a new
document when no match is found.
interface: phpmethod
operation: ~
optional: true
...
arg_name: param
name: $filter
type: array|object
description: |
The filter criteria that specifies the documents{{action}}.
interface: phpmethod
operation: ~
optional: false
replacement:
action: ""
---
arg_name: param
name: $replacement
type: array|object
description: |
The replacement document.
interface: phpmethod
operation: ~
optional: false
---
arg_name: param
name: $update
type: array|object
description: |
Specifies the field and value combinations to update and any relevant update
operators. ``$update`` uses MongoDB's :method:`update operators
</reference/operator/update>`.
interface: phpmethod
operation: ~
optional: false
...
...@@ -2,72 +2,81 @@ arg_name: option ...@@ -2,72 +2,81 @@ arg_name: option
name: allowDiskUse name: allowDiskUse
type: boolean type: boolean
description: | description: |
Enables writing to temporary files. When set to true, aggregation Enables writing to temporary files. When set to ``true``, aggregation stages
stages can write data to the ``_tmp`` sub-directory in the dbPath can write data to the ``_tmp`` sub-directory in the ``dbPath`` directory. The
directory. The default is ``false``. default is ``false``.
interface: phpmethod interface: phpmethod
operation: MongoDB\\Collection::aggregate operation: ~
optional: true optional: true
position: 1
--- ---
arg_name: option arg_name: option
name: batchSize name: batchSize
type: integer type: integer
description: | description: |
The number of documents to return per batch Specifies the initial batch size for the cursor. A batchSize of ``0`` means an
empty first batch and is useful for quickly returning a cursor or failure
message without doing significant server-side work.
.. note::
This is not supported for inline aggregation results (i.e. ``useCursor``
option is ``false`` or the server version is < 2.6).
interface: phpmethod interface: phpmethod
operation: MongoDB\\Collection::aggregate operation: ~
optional: true optional: true
position: 2
--- ---
source: source:
file: apiargs-MongoDBCollection-common-option.yaml
ref: bypassDocumentValidation ref: bypassDocumentValidation
file: apiargs-common-option.yaml post: |
operation: MongoDB\\Collection::aggregate This only applies when using the :ref:`$out <agg-out>` stage.
position: 5
Document validation requires MongoDB 3.2 or later: if you are using an earlier
version of MongoDB, this option will be ignored.
--- ---
source: source:
ref: maxTimeMS
file: apiargs-common-option.yaml file: apiargs-common-option.yaml
operation: MongoDB\\Collection::aggregate ref: maxTimeMS
position: 4
--- ---
source: source:
file: apiargs-MongoDBCollection-common-option.yaml
ref: readConcern ref: readConcern
file: apiargs-common-option.yaml
operation: MongoDB\\Collection::selectDatabase
replacement:
resource: "aggregation"
position: 5
--- ---
source: source:
file: apiargs-MongoDBCollection-common-option.yaml
ref: readPreference ref: readPreference
file: apiargs-common-option.yaml
operation: MongoDB\\Collection::selectDatabase
replacement:
resource: "aggregation"
position: 6
--- ---
source: source:
file: apiargs-MongoDBCollection-common-option.yaml
ref: typeMap ref: typeMap
file: apiargs-common-option.yaml post: |
operation: MongoDB\\Collection::selectDatabase .. note::
position: 7
This is not supported for inline aggregation results (i.e. ``useCursor``
option is ``false`` or the server version is < 2.6).
--- ---
arg_name: param arg_name: option
name: useCursor name: useCursor
type: boolean type: boolean
description: | description: |
Indicates whether the command will request that the server provide Indicates whether the command will request that the server provide results
results using a cursor. The default is ``true``. using a cursor. The default is ``true``.
For MongoDB version 2.6 or later, ``useCursor`` allows users to turn For MongoDB version 2.6 or later, ``useCursor`` allows users to turn off
off cursors if necessary to aid in mongod/mongos upgrades. cursors if necessary to aid in replica set or shard cluster upgrades.
``useCursor`` is ignored for MongoDB versions prior to 2.6 as ``useCursor`` is ignored for MongoDB versions prior to 2.6 as aggregation
aggregation cursors are not available pre-2.6. cursors are not available.
interface: phpmethod interface: phpmethod
operation: MongoDB\\Collection::aggregate operation: ~
optional: true optional: true
position: 8 ---
source:
file: apiargs-MongoDBCollection-common-option.yaml
ref: writeConcern
post: |
This only applies when the :ref:`$out <agg-out>` stage is specified.
This is not supported for server versions prior to 3.4 and will result in an
exception at execution time if used.
... ...
...@@ -2,15 +2,13 @@ arg_name: param ...@@ -2,15 +2,13 @@ arg_name: param
name: $pipeline name: $pipeline
type: array type: array
description: | description: |
Specifies an :manual:`aggregation pipeline </core/aggregation-pipeline>` operation. Specifies an :manual:`aggregation pipeline </core/aggregation-pipeline>`
operation.
interface: phpmethod interface: phpmethod
operation: MongoDB\\Collection::aggregate operation: ~
optional: true optional: false
position: 1
--- ---
source: source:
ref: $options
file: apiargs-common-param.yaml file: apiargs-common-param.yaml
operation: MongoDB\\Collection::aggregate ref: $options
position: 2 ...
...
\ No newline at end of file
source: source:
file: apiargs-MongoDBCollection-common-option.yaml
ref: bypassDocumentValidation ref: bypassDocumentValidation
file: apiargs-common-option.yaml
operation: MongoDB\\Collection::bulkWrite
position: 1
--- ---
arg_name: option arg_name: option
name: ordered name: ordered
type: boolean type: boolean
description: | description: |
If ``true``: when an insert fails, the operation returns without performing the If ``true``: when a single write fails, the operation returns without
remaining writes. performing the remaining writes.
If ``false``: when a write fails, the operation will continue with the If ``false``: when a single write fails, the operation will continue with the
remaining writes, if any. remaining writes, if any.
The default is ``true``. The default is ``true``.
optional: true
interface: phpmethod interface: phpmethod
operation: MongoDB\\Collection::bulkWrite operation: ~
position: 2 optional: true
--- ---
source: source:
file: apiargs-MongoDBCollection-common-option.yaml
ref: writeConcern ref: writeConcern
file: apiargs-common-option.yaml
operation: MongoDB\\Collection::bulkWrite
replacement:
resource: "write"
position: 3
... ...
...@@ -2,17 +2,18 @@ arg_name: param ...@@ -2,17 +2,18 @@ arg_name: param
name: $operations name: $operations
type: array type: array
description: | description: |
An array containing the write operations to perform. {{role}} An array containing the write operations to perform.
supports :phpmethod:`deleteMany <MongoDB\\Collection::deleteMany>`, :phpmethod:`MongoDB\\Collection::bulkWrite()` supports
:phpmethod:`deleteOne <MongoDB\\Collection::deleteOne>`, :phpmethod:`insertOne :phpmethod:`deleteMany() <MongoDB\\Collection::deleteMany>`,
<MongoDB\\Collection::insertOne>`, :phpmethod:`replaceOne :phpmethod:`deleteOne() <MongoDB\\Collection::deleteOne>`,
<MongoDB\\Collection::replaceOne>`, :phpmethod:`updateMany :phpmethod:`insertOne() <MongoDB\\Collection::insertOne>`,
<MongoDB\\Collection::updateMany>`, and :phpmethod:`updateOne :phpmethod:`replaceOne() <MongoDB\\Collection::replaceOne>`,
<MongoDB\\Collection::updateOne>` operations in the following array :phpmethod:`updateMany() <MongoDB\\Collection::updateMany>`, and
structure: :phpmethod:`updateOne() <MongoDB\\Collection::updateOne>` operations in the
following array structure:
.. code-block:: php .. code-block:: php
[ [
[ 'deleteMany' => [ $filter ] ], [ 'deleteMany' => [ $filter ] ],
[ 'deleteOne' => [ $filter ] ], [ 'deleteOne' => [ $filter ] ],
...@@ -21,19 +22,16 @@ description: | ...@@ -21,19 +22,16 @@ description: |
[ 'updateMany' => [ $filter, $update, $options ] ], [ 'updateMany' => [ $filter, $update, $options ] ],
[ 'updateOne' => [ $filter, $update, $options ] ], [ 'updateOne' => [ $filter, $update, $options ] ],
] ]
post: |
Arguments correspond to the respective operation methods. However, Arguments correspond to the respective operation methods. However, the
the ``writeConcern`` option is specified for the top-level bulk write ``writeConcern`` option is specified as a top-level option to
operation instead of each individual operation. :phpmethod:`MongoDB\\Collection::bulkWrite()` instead of each individual
operation.
interface: phpmethod interface: phpmethod
operation: MongoDB\\Collection::bulkWrite operation: ~
optional: true optional: true
position: 1
--- ---
source: source:
ref: $options
file: apiargs-common-param.yaml file: apiargs-common-param.yaml
operation: MongoDB\\Collection::bulkWrite ref: $options
interface: phpmethod ...
position: 2
...
\ No newline at end of file
source:
file: apiargs-common-option.yaml
ref: readConcern
replacement:
resource: "collection"
parent: "manager"
---
source:
file: apiargs-common-option.yaml
ref: readPreference
replacement:
resource: "collection"
parent: "manager"
---
source:
file: apiargs-MongoDBClient-method-construct-driverOptions.yaml
ref: typeMap
---
source:
file: apiargs-common-option.yaml
ref: writeConcern
replacement:
resource: "collection"
parent: "manager"
...
arg_name: param source:
name: $manager file: apiargs-common-param.yaml
type: :php:`MongoDB\\Driver\\Manager <class.mongodb-driver-manager>` ref: $manager
description: |
The :php:`Manager <mongodb-driver-manager>` instance from the driver.
The manager maintains connections between the driver and your MongoDB
instances.
interface: phpmethod
operation: MongoDB\\Collection::__construct
optional: false
position: 1
--- ---
source: source:
ref: $databaseName
file: apiargs-common-param.yaml file: apiargs-common-param.yaml
operation: MongoDB\\Collection::__construct ref: $databaseName
replacement:
select: ""
position: 2
--- ---
source: source:
ref: $collectionName
file: apiargs-common-param.yaml file: apiargs-common-param.yaml
operation: MongoDB\\Collection::__construct ref: $collectionName
replacement:
select: ""
position: 3
--- ---
source: source:
ref: $options
file: apiargs-common-param.yaml file: apiargs-common-param.yaml
operation: MongoDB\\Collection::__construct ref: $options
position: 4 ...
...
\ No newline at end of file
source:
file: apiargs-MongoDBCollection-common-option.yaml
ref: collation
---
arg_name: option arg_name: option
name: hint name: hint
type: string or array|object type: string|array|object
description: | description: |
The index to use. If you specify a document, it is interpreted as The index to use. If you specify a document, it is interpreted as an index
an index specification and a name will be generated. specification from which a name will be derived.
optional: true
interface: phpmethod interface: phpmethod
operation: MongoDB\\Collection::count operation: ~
position: 1 optional: true
--- ---
arg_name: option arg_name: option
name: limit name: limit
type: integer type: integer
description: | description: |
The maximum number of documents to return. The maximum number of matching documents to return.
optional: true
interface: phpmethod interface: phpmethod
operation: MongoDB\\Collection::count operation: ~
position: 2 optional: true
--- ---
source: source:
ref: maxTimeMS
file: apiargs-common-option.yaml file: apiargs-common-option.yaml
operation: MongoDB\\Collection::count ref: maxTimeMS
position: 3
--- ---
source: source:
file: apiargs-MongoDBCollection-common-option.yaml
ref: readConcern ref: readConcern
file: apiargs-common-option.yaml
operation: MongoDB\\Collection::count
replacement:
resource: "count"
position: 4
--- ---
source: source:
file: apiargs-MongoDBCollection-common-option.yaml
ref: readPreference ref: readPreference
file: apiargs-common-option.yaml
replacement:
resource: "count"
position: 5
--- ---
arg_name: option arg_name: option
name: skip name: skip
type: integer type: integer
description: | description: |
The number of documents to skip before returning the documents. The number of matching documents to skip before returning results.
optional: true
interface: phpmethod interface: phpmethod
operation: MongoDB\\Collection::count operation: ~
position: 6 optional: true
... ...
source: source:
file: apiargs-MongoDBCollection-common-param.yaml
ref: $filter ref: $filter
file: apiargs-common-param.yaml optional: true
operation: MongoDB\\Collection::count replacement:
position: 1 action: " to count"
--- ---
source: source:
ref: $options
file: apiargs-common-param.yaml file: apiargs-common-param.yaml
operation: MongoDB\\Collection::count ref: $options
position: 2
... ...
...@@ -4,9 +4,15 @@ type: boolean ...@@ -4,9 +4,15 @@ type: boolean
description: | description: |
Creates a :manual:`unique </core/index-unique>` index. Creates a :manual:`unique </core/index-unique>` index.
interface: phpmethod interface: phpmethod
operation: MongoDB\\Collection::createIndex operation: ~
optional: true optional: true
position: 1 ---
source:
file: apiargs-MongoDBCollection-common-option.yaml
ref: collation
pre: |
Specifies the :manual:`collation
</reference/bson-type-comparison-order/#collation>` for the index.
--- ---
arg_name: option arg_name: option
name: partialFilterExpression name: partialFilterExpression
...@@ -14,9 +20,8 @@ type: array|object ...@@ -14,9 +20,8 @@ type: array|object
description: | description: |
Creates a :manual:`partial </core/index-partial>` index. Creates a :manual:`partial </core/index-partial>` index.
interface: phpmethod interface: phpmethod
operation: MongoDB\\Collection::createIndex operation: ~
optional: true optional: true
position: 2
--- ---
arg_name: option arg_name: option
name: sparse name: sparse
...@@ -24,9 +29,8 @@ type: boolean ...@@ -24,9 +29,8 @@ type: boolean
description: | description: |
Creates a :manual:`sparse </core/index-sparse>` index. Creates a :manual:`sparse </core/index-sparse>` index.
interface: phpmethod interface: phpmethod
operation: MongoDB\\Collection::createIndex operation: ~
optional: true optional: true
position: 3
--- ---
arg_name: option arg_name: option
name: expireAfterSeconds name: expireAfterSeconds
...@@ -34,66 +38,47 @@ type: integer ...@@ -34,66 +38,47 @@ type: integer
description: | description: |
Creates a :manual:`TTL </core/index-ttl>` index. Creates a :manual:`TTL </core/index-ttl>` index.
interface: phpmethod interface: phpmethod
operation: MongoDB\\Collection::createIndex operation: ~
optional: true optional: true
position: 4
--- ---
arg_name: option arg_name: option
name: name name: name
type: string type: string
description: | description: |
Specifies the name for the index. By default, MongoDB creates index A name that uniquely identifies the index. By default, MongoDB creates index
names based on the key. names based on the key.
interface: phpmethod interface: phpmethod
operation: MongoDB\\Collection::createIndex operation: ~
optional: true optional: true
position: 5
--- ---
arg_name: option arg_name: option
name: background name: background
type: string type: string
description: | description: |
Instructs MongoDB to build the index :manual:`as a background Instructs MongoDB to build the index :manual:`as a background
</core/index-creation>` process. </core/index-creation>` process.
interface: phpmethod interface: phpmethod
operation: MongoDB\\Collection::createIndex operation: ~
optional: true optional: true
position: 6
--- ---
arg_name: option arg_name: option
name: 2dsphereIndexVersion name: 2dsphereIndexVersion
type: integer type: integer
description: | description: |
Specifies the :manual:`version of a 2dsphere </core/2dsphere>` index Specifies the :manual:`version of a 2dsphere </core/2dsphere>` index to
to create. create.
MongoDB 2.6 introduced version 2 of 2dsphere indexes. Version 2 is MongoDB 2.6 introduced version 2 of 2dsphere indexes. Version 2 is the default
the default version of 2dsphere indexes created in MongoDB 2.6 and version of 2dsphere indexes created in MongoDB 2.6 and later versions.
later series. ``2dsphereIndexVersion`` enables you to overrride the ``2dsphereIndexVersion`` enables you to override the default version 2.
default version 2.
interface: phpmethod
operation: MongoDB\\Collection::createIndex
optional: true
position: 7
---
arg_name: option
name: socketTimeoutMS
type: integer
description: |
Specifies the time limit, in milliseconds, for socket
communication. If the :program:`mongod` does not respond within the
timeout period, a ``MongoCursorTimeoutException`` is thrown and
there will be no way to determine if the server actually handled the
write or not. Specify ``-1`` to block indefinitely. The default value
is 30000 (30 seconds).
interface: phpmethod interface: phpmethod
operation: MongoDB\\Collection::createIndex operation: ~
optional: true optional: true
position: 8
--- ---
source: source:
ref: maxTimeMS file: apiargs-MongoDBCollection-common-option.yaml
file: apiargs-common-option.yaml ref: writeConcern
operation: MongoDB\\Collection::createIndex post: |
position: 9 This is not supported for server versions prior to 3.4 and will result in an
exception at execution time if used.
... ...
...@@ -3,22 +3,18 @@ name: $key ...@@ -3,22 +3,18 @@ name: $key
type: array|object type: array|object
description: | description: |
Specifies the field or fields to index and the index order. Specifies the field or fields to index and the index order.
For example, the following specifies a descending index For example, the following specifies a descending index on the ``username``
on the ``username`` field: field:
.. code-block:: php .. code-block:: php
$key = [ 'username' => -1 ];
operation: MongoDB\\Collection::createIndex [ 'username' => -1 ]
interface: phpmethod interface: phpmethod
operation: ~
optional: false optional: false
position: 1
--- ---
source: source:
file: apiargs-common-param.yaml file: apiargs-common-param.yaml
ref: $options ref: $options
operation: MongoDB\\Collection::createIndex ...
position: 2
...
\ No newline at end of file
source:
file: apiargs-MongoDBCollection-common-option.yaml
ref: writeConcern
post: |
This is not supported for server versions prior to 3.4 and will result in an
exception at execution time if used.
...
arg_name: param
name: $indexes
type: array
description: |
The indexes to create on the collection.
For example, the following specifies a unique index on the ``username`` field
and a compound index on the ``email`` and ``createdAt`` fields:
.. code-block:: php
[
[ 'key' => [ 'username' => -1 ], 'unique' => true ],
[ 'key' => [ 'email' => 1, 'createdAt' => 1 ] ],
]
interface: phpmethod
operation: ~
optional: false
---
source:
file: apiargs-common-param.yaml
ref: $options
...
source: source:
file: apiargs-MongoDBCollection-common-option.yaml
ref: collation
---
source:
file: apiargs-MongoDBCollection-common-option.yaml
ref: writeConcern ref: writeConcern
file: apiargs-common-option.yaml
operation: MongoDB\\Collection::deleteMany
replacement:
resource: "delete"
position: 1
... ...
source: source:
file: apiargs-MongoDBCollection-common-param.yaml
ref: $filter ref: $filter
file: apiargs-common-param.yaml optional: false
operation: MongoDB\\Collection::deleteMany
replacement: replacement:
verb: "delete" action: " to delete"
position: 1
--- ---
source: source:
ref: $options
file: apiargs-common-param.yaml file: apiargs-common-param.yaml
operation: MongoDB\\Collection::deleteMany ref: $options
position: 2
... ...
source: source:
file: apiargs-MongoDBCollection-common-option.yaml
ref: collation
---
source:
file: apiargs-MongoDBCollection-common-option.yaml
ref: writeConcern ref: writeConcern
file: apiargs-common-option.yaml
operation: MongoDB\\Collection::deleteOne
replacement:
resource: "delete"
position: 1
... ...
source: source:
file: apiargs-MongoDBCollection-common-param.yaml
ref: $filter ref: $filter
file: apiargs-common-param.yaml optional: false
operation: MongoDB\\Collection::deleteOne
replacement: replacement:
verb: "delete" action: " to delete"
position: 1
--- ---
source: source:
ref: $options
file: apiargs-common-param.yaml file: apiargs-common-param.yaml
operation: MongoDB\\Collection::deleteOne ref: $options
position: 2
... ...
source: source:
ref: maxTimeMS file: apiargs-MongoDBCollection-common-option.yaml
ref: collation
---
source:
file: apiargs-common-option.yaml file: apiargs-common-option.yaml
operation: MongoDB\\Collection::distinct ref: maxTimeMS
position: 1
--- ---
source: source:
file: apiargs-MongoDBCollection-common-option.yaml
ref: readConcern ref: readConcern
file: apiargs-common-option.yaml
operation: MongoDB\\Collection::distinct
replacement:
resource: "distinct"
position: 2
--- ---
source: source:
file: apiargs-MongoDBCollection-common-option.yaml
ref: readPreference ref: readPreference
file: apiargs-common-option.yaml
replacement:
resource: "distinct"
position: 3
... ...
...@@ -4,19 +4,17 @@ type: string ...@@ -4,19 +4,17 @@ type: string
description: | description: |
The field for which to return distinct values. The field for which to return distinct values.
interface: phpmethod interface: phpmethod
operation: MongoDB\\Collection::distinct operation: ~
optional: false optional: false
position: 1
--- ---
source: source:
file: apiargs-common-param.yaml file: apiargs-MongoDBCollection-common-param.yaml
ref: $filter ref: $filter
position: 2
optional: true optional: true
replacement:
action: " from which to retrieve the distinct values"
--- ---
source: source:
ref: $options
file: apiargs-common-param.yaml file: apiargs-common-param.yaml
operation: MongoDB\\Collection::count ref: $options
position: 3
... ...
source: source:
file: apiargs-common-option.yaml file: apiargs-MongoDBCollection-common-option.yaml
ref: typeMap ref: typeMap
operation: MongoDB\\Collection::drop post: |
position: 1 This will be used for the returned command result document.
... ---
\ No newline at end of file source:
file: apiargs-MongoDBCollection-common-option.yaml
ref: writeConcern
post: |
This is not supported for server versions prior to 3.4 and will result in an
exception at execution time if used.
...
source: source:
file: apiargs-common-param.yaml file: apiargs-common-param.yaml
ref: $options ref: $options
interface: phpmethod ...
operation: MongoDB\\Collection::drop
position: 1
...
\ No newline at end of file
source: source:
file: apiargs-common-option.yaml file: apiargs-MongoDBCollection-common-option.yaml
ref: typeMap ref: typeMap
operation: MongoDB\\Collection::dropIndex post: |
position: 1 This will be used for the returned command result document.
... ---
\ No newline at end of file source:
file: apiargs-MongoDBCollection-common-option.yaml
ref: writeConcern
post: |
This is not supported for server versions prior to 3.4 and will result in an
exception at execution time if used.
...
...@@ -2,18 +2,14 @@ arg_name: param ...@@ -2,18 +2,14 @@ arg_name: param
name: $indexName name: $indexName
type: string type: string
description: | description: |
The name of the index to drop. View the existing indexes on the The name of the index to drop. View the existing indexes on the collection
collection using the :phpmethod:`listIndexes using the :phpmethod:`listIndexes() <MongoDB\\Collection::listIndexes>`
<MongoDB\\Collection::listIndexes>` method. method.
interface: phpmethod interface: phpmethod
operation: MongoDB\\Collection::dropIndex operation: ~
optional: false optional: false
position: 1
--- ---
source: source:
file: apiargs-common-param.yaml file: apiargs-common-param.yaml
ref: $options ref: $options
interface: phpmethod ...
operation: MongoDB\\Collection::dropIndex
position: 2
...
\ No newline at end of file
source: source:
file: apiargs-common-option.yaml file: apiargs-MongoDBCollection-common-option.yaml
ref: typeMap ref: typeMap
operation: MongoDB\\Collection::dropIndexes post: |
position: 1 This will be used for the returned command result document.
... ---
\ No newline at end of file source:
file: apiargs-MongoDBCollection-common-option.yaml
ref: writeConcern
post: |
This is not supported for server versions prior to 3.4 and will result in an
exception at execution time if used.
...
source: source:
file: apiargs-common-param.yaml file: apiargs-common-param.yaml
ref: $options ref: $options
operation: MongoDB\\Collection::dropIndexes ...
position: 1
...
\ No newline at end of file
name: sort arg_name: option
name: projection
type: array|object type: array|object
optional: true
description: | description: |
The sort specification for the ordering of the results. The :ref:`projection specification <projections>` to determine which fields to
arg_name: field include in the returned documents. See :manual:`Project Fields to Return from
operation: MongoDB\\Collection::find Query </tutorial/project-fields-from-query-results>` and
:manual:`Projection Operators </reference/operator/projection>` in the MongoDB
manual.
interface: phpmethod interface: phpmethod
position: 2 operation: ~
optional: true
--- ---
name: projection arg_name: option
name: sort
type: array|object type: array|object
optional: true
description: | description: |
The :ref:`projection specification <projections>` to determine The sort specification for the ordering of the results.
which fields to include in the returned documents. See
:manual:`Project Fields to Return from Query
</tutorial/project-fields-from-query-results>` in the MongoDB
manual.
arg_name: field
operation: MongoDB\\Collection::find
interface: phpmethod interface: phpmethod
position: 1 operation: ~
optional: true
--- ---
arg_name: option
name: skip name: skip
type: integer type: integer
optional: true
description: | description: |
Number of documents to skip. Defaults to 0. Number of documents to skip. Defaults to ``0``.
arg_name: field
operation: MongoDB\\Collection::find
interface: phpmethod interface: phpmethod
position: 3 operation: ~
optional: true
--- ---
arg_name: option
name: limit name: limit
type: integer type: integer
optional: true
description: | description: |
The maximum number of documents to return. If unspecified, The maximum number of documents to return. If unspecified, then defaults to no
then defaults to no limit. A limit of 0 is equivalent to setting no limit. A limit of ``0`` is equivalent to setting no limit.
limit.
arg_name: field
operation: MongoDB\\Collection::find
interface: phpmethod interface: phpmethod
position: 4 operation: ~
optional: true
--- ---
arg_name: option
name: batchSize name: batchSize
type: integer type: integer
optional: true
description: | description: |
The number of documents to return in the first batch. The number of documents to return in the first batch. Defaults to ``101``. A
Defaults to 101. A batchSize of 0 means that the cursor will be batchSize of ``0`` means that the cursor will be established, but no documents
established, but no documents will be returned in the first batch. will be returned in the first batch.
Unlike the previous wire protocol version, a batchSize of 1 for Unlike the previous wire protocol version, a batchSize of ``1`` for the
the :dbcommand:`find` command does not close the cursor. :dbcommand:`find` command does not close the cursor.
arg_name: field
operation: MongoDB\\Collection::find
interface: phpmethod interface: phpmethod
position: 5 operation: ~
optional: true
--- ---
source:
file: apiargs-MongoDBCollection-common-option.yaml
ref: collation
---
arg_name: option
name: comment name: comment
type: string type: string
optional: true
description: | description: |
A comment to attach to the query to help interpret and trace query A comment to attach to the query to help interpret and trace query
:dbcommand:`profile` data. :dbcommand:`profile` data.
arg_name: field
operation: MongoDB\\Collection::find
interface: phpmethod interface: phpmethod
position: 6 operation: ~
optional: true
--- ---
arg_name: option arg_name: option
name: cursorType name: cursorType
type: integer type: integer
description: | description: |
Indicates the type of cursor to use. The cursor types are Indicates the type of cursor to use. ``cursorType`` supports the following
``MongoDB\Operation\Find`` class constants. values:
Must be either - ``MongoDB\Operation\Find::NON_TAILABLE`` (*default*)
``NON_TAILABLE``, ``TAILABLE``, or ``TAILABLE_AWAIT``. The default is - ``MongoDB\Operation\Find::TAILABLE``
``NON_TAILABLE``.
interface: phpmethod interface: phpmethod
operation: MongoDB\\Collection::find operation: ~
optional: true optional: true
position: 7
--- ---
source: source:
file: apiargs-common-option.yaml file: apiargs-common-option.yaml
ref: maxTimeMS ref: maxTimeMS
operation: MongoDB\\Collection::find
position: 8
--- ---
source: source:
file: apiargs-common-option.yaml file: apiargs-MongoDBCollection-common-option.yaml
ref: readConcern ref: readConcern
operation: MongoDB\\Collection::find
position: 9
--- ---
source: source:
file: apiargs-common-option.yaml file: apiargs-MongoDBCollection-common-option.yaml
ref: readPreference ref: readPreference
pre: |
For use with MongoDB 3.0 and earlier.
operation: MongoDB\\Collection::find
position: 10
--- ---
arg_name: option
name: oplogReplay name: oplogReplay
type: boolean type: boolean
optional: true
description: | description: |
Internal use for replica sets. To use oplogReplay, you must include Internal use for replica sets. To use ``oplogReplay``, you must include the
the following condition in the filter: following condition in the filter:
.. code-block:: javascript .. code-block:: javascript
{ ts: { $gte: <timestamp> } } { ts: { $gte: <timestamp> } }
The :php:`MongoDB\\BSON\\Timestamp <class.mongodb-bson-timestamp>` The :php:`MongoDB\\BSON\\Timestamp <class.mongodb-bson-timestamp>` class
class reference describes how to represent MongoDB's BSON reference describes how to represent MongoDB's BSON timestamp type with PHP.
timestamp type with PHP.
arg_name: field
operation: MongoDB\\Collection::find
interface: phpmethod interface: phpmethod
position: 11 operation: ~
optional: true
--- ---
arg_name: option
name: noCursorTimeout name: noCursorTimeout
type: boolean type: boolean
optional: true
description: | description: |
Prevents the server from timing out idle cursors after an inactivity Prevents the server from timing out idle cursors after an inactivity period
period (10 minutes). (10 minutes).
arg_name: field
operation: MongoDB\\Collection::find
interface: phpmethod interface: phpmethod
position: 12 operation: ~
optional: true
--- ---
arg_name: option
name: allowPartialResults name: allowPartialResults
type: boolean type: boolean
optional: true
description: | description: |
For queries against a sharded collection, returns partial results from For queries against a sharded collection, returns partial results from the
the :program:`mongos` if some shards are unavailable instead of :program:`mongos` if some shards are unavailable instead of throwing an error.
throwing an error.
arg_name: field
operation: MongoDB\\Collection::find
interface: phpmethod interface: phpmethod
position: 13 operation: ~
optional: true
--- ---
source: source:
file: apiargs-common-option.yaml file: apiargs-MongoDBCollection-common-option.yaml
ref: typeMap ref: typeMap
operation: MongoDB\\Collection::find
position: 14
--- ---
arg_name: option arg_name: option
name: modifiers name: modifiers
type: array type: array|object
description: | description: |
Meta-operators that modify the output or behavior of a query. Meta-operators that modify the output or behavior of a query. :manual:`Cursor
:manual:`Cursor Methods </reference/method/js-cursor`> describes the Methods </reference/method/js-cursor`> describes the query modification
query modification methods available in MongoDB. methods available in MongoDB.
interface: phpmethod interface: phpmethod
operation: MongoDB\\Collection::find operation: ~
optional: true optional: true
position: 15
... ...
source: source:
file: apiargs-MongoDBCollection-common-param.yaml
ref: $filter ref: $filter
file: apiargs-common-param.yaml optional: true
operation: MongoDB\\Collection::find
replacement: replacement:
verb: "query" action: " to query"
position: 1
--- ---
source: source:
ref: $options
file: apiargs-common-param.yaml file: apiargs-common-param.yaml
operation: MongoDB\\Collection::find ref: $options
position: 2
... ...
source: source:
file: apiargs-MongoDBCollection-method-find-option.yaml file: apiargs-MongoDBCollection-method-find-option.yaml
ref: projection ref: projection
operation: MongoDB\\Collection::findOne
position: 1
--- ---
source: source:
file: apiargs-MongoDBCollection-method-find-option.yaml file: apiargs-MongoDBCollection-method-find-option.yaml
ref: sort ref: sort
operation: MongoDB\\Collection::findOne
position: 2
--- ---
source: source:
file: apiargs-MongoDBCollection-method-find-option.yaml file: apiargs-MongoDBCollection-method-find-option.yaml
ref: skip ref: skip
operation: MongoDB\\Collection::findOne
position: 3
--- ---
source: source:
file: apiargs-MongoDBCollection-method-find-option.yaml file: apiargs-MongoDBCollection-common-option.yaml
ref: comment ref: collation
operation: MongoDB\\Collection::findOne
position: 4
--- ---
source: source:
file: apiargs-MongoDBCollection-method-find-option.yaml file: apiargs-MongoDBCollection-method-find-option.yaml
ref: modifiers ref: comment
operation: MongoDB\\Collection::findOne
position: 5
--- ---
source: source:
file: apiargs-common-option.yaml file: apiargs-common-option.yaml
ref: maxTimeMS ref: maxTimeMS
operation: MongoDB\\Collection::findOne
position: 6
--- ---
source: source:
file: apiargs-common-option.yaml file: apiargs-MongoDBCollection-common-option.yaml
ref: readConcern ref: readConcern
operation: MongoDB\\Collection::findOne
position: 7
--- ---
source: source:
file: apiargs-common-option.yaml file: apiargs-MongoDBCollection-common-option.yaml
ref: readPreference ref: readPreference
pre: |
For use with MongoDB 3.0 and earlier.
operation: MongoDB\\Collection::findOne
position: 8
--- ---
source: source:
file: apiargs-common-option.yaml file: apiargs-MongoDBCollection-common-option.yaml
ref: typeMap ref: typeMap
operation: MongoDB\\Collection::findOne post: |
position: 9 This will be used for the returned result document.
... ---
\ No newline at end of file source:
file: apiargs-MongoDBCollection-method-find-option.yaml
ref: modifiers
...
source: source:
file: apiargs-MongoDBCollection-common-param.yaml
ref: $filter ref: $filter
file: apiargs-common-param.yaml optional: true
operation: MongoDB\\Collection::findOne
replacement: replacement:
verb: "query" action: " to query"
position: 1
--- ---
source: source:
ref: $options
file: apiargs-common-param.yaml file: apiargs-common-param.yaml
operation: MongoDB\\Collection::findOne ref: $options
position: 2
... ...
source: source:
file: apiargs-MongoDBCollection-method-find-option.yaml file: apiargs-MongoDBCollection-method-find-option.yaml
ref: projection ref: projection
operation: MongoDB\\Collection::findOneAndDelete
position: 1
--- ---
source: source:
file: apiargs-MongoDBCollection-method-find-option.yaml file: apiargs-MongoDBCollection-method-find-option.yaml
ref: sort ref: sort
operation: MongoDB\\Collection::findOneAndDelete ---
position: 2 source:
file: apiargs-MongoDBCollection-common-option.yaml
ref: collation
--- ---
source: source:
file: apiargs-common-option.yaml file: apiargs-common-option.yaml
ref: maxTimeMS ref: maxTimeMS
operation: MongoDB\\Collection::findOneAndDelete
position: 3
--- ---
source: source:
file: apiargs-common-option.yaml file: apiargs-MongoDBCollection-common-option.yaml
ref: writeConcern ref: writeConcern
operation: MongoDB\\Collection::findOneAndDelete post: |
position: 4 This is not supported for server versions prior to 3.2 and will be ignored if
... used.
\ No newline at end of file ...
source: source:
file: apiargs-MongoDBCollection-common-param.yaml
ref: $filter ref: $filter
file: apiargs-common-param.yaml optional: false
operation: MongoDB\\Collection::findOneAndDelete
replacement: replacement:
verb: "query" action: " to delete"
position: 1
--- ---
source: source:
ref: $options
file: apiargs-common-param.yaml file: apiargs-common-param.yaml
operation: MongoDB\\Collection::findOneAndDelete ref: $options
position: 2
... ...
source: source:
file: apiargs-MongoDBCollection-method-find-option.yaml file: apiargs-MongoDBCollection-method-find-option.yaml
ref: projection ref: projection
operation: MongoDB\\Collection::findOneAndReplace
position: 1
--- ---
source: source:
file: apiargs-MongoDBCollection-method-find-option.yaml file: apiargs-MongoDBCollection-method-find-option.yaml
ref: sort ref: sort
operation: MongoDB\\Collection::findOneAndReplace ---
position: 2 source:
file: apiargs-MongoDBCollection-common-option.yaml
ref: collation
--- ---
source: source:
file: apiargs-common-option.yaml file: apiargs-common-option.yaml
ref: maxTimeMS ref: maxTimeMS
operation: MongoDB\\Collection::findOneAndReplace
position: 3
--- ---
source: source:
file: apiargs-common-option.yaml file: apiargs-MongoDBCollection-common-option.yaml
ref: bypassDocumentValidation ref: bypassDocumentValidation
operation: MongoDB\\Collection::findOneAndReplace
position: 4
--- ---
source: arg_name: option
file: apiargs-MongoDBCollection-method-findOneAndUpdate-option.yaml name: returnDocument
ref: returnDocument type: integer
operation: MongoDB\\Collection::findOneAndReplace description: |
position: 5 Specifies whether to return the document before the replacement is applied, or
after. ``returnDocument`` supports the following values:
- ``MongoDB\Operation\FindOneAndReplace::RETURN_DOCUMENT_BEFORE`` (*default*)
- ``MongoDB\Operation\FindOneAndReplace::RETURN_DOCUMENT_AFTER``
interface: phpmethod
operation: ~
optional: true
--- ---
source: source:
file: apiargs-common-option.yaml file: apiargs-MongoDBCollection-common-option.yaml
ref: upsert ref: upsert
operation: MongoDB\\Collection::findOneAndReplace
position: 6
--- ---
source: source:
file: apiargs-common-option.yaml file: apiargs-MongoDBCollection-common-option.yaml
ref: writeConcern ref: writeConcern
operation: MongoDB\\Collection::findOneAndReplace post: |
position: 7 This is not supported for server versions prior to 3.2 and will be ignored if
... used.
\ No newline at end of file ...
source: source:
file: apiargs-MongoDBCollection-common-param.yaml
ref: $filter ref: $filter
file: apiargs-common-param.yaml
operation: MongoDB\\Collection::findOneAndReplace
replacement:
verb: "query"
optional: false optional: false
position: 1 replacement:
action: " to replace"
--- ---
arg_name: param source:
name: $replacement file: apiargs-MongoDBCollection-common-param.yaml
type: array|object ref: $replacement
description: |
The document to replace.
interface: phpmethod
operation: MongoDB\\Collection::findOneAndReplace
optional: false
position: 2
--- ---
source: source:
ref: $options
file: apiargs-common-param.yaml file: apiargs-common-param.yaml
operation: MongoDB\\Collection::findOneAndReplace ref: $options
position: 3
... ...
source: source:
file: apiargs-MongoDBCollection-method-find-option.yaml file: apiargs-MongoDBCollection-method-find-option.yaml
ref: projection ref: projection
operation: MongoDB\Collection::findOneAndUpdate
position: 1
--- ---
source: source:
file: apiargs-MongoDBCollection-method-find-option.yaml file: apiargs-MongoDBCollection-method-find-option.yaml
ref: sort ref: sort
operation: MongoDB\Collection::findOneAndUpdate ---
position: 2 source:
file: apiargs-MongoDBCollection-common-option.yaml
ref: collation
--- ---
source: source:
file: apiargs-common-option.yaml file: apiargs-common-option.yaml
ref: maxTimeMS ref: maxTimeMS
operation: MongoDB\Collection::findOneAndUpdate
position: 3
--- ---
source: source:
file: apiargs-common-option.yaml file: apiargs-MongoDBCollection-common-option.yaml
ref: bypassDocumentValidation ref: bypassDocumentValidation
operation: MongoDB\Collection::findOneAndUpdate
position: 4
--- ---
arg_name: option arg_name: option
name: returnDocument name: returnDocument
type: integer type: integer
description: | description: |
Specifies whether to return the document before the {{event}}, or Specifies whether to return the document before the update is applied, or
after. ``returnDocument`` supports the following values: after. ``returnDocument`` supports the following values:
- ``MongoDB\Operation\FindOneAndReplace::RETURN_DOCUMENT_BEFORE`` (*default*) - ``MongoDB\Operation\FindOneAndUpdate::RETURN_DOCUMENT_BEFORE`` (*default*)
- ``MongoDB\Operation\FindOneAndReplace::RETURN_DOCUMENT_AFTER`` - ``MongoDB\Operation\FindOneAndUpdate::RETURN_DOCUMENT_AFTER``
optional: true
replacement:
event: "update is applied"
interface: phpmethod interface: phpmethod
operation: MongoDB\Collection::findOneAndUpdate operation: ~
position: 5 optional: true
--- ---
source: source:
file: apiargs-common-option.yaml file: apiargs-MongoDBCollection-common-option.yaml
ref: upsert ref: upsert
operation: MongoDB\\Collection::findOneAndUpdate
position: 6
--- ---
source: source:
file: apiargs-common-option.yaml file: apiargs-MongoDBCollection-common-option.yaml
ref: writeConcern ref: writeConcern
operation: MongoDB\Collection::findOneAndUpdate post: |
position: 7 This is not supported for server versions prior to 3.2 and will be ignored if
... used.
\ No newline at end of file ...
source: source:
file: apiargs-MongoDBCollection-common-param.yaml
ref: $filter ref: $filter
file: apiargs-common-param.yaml
operation: MongoDB\\Collection::findOneAndUpdate
replacement:
verb: "query"
optional: false optional: false
position: 1 replacement:
action: " to update"
--- ---
arg_name: param source:
name: $update file: apiargs-MongoDBCollection-common-param.yaml
type: array|object ref: $update
description: |
Specifies the field and value combinations to update and any
relevant update operators. ``$update`` uses MongoDB's
:method:`update operators </reference/operator/update>`.
interface: phpmethod
operation: MongoDB\\Collection::findOneAndUpdate
optional: false
position: 2
--- ---
source: source:
ref: $options
file: apiargs-common-param.yaml file: apiargs-common-param.yaml
operation: MongoDB\\Collection::findOneAndUpdate ref: $options
position: 3
... ...
source: source:
file: apiargs-common-option.yaml file: apiargs-MongoDBCollection-common-option.yaml
ref: bypassDocumentValidation ref: bypassDocumentValidation
operation: MongoDB\\Collection::insertMany
position: 1
--- ---
source: source:
file: apiargs-MongoDBCollection-method-bulkWrite-option.yaml file: apiargs-MongoDBCollection-method-bulkWrite-option.yaml
ref: ordered ref: ordered
operation: MongoDB\\Collection::insertMany
position: 2
--- ---
source: source:
file: apiargs-common-option.yaml file: apiargs-MongoDBCollection-common-option.yaml
ref: writeConcern ref: writeConcern
operation: MongoDB\\Collection::insertMany ...
position: 3
...
\ No newline at end of file
...@@ -4,13 +4,10 @@ type: array ...@@ -4,13 +4,10 @@ type: array
description: | description: |
The documents to insert into the collection. The documents to insert into the collection.
interface: phpmethod interface: phpmethod
operation: MongoDB\\Collection::insertMany operation: ~
optional: false optional: false
position: 1
--- ---
source: source:
file: apiargs-common-param.yaml file: apiargs-common-param.yaml
ref: $options ref: $options
operation: MongoDB\\Collection::insertMany ...
position: 2
...
\ No newline at end of file
source: source:
file: apiargs-common-option.yaml file: apiargs-MongoDBCollection-common-option.yaml
ref: bypassDocumentValidation ref: bypassDocumentValidation
operation: MongoDB\\Collection::insertOne
position: 1
--- ---
source: source:
file: apiargs-common-option.yaml file: apiargs-MongoDBCollection-common-option.yaml
ref: writeConcern ref: writeConcern
operation: MongoDB\\Collection::insertOne ...
position: 2
...
\ No newline at end of file
...@@ -4,13 +4,10 @@ type: array|object ...@@ -4,13 +4,10 @@ type: array|object
description: | description: |
The document to insert into the collection. The document to insert into the collection.
interface: phpmethod interface: phpmethod
operation: MongoDB\\Collection::insertOne operation: ~
optional: false optional: false
position: 1
--- ---
source: source:
file: apiargs-common-param.yaml file: apiargs-common-param.yaml
ref: $options ref: $options
operation: MongoDB\\Collection::insertOne ...
position: 2
...
\ No newline at end of file
source: source:
ref: maxTimeMS
file: apiargs-common-option.yaml file: apiargs-common-option.yaml
operation: MongoDB\\Collection::listIndexes ref: maxTimeMS
position: 1
... ...
source: source:
ref: $options
file: apiargs-common-param.yaml file: apiargs-common-param.yaml
operation: MongoDB\\Collection::listIndexes ref: $options
position: 1
... ...
source: source:
file: apiargs-common-option.yaml file: apiargs-MongoDBCollection-common-option.yaml
ref: upsert
---
source:
file: apiargs-MongoDBCollection-common-option.yaml
ref: bypassDocumentValidation ref: bypassDocumentValidation
operation: MongoDB\\Collection::replaceOne
position: 1
--- ---
source: source:
file: apiargs-common-option.yaml file: apiargs-MongoDBCollection-common-option.yaml
ref: upsert ref: collation
operation: MongoDB\\Collection::replaceOne
position: 2
--- ---
source: source:
file: apiargs-common-option.yaml file: apiargs-MongoDBCollection-common-option.yaml
ref: writeConcern ref: writeConcern
operation: MongoDB\\Collection::replaceOne ...
position: 3
...
\ No newline at end of file
source: source:
file: apiargs-MongoDBCollection-common-param.yaml
ref: $filter ref: $filter
file: apiargs-common-param.yaml
operation: MongoDB\\Collection::replaceOne
replacement:
verb: "query"
optional: false optional: false
position: 1 replacement:
action: " to replace"
--- ---
arg_name: param source:
name: $replacement file: apiargs-MongoDBCollection-common-param.yaml
type: array ref: $replacement
description: |
The document to replace.
interface: phpmethod
operation: MongoDB\\Collection::replaceOne
optional: false
position: 2
--- ---
source: source:
ref: $options
file: apiargs-common-param.yaml file: apiargs-common-param.yaml
operation: MongoDB\\Collection::replaceOne ref: $options
position: 3
... ...
source: source:
file: apiargs-common-option.yaml file: apiargs-MongoDBCollection-common-option.yaml
ref: upsert
---
source:
file: apiargs-MongoDBCollection-common-option.yaml
ref: bypassDocumentValidation ref: bypassDocumentValidation
operation: MongoDB\\Collection::updateMany
position: 1
--- ---
source: source:
file: apiargs-common-option.yaml file: apiargs-MongoDBCollection-common-option.yaml
ref: upsert ref: collation
operation: MongoDB\\Collection::updateMany
position: 2
--- ---
source: source:
file: apiargs-common-option.yaml file: apiargs-MongoDBCollection-common-option.yaml
ref: writeConcern ref: writeConcern
operation: MongoDB\\Collection::updateMany ...
position: 3
...
\ No newline at end of file
source: source:
file: apiargs-MongoDBCollection-common-param.yaml
ref: $filter ref: $filter
file: apiargs-common-param.yaml
operation: MongoDB\\Collection::updateMany
replacement:
verb: "query"
optional: false optional: false
position: 1 replacement:
action: " to update"
--- ---
source: source:
file: apiargs-MongoDBCollection-method-findOneAndUpdate-param.yaml file: apiargs-MongoDBCollection-common-param.yaml
ref: $update ref: $update
operation: MongoDB\\Collection::updateMany
optional: false
position: 2
--- ---
source: source:
ref: $options
file: apiargs-common-param.yaml file: apiargs-common-param.yaml
operation: MongoDB\\Collection::updateMany ref: $options
position: 3
... ...
source: source:
file: apiargs-common-option.yaml file: apiargs-MongoDBCollection-common-option.yaml
ref: upsert
---
source:
file: apiargs-MongoDBCollection-common-option.yaml
ref: bypassDocumentValidation ref: bypassDocumentValidation
operation: MongoDB\\Collection::updateOne
position: 1
--- ---
source: source:
file: apiargs-common-option.yaml file: apiargs-MongoDBCollection-common-option.yaml
ref: upsert ref: collation
operation: MongoDB\\Collection::updateOne
position: 2
--- ---
source: source:
file: apiargs-common-option.yaml file: apiargs-MongoDBCollection-common-option.yaml
ref: writeConcern ref: writeConcern
operation: MongoDB\\Collection::updateOne ...
position: 3
...
\ No newline at end of file
source: source:
file: apiargs-MongoDBCollection-common-param.yaml
ref: $filter ref: $filter
file: apiargs-common-param.yaml
operation: MongoDB\\Collection::updateOne
replacement:
verb: "query"
optional: false optional: false
position: 1 replacement:
action: " to update"
--- ---
source: source:
file: apiargs-MongoDBCollection-method-findOneAndUpdate-param.yaml file: apiargs-MongoDBCollection-common-param.yaml
ref: $update ref: $update
operation: MongoDB\\Collection::updateOne
optional: false
position: 2
--- ---
source: source:
ref: $options
file: apiargs-common-param.yaml file: apiargs-common-param.yaml
operation: MongoDB\\Collection::updateOne ref: $options
position: 3
... ...
source: source:
file: apiargs-common-option.yaml file: apiargs-common-option.yaml
ref: readConcern ref: readConcern
operation: MongoDB\\Collection::withOptions replacement:
description: | resource: "collection"
The default read concern to use for collection operations. Defaults parent: "original collection"
to the original Collection's specified read concern.
--- ---
source: source:
file: apiargs-common-option.yaml file: apiargs-common-option.yaml
ref: readPreference ref: readPreference
operation: MongoDB\\Collection::withOptions replacement:
description: | resource: "collection"
The default read preference to use for collection operations. parent: "original collection"
Defaults to the original Collection's read preference.
--- ---
source: source:
file: apiargs-common-option.yaml file: apiargs-common-option.yaml
ref: typeMap ref: typeMap
operation: MongoDB\\Collection::withOptions replacement:
description: | parent: "original collection"
Default type map for cursors and BSON documents. Defaults to the
original Collection's type map value.
--- ---
source: source:
file: apiargs-common-option.yaml file: apiargs-common-option.yaml
ref: writeConcern ref: writeConcern
operation: MongoDB\\Collection::withOptions replacement:
description: | resource: "collection"
The default write concern to use for collection operations. Defaults parent: "original collection"
to the original Collection's specified write concern. ...
...
\ No newline at end of file
source: source:
ref: $options
file: apiargs-common-param.yaml file: apiargs-common-param.yaml
operation: MongoDB\\Collection::withOptions ref: $options
position: 1
... ...
source:
file: apiargs-common-option.yaml
ref: typeMap
replacement:
parent: "database"
---
arg_name: option
name: writeConcern
type: :php:`MongoDB\\Driver\\WriteConcern <class.mongodb-driver-writeconcern>`
description: |
:manual:`Write concern </reference/write-concern>` to use for the operation.
Defaults to the database's write concern.
interface: phpmethod
operation: ~
optional: true
...
source: source:
file: apiargs-common-option.yaml file: apiargs-common-option.yaml
ref: readPreference ref: readPreference
operation: MongoDB\\Database::command description: |
position: 1 :manual:`Read preference </reference/read-preference>` to use for the
operation. Defaults to the database's read preference.
--- ---
source: source:
file: apiargs-common-option.yaml file: apiargs-MongoDBDatabase-common-option.yaml
ref: typeMap ref: typeMap
operation: MongoDB\\Database::command
position: 2
... ...
arg_name: param arg_name: param
name: $command name: $command
type: string type: array|object
description: | description: |
The name of the :manual:`database command </reference/command>` The :manual:`database command </reference/command>` document.
to execute.
interface: phpmethod interface: phpmethod
operation: MongoDB\\Database::command operation: ~
optional: false optional: false
position: 1
--- ---
source: source:
file: apiargs-common-param.yaml file: apiargs-common-param.yaml
ref: $options ref: $options
operation: MongoDB\\Database::command
position: 2
... ...
source: source:
file: apiargs-common-option.yaml file: apiargs-common-option.yaml
ref: readConcern ref: readConcern
operation: MongoDB\\Database::__construct replacement:
position: 1 resource: "database"
parent: "manager"
--- ---
source: source:
file: apiargs-common-option.yaml file: apiargs-common-option.yaml
ref: readPreference ref: readPreference
operation: MongoDB\\Database::__construct replacement:
position: 2 resource: "database"
parent: "manager"
--- ---
source: source:
file: apiargs-common-option.yaml file: apiargs-MongoDBClient-method-construct-driverOptions.yaml
ref: typeMap ref: typeMap
operation: MongoDB\\Database::__construct
position: 3
--- ---
source: source:
file: apiargs-common-option.yaml file: apiargs-common-option.yaml
ref: writeConcern ref: writeConcern
operation: MongoDB\\Database::__construct replacement:
position: 4 resource: "database"
... parent: "manager"
\ No newline at end of file ...
source: source:
file: apiargs-MongoDBCollection-method-construct-param.yaml file: apiargs-common-param.yaml
ref: $manager ref: $manager
operation: MongoDB\\Database::__construct
position: 1
--- ---
source: source:
ref: $databaseName
file: apiargs-common-param.yaml file: apiargs-common-param.yaml
operation: MongoDB\\Database::__construct ref: $databaseName
position: 2
--- ---
source: source:
ref: $options
file: apiargs-common-param.yaml file: apiargs-common-param.yaml
operation: MongoDB\\Database::__construct ref: $options
position: 2 ...
...
\ No newline at end of file
source: source:
file: apiargs-common-param.yaml file: apiargs-common-param.yaml
ref: $collectionName ref: $collectionName
operation: MongoDB\\Database::createCollection replacement:
position: 1 action: " to create"
optional: false
--- ---
source: source:
file: apiargs-common-param.yaml file: apiargs-common-param.yaml
ref: $options ref: $options
operation: MongoDB\\Database::createCollection ...
position: 2
optional: true
...
\ No newline at end of file
source: source:
file: apiargs-common-option.yaml file: apiargs-MongoDBDatabase-common-option.yaml
ref: typeMap ref: typeMap
operation: MongoDB\\Database::dropCollection post: |
position: 1 This will be used for the returned command result document.
... ---
\ No newline at end of file source:
file: apiargs-MongoDBDatabase-common-option.yaml
ref: writeConcern
post: |
This is not supported for server versions prior to 3.4 and will result in an
exception at execution time if used.
...
source:
file: apiargs-common-param.yaml
ref: $collectionName
operation: MongoDB\\Database::dropCollection
position: 1
optional: false
---
source: source:
file: apiargs-common-param.yaml file: apiargs-common-param.yaml
ref: $options ref: $options
operation: MongoDB\\Database::dropCollection ...
position: 2
optional: true
...
\ No newline at end of file
source: source:
file: apiargs-common-option.yaml file: apiargs-MongoDBDatabase-common-option.yaml
ref: typeMap ref: typeMap
operation: MongoDB\\Database::dropCollection post: |
position: 1 This will be used for the returned command result document.
... ---
\ No newline at end of file source:
file: apiargs-MongoDBDatabase-common-option.yaml
ref: writeConcern
post: |
This is not supported for server versions prior to 3.4 and will result in an
exception at execution time if used.
...
source: source:
file: apiargs-common-param.yaml file: apiargs-common-param.yaml
ref: $collectionName ref: $collectionName
operation: MongoDB\\Database::dropCollection replacement:
position: 1 action: " to drop"
optional: false
--- ---
source: source:
file: apiargs-common-param.yaml file: apiargs-common-param.yaml
ref: $options ref: $options
operation: MongoDB\\Database::dropCollection ...
position: 2
optional: true
...
\ No newline at end of file
source: source:
file: apiargs-common-param.yaml file: apiargs-common-param.yaml
ref: $collectionName ref: $collectionName
operation: MongoDB\\Database::__get replacement:
position: 1 action: " to select"
... ...
\ No newline at end of file
source: arg_name: option
file: apiargs-common-option.yaml name: filter
ref: readConcern type: array|object
operation: MongoDB\\Database::listCollections description: |
position: 1 A query expression to filter the list of collections.
---
source: You can specify a query expression on the collection ``name`` and ``options``.
file: apiargs-common-option.yaml interface: phpmethod
ref: readPreference operation: ~
operation: MongoDB\\Database::listCollections optional: true
position: 2
---
source:
file: apiargs-common-option.yaml
ref: typeMap
operation: MongoDB\\Database::listCollections
position: 3
--- ---
source: source:
file: apiargs-common-option.yaml file: apiargs-common-option.yaml
ref: writeConcern ref: maxTimeMS
operation: MongoDB\\Database::listCollections ...
position: 4
...
\ No newline at end of file
source: source:
file: apiargs-common-param.yaml file: apiargs-common-param.yaml
ref: $options ref: $options
operation: MongoDB\\Database::listCollections ...
position: 1
optional: true
...
\ No newline at end of file
source: source:
file: apiargs-common-option.yaml file: apiargs-common-option.yaml
ref: readConcern ref: readConcern
operation: MongoDB\\Database::selectCollection replacement:
position: 1 resource: "collection"
parent: "database"
--- ---
source: source:
file: apiargs-common-option.yaml file: apiargs-common-option.yaml
ref: readPreference ref: readPreference
operation: MongoDB\\Database::selectCollection replacement:
position: 2 resource: "collection"
parent: "database"
--- ---
source: source:
file: apiargs-common-option.yaml file: apiargs-common-option.yaml
ref: typeMap ref: typeMap
operation: MongoDB\\Database::selectCollection replacement:
position: 3 parent: "database"
--- ---
source: source:
file: apiargs-common-option.yaml file: apiargs-common-option.yaml
ref: writeConcern ref: writeConcern
operation: MongoDB\\Database::selectCollection replacement:
position: 4 resource: "collection"
... parent: "database"
\ No newline at end of file ...
source: source:
file: apiargs-common-param.yaml file: apiargs-common-param.yaml
ref: $collectionName ref: $collectionName
operation: MongoDB\\Database::selectCollection replacement:
position: 1 action: " to select"
optional: false
--- ---
source: source:
file: apiargs-common-param.yaml file: apiargs-common-param.yaml
ref: $options ref: $options
operation: MongoDB\\Database::selectCollection ...
position: 2
...
\ No newline at end of file
arg_name: option
name: bucketName
type: string
description: |
The bucket name, which will be used as a prefix for the files and chunks
collections. Defaults to ``"fs"``.
interface: phpmethod
operation: ~
optional: true
---
arg_name: option
name: chunkSizeBytes
type: integer
description: |
The chunk size in bytes. Defaults to ``261120`` (i.e. 255 KiB).
interface: phpmethod
operation: ~
optional: true
---
source:
file: apiargs-common-option.yaml
ref: readConcern
replacement:
resource: "bucket"
parent: "database"
---
source:
file: apiargs-common-option.yaml
ref: readPreference
replacement:
resource: "bucket"
parent: "database"
---
source:
file: apiargs-common-option.yaml
ref: writeConcern
replacement:
resource: "bucket"
parent: "database"
...
source:
file: apiargs-common-param.yaml
ref: $options
...
source: source:
file: apiargs-common-option.yaml file: apiargs-common-option.yaml
ref: readConcern ref: readConcern
operation: MongoDB\\Database::withOptions replacement:
description: | resource: "database"
The default read concern to use for database operations. Defaults parent: "original database"
to the original Databases's specified read concern.
--- ---
source: source:
file: apiargs-common-option.yaml file: apiargs-common-option.yaml
ref: readPreference ref: readPreference
operation: MongoDB\\Database::withOptions replacement:
description: | resource: "database"
The default read preference to use for database operations. parent: "original database"
Defaults to the original Database's read preference.
--- ---
source: source:
file: apiargs-common-option.yaml file: apiargs-common-option.yaml
ref: typeMap ref: typeMap
operation: MongoDB\\Database::withOptions replacement:
description: | parent: "original database"
Default type map for cursors and BSON documents. Defaults to the
original Database's type map value.
--- ---
source: source:
file: apiargs-common-option.yaml file: apiargs-common-option.yaml
ref: writeConcern ref: writeConcern
operation: MongoDB\\Database::withOptions replacement:
description: | resource: "database"
The default write concern to use for database operations. Defaults parent: "original database"
to the original Database's specified write concern. ...
...
\ No newline at end of file
source: source:
ref: $options
file: apiargs-common-param.yaml file: apiargs-common-param.yaml
operation: MongoDB\\Database::withOptions ref: $options
position: 1
... ...
arg_name: option
name: _id
type: mixed
description: |
Value to use as the file document identifier. Defaults to a new
:php:`MongoDB\\BSON\\ObjectID <class.mongodb-bson-objectid>` object.
interface: phpmethod
operation: ~
optional: true
---
arg_name: option
name: chunkSizeBytes
type: integer
description: |
The chunk size in bytes. Defaults to the bucket's ``chunkSizeBytes`` option.
interface: phpmethod
operation: ~
optional: true
---
arg_name: option
name: metadata
type: array|object
description: |
User data for the ``metadata`` field of the file document. If not specified,
the ``metadata`` field will not be set on the file document.
interface: phpmethod
operation: ~
optional: true
---
arg_name: option
name: revision
type: integer
description: |
The revision of the file to retrieve. Files with the name ``filename`` will be
differentiated by their ``uploadDate`` field.
Revision numbers are defined as follows:
- 0 = the original stored file
- 1 = the first revision
- 2 = the second revision
- etc...
- -2 = the second most recent revision
- -1 = the most recent revision
Defaults to -1 (i.e. the most recent revision).
interface: phpmethod
operation: ~
optional: true
...
arg_name: param
name: $filename
type: string
description: |
The ``filename`` of the file{{action}}.
interface: phpmethod
operation: ~
optional: false
replacement:
action: ""
---
arg_name: param
name: $id
type: mixed
description: |
The ``_id`` of the file{{action}}.
interface: phpmethod
operation: ~
optional: false
replacement:
action: ""
---
arg_name: param
name: $stream
type: resource
description: |
The GridFS stream resource.
interface: phpmethod
operation: ~
---
arg_name: param
name: $destination
type: resource
description: |
Writable stream, to which the GridFS file's contents will be written.
interface: phpmethod
operation: ~
optional: false
...
arg_name: option
name: bucketName
type: string
description: |
The bucket name, which will be used as a prefix for the files and chunks
collections. Defaults to ``"fs"``.
interface: phpmethod
operation: ~
optional: true
---
arg_name: option
name: chunkSizeBytes
type: integer
description: |
The chunk size in bytes. Defaults to ``261120`` (i.e. 255 KiB).
interface: phpmethod
operation: ~
optional: true
---
source:
file: apiargs-common-option.yaml
ref: readConcern
replacement:
resource: "bucket"
parent: "database"
---
source:
file: apiargs-common-option.yaml
ref: readPreference
replacement:
resource: "bucket"
parent: "database"
---
source:
file: apiargs-common-option.yaml
ref: writeConcern
replacement:
resource: "bucket"
parent: "database"
...
source:
file: apiargs-common-param.yaml
ref: $manager
---
source:
file: apiargs-common-param.yaml
ref: $databaseName
---
source:
file: apiargs-common-param.yaml
ref: $options
...
source:
file: apiargs-MongoDBGridFSBucket-common-param.yaml
ref: $id
replacement:
resource: " to delete"
...
source:
file: apiargs-MongoDBGridFSBucket-common-param.yaml
ref: $id
replacement:
resource: " to download"
---
source:
file: apiargs-MongoDBGridFSBucket-common-param.yaml
ref: $destination
...
source:
file: apiargs-MongoDBGridFSBucket-common-option.yaml
ref: revision
...
source:
file: apiargs-MongoDBGridFSBucket-common-param.yaml
ref: $filename
replacement:
resource: " to download"
---
source:
file: apiargs-MongoDBGridFSBucket-common-param.yaml
ref: $destination
---
source:
file: apiargs-common-param.yaml
ref: $options
...
source:
file: apiargs-MongoDBCollection-method-find-option.yaml
ref: projection
---
source:
file: apiargs-MongoDBCollection-method-find-option.yaml
ref: sort
---
source:
file: apiargs-MongoDBCollection-method-find-option.yaml
ref: skip
---
source:
file: apiargs-MongoDBCollection-method-find-option.yaml
ref: limit
---
source:
file: apiargs-MongoDBCollection-method-find-option.yaml
ref: batchSize
---
source:
file: apiargs-MongoDBCollection-method-find-option.yaml
ref: collation
---
source:
file: apiargs-MongoDBCollection-method-find-option.yaml
ref: comment
---
source:
file: apiargs-MongoDBCollection-method-find-option.yaml
ref: cursorType
---
source:
file: apiargs-MongoDBCollection-method-find-option.yaml
ref: maxTimeMS
---
source:
file: apiargs-MongoDBCollection-method-find-option.yaml
ref: readConcern
description: |
:manual:`Read concern </reference/read-concern>` to use for the operation.
Defaults to the bucket's read concern.
---
source:
file: apiargs-MongoDBCollection-method-find-option.yaml
ref: readPreference
description: |
:manual:`Read preference </reference/read-preference>` to use for the
operation. Defaults to the bucket's read preference.
---
source:
file: apiargs-MongoDBCollection-method-find-option.yaml
ref: oplogReplay
---
source:
file: apiargs-MongoDBCollection-method-find-option.yaml
ref: noCursorTimeout
---
source:
file: apiargs-MongoDBCollection-method-find-option.yaml
ref: allowPartialResults
---
source:
file: apiargs-MongoDBCollection-method-find-option.yaml
ref: typeMap
replacement:
parent: "bucket"
---
source:
file: apiargs-MongoDBCollection-method-find-option.yaml
ref: modifiers
...
source:
file: apiargs-MongoDBGridFSBucket-common-param.yaml
ref: $stream
...
source:
file: apiargs-MongoDBGridFSBucket-common-param.yaml
ref: $stream
...
source:
file: apiargs-MongoDBGridFSBucket-common-param.yaml
ref: $id
replacement:
resource: " to download"
...
source:
file: apiargs-MongoDBGridFSBucket-common-option.yaml
ref: revision
...
source:
file: apiargs-MongoDBGridFSBucket-common-param.yaml
ref: $filename
replacement:
resource: " to download"
---
source:
file: apiargs-common-param.yaml
ref: $options
...
source:
file: apiargs-MongoDBGridFSBucket-common-option.yaml
ref: _id
---
source:
file: apiargs-MongoDBGridFSBucket-common-option.yaml
ref: chunkSizeBytes
---
source:
file: apiargs-MongoDBGridFSBucket-common-option.yaml
ref: metadata
...
source:
file: apiargs-MongoDBGridFSBucket-common-param.yaml
ref: $filename
replacement:
resource: " to create"
---
source:
file: apiargs-common-param.yaml
ref: $options
...
source:
file: apiargs-MongoDBGridFSBucket-common-param.yaml
ref: $id
replacement:
resource: " to rename"
---
arg_name: param
name: $newFilename
type: string
description: |
The new ``filename`` value.
interface: phpmethod
operation: ~
optional: false
...
source:
file: apiargs-MongoDBGridFSBucket-common-option.yaml
ref: _id
---
source:
file: apiargs-MongoDBGridFSBucket-common-option.yaml
ref: chunkSizeBytes
---
source:
file: apiargs-MongoDBGridFSBucket-common-option.yaml
ref: metadata
...
source:
file: apiargs-MongoDBGridFSBucket-common-param.yaml
ref: $filename
replacement:
resource: " to create"
---
arg_name: param
name: $source
type: resource
description: |
Readable stream, from which the new GridFS file's contents will be read.
interface: phpmethod
operation: ~
optional: false
---
source:
file: apiargs-common-param.yaml
ref: $options
...
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment