Skip to content

Revise docs for bypassDocumentValidation option #391

New issue

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

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

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 7, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/includes/apiargs-MongoDBCollection-common-option.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ type: boolean
description: |
If ``true``, allows the write operation to circumvent document level
validation. Defaults to ``false``.

This option is available in MongoDB 3.2+ and is ignored for older server
versions, which do not support document level validation.
interface: phpmethod
operation: ~
optional: true
Expand Down
4 changes: 2 additions & 2 deletions src/Operation/Aggregate.php
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,8 @@ class Aggregate implements Executable
*
* * batchSize (integer): The number of documents to return per batch.
*
* * bypassDocumentValidation (boolean): If true, allows the write to opt
* out of document level validation. This only applies when the $out
* * bypassDocumentValidation (boolean): If true, allows the write to
* circumvent document level validation. This only applies when the $out
* stage is specified.
*
* For servers < 3.2, this option is ignored as document level validation
Expand Down
7 changes: 5 additions & 2 deletions src/Operation/BulkWrite.php
Original file line number Diff line number Diff line change
Expand Up @@ -86,8 +86,11 @@ class BulkWrite implements Executable
*
* Supported options for the bulk write operation:
*
* * bypassDocumentValidation (boolean): If true, allows the write to opt
* out of document level validation.
* * bypassDocumentValidation (boolean): If true, allows the write to
* circumvent document level validation. The default is false.
*
* For servers < 3.2, this option is ignored as document level validation
* is not available.
*
* * ordered (boolean): If true, when an insert fails, return without
* performing the remaining writes. If false, when a write fails,
Expand Down
7 changes: 5 additions & 2 deletions src/Operation/FindAndModify.php
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,11 @@ class FindAndModify implements Executable
* This is not supported for server versions < 3.4 and will result in an
* exception at execution time if used.
*
* * bypassDocumentValidation (boolean): If true, allows the write to opt
* out of document level validation.
* * bypassDocumentValidation (boolean): If true, allows the write to
* circumvent document level validation.
*
* For servers < 3.2, this option is ignored as document level validation
* is not available.
*
* * fields (document): Limits the fields to return for the matching
* document.
Expand Down
7 changes: 5 additions & 2 deletions src/Operation/FindOneAndReplace.php
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,11 @@ class FindOneAndReplace implements Executable
*
* Supported options:
*
* * bypassDocumentValidation (boolean): If true, allows the write to opt
* out of document level validation.
* * bypassDocumentValidation (boolean): If true, allows the write to
* circumvent document level validation.
*
* For servers < 3.2, this option is ignored as document level validation
* is not available.
*
* * collation (document): Collation specification.
*
Expand Down
7 changes: 5 additions & 2 deletions src/Operation/FindOneAndUpdate.php
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,11 @@ class FindOneAndUpdate implements Executable
*
* Supported options:
*
* * bypassDocumentValidation (boolean): If true, allows the write to opt
* out of document level validation.
* * bypassDocumentValidation (boolean): If true, allows the write to
* circumvent document level validation.
*
* For servers < 3.2, this option is ignored as document level validation
* is not available.
*
* * collation (document): Collation specification.
*
Expand Down
7 changes: 5 additions & 2 deletions src/Operation/InsertMany.php
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,11 @@ class InsertMany implements Executable
*
* Supported options:
*
* * bypassDocumentValidation (boolean): If true, allows the write to opt
* out of document level validation.
* * bypassDocumentValidation (boolean): If true, allows the write to
* circumvent document level validation.
*
* For servers < 3.2, this option is ignored as document level validation
* is not available.
*
* * ordered (boolean): If true, when an insert fails, return without
* performing the remaining writes. If false, when a write fails,
Expand Down
7 changes: 5 additions & 2 deletions src/Operation/InsertOne.php
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,11 @@ class InsertOne implements Executable
*
* Supported options:
*
* * bypassDocumentValidation (boolean): If true, allows the write to opt
* out of document level validation.
* * bypassDocumentValidation (boolean): If true, allows the write to
* circumvent document level validation.
*
* For servers < 3.2, this option is ignored as document level validation
* is not available.
*
* * writeConcern (MongoDB\Driver\WriteConcern): Write concern.
*
Expand Down
7 changes: 5 additions & 2 deletions src/Operation/ReplaceOne.php
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,11 @@ class ReplaceOne implements Executable
*
* Supported options:
*
* * bypassDocumentValidation (boolean): If true, allows the write to opt
* out of document level validation.
* * bypassDocumentValidation (boolean): If true, allows the write to
* circumvent document level validation.
*
* For servers < 3.2, this option is ignored as document level validation
* is not available.
*
* * collation (document): Collation specification.
*
Expand Down
7 changes: 5 additions & 2 deletions src/Operation/Update.php
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,11 @@ class Update implements Executable
*
* Supported options:
*
* * bypassDocumentValidation (boolean): If true, allows the write to opt
* out of document level validation.
* * bypassDocumentValidation (boolean): If true, allows the write to
* circumvent document level validation.
*
* For servers < 3.2, this option is ignored as document level validation
* is not available.
*
* * collation (document): Collation specification.
*
Expand Down
7 changes: 5 additions & 2 deletions src/Operation/UpdateMany.php
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,11 @@ class UpdateMany implements Executable
*
* Supported options:
*
* * bypassDocumentValidation (boolean): If true, allows the write to opt
* out of document level validation.
* * bypassDocumentValidation (boolean): If true, allows the write to
* circumvent document level validation.
*
* For servers < 3.2, this option is ignored as document level validation
* is not available.
*
* * collation (document): Collation specification.
*
Expand Down
7 changes: 5 additions & 2 deletions src/Operation/UpdateOne.php
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,11 @@ class UpdateOne implements Executable
*
* Supported options:
*
* * bypassDocumentValidation (boolean): If true, allows the write to opt
* out of document level validation.
* * bypassDocumentValidation (boolean): If true, allows the write to
* circumvent document level validation.
*
* For servers < 3.2, this option is ignored as document level validation
* is not available.
*
* * collation (document): Collation specification.
*
Expand Down