문서 메뉴

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

MongoDB\Collection::listIndexes()

이 페이지의 내용

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

정의

MongoDB\Collection::listIndexes()

이 collection의 모든 인덱스에 대한 정보를 반환합니다.

function listIndexes(array $options = []): MongoDB\Model\IndexInfoIterator

매개변수

$options : 배열

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

이름
유형
설명
comment
혼합

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

이 옵션은 MongoDB 4.4부터 사용할 수 있으며 이전 서버 버전에 대해 지정된 경우 실행 시 예외가 발생합니다.

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

최대 시간 (MS)
integer

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

세션
MongoDB\Driver\Session

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

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

반환 값

컬렉션의 각 인덱스에 대한 객체를 MongoDB\Model\IndexInfo 포함하는 MongoDB\Model\IndexInfoIterator 순회 가능한 입니다.

오류/예외

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

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

예제

다음 예제에서는 데이터베이스의 restaurants collection에 대한 모든 인덱스를 test 나열합니다.

<?php
$collection = (new MongoDB\Client)->test->restaurants;
foreach ($collection->listIndexes() as $index) {
   var_dump($index);
}

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

object(MongoDB\Model\IndexInfo)#8 (4) {
  ["v"]=>
  int(1)
  ["key"]=>
  array(1) {
    ["_id"]=>
    int(1)
  }
  ["name"]=>
  string(4) "_id_"
  ["ns"]=>
  string(16) "test.restaurants"
}
object(MongoDB\Model\IndexInfo)#12 (4) {
  ["v"]=>
  int(1)
  ["key"]=>
  array(1) {
    ["cuisine"]=>
    float(-1)
  }
  ["name"]=>
  string(10) "cuisine_-1"
  ["ns"]=>
  string(16) "test.restaurants"
}
object(MongoDB\Model\IndexInfo)#8 (4) {
  ["v"]=>
  int(1)
  ["key"]=>
  array(1) {
    ["borough"]=>
    float(1)
  }
  ["name"]=>
  string(9) "borough_1"
  ["ns"]=>
  string(16) "test.restaurants"
}

다음도 참조하세요.

← MongoDB\Collection::insertOne()
MongoDB\Collection::listSearchIndexes() →

이 페이지의 내용