MongoDB\Collection::withOptions()

정의

MongoDB\Collection::withOptions()

Collection 객체의 복제본을 반환하지만 옵션은 다릅니다.

function withOptions(array $options = []): MongoDB\Collection

매개변수

$options : 배열

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

이름	유형	설명
builderEncoder	MongoDB\Codec\Encoder	쿼리 및 집계 옵션에서 네이티브 PHP 유형을 BSON 데이터로 직렬화하는 데 사용되는 인코더입니다. 생략하면 Collection 인스턴스 기본값 인코더를 사용합니다. 버전 1.21에 추가 되었습니다.
코덱	MongoDB\Codec\DocumentCodec	컬렉션 작업에 사용할 기본값 코덱 입니다. 기본값은 원본 컬렉션의 코덱입니다. 버전 1.17에 추가 되었습니다.
readConcern	MongoDB\Driver\ReadConcern	컬렉션 작업에 사용할 기본 읽기 고려입니다. 기본값은 원본 컬렉션의 읽기 고려입니다.
읽기 설정	MongoDB\Driver\ReadPreference	컬렉션 작업에 사용할 기본값 읽기 설정 (read preference) 입니다. 기본값은 원본 컬렉션의 읽기 설정 (read preference) 입니다.
typeMap	배열	커서에 적용할 타입 맵으로, BSON 문서가 PHP 값으로 변환되는 방식을 결정합니다. 기본값은 원본 컬렉션의 유형 맵입니다.
쓰기 고려	MongoDB\Driver\WriteConcern	컬렉션 작업에 사용할 기본 쓰기 고려입니다. 기본값은 원본 컬렉션의 쓰기 고려입니다.

Return Values

MongoDB\Collection 객체입니다.

오류/예외

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

예시

다음 예제에서는 새로운 읽기 설정을 사용하여 기존 Collection 객체를 복제합니다.

<?php
$collection = (new MongoDB\Client)->getCollection('test', 'restaurants');
$newCollection = $sourceCollection->withOptions([
    'readPreference' => new MongoDB\Driver\ReadPreference('primaryPreferred'),
]);

다음도 참조하세요.

• MongoDB\Collection::__construct()