MongoDB\Client::listDatabases()

정의

MongoDB\Client::listDatabases()

서버의 모든 데이터베이스에 대한 정보를 반환합니다.

function listDatabases(array $options = []): MongoDB\Model\DatabaseInfoIterator

매개변수

$options : 배열

원하는 옵션을 지정하는 배열입니다.

이름	유형	설명
authorizedDatabases	부울	액세스 제어가 활성화된 경우 사용자 권한에 따라 반환되는 데이터베이스를 결정하는 플래그입니다. 자세한 내용은 listDatabases 명령 문서 를 참조하세요. 4.0.5 미만의 서버에서는 이 옵션이 무시됩니다. 버전 1.7에 추가 되었습니다.
comment	혼합	사용자가 데이터베이스 프로파일러, currentOp 출력 및 로그를 통해 작업을 추적하는 데 도움이 되는 임의의 주석을 지정할 수 있습니다. 이 옵션은 MongoDB 4.4부터 사용할 수 있으며 이전 서버 버전에 대해 지정된 경우 실행 시 예외가 발생합니다. 버전 1.13에 새로 추가되었습니다.
필터	배열|객체	데이터베이스 목록을 필터링하는 쿼리 표현식입니다. 데이터베이스 필드에 대한 쿼리 표현식을 지정할 수 있습니다(예: name, sizeOnDisk, empty). 버전 1.3에 새로 추가되었습니다.
최대 시간 (MS)	integer	커서에서 작업을 처리하는 데 걸리는 누적 시간 제한(밀리초)입니다. MongoDB는 중단 지점 이후 가장 빠른 시점에 작업을 중단합니다.
Session	MongoDB\Driver\Session	작업과 연결할 클라이언트 세션입니다. 버전 1.3에 새로 추가되었습니다.

Return Values

순회 가능한 MongoDB\Model\DatabaseInfoIterator 로, 서버 의 각 데이터베이스 에 대한 MongoDB\Model\DatabaseInfo 객체 를 포함합니다.

오류/예외

MongoDB\Exception\UnexpectedValueException 서버의 명령 응답이 잘못된 경우입니다.

MongoDB\Exception\InvalidArgumentException 매개변수 또는 옵션의 구문 분석과 관련된 오류의 경우입니다.

MongoDB\ 드라이버\Exception\RuntimeException 확장 수준의 다른 오류(예: 연결 오류).

예시

다음 예에서는 서버의 모든 데이터베이스를 나열합니다.

<?php
$client = new MongoDB\Client;
foreach ($client->listDatabases() as $databaseInfo) {
    var_dump($databaseInfo);
}

이 경우 출력은 다음과 유사합니다:

object(MongoDB\Model\DatabaseInfo)#4 (3) {
  ["name"]=>
  string(5) "local"
  ["sizeOnDisk"]=>
  float(65536)
  ["empty"]=>
  bool(false)
}
object(MongoDB\Model\DatabaseInfo)#7 (3) {
  ["name"]=>
  string(4) "test"
  ["sizeOnDisk"]=>
  float(32768)
  ["empty"]=>
  bool(false)
}

다음도 참조하세요.

• MongoDB\Client::listDatabaseNames()

• MongoDB 매뉴얼의 listDatabases 명령 참조

• 데이터베이스 열거 사양