listCollections (영문)

정의

listCollections

데이터베이스의 컬렉션 및 뷰 에 대한 이름 및 만들기 옵션을 포함한 정보를 조회합니다.

listCollections 명령은 컬렉션에 커서를 만드는 데 사용할 수 있는 정보가 포함된 문서를 반환합니다.

mongosh 는 db.getCollectionInfos() 및 db.getCollectionNames() 헬퍼 메서드를 제공합니다.

호환성

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

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

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

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

구문

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

db.runCommand(
   {
     listCollections: 1,
     filter: <document>,
     nameOnly: <boolean>,
     authorizedCollections: <boolean>,
     comment: <any>
   }
)

명령 필드

이 명령은 다음과 같은 선택적 필드를 사용할 수 있습니다.

행동

필요한 액세스 권한

listCollections 명령은 액세스 제어가 시행될 때 listCollections 조치가 필요합니다. 사용자는 listCollections 을(를) 실행하려면 데이터베이스에 대한 listCollections 작업을 수행할 수 있는 권한이 있어야 합니다.

예를 들어, 다음 명령은 test 데이터베이스에 대해 db.getCollectionInfos()를 실행할 수 있는 권한을 부여합니다.

{ resource: { db: "test", collection: "" }, actions: [ "listCollections" ] }

기본 제공 역할 read은(는) 특정 데이터베이스에 대해 listCollections을(를) 실행할 수 있는 권한을 제공합니다.

필수 read 권한이 없는 사용자는 authorizedCollections 및 nameOnly이(가) 둘 다 true(으)로 설정된 경우 listCollections을(를) 실행할 수 있습니다. 이 경우 이 명령은 사용자에게 권한이 있는 컬렉션의 이름과 유형을 반환합니다.

그 예로 다음의 find 권한을 부여하는 역할이 있는 사용자를 생각해 보세요.

{ resource: { db: "sales", collection: "currentQuarter" }, actions: [ "find" ] }

authorizedCollections 및 nameOnly이(가) 둘 다 true(으)로 설정된 경우에는 사용자가 listCollections을(를) 실행할 수 있습니다.

db.runCommand(
   {
       listCollections: 1.0,
       authorizedCollections: true,
       nameOnly: true
   }
)

이 연산은 currentQuarter 컬렉션의 이름과 유형을 반환합니다.

단, 사용자에게 필수 액세스 권한이 없으면 다음 연산에서 오류가 반환됩니다.

db.runCommand(
   {
       listCollections: 1.0,
       authorizedCollections: true
   }
)
db.runCommand(
   {
       listCollections: 1.0,
       nameOnly: true
   }
)

db.runCommand(
   {
       listCollections: 1.0,
       authorizedCollections: true,
       nameOnly: true
   }
)

출력

listCollections.cursor

컬렉션 이름 및 옵션이 포함된 문서에 커서를 생성하는 데 사용할 수 있는 정보가 들어 있는 문서입니다. 커서 정보에는 커서 ID, 명령의 전체 네임스페이스 및 첫 번째 결과 배치가 포함됩니다. 배치 출력의 각 문서에는 다음 필드가 포함되어 있습니다:

필드	유형	설명
이름	문자열	컬렉션의 이름입니다.
유형	문자열	데이터 저장소 유형입니다. 컬렉션 의 경우 collection , 뷰 의 경우 view , time series 컬렉션의 경우 timeseries 를 반환합니다.
옵션	문서	컬렉션 옵션. 이러한 옵션은 db.createCollection()에서 사용할 수 있는 옵션에 직접 해당합니다. 옵션에 대한 설명은 db.createCollection()을 참조하세요.
정보	문서	컬렉션과 관련된 다음 필드를 나열합니다. 읽기 전용 booleantrue인 경우 데이터 저장소는 읽기 전용입니다. uuid UUID. 일단 설정되면 컬렉션 UUID는 변경되지 않습니다. 컬렉션 UUID는 샤드 클러스터의 복제본 세트 멤버와 샤드 전체에서 동일하게 유지됩니다.
idIndex	문서	컬렉션의 _id 인덱스에 대한 정보를 제공합니다.

listCollections.ok

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

예제

show collections

motorhead
ramones
taylorSwift

db.runCommand(
   {
      listCollections: 1.0,
      nameOnly: true
   }
)

{
  cursor: {
    id: Long("0"),
    ns: 'music.$cmd.listCollections',
    firstBatch: [
      { name: 'motorhead', type: 'collection' },
      { name: 'taylorSwift', type: 'collection' },
      { name: 'ramones', type: 'collection' }
    ]
  },
  ok: 1
}

db.runCommand(
   {
      listCollections: 1.0
   }
)

{
  cursor: {
    id: Long("0"),
    ns: 'music.$cmd.listCollections',
    firstBatch: [
      {
        name: 'motorhead',
        type: 'collection',
        options: {},
        info: {
          readOnly: false,
          uuid: new UUID("09ef1858-2831-47d2-a3a7-9a29a9cfeb94")
        },
        idIndex: { v: 2, key: { _id: 1 }, name: '_id_' }
      },
      {
        name: 'taylorSwift',
        type: 'collection',
        options: {},
        info: {
          readOnly: false,
          uuid: new UUID("6c46c8b9-4999-4213-bcef-9a36b0cff228")
        },
        idIndex: { v: 2, key: { _id: 1 }, name: '_id_' }
      },
      {
        name: 'ramones',
        type: 'collection',
        options: {},
        info: {
          readOnly: false,
          uuid: new UUID("7e1925ba-f2f9-4e42-90e4-8cafd434a6c4")
        },
        idIndex: { v: 2, key: { _id: 1 }, name: '_id_' }
      }
    ]
  },
  ok: 1
}

자세히 알아보기

컬렉션 옵션의 경우:

• db.createCollection()

• create

컬렉션 정보의 경우:

• db.getCollectionInfos()

• mongosh 기본 제공 명령