<?php
/*
* Copyright 2020-present 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
> * https://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 ArrayIterator;
use Iterator;
use MongoDB\Command\ListDatabases as ListDatabasesCommand;
use MongoDB\Driver\Exception\RuntimeException as DriverRuntimeException;
use MongoDB\Driver\Server;
use MongoDB\Exception\InvalidArgumentException;
use MongoDB\Exception\UnexpectedValueException;
>
use function array_column;
/**
* Operation for the ListDatabases command, returning only database names.
*
* @api
* @see \MongoDB\Client::listDatabaseNames()
< * @see http://docs.mongodb.org/manual/reference/command/ListDatabases/
> * @see https://mongodb.com/docs/manual/reference/command/listDatabases/#mongodb-dbcommand-dbcmd.listDatabases
*/
class ListDatabaseNames implements Executable
{
/** @var ListDatabasesCommand */
private $listDatabases;
/**
* Constructs a listDatabases command.
*
* Supported options:
*
* * authorizedDatabases (boolean): Determines which databases are returned
* based on the user privileges.
*
* For servers < 4.0.5, this option is ignored.
*
< * * filter (document): Query by which to filter databases.
> * * comment (mixed): BSON value to attach as a comment to this command.
*
< * For servers < 3.6, this option is ignored.
> * This is not supported for servers versions < 4.4.
> *
> * * filter (document): Query by which to filter databases.
*
* * maxTimeMS (integer): The maximum amount of time to allow the query to
* run.
*
* * session (MongoDB\Driver\Session): Client session.
*
< * Sessions are not supported for server versions < 3.6.
< *
* @param array $options Command options
* @throws InvalidArgumentException for parameter/option parsing errors
*/
public function __construct(array $options = [])
{
$this->listDatabases = new ListDatabasesCommand(['nameOnly' => true] + $options);
}
/**
* Execute the operation.
*
* @see Executable::execute()
< * @param Server $server
< * @return Iterator
* @throws UnexpectedValueException if the command response was malformed
* @throws DriverRuntimeException for other driver errors (e.g. connection errors)
*/
public function execute(Server $server) : Iterator
{
$result = $this->listDatabases->execute($server);
return new ArrayIterator(array_column($result, 'name'));
}
}