색인
-
FirestoreAdmin
(인터페이스) -
CreateIndexRequest
(메시지) -
DeleteIndexRequest
(메시지) -
ExportDocumentsMetadata
(메시지) -
ExportDocumentsRequest
(메시지) -
ExportDocumentsResponse
(메시지) -
Field
(메시지) -
Field.IndexConfig
(메시지) -
FieldOperationMetadata
(메시지) -
FieldOperationMetadata.IndexConfigDelta
(메시지) -
FieldOperationMetadata.IndexConfigDelta.ChangeType
(열거형) -
GetFieldRequest
(메시지) -
GetIndexRequest
(메시지) -
ImportDocumentsMetadata
(메시지) -
ImportDocumentsRequest
(메시지) -
Index
(메시지) -
Index.IndexField
(메시지) -
Index.IndexField.ArrayConfig
(열거형) -
Index.IndexField.Order
(열거형) -
Index.QueryScope
(열거형) -
Index.State
(열거형) -
IndexOperationMetadata
(메시지) -
ListFieldsRequest
(메시지) -
ListFieldsResponse
(메시지) -
ListIndexesRequest
(메시지) -
ListIndexesResponse
(메시지) -
OperationState
(열거형) -
Progress
(메시지) -
UpdateFieldRequest
(메시지)
Firestore관리자
작업은 FirestoreAdmin
서비스에 의해 생성되지만 google.longrunning.Operations
서비스를 통해 액세스됩니다.
인덱스 생성 |
---|
복합 인덱스를 생성합니다. 생성 상태를 추적하는 데 사용할 수 있는
|
삭제인덱스 |
---|
복합 인덱스를 삭제합니다.
|
문서 내보내기 |
---|
Google Cloud Firestore에서 문서 전체 또는 일부의 사본을 Google Cloud Storage와 같은 다른 저장소 시스템으로 내보냅니다. 문서에 대한 최근 업데이트는 내보내기에 반영되지 않을 수 있습니다. 내보내기는 백그라운드에서 수행되며 생성된 작업 리소스를 통해 진행 상황을 모니터링하고 관리할 수 있습니다. 내보내기 출력은 관련 작업이 완료된 후에만 사용할 수 있습니다. 내보내기 작업이 완료되기 전에 취소되면 Google Cloud Storage에 일부 데이터가 남을 수 있습니다.
|
GetField |
---|
필드에 대한 메타데이터 및 구성을 가져옵니다.
|
인덱스 가져오기 |
---|
복합 인덱스를 가져옵니다.
|
가져오기문서 |
---|
Google Cloud Firestore로 문서를 가져옵니다. 동일한 이름을 가진 기존 문서를 덮어씁니다. 가져오기는 백그라운드에서 발생하며 생성된 작업 리소스를 통해 진행 상황을 모니터링하고 관리할 수 있습니다. ImportDocuments 작업이 취소되면 데이터의 하위 집합이 이미 Cloud Firestore로 가져왔을 수 있습니다.
|
목록필드 |
---|
이 데이터베이스에 대한 필드 구성 및 메타데이터를 나열합니다. 현재
|
목록 인덱스 |
---|
복합 인덱스를 나열합니다.
|
업데이트필드 |
---|
필드 구성을 업데이트합니다. 현재 필드 업데이트는 단일 필드 인덱스 구성에만 적용됩니다. 그러나 이 호출은 필드 업데이트 상태를 추적하는 데 사용할 수 있는 데이터베이스의 기본 필드 설정을 구성하려면 리소스 이름이 있는 특수
|
CreateIndex요청
FirestoreAdmin.CreateIndex
에 대한 요청입니다.
필드 | |
---|---|
parent | |
index | 생성할 복합 인덱스입니다. |
삭제인덱스요청
FirestoreAdmin.DeleteIndex
에 대한 요청입니다.
필드 | |
---|---|
name | |
내보내기문서메타데이터
FirestoreAdmin.ExportDocuments
의 google.longrunning.Operation
결과에 대한 메타데이터입니다.
필드 | |
---|---|
start_time | 이 작업이 시작된 시간입니다. |
end_time | 이 작업이 완료된 시간입니다. 작업이 아직 진행 중인 경우 설정이 해제됩니다. |
operation_state | 내보내기 작업의 상태입니다. |
progress_documents | 이 작업의 진행 상황을 문서로 표시합니다. |
progress_bytes | 이 작업의 진행률(바이트)입니다. |
collection_ids[] | 내보내는 컬렉션 ID입니다. |
output_uri_prefix | 엔터티를 내보내는 위치입니다. |
문서 내보내기요청
FirestoreAdmin.ExportDocuments
에 대한 요청입니다.
필드 | |
---|---|
name | 내보낼 데이터베이스입니다. |
collection_ids[] | 내보낼 컬렉션 ID입니다. 지정되지 않음은 모든 컬렉션을 의미합니다. |
output_uri_prefix | 출력 URI입니다. 현재는 |
내보내기문서응답
google.longrunning.Operation
응답 필드에 반환됩니다.
필드 | |
---|---|
output_uri_prefix | 출력 파일의 위치입니다. 작업이 성공적으로 완료된 후 Cloud Firestore(이 프로젝트 또는 다른 프로젝트)로 가져오기를 시작하는 데 사용할 수 있습니다. |
필드
데이터베이스의 단일 필드를 나타냅니다.
필드는 동일한 ID를 가진 데이터베이스의 모든 컬렉션을 나타내는 "컬렉션 그룹"별로 그룹화됩니다.
필드 | |
---|---|
name | 필드 경로는 간단한 필드 이름(예: 필드 경로는 예: (참고: 여기의 주석은 마크다운 구문으로 작성되었으므로 코드 블록을 나타내는 추가 백틱 레이어가 있습니다.) 특수 |
index_config | 이 필드의 색인 구성입니다. 설정하지 않으면 필드 인덱싱이 |
IndexConfig
이 필드의 색인 구성입니다.
필드 | |
---|---|
indexes[] | 이 필드에 지원되는 인덱스입니다. |
uses_ancestor_config | 출력만 가능합니다. true인 경우 |
ancestor_field | 출력만 가능합니다. 이 필드의 인덱스 구성이 설정되는( |
reverting | 출력 전용 true인 경우 |
FieldOperation메타데이터
FirestoreAdmin.UpdateField
의 google.longrunning.Operation
결과에 대한 메타데이터입니다.
필드 | |
---|---|
start_time | 이 작업이 시작된 시간입니다. |
end_time | 이 작업이 완료된 시간입니다. 작업이 아직 진행 중인 경우 설정이 해제됩니다. |
field | 이 작업이 수행되는 필드 리소스입니다. 예: |
index_config_deltas[] | 이 작업의 의도를 설명하는 |
state | 작업 상태입니다. |
document_progress | 이 작업의 진행 상황을 문서로 표시합니다. |
bytes_progress | 이 작업의 진행률(바이트)입니다. |
IndexConfigDelta
인덱스 구성 변경에 대한 정보입니다.
필드 | |
---|---|
change_type | 인덱스가 어떻게 변경되는지 지정합니다. |
index | 인덱스가 변경되고 있습니다. |
변경 유형
인덱스가 어떻게 변경되는지 지정합니다.
열거형 | |
---|---|
CHANGE_TYPE_UNSPECIFIED | 변경 유형이 지정되지 않았거나 알려져 있지 않습니다. |
ADD | 단일 필드 인덱스가 추가되고 있습니다. |
REMOVE | 단일 필드 인덱스가 제거되고 있습니다. |
GetField요청
FirestoreAdmin.GetField
에 대한 요청입니다.
필드 | |
---|---|
name | |
GetIndex요청
FirestoreAdmin.GetIndex
에 대한 요청입니다.
필드 | |
---|---|
name | |
가져오기문서메타데이터
FirestoreAdmin.ImportDocuments
의 google.longrunning.Operation
결과에 대한 메타데이터입니다.
필드 | |
---|---|
start_time | 이 작업이 시작된 시간입니다. |
end_time | 이 작업이 완료된 시간입니다. 작업이 아직 진행 중인 경우 설정이 해제됩니다. |
operation_state | 가져오기 작업의 상태입니다. |
progress_documents | 이 작업의 진행 상황을 문서로 표시합니다. |
progress_bytes | 이 작업의 진행률(바이트)입니다. |
collection_ids[] | 가져오는 컬렉션 ID입니다. |
input_uri_prefix | 가져오는 문서의 위치입니다. |
문서 가져오기요청
FirestoreAdmin.ImportDocuments
에 대한 요청입니다.
필드 | |
---|---|
name | 가져올 데이터베이스입니다. |
collection_ids[] | 가져올 컬렉션 ID입니다. 지정되지 않음은 가져오기에 포함된 모든 컬렉션을 의미합니다. |
input_uri_prefix | 내보낸 파일의 위치입니다. 이는 성공적으로 완료된 내보내기의 ImportDocumentsResponse의 output_uri_prefix와 일치해야 합니다. |
색인
Cloud Firestore 색인을 사용하면 데이터베이스의 문서에 대해 간단하고 복잡한 쿼리를 수행할 수 있습니다.
필드 | |
---|---|
name | 출력만 가능합니다. 이 인덱스에 대한 서버 정의 이름입니다. 복합 인덱스에 대한 이 이름의 형식은 다음과 같습니다: |
query_scope | 컬렉션 쿼리 범위가 지정된 인덱스는 쿼리 시 지정되고 동일한 컬렉션 ID를 가진 특정 문서의 하위 컬렉션에 대한 쿼리를 허용합니다. 컬렉션 그룹 쿼리 범위가 지정된 인덱스는 쿼리 시간에 지정되고 이 인덱스와 동일한 컬렉션 ID를 가진 특정 문서의 하위 컬렉션에 대한 쿼리를 허용합니다. |
fields[] | 이 인덱스가 지원하는 필드입니다. 복합 인덱스의 경우 이는 항상 2개 이상의 필드입니다. 마지막 필드 항목은 항상 필드 경로 단일 필드 인덱스의 경우 이는 항상 연관된 필드의 필드 경로와 동일한 필드 경로를 가진 정확히 하나의 항목입니다. |
state | 출력만 가능합니다. 색인의 제공 상태입니다. |
인덱스필드
인덱스의 필드입니다. field_path는 어떤 필드가 인덱싱되는지 설명하고 value_mode는 필드 값이 인덱싱되는 방식을 설명합니다.
필드 | |
---|---|
field_path | 이름이 될 수 있습니다. 단일 필드 인덱스의 경우 이는 필드 이름과 일치해야 하며 그렇지 않으면 생략될 수 있습니다. |
유니온 필드 value_mode . 필드 값이 인덱싱되는 방식입니다. value_mode 다음 중 하나만 가능합니다. | |
order | 이 필드가 지정된 순서에 따른 정렬이나 =, <, <=, >, >=를 사용한 비교를 지원함을 나타냅니다. |
array_config | 이 필드가 |
배열 구성
지원되는 배열 값 구성입니다.
열거형 | |
---|---|
ARRAY_CONFIG_UNSPECIFIED | 인덱스는 추가 배열 쿼리를 지원하지 않습니다. |
CONTAINS | 인덱스는 배열 포함 쿼리를 지원합니다. |
주문하다
지원되는 주문입니다.
열거형 | |
---|---|
ORDER_UNSPECIFIED | 순서가 지정되지 않았습니다. 유효한 옵션이 아닙니다. |
ASCENDING | 필드는 필드 값의 오름차순으로 정렬됩니다. |
DESCENDING | 필드는 필드 값의 내림차순으로 정렬됩니다. |
쿼리 범위
쿼리 범위는 쿼리가 실행되는 범위를 정의합니다. 이는 StructuredQuery의 from
필드에 지정됩니다.
열거형 | |
---|---|
QUERY_SCOPE_UNSPECIFIED | 쿼리 범위가 지정되지 않았습니다. 유효한 옵션이 아닙니다. |
COLLECTION | 컬렉션 쿼리 범위가 지정된 인덱스를 사용하면 쿼리 시 지정되고 인덱스에 의해 지정된 컬렉션 ID가 있는 특정 문서의 하위 컬렉션에 대한 쿼리가 허용됩니다. |
COLLECTION_GROUP | 컬렉션 그룹 쿼리 범위가 지정된 인덱스는 인덱스에 의해 지정된 컬렉션 ID가 있는 모든 컬렉션에 대한 쿼리를 허용합니다. |
상태
인덱스의 상태입니다. 인덱스 생성 중에 인덱스는 CREATING
상태가 됩니다. 인덱스가 성공적으로 생성되면 READY
상태로 전환됩니다. 인덱스 생성 시 문제가 발생하면 인덱스가 NEEDS_REPAIR
상태로 전환됩니다.
열거형 | |
---|---|
STATE_UNSPECIFIED | 상태가 지정되지 않았습니다. |
CREATING | 인덱스를 생성하는 중입니다. 인덱스에 대해 활성 장기 실행 작업이 있습니다. 문서를 작성할 때 색인이 업데이트됩니다. 일부 인덱스 데이터가 존재할 수 있습니다. |
READY | 인덱스를 사용할 준비가 되었습니다. 문서를 작성할 때 색인이 업데이트됩니다. 인덱스는 적용되는 모든 저장된 문서에서 완전히 채워집니다. |
NEEDS_REPAIR | 인덱스를 생성하는 중이지만 문제가 발생했습니다. 인덱스에 대한 활성 장기 실행 작업이 없으며 가장 최근에 완료된 장기 실행 작업이 실패했습니다. 문서를 작성할 때 색인은 업데이트되지 않습니다. 일부 인덱스 데이터가 존재할 수 있습니다. google.longrunning.Operations API를 사용하여 마지막으로 이 색인을 생성하려고 시도한 작업이 실패한 이유를 확인한 후 색인을 다시 생성하세요. |
IndexOperationMetadata
FirestoreAdmin.CreateIndex
의 google.longrunning.Operation
결과에 대한 메타데이터입니다.
필드 | |
---|---|
start_time | 이 작업이 시작된 시간입니다. |
end_time | 이 작업이 완료된 시간입니다. 작업이 아직 진행 중인 경우 설정이 해제됩니다. |
index | 이 작업이 수행되는 인덱스 리소스입니다. 예: |
state | 작업 상태입니다. |
progress_documents | 이 작업의 진행 상황을 문서로 표시합니다. |
progress_bytes | 이 작업의 진행률(바이트)입니다. |
목록필드요청
FirestoreAdmin.ListFields
에 대한 요청입니다.
필드 | |
---|---|
parent | |
filter | 목록 결과에 적용할 필터입니다. 현재 |
page_size | 반환할 결과 수입니다. |
page_token | |
목록필드응답
FirestoreAdmin.ListFields
에 대한 응답입니다.
필드 | |
---|---|
fields[] | 요청된 필드입니다. |
next_page_token | 다른 결과 페이지를 요청하는 데 사용할 수 있는 페이지 토큰입니다. 비어 있으면 이것이 마지막 페이지입니다. |
목록인덱스요청
FirestoreAdmin.ListIndexes
에 대한 요청입니다.
필드 | |
---|---|
parent | |
filter | 목록 결과에 적용할 필터입니다. |
page_size | 반환할 결과 수입니다. |
page_token | |
목록인덱스응답
FirestoreAdmin.ListIndexes
에 대한 응답입니다.
필드 | |
---|---|
indexes[] | 요청된 인덱스입니다. |
next_page_token | 다른 결과 페이지를 요청하는 데 사용할 수 있는 페이지 토큰입니다. 비어 있으면 이것이 마지막 페이지입니다. |
작업 상태
작업 상태를 설명합니다.
열거형 | |
---|---|
OPERATION_STATE_UNSPECIFIED | 지정되지 않음. |
INITIALIZING | 요청 처리를 준비 중입니다. |
PROCESSING | 요청이 활발히 처리되고 있습니다. |
CANCELLING | 사용자가 해당 작업에 대해 google.longrunning.Operations.CancelOperation을 호출한 후 요청이 취소되는 중입니다. |
FINALIZING | 요청이 처리되었으며 완료 단계에 있습니다. |
SUCCESSFUL | 요청이 성공적으로 완료되었습니다. |
FAILED | 요청 처리가 완료되었지만 오류가 발생했습니다. |
CANCELLED | 사용자가 google.longrunning.Operations.CancelOperation을 호출한 후 요청 취소가 완료되었습니다. |
진전
작업 진행 상황을 설명합니다. 작업 단위는 일반적이며 Progress
사용되는 위치에 따라 해석되어야 합니다.
필드 | |
---|---|
estimated_work | 예상 작업량. |
completed_work | 완료된 작업량. |
업데이트필드요청
FirestoreAdmin.UpdateField
에 대한 요청입니다.
필드 | |
---|---|
field | 업데이트할 필드입니다. |
update_mask | 필드를 기준으로 한 마스크입니다. 지정된 경우 이 field_mask로 지정된 구성만 필드에서 업데이트됩니다. |