PHPLIB-340: Deprecate maxScan query option #532
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jmikola
reviewed
Apr 23, 2018
| description: | | ||
| Maximum number of documents or index keys to scan when executing the query. | ||
| .. versionadded:: 1.2 |
Member
There was a problem hiding this comment.
Removing these options would technically be a BC break. We should actually note that they're deprecated in the documentation with .. deprecated:: 1.4.
| * on new documents to satisfy a query, if cursorType is TAILABLE_AWAIT. | ||
| * | ||
| * * maxScan (integer): Maximum number of documents or index keys to scan | ||
| * when executing the query. |
Member
There was a problem hiding this comment.
We can add a sentence or paragraph here that says "Deprecated since 1.4."
| * * max (document): The exclusive upper bound for a specific index. | ||
| * | ||
| * * maxScan (integer): Maximum number of documents or index keys to scan | ||
| * when executing the query. |
Member
There was a problem hiding this comment.
This can be synced with the Find.php text once you add a note there.
|
|
||
| foreach ($this->getInvalidIntegerValues() as $value) { | ||
| $options[][] = ['maxScan' => $value]; | ||
| } |
Member
There was a problem hiding this comment.
This can stay and we can add a deprecation notice test as I'm doing with https://github.com/mongodb/mongo-php-library/pull/533/files#diff-aa6398bbbe577c2105dfa55f4afcf30b (once that's merged).
jmikola
approved these changes
May 1, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
https://jira.mongodb.org/browse/PHPLIB-340