listIndexes

정의

listIndexes

지정된 컬렉션의 인덱스에 관한 정보를 반환합니다. 반환된 인덱스 정보에는 인덱스 생성에 사용된 키와 옵션,숨겨진 인덱스가 포함됩니다. 선택적으로 첫 번째 결과 배치의 배치 크기를 설정할 수 있습니다.

팁

mongosh에서는 이 명령을 db.collection.getIndexes() 헬퍼 메서드를 통해서도 실행할 수 있습니다.

헬퍼 메서드는 mongosh 사용자에게 편리하지만 데이터베이스 명령과 동일한 수준의 정보를 반환하지 못할 수 있습니다. 편의가 필요하지 않거나 추가 리턴 필드가 필요한 경우 데이터베이스 명령을 사용합니다.

호환성

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

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

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

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

구문

명령은 다음과 같은 구문을 가집니다:

db.runCommand (
   {
      listIndexes: "<collection-name>",
      cursor: { batchSize: <int> },
      comment: <any>
   }
)

명령 필드

이 명령은 다음 필드를 사용합니다.

필요한 액세스 권한

액세스 제어가 적용된 경우 sowkd read 역할은 데이터베이스 내 컬렉션에 listIndexes를 실행하는 데 필요한 권한을 제공합니다.

행동

출력

listIndexes.cursor

커서가 지정한 배치 크기로 반환되는 결과 세트입니다. 배치 출력의 각 문서에는 다음 필드가 포함되어 있습니다.

필드	유형	설명
id	integer	64비트 정수입니다. 0이면 더 이상 정보 배치가 없다는 뜻입니다. 0이 아닌 경우, getMore 명령에서 다음 인덱스 정보 배치를 가져오는 데 사용할 수 있는 커서 ID입니다.
ns	문자열	다음 형식의 데이터베이스 및 컬렉션 이름 <database-name>.<collection-name>
firstBatch	문서	인덱스 정보에는 인덱스 생성에 사용된 키와 옵션이 포함됩니다. 인덱스 옵션 숨김은 값이 참(true)인 경우에만 존재합니다. 필요에 따라 getMore를 사용하여 추가 결과를 조회합니다.

listIndexes.ok

명령의 반환 값입니다. 값이 1이면 성공입니다.

예시

1
db.runCommand (
2
  {
3
     listIndexes: "contacts"
4
  }
5
)

1
{
2
   cursor: {
3
      id: Long("0"),
4
      ns: 'test.contacts',
5
      firstBatch: [
6
         { v: 2, key: { _id: 1 }, name: '_id_', ns: 'test.contacts' },
7
         { v: 2, key: { a: 1 }, name: 'a_1', ns: 'test.contacts' }
8
      ]
9
   },
10
   ok: 1
11
}

1
db.runCommand (
2
   {
3
      listIndexes: "contacts", cursor: { batchSize: 1 }
4
   }
5
)

1
{
2
   cursor: {
3
     id: Long("4809221676960028307"),
4
     ns: 'test.contacts',
5
    firstBatch: [ { v: 2, key: { _id: 1 }, name: '_id_', ns: 'test.contacts' } ]
6
  },
7
  ok: 1
8
}

1
db.runCommand(
2
   {
3
      getMore: Long("4809221676960028307"), collection: "contacts"
4
   }
5
)

1
{
2
   cursor: {
3
    nextBatch: [ { v: 2, key: { a: 1 }, name: 'a_1', ns: 'test.contacts' } ],
4
    id: Long("0"),
5
    ns: 'test.contacts'
6
  },
7
  ok: 1
8
}