Docs Menu

MongoDB\Database::listCollections()

MongoDB\Database::listCollections()

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

function listCollections(array $options = []): Iterator
$options : 배열

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

이름
유형
설명

authorizedCollections

부울

액세스 제어가 활성화된 경우 사용자 권한에 따라 반환되는 컬렉션을 결정하는 플래그입니다. 자세한 내용은 listCollections 명령 문서를 참조하세요.

4.0 미만의 서버에서는 이 옵션이 무시됩니다.

버전 1.12에 추가 되었습니다.

comment

혼합

사용자가 데이터베이스 프로파일러, currentOp 출력 및 로그를 통해 작업을 추적하는 데 도움이 되는 임의의 주석을 지정할 수 있습니다.

이 옵션은 MongoDB 4.4부터 사용할 수 있으며 이전 서버 버전에 대해 지정된 경우 실행 시 예외가 발생합니다.

버전 1.13에 새로 추가되었습니다.

필터

배열|객체

컬렉션 목록을 필터링하는 쿼리 표현식입니다.

컬렉션 필드에 대한 쿼리 표현식을 지정할 수 있습니다(예: name, options).

최대 시간 (MS)

integer

커서에서 작업을 처리하는 데 걸리는 누적 시간 제한(밀리초)입니다. MongoDB는 중단 지점 이후 가장 빠른 시점에 작업을 중단합니다.

Session

작업과 연결할 클라이언트 세션입니다.

버전 1.3에 새로 추가되었습니다.

데이터베이스 의 각 컬렉션 에 MongoDB\Model\CollectionInfo 대해 객체 제공하는 반복자 인스턴스 입니다.

다음 예에서는 test 데이터베이스의 모든 collection을 나열합니다.

<?php
$database = (new MongoDB\Client)->test;
foreach ($database->listCollections() as $collectionInfo) {
var_dump($collectionInfo);
}

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

object(MongoDB\Model\CollectionInfo)#3 (2) {
["name"]=>
string(11) "restaurants"
["options"]=>
array(0) {
}
}
object(MongoDB\Model\CollectionInfo)#3 (2) {
["name"]=>
string(5) "users"
["options"]=>
array(0) {
}
}
object(MongoDB\Model\CollectionInfo)#3 (2) {
["name"]=>
string(6) "restos"
["options"]=>
array(0) {
}
}

다음 예에서는 test 데이터베이스에서 이름이 "rest" (으)로 시작하는 모든 collection을 나열합니다.

<?php
$database = (new MongoDB\Client)->test;
$collections = $database->listCollections([
'filter' => [
'name' => new MongoDB\BSON\Regex('^rest.*'),
],
]);
foreach ($collections as $collectionInfo) {
var_dump($collectionInfo);
}

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

object(MongoDB\Model\CollectionInfo)#3 (2) {
["name"]=>
string(11) "restaurants"
["options"]=>
array(0) {
}
}
object(MongoDB\Model\CollectionInfo)#3 (2) {
["name"]=>
string(6) "restos"
["options"]=>
array(0) {
}
}