MongoDB\Collection::listSearchIndexes()
이 페이지의 내용
버전 1.17에 추가 되었습니다.
정의
MongoDB\Collection::listSearchIndexes()collection에 있는 하나 이상의 검색 인덱스에 대한 인덱스 정보를 가져옵니다.
function listSearchIndexes(array $options = []): Countable&Iterator 이 명령은 MongoDB Atlas 에서 호스팅되는 배포서버 에서만 실행 수 있으며 M10 이상의 Atlas cluster 계층 이 필요합니다. 로컬 Atlas 배포서버 를 개발에도 사용할 수 있습니다.
매개변수
$options: 배열원하는 옵션을 지정하는 배열입니다.
이름유형설명batchSize
integer
aggregate명령에 적용되는 인덱스 목록에서 반환되는 각 배치 내 최대 문서 수입니다. 기본값 으로aggregate명령의 초기 배치 크기는101문서이고, 각 후속 배치 의 최대 크기는 16 메비바이트(MiB)입니다. 이 옵션은 16 MiB보다 작은 제한을 시행하다 할 수 있지만 더 큰 제한은 적용할 수 없습니다. 배치가 16 MiB보다 커지는 제한으로batchSize를 설정하다 경우 이 옵션은 효과가 없습니다.코덱
MongoDB\Codec\DocumentCodec
문서 인코딩 또는 디코딩에 사용하는 코덱입니다. 이 옵션은
typeMap옵션과 상호 배타적입니다.컬렉션의 코덱을 기본값으로 설정합니다. 기본
codec옵션의 상속은typeMap옵션의 상속보다 우선합니다.버전 1.17에 추가 되었습니다.
데이터 정렬
배열|객체
데이터 정렬 을 통해 사용자는 string 비교를 위한 언어별 규칙(예: 대소문자 및 악센트 표시 규칙)을 지정할 수 있습니다. 데이터 정렬을 지정할 때
locale필드는 필수입니다. 다른 모든 데이터 정렬 필드는 선택 사항입니다. 필드에 대한 설명은 데이터 정렬 문서를 참조하세요.comment
혼합
최대 시간 (MS)
integer
커서에서 작업을 처리하는 데 걸리는 누적 시간 제한(밀리초)입니다. MongoDB는 중단 지점 이후 가장 빠른 시점에 작업을 중단합니다.
이름
문자열
정보를 반환할 인덱스의 이름입니다.
이름을 지정하지 않으면 collection의 모든 인덱스에 대한 정보가 반환됩니다.
readConcern
읽기 설정
작업에 사용할 읽기 설정 입니다. 기본값은 컬렉션의 읽기 설정입니다.
Session
작업과 연결할 클라이언트 세션입니다.
typeMap
배열
커서에 적용할 타입 맵으로, BSON 문서가 PHP 값으로 변환되는 방식을 결정합니다. 기본값은 컬렉션의 타입 맵입니다.
Return Values
각 문서가 컬렉션의 Atlas Search 인덱스를 설명하는 문서 목록입니다. 출력 필드에 대한 자세한 내용은 MongoDB 매뉴얼의 $listSearchIndexes: 출력 을 참조하세요.
오류/예외
옵션이 사용되지만 선택한 서버에서 지원되지 않는 경우 MongoDB\Exception\UnsupportedException입니다(예: collation, readConcern, writeConcern).
매개변수 또는 옵션의 구문 분석과 관련된 오류의 경우 MongoDB\Exception\InvalidArgumentException 입니다.
MongoDB\ 드라이버\Exception\RuntimeException 확장 수준의 다른 오류(예: 연결 오류).