리소스: Index
색인 정의
JSON 표현 |
---|
{ "name": string, "collectionId": string, "fields": [ { object ( |
입력란 | |
---|---|
name |
색인의 리소스 이름입니다. 출력 전용. |
collectionId |
이 색인이 적용되는 컬렉션 ID입니다. 필수 항목입니다. |
fields[] |
색인을 생성할 필드입니다. |
state |
색인의 상태입니다. 출력 전용. |
IndexField
색인의 필드입니다.
JSON 표현 |
---|
{
"fieldPath": string,
"mode": enum ( |
입력란 | |
---|---|
fieldPath |
필드의 경로입니다. [google.firestore.v1beta1.Document.fields][fields]에 설명된 필드 경로 사양과 일치해야 합니다. 특수 필드 경로 |
mode |
필드의 모드입니다. |
모드
모드는 필드의 색인이 생성되는 방식을 결정합니다.
열거형 | |
---|---|
MODE_UNSPECIFIED |
모드가 지정되지 않았습니다. |
ASCENDING |
시퀀싱을 지원하고 <, >, <=, >=, =로 쿼리할 수 있도록 필드 값의 색인이 생성됩니다. |
DESCENDING |
내림차순의 시퀀싱을 지원하고 <, >, <=, >=, =로 쿼리할 수 있도록 필드 값의 색인이 생성됩니다. |
ARRAY_CONTAINS |
ARRAY_CONTAINS 쿼리를 사용하여 멤버십을 지원하기 위해 필드의 배열 값에 대한 색인이 생성됩니다. |
상태
색인의 상태입니다. 색인을 만드는 동안 색인은 CREATING
상태가 됩니다. 색인이 생성되면 READY
상태로 전환됩니다. 색인을 만들 수 없는 경우 ERROR
상태로 전환됩니다.
열거형 | |
---|---|
STATE_UNSPECIFIED |
상태가 지정되지 않았습니다. |
CREATING |
색인을 만드는 중입니다. 색인에 대한 활성 장기 실행 작업이 있습니다. 색인은 문서를 작성할 때 업데이트됩니다. 일부 색인 데이터가 있을 수 있습니다. |
READY |
색인을 사용할 준비가 되었습니다. 색인은 문서를 작성할 때 업데이트됩니다. 색인은 적용되는 모든 저장된 문서로부터 완전히 채워집니다. |
ERROR |
색인을 생성 중이지만 문제가 발생했습니다. 색인에 대한 활성 장기 실행 작업이 없으며 가장 최근에 완료된 장기 실행 작업이 실패했습니다. 문서를 작성할 때는 색인이 업데이트되지 않습니다. 일부 색인 데이터가 있을 수 있습니다. |
방법 |
|
---|---|
|
지정된 색인을 만듭니다. |
|
색인을 삭제합니다. |
|
색인을 가져옵니다. |
|
지정된 필터와 일치하는 색인을 나열합니다. |