Shamim Rezaie
109 lines
3.3 KiB
PHP
109 lines
3.3 KiB
PHP
<?php
|
|
/*
|
|
* Copyright 2015-2017 MongoDB, Inc.
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
namespace MongoDB\Operation;
|
|
|
|
use MongoDB\Driver\Exception\RuntimeException as DriverRuntimeException;
|
|
use MongoDB\Driver\Server;
|
|
use MongoDB\Exception\InvalidArgumentException;
|
|
use MongoDB\Exception\UnexpectedValueException;
|
|
use MongoDB\Exception\UnsupportedException;
|
|
use function array_intersect_key;
|
|
|
|
/**
|
|
* Operation for obtaining an estimated count of documents in a collection
|
|
*
|
|
* @api
|
|
* @see \MongoDB\Collection::estimatedDocumentCount()
|
|
* @see http://docs.mongodb.org/manual/reference/command/count/
|
|
*/
|
|
class EstimatedDocumentCount implements Executable, Explainable
|
|
{
|
|
/** @var string */
|
|
private $databaseName;
|
|
|
|
/** @var string */
|
|
private $collectionName;
|
|
|
|
/** @var array */
|
|
private $options;
|
|
|
|
/** @var Count */
|
|
private $count;
|
|
|
|
/**
|
|
* Constructs a count command.
|
|
*
|
|
* Supported options:
|
|
*
|
|
* * maxTimeMS (integer): The maximum amount of time to allow the query to
|
|
* run.
|
|
*
|
|
* * readConcern (MongoDB\Driver\ReadConcern): Read concern.
|
|
*
|
|
* This is not supported for server versions < 3.2 and will result in an
|
|
* exception at execution time if used.
|
|
*
|
|
* * readPreference (MongoDB\Driver\ReadPreference): Read preference.
|
|
*
|
|
* * session (MongoDB\Driver\Session): Client session.
|
|
*
|
|
* Sessions are not supported for server versions < 3.6.
|
|
*
|
|
* @param string $databaseName Database name
|
|
* @param string $collectionName Collection name
|
|
* @param array $options Command options
|
|
* @throws InvalidArgumentException for parameter/option parsing errors
|
|
*/
|
|
public function __construct($databaseName, $collectionName, array $options = [])
|
|
{
|
|
$this->databaseName = (string) $databaseName;
|
|
$this->collectionName = (string) $collectionName;
|
|
$this->options = array_intersect_key($options, ['maxTimeMS' => 1, 'readConcern' => 1, 'readPreference' => 1, 'session' => 1]);
|
|
|
|
$this->count = $this->createCount();
|
|
}
|
|
|
|
/**
|
|
* Execute the operation.
|
|
*
|
|
* @see Executable::execute()
|
|
* @param Server $server
|
|
* @return integer
|
|
* @throws UnexpectedValueException if the command response was malformed
|
|
* @throws UnsupportedException if collation or read concern is used and unsupported
|
|
* @throws DriverRuntimeException for other driver errors (e.g. connection errors)
|
|
*/
|
|
public function execute(Server $server)
|
|
{
|
|
return $this->count->execute($server);
|
|
}
|
|
|
|
public function getCommandDocument(Server $server)
|
|
{
|
|
return $this->count->getCommandDocument($server);
|
|
}
|
|
|
|
/**
|
|
* @return Count
|
|
*/
|
|
private function createCount()
|
|
{
|
|
return new Count($this->databaseName, $this->collectionName, [], $this->options);
|
|
}
|
|
}
|