REST Resource: projects.databases.collectionGroups.indexes

{
  "name": string,
  "queryScope": enum (QueryScope),
  "fields": [
    {
      object (IndexField)
    }
  ],
  "state": enum (State)
}

string

출력 전용입니다. 이 색인에 대해 서버에서 정의한 이름입니다. 복합 색인의 경우 이 이름의 형식은 projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/indexes/{composite_index_id}입니다. 단일 필드 색인의 경우 이 필드는 비어 있습니다.

enum (QueryScope)

컬렉션 쿼리 범위가 지정된 색인을 사용하면 특정 문서의 하위 요소이고, 쿼리 시 지정되고, 컬렉션 ID가 동일한 컬렉션에 대한 쿼리를 허용합니다.

컬렉션 그룹 쿼리 범위가 지정된 색인을 사용하면 쿼리 시 지정되고 이 색인과 컬렉션 ID가 동일한 특정 문서의 모든 컬렉션에 대한 쿼리가 허용됩니다.

object (IndexField)

이 색인에서 지원하는 필드입니다.

복합 색인의 경우 항상 2개 이상의 필드입니다. 마지막 입력란 항목은 항상 입력란 경로 __name__에 해당합니다. 생성 시 __name__가 마지막 필드로 지정되지 않은 경우, 마지막으로 정의된 필드와 같은 방향으로 자동으로 추가됩니다. 복합 색인의 마지막 필드가 방향이 아닌 경우 __name__는 명시적으로 지정되지 않는 한 ASCENDING으로 정렬됩니다.

단일 필드 색인의 경우 필드 경로가 연결된 필드의 필드 경로와 동일한 정확히 하나의 항목입니다.

enum (State)

출력 전용입니다. 색인의 제공 상태입니다.