문서 메뉴

문서 홈 → PHP 라이브러리 매뉴얼

MongoDB\Collection::listSearchIndexes()

이 페이지의 내용

  • 정의
  • 매개변수
  • 반환 값
  • 오류/예외
  • 다음도 참조하세요.

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

정의

MongoDB\Collection::listSearchIndexes()

collection에 있는 하나 이상의 검색 인덱스에 대한 인덱스 정보를 가져옵니다.

function listSearchIndexes(array $options = []): Countable&Iterator

이 명령은 MongoDB Atlas 에 호스팅된 배포에서만 실행할 수 있으며10 이상의 Atlas 클러스터 계층이 필요합니다. 로컬 Atlas 배포서버 를 개발에도 사용할 수 있습니다.

매개변수

$options : 배열

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

이름
유형
설명
batchSize
integer

초기 aggregate 명령과 후속 getMore 명령 모두에 적용되는 커서의 배치 크기를 지정합니다. 이는 서버의 각 응답으로 반환할 최대 문서 수를 결정합니다.

0의 배치 크기는 초기 aggregate 명령에만 적용된다는 점에서 특별하며 후속 getMore 명령은 서버의 기본 배치 크기를 사용합니다. 이는 중요한 서버 측 작업을 수행하지 않고도 aggregate에서 커서 또는 오류를 빠르게 반환하는 데 유용할 수 있습니다.

코덱
MongoDB\Codec\DocumentCodec

문서를 인코딩 또는 디코딩하는 데 사용할 코덱 입니다. 이 옵션은 typeMap 옵션과 상호 배타적입니다.

기본값은 컬렉션의 코덱입니다. 기본 codec 옵션의 상속이 typeMap 옵션의 상속보다 우선합니다.

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

데이터 정렬
배열|객체

데이터 정렬 을 통해 사용자는 문자열 비교를 위한 언어별 규칙(예: 대소문자 및 악센트 표시 규칙)을 지정할 수 있습니다. 데이터 정렬을 지정할 때 locale 필드는 필수입니다. 다른 모든 데이터 정렬 필드는 선택 사항입니다. 필드에 대한 설명은 데이터 정렬 문서를 참조하세요.

comment
혼합

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

최대 시간 (MS)
integer

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

이름
문자열

정보를 반환할 인덱스의 이름입니다.

이름을 지정하지 않으면 collection의 모든 인덱스에 대한 정보가 반환됩니다.

readConcern
MongoDB\Driver\ReadConcern

작업에 사용할 읽기 고려 입니다. 기본값은 컬렉션의 읽기 고려입니다.

트랜잭션의 일부로 개별 작업에 대한 읽기 고려를 지정할 수 없습니다. 대신 readConcern 트랜잭션을 시작할 때옵션을 설정합니다.

읽기 설정
MongoDB\Driver\ReadPreference

작업에 사용할 읽기 설정 입니다. 기본값은 컬렉션의 읽기 설정입니다.

세션
MongoDB\Driver\Session

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

typeMap
배열

커서에 적용할 타입 맵으로, BSON 문서가 PHP 값으로 변환되는 방식을 결정합니다. 기본값은 컬렉션의 타입 맵입니다.

반환 값

각 문서가 컬렉션의 검색 인덱스를 설명하는 문서 목록입니다. 출력 필드에 대한 자세한 내용은 MongoDB 매뉴얼의 $listSearchIndexes: 출력 을 참조하세요.

오류/예외

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

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

MongoDB\Driver\Exception\RuntimeException 드라이버 수준의 기타 오류(예: 연결 오류).

다음도 참조하세요.

← MongoDB\Collection::listIndexes()
MongoDB\Collection::mapReduce() →

이 페이지의 내용