db.collection.getIndexes()

정의

db.collection.getIndexes()

숨겨진 인덱스와 현재 빌드 중인 인덱스를 포함하여 컬렉션 의 기존 인덱스를 식별하고 설명하는 문서 목록이 포함된 배열 반환합니다.

컬렉션에서 db.collection.getIndexes()를 호출해야 합니다. 예를 들면 다음과 같습니다.

db.collection.getIndexes()

collection을 인덱스 정보를 반환할 collection의 이름으로 변경합니다.

호환성

이 메서드는 다음 환경에서 호스팅되는 배포에서 사용할 수 있습니다.

• MongoDB Atlas: 클라우드에서의 MongoDB 배포를 위한 완전 관리형 서비스

• MongoDB Enterprise: MongoDB의 구독 기반 자체 관리 버전

• MongoDB Community: MongoDB의 소스 사용 가능 무료 자체 관리 버전

행동

필요한 액세스 권한

액세스 제어가 적용된 상태에서 db.collection.getIndexes()를 실행하려면 사용자에게 컬렉션에 대한 listIndexes 권한이 있어야 합니다.

기본 제공 역할 read는 데이터베이스의 컬렉션에 대해 db.collection.getIndexes()를 실행하는 데 필요한 권한을 제공합니다.

출력

db.collection.getIndexes() 컬렉션에 대한 인덱스 정보를 담고 있는 문서 배열을 반환합니다. 예시:

[
   {
      "v" : 2,
      "key" : {
         "_id" : 1
      },
      "name" : "_id_"
   },
   {
      "v" : 2,
      "key" : {
         "status" : 1
      },
      "name" : "status_1"
   },
   {
      "v" : 2,
      "key" : {
         "points" : 1
      },
      "name" : "points_1"
   }
]

인덱스 정보에는 인덱스 생성에 사용된 키와 옵션이 포함됩니다. 인덱스 옵션 hidden은 값이 true인 경우에만 사용할 수 있습니다.

키 및 인덱스 옵션에 대한 자세한 내용은 db.collection.createIndex()을(를) 참조하세요.