MongoDB\Collection::rename()

정의

MongoDB\Collection::rename()

collection의 이름을 변경합니다.

function rename(    string $toCollectionName,    ?string $toDatabaseName = null,    array $options = []): void

매개변수

$toCollectionName : 문자열

collection의 새 이름입니다.

$toDatabaseName : 문자열

collection의 새 데이터베이스 이름입니다. 새 데이터베이스 이름을 지정하지 않으면 원본 collection의 데이터베이스가 사용됩니다. 새 이름이 다른 데이터베이스를 지정하는 경우 명령은 collection을 새 데이터베이스에 복사하고 소스 collection을 삭제합니다.

$options : 배열

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

이름	유형	설명
dropTarget	부울	true 인 경우 MongoDB는 collection 이름을 바꾸기 전에 대상을 삭제합니다. 기본값은 false 입니다.
comment	혼합	사용자가 데이터베이스 프로파일러, currentOp 출력 및 로그를 통해 작업을 추적하는 데 도움이 되는 임의의 주석을 지정할 수 있습니다. 이 옵션은 MongoDB 4.4부터 사용할 수 있으며 이전 서버 버전에 대해 지정된 경우 실행 시 예외가 발생합니다. 버전 1.13에 추가 되었습니다.
Session	MongoDB\Driver\Session	작업과 연결할 클라이언트 세션입니다.
쓰기 고려	MongoDB\Driver\WriteConcern	작업에 사용할 고려를 씁니다 . 기본값은 컬렉션의 쓰기 고려입니다. 트랜잭션 의 일부로 개별 작업에 대한 쓰기 고려 (write concern) 지정할 수 없습니다. 대신 트랜잭션시작할 때 옵션을 writeConcern 설정하다 .

오류/예외

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

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

확장 수준의 기타 오류에 대한MongoDB\ 드라이버\Exception\RuntimeException (예: 연결 오류).

예시

다음 작업은 test 데이터베이스의 restaurants collection 이름을 places 로 변경합니다.

<?php
$collection = (new MongoDB\Client)->test->restaurants;
$collection->rename('places');

다음도 참조하세요.

• MongoDB\Database::renameCollection()

• MongoDB 매뉴얼의 renameCollection 명령 참조