REST Resource: projects.databases.collectionGroups.indexes

자원: 색인

Cloud Firestore 색인을 사용하면 데이터베이스의 문서에 대해 간단하고 복잡한 쿼리를 수행할 수 있습니다.

JSON 표현
{
  "name": string,
  "queryScope": enum (QueryScope),
  "apiScope": enum (ApiScope),
  "fields": [
    {
      object (IndexField)
    }
  ],
  "state": enum (State)
}
필드
name

string

출력만 가능합니다. 이 인덱스에 대한 서버 정의 이름입니다. 복합 인덱스에 대한 이 이름의 형식은 다음과 같습니다: projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/indexes/{composite_index_id} 단일 필드 인덱스의 경우 이 필드는 비어 있습니다.

queryScope

enum ( QueryScope )

컬렉션 쿼리 범위가 지정된 인덱스는 쿼리 시 지정되고 동일한 컬렉션 ID를 가진 특정 문서의 하위 컬렉션에 대한 쿼리를 허용합니다.

컬렉션 그룹 쿼리 범위가 지정된 인덱스는 쿼리 시간에 지정되고 이 인덱스와 동일한 컬렉션 ID를 가진 특정 문서의 하위 컬렉션에 대한 쿼리를 허용합니다.

apiScope

enum ( ApiScope )

이 색인이 지원하는 API 범위입니다.

fields[]

object ( IndexField )

이 인덱스가 지원하는 필드입니다.

복합 인덱스의 경우 최소 2개, 최대 100개의 필드가 필요합니다. 마지막 필드 항목은 항상 필드 경로 __name__ 에 대한 것입니다. 생성 시 __name__ 마지막 필드로 지정되지 않은 경우 정의된 마지막 필드와 동일한 방향으로 자동으로 추가됩니다. 복합 인덱스의 마지막 필드가 방향성이 아닌 경우 __name__ (명시적으로 지정하지 않는 한) ASCENDING으로 정렬됩니다.

단일 필드 인덱스의 경우 이는 항상 연관된 필드의 필드 경로와 동일한 필드 경로를 가진 정확히 하나의 항목입니다.

state

enum ( State )

출력만 가능합니다. 색인의 제공 상태입니다.

행동 양식

create

복합 인덱스를 생성합니다.

delete

복합 인덱스를 삭제합니다.

get

복합 인덱스를 가져옵니다.

list

복합 인덱스를 나열합니다.