MongoDB\Database::modifyCollection()

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

정의

MongoDB\Database::modifyCollection()

지정된 $collectionOptions 에 따라 collection 또는 뷰를 수정합니다.

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

매개변수

$collectionName : 문자열

수정할 collection 또는 뷰의 이름입니다.

$collectionOptions : 배열

할당할 collection 또는 보기 옵션입니다.

$options : 배열

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

이름	유형	설명
comment	혼합	사용자가 데이터베이스 프로파일러, currentOp 출력 및 로그를 통해 작업을 추적하는 데 도움이 되는 임의의 주석을 지정할 수 있습니다. 이 옵션은 MongoDB 4.4부터 사용할 수 있으며 이전 서버 버전에 대해 지정된 경우 실행 시 예외가 발생합니다. 버전 1.13에 새로 추가되었습니다.
Session	MongoDB\Driver\Session	작업과 연결할 클라이언트 세션입니다.
typeMap	배열	유형 맵커서에 적용하여 BSON 문서가 PHP 값으로 변환되는 방식을 결정합니다. 기본값은 데이터베이스의 유형 맵입니다. 이는 반환된 명령 결과 문서에 사용됩니다.
쓰기 고려	MongoDB\Driver\WriteConcern	작업에 사용할 고려를 씁니다 . 기본값은 데이터베이스의 쓰기 고려입니다.

Return Values

collMod 명령의 결과 문서가 포함된 배열 또는 객체입니다.

오류/예외

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

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

예시

다음 예시에서는 test 데이터베이스에서 TTL collection의 만료 시간을 변경합니다.

<?php
$db = (new MongoDB\Client)->test;
$result = $db->modifyCollection('users', [
    'keyPattern' => ['lastAccess' => 1],
    'expireAfterSeconds' => 1000
]);
var_dump($result);

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

object(stdClass)#2779 {
  ["expireAfterSeconds_old"]=>
  int(3)
  ["expireAfterSeconds_new"]=>
  int(1000)
  ["ok"]=>
  float(1)
}

다음도 참조하세요.

MongoDB 매뉴얼의 collMod 명령 참조

돌아가기

listCollections()

renameCollection()