MongoDB\Database::dropCollection()

정의

MongoDB\Database::dropCollection()

현재 데이터베이스 내에서 collection을 삭제합니다.

function dropCollection(
    string $collectionName,
    array $options = []
): array|object

매개변수

$collectionName : 문자열

제거할 컬렉션의 이름입니다.

$options : 배열

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

이름	유형	설명
논평	혼합	사용자가 데이터베이스 프로파일러, currentOp 출력 및 로그를 통해 작업을 추적하는 데 도움이 되는 임의의 주석을 지정할 수 있습니다. 이 옵션은 MongoDB 4.4부터 사용할 수 있으며 이전 서버 버전에 대해 지정된 경우 실행 시 예외가 발생합니다. 버전 1.13에 새로 추가되었습니다.
암호화된 필드	배열|객체	Queryable Encryption을 위한 암호화된 필드를 설명하는 문서입니다. 생략하면 autoEncryption 드라이버 옵션 내의 encryptedFieldsMap 옵션이 참조됩니다. encryptedFieldsMap 가 정의되었지만 이 컬렉션을 지정하지 않은 경우 라이브러리는 encryptedFields 에 대한 서버 측 값을 참조하기 위해 최종 시도합니다. 자세한 내용은 MongoDB 매뉴얼의 필드 암호화 및 쿼리 가능성 을 참조하세요. 이 옵션은 삭제 명령에 전달되지 않습니다. 라이브러리는 이를 사용하여 암호화된 컬렉션 외에도 삭제해야 하는 관련 메타데이터 컬렉션을 결정합니다. 버전 1.13에 새로 추가되었습니다.
세션	MongoDB\Driver\Session	작업과 연결할 클라이언트 세션입니다. 버전 1.3에 새로 추가되었습니다.
typeMap	배열	유형 맵 커서에 적용하여 BSON 문서가 PHP 값으로 변환되는 방식을 결정합니다. 기본값은 데이터베이스의 유형 맵입니다. 이는 반환된 명령 결과 문서에 사용됩니다.
쓰기 고려	MongoDB\Driver\WriteConcern	작업에 사용할 고려를 씁니다 . 기본값은 데이터베이스의 쓰기 고려입니다.

반환 값

드롭 명령의 결과 문서가 포함된 배열 또는 객체입니다. 반환 유형은 typeMap 옵션에 따라 달라집니다.

오류/예외

옵션이 사용되지만 선택한 서버에서 지원되지 않는 경우 MongoDB\Exception\UnsupportedException입니다(예: collation, readConcern, writeConcern).

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

MongoDB\Driver\Exception\RuntimeException 확장 수준의 기타 오류(예: 연결 오류)의 경우.

예제

다음 예제에서는 test 데이터베이스에서 users collection을 삭제합니다.

<?php
$db = (new MongoDB\Client)->test;
$result = $db->dropCollection('users');
var_dump($result);

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

object(MongoDB\Model\BSONDocument)#8 (1) {
  ["storage":"ArrayObject":private]=>
  array(3) {
    ["ns"]=>
    string(10) "test.users"
    ["nIndexesWas"]=>
    int(1)
    ["ok"]=>
    float(1)
  }
}

다음도 참조하세요.

• MongoDB\Collection::drop()

• MongoDB 매뉴얼의 drop 명령 참조