PHPLIB-354: Implement new count API #542
Conversation
| pattern as a document. If specified, then the query system will only consider | ||
| plans using the hinted index. | ||
| .. versionchanged:: 1.2 |
There was a problem hiding this comment.
The versionchanged macro can be removed here. Since the method itself is versionadded in 1.4, everything is new.
| file: apiargs-common-option.yaml | ||
| ref: session | ||
| post: | | ||
| .. versionadded:: 1.3 |
| source: | ||
| file: apiargs-MongoDBCollection-common-param.yaml | ||
| ref: $filter | ||
| optional: true |
There was a problem hiding this comment.
I noted that the CRUD spec states that applications must be required to pass a value, but I'm totally in favor of keeping this optional and defaulting to an empty document. It's consistent with the deviation I made for find().
| file: apiargs-common-option.yaml | ||
| ref: session | ||
| post: | | ||
| .. versionadded:: 1.3 |
|
|
||
| .. phpmethod:: MongoDB\\Collection::estimateDocumentCount() | ||
|
|
||
| Gets an estimate of the count of documents in a collection using collection metadata. |
There was a problem hiding this comment.
I think this reads better (less "of"):
Gets an estimated number of documents in the collection using the collection metadata.
There was a problem hiding this comment.
I copied it out of the CRUD spec... I agree though, so updated.
| * @param array $options Command options | ||
| * @throws InvalidArgumentException for parameter/option parsing errors | ||
| */ | ||
| public function __construct($databaseName, $collectionName, array $options = []) |
There was a problem hiding this comment.
Similar to CountDocuments encapsulating an Aggregate, I think this class an encapsulate a Count operation. We'd then leverage it's existing implementation of Executable and Explainable.
Feel free to lump this in with the ticket for refactoring CountDocuments.
There was a problem hiding this comment.
I've created that ticket: https://jira.mongodb.org/browse/PHPLIB-357
| throw new UnexpectedValueException('count command did not return a numeric "n" value'); | ||
| } | ||
|
|
||
| return (integer) $result->n; |
There was a problem hiding this comment.
Another candidate for PHPLIB-356, along with the original Count operation of course.
| ); | ||
|
|
||
| case 'estimatedDocumentCount': | ||
| return $this->collection->estimatedDocumentCount( |
There was a problem hiding this comment.
This can probably fit on one line.
|
|
||
| default: | ||
| throw new LogicException('Unsupported operation: ' . $operationName); | ||
| throw new LogicException('Unsupported operation: ' . $operation['name']); |
There was a problem hiding this comment.
Was $operationName undefined? If so, good catch!
| * @throws InvalidArgumentException for parameter/option parsing errors | ||
| * @throws DriverRuntimeException for other driver errors (e.g. connection errors) | ||
| */ | ||
| public function countDocuments($filter = [], array $options = []) |
There was a problem hiding this comment.
As noted elsewhere, this default value on $filter is sufficient to provide a convenience to users. The Operation class can omit the default value.
| /reference/method/MongoDBCollection-drop | ||
| /reference/method/MongoDBCollection-dropIndex | ||
| /reference/method/MongoDBCollection-dropIndexes | ||
| /reference/method/MongoDBCollection-estimatedDocumentCount |
There was a problem hiding this comment.
Building the docs produced the following warning:
source/reference/class/MongoDBCollection.txt:59: WARNING: toctree contains reference to nonexisting document u'reference/method/MongoDBCollection-estimatedDocumentCount'
Looks like a typo in the filename for MongoDBCollection-estimateDocumentCount.txt (missing a "d" before "Document").
| @@ -0,0 +1,56 @@ | |||
| ============================================ | |||
| MongoDB\\Collection::estimateDocumentCount() | |||
There was a problem hiding this comment.
I have this done wrong consistently - mostly.
| Definition | ||
| ---------- | ||
|
|
||
| .. phpmethod:: MongoDB\\Collection::estimateDocumentCount() |
jmikola
left a comment
jmikola
left a comment
There was a problem hiding this comment.
Changes LGTM.
PHPLIB-356 can deal with the integer casts. Thanks for creating PHPLIB-357 to track refactoring.
derickr
force-pushed
the
PHPLIB-354-count-helpers
branch
from
b75386e to
5464f18
Compare
2 participants
No description provided.