Package google.firestore.admin.v1beta1

Chỉ mục

FirestoreAdmin

API Quản trị của Cloud Firestore.

API này cung cấp một số dịch vụ quản trị cho Cloud Firestore.

Khái niệm

Dự án, Cơ sở dữ liệu, Không gian tên, Bộ sưu tập và Tài liệu được sử dụng theo định nghĩa trong API Google Cloud Firestore.

Thao tác: Một thao tác thể hiện công việc đang được thực hiện ở chế độ nền.

Dịch vụ

Chỉ mục

Dịch vụ chỉ mục quản lý các chỉ mục của Cloud Firestore.

Quá trình tạo chỉ mục được thực hiện không đồng bộ. Một tài nguyên Hoạt động được tạo cho mỗi hoạt động không đồng bộ như vậy. Trạng thái của hoạt động (bao gồm mọi lỗi đã gặp phải) có thể được truy vấn thông qua tài nguyên Hoạt động.

Metadata

Cung cấp siêu dữ liệu và thông tin thống kê về dữ liệu trong Cloud Firestore. Dữ liệu được cung cấp như một phần của API này có thể đã lỗi thời.

Hoạt động

Tập hợp Hoạt động cung cấp bản ghi các thao tác được thực hiện cho Dự án được chỉ định (bao gồm mọi Hoạt động đang diễn ra). Các thao tác không được tạo trực tiếp mà thông qua các lệnh gọi trên các tập hợp hoặc tài nguyên khác.

Một thao tác chưa được thực hiện có thể bị huỷ. Yêu cầu huỷ không đồng bộ và Thao tác có thể tiếp tục chạy trong một khoảng thời gian sau khi yêu cầu huỷ được thực hiện.

Hoạt động đã được thực hiện có thể bị xoá để không còn được liệt kê trong tập hợp Hoạt động nữa.

Các hoạt động do dịch vụ FirestoreAdmin tạo nhưng được truy cập thông qua dịch vụ google.longrunning.Operations.

CreateIndex

rpc CreateIndex(CreateIndexRequest) returns (Operation)

Tạo chỉ mục được chỉ định. Trạng thái ban đầu của chỉ mục mới được tạo là CREATING. Khi hoàn thành google.longrunning.Operation được trả về, trạng thái sẽ là READY. Nếu chỉ mục đã tồn tại, lệnh gọi sẽ trả về trạng thái ALREADY_EXISTS.

Trong quá trình tạo, quá trình này có thể dẫn đến lỗi. Trong trường hợp này, chỉ mục sẽ chuyển sang trạng thái ERROR. Bạn có thể khôi phục quá trình này bằng cách sửa dữ liệu gây ra lỗi, xoá chỉ mục bằng delete, sau đó tạo lại chỉ mục bằng create.

Không thể tạo chỉ mục có một trường duy nhất.

Phạm vi uỷ quyền

Yêu cầu một trong các phạm vi OAuth sau đây:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Để biết thêm thông tin, hãy xem bài viết Tổng quan về hoạt động xác thực.
DeleteIndex

rpc DeleteIndex(DeleteIndexRequest) returns (Empty)

Xoá chỉ mục.

Phạm vi uỷ quyền

Yêu cầu một trong các phạm vi OAuth sau đây:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Để biết thêm thông tin, hãy xem bài viết Tổng quan về hoạt động xác thực.
ExportDocuments

rpc ExportDocuments(ExportDocumentsRequest) returns (Operation)

Xuất bản sao của tất cả hoặc một nhóm nhỏ tài liệu từ Google Cloud Firestore sang một hệ thống lưu trữ khác, chẳng hạn như Google Cloud Storage. Nội dung cập nhật gần đây đối với tài liệu có thể không được phản ánh trong quá trình xuất. Quá trình xuất diễn ra trong nền và tiến trình xuất có thể được theo dõi và quản lý thông qua tài nguyên Hoạt động được tạo. Chỉ có thể sử dụng kết quả của dữ liệu xuất sau khi hoàn tất thao tác liên kết. Nếu một hoạt động xuất bị huỷ trước khi hoàn tất, thì thao tác này có thể để lại một phần dữ liệu trong Google Cloud Storage.

Phạm vi uỷ quyền

Yêu cầu một trong các phạm vi OAuth sau đây:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Để biết thêm thông tin, hãy xem bài viết Tổng quan về hoạt động xác thực.
GetIndex

rpc GetIndex(GetIndexRequest) returns (Index)

Lấy chỉ mục.

Phạm vi uỷ quyền

Yêu cầu một trong các phạm vi OAuth sau đây:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Để biết thêm thông tin, hãy xem bài viết Tổng quan về hoạt động xác thực.
ImportDocuments

rpc ImportDocuments(ImportDocumentsRequest) returns (Operation)

Nhập tài liệu vào Google Cloud Firestore. Các tài liệu hiện có có cùng tên sẽ bị ghi đè. Quá trình nhập diễn ra ở chế độ nền và có thể theo dõi cũng như quản lý tiến trình này thông qua tài nguyên Hoạt động được tạo. Nếu thao tác ImportDocuments bị huỷ, thì có thể một tập hợp con dữ liệu đã được nhập vào Cloud Firestore.

Phạm vi uỷ quyền

Yêu cầu một trong các phạm vi OAuth sau đây:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Để biết thêm thông tin, hãy xem bài viết Tổng quan về hoạt động xác thực.
ListIndexes

rpc ListIndexes(ListIndexesRequest) returns (ListIndexesResponse)

Liệt kê các chỉ mục phù hợp với bộ lọc đã chỉ định.

Phạm vi uỷ quyền

Yêu cầu một trong các phạm vi OAuth sau đây:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Để biết thêm thông tin, hãy xem bài viết Tổng quan về hoạt động xác thực.

CreateIndexRequest

Yêu cầu đối với FirestoreAdmin.CreateIndex.

Trường
parent

string

Tên của cơ sở dữ liệu sẽ áp dụng chỉ mục này. Ví dụ: projects/{project_id}/databases/{database_id}
index

Index

Chỉ mục cần tạo. Các trường tên và trạng thái chỉ để xuất và sẽ bị bỏ qua. Không thể tạo hoặc xoá một số chỉ mục trường đơn nhất định.

DeleteIndexRequest

Yêu cầu đối với FirestoreAdmin.DeleteIndex.

Trường
name

string

Tên chỉ mục. Ví dụ: projects/{project_id}/databases/{database_id}/indexes/{index_id}

ExportDocumentsMetadata

Siêu dữ liệu cho hoạt động ExportDocuments.

Trường
start_time

Timestamp

Thời gian bắt đầu thao tác.
end_time

Timestamp

Thời gian kết thúc hoạt động, dù thành công hay không. Không đặt nếu thao tác này vẫn đang hoạt động.
operation_state

OperationState

Trạng thái của hoạt động xuất.
progress_documents

Progress

Ước tính số lượng chứng từ được xử lý.
progress_bytes

Progress

Ước tính số lượng byte được xử lý.
collection_ids[]

string

Mã bộ sưu tập nào đang được xuất.
output_uri_prefix

string

Nơi thực thể đang được xuất sang.

ExportDocumentsRequest

Yêu cầu đối với FirestoreAdmin.ExportDocuments.

Trường
name

string

Cơ sở dữ liệu để xuất. Phải có dạng: projects/{project_id}/databases/{database_id}.
collection_ids[]

string

Mã bộ sưu tập cần xuất. Chưa xác định có nghĩa là tất cả các bộ sưu tập.
output_uri_prefix

string

URI đầu ra. Hiện chỉ hỗ trợ các URI Google Cloud Storage có dạng: gs://BUCKET_NAME[/NAMESPACE_PATH], trong đó BUCKET_NAME là tên của bộ chứa Google Cloud Storage và NAMESPACE_PATH là đường dẫn không gian tên Google Cloud Storage tuỳ chọn. Khi chọn tên, hãy nhớ cân nhắc các nguyên tắc đặt tên của Google Cloud Storage: https://cloud.google.com/storage/docs/naming. Nếu URI là một bộ chứa (không có đường dẫn không gian tên), thì tiền tố sẽ được tạo dựa trên thời gian bắt đầu.

ExportDocumentsResponse

Được trả về trong trường phản hồi google.longrunning.Operation.

Trường
output_uri_prefix

string

Vị trí của các tệp đầu ra. Bạn có thể sử dụng mã này để bắt đầu nhập vào Cloud Firestore (dự án này hoặc một dự án khác) sau khi thao tác hoàn tất.

GetIndexRequest

Yêu cầu đối với FirestoreAdmin.GetIndex.

Trường
name

string

Tên của chỉ mục. Ví dụ: projects/{project_id}/databases/{database_id}/indexes/{index_id}

ImportDocumentsMetadata

Siêu dữ liệu cho hoạt động ImportDocuments.

Trường
start_time

Timestamp

Thời gian bắt đầu thao tác.
end_time

Timestamp

Thời gian kết thúc hoạt động, dù thành công hay không. Không đặt nếu thao tác này vẫn đang hoạt động.
operation_state

OperationState

Trạng thái của thao tác nhập.
progress_documents

Progress

Ước tính số lượng chứng từ được xử lý.
progress_bytes

Progress

Ước tính số lượng byte được xử lý.
collection_ids[]

string

Mã bộ sưu tập nào đang được nhập.
input_uri_prefix

string

Vị trí của chứng từ đang được nhập.

ImportDocumentsRequest

Yêu cầu đối với FirestoreAdmin.ImportDocuments.

Trường
name

string

Cơ sở dữ liệu để nhập vào. Phải có dạng: projects/{project_id}/databases/{database_id}.
collection_ids[]

string

Mã bộ sưu tập cần nhập. Chưa chỉ định có nghĩa là tất cả tập hợp có trong dữ liệu nhập.
input_uri_prefix

string

Vị trí của các tệp đã xuất. Giá trị này phải khớp với output_uri_prefix của ExportDocumentsResponse trong một quá trình xuất đã hoàn tất thành công. Hãy xem: google.firestore.admin.v1beta1.ExportDocumentsResponse.output_uri_prefix.

Chỉ mục

Định nghĩa chỉ mục.

Trường
name

string

Tên tài nguyên của chỉ mục. Chỉ có đầu ra.
collection_id

string

Mã bộ sưu tập áp dụng chỉ mục này. Bắt buộc.
fields[]

IndexField

Các trường cần lập chỉ mục.
state

State

Trạng thái của chỉ mục. Chỉ có đầu ra.

Tiểu bang

Trạng thái của chỉ mục. Trong quá trình tạo chỉ mục, chỉ mục sẽ ở trạng thái CREATING. Nếu được tạo thành công, chỉ mục sẽ chuyển sang trạng thái READY. Nếu không thể tạo chỉ mục, chỉ mục sẽ chuyển sang trạng thái ERROR.

Enum
STATE_UNSPECIFIED Chưa xác định tiểu bang này.
CREATING Chỉ mục đang được tạo. Có một hoạt động hoạt động diễn ra trong thời gian dài cho chỉ mục. Chỉ mục được cập nhật khi soạn một tài liệu. Một số dữ liệu chỉ mục có thể tồn tại.
READY Chỉ mục đã sẵn sàng để sử dụng. Chỉ mục được cập nhật khi soạn một tài liệu. Chỉ mục được điền đầy đủ từ tất cả các tài liệu được lưu trữ mà chỉ mục áp dụng.
ERROR Chỉ mục đang được tạo, nhưng đã xảy ra lỗi. Không có hoạt động nào đang hoạt động trong thời gian dài cho chỉ mục và hoạt động chạy trong thời gian dài kết thúc gần đây nhất đều không thành công. Chỉ mục không được cập nhật khi soạn một tài liệu. Một số dữ liệu chỉ mục có thể tồn tại.

IndexField

Một trường của chỉ mục.

Trường
field_path

string

Đường dẫn của trường. Phải khớp với thông số kỹ thuật của đường dẫn trường được mô tả trong [google.firestore.v1beta1.Document.fields][fields]. Đường dẫn trường đặc biệt __name__ có thể được sử dụng độc lập hoặc ở cuối đường dẫn. Bạn chỉ có thể sử dụng __type__ ở cuối đường dẫn.
mode

Mode

Chế độ của trường.

Chế độ

Chế độ này xác định cách lập chỉ mục một trường.

Enum
MODE_UNSPECIFIED Chưa chỉ định chế độ.
ASCENDING Các giá trị của trường được lập chỉ mục để hỗ trợ sắp xếp theo trình tự tăng dần, đồng thời truy vấn theo <, >, <=, >= và =.
DESCENDING Các giá trị của trường được lập chỉ mục để hỗ trợ sắp xếp theo trình tự giảm dần, đồng thời truy vấn theo <, >, <=, >= và =.
ARRAY_CONTAINS Các giá trị mảng của trường được lập chỉ mục để hỗ trợ tư cách thành viên bằng cách sử dụng các truy vấn ARRAY_OPTIONSS.

IndexOperationMetadata

Siêu dữ liệu cho các hoạt động lập chỉ mục. Siêu dữ liệu này sẽ điền trường siêu dữ liệu của google.longrunning.Operation.

Trường
start_time

Timestamp

Thời gian bắt đầu thao tác.
end_time

Timestamp

Thời gian kết thúc hoạt động, dù thành công hay không. Không đặt nếu thao tác này vẫn đang hoạt động.
index

string

Tài nguyên chỉ mục mà toán tử này đang xử lý. Ví dụ: projects/{project_id}/databases/{database_id}/indexes/{index_id}
operation_type

OperationType

Loại toán tử lập chỉ mục.
cancelled

bool

Đúng nếu google.longrunning.Operation bị huỷ. Nếu quá trình huỷ đang diễn ra, thì hàm huỷ sẽ có giá trị là true nhưng google.longrunning.Operation.done sẽ là giá trị false.
document_progress

Progress

Tiến trình của hoạt động hiện tại, được đo bằng số lượng tài liệu.

OperationType

Loại toán tử lập chỉ mục.

Enum
OPERATION_TYPE_UNSPECIFIED Không xác định. Không bao giờ được đặt bởi máy chủ.
CREATING_INDEX Thao tác sẽ tạo chỉ mục. Được bắt đầu bằng một cuộc gọi CreateIndex.

ListIndexesRequest

Yêu cầu đối với FirestoreAdmin.ListIndexes.

Trường
parent

string

Tên cơ sở dữ liệu. Ví dụ: projects/{project_id}/databases/{database_id}
filter

string
page_size

int32

Kích thước trang Danh sách chuẩn.
page_token

string

Mã thông báo trang Danh sách chuẩn.

ListIndexesResponse

Câu trả lời cho FirestoreAdmin.ListIndexes.

Trường
indexes[]

Index

Chỉ mục.
next_page_token

string

Mã thông báo tiêu chuẩn trên trang tiếp theo của Danh sách.

LocationMetadata

Loại này không có trường.

Thông báo siêu dữ liệu cho google.cloud.location.Location.metadata.

OperationState

Các trạng thái khác nhau có thể có cho một Hoạt động đang diễn ra.

Enum
STATE_UNSPECIFIED Không xác định.
INITIALIZING Yêu cầu đang được chuẩn bị để xử lý.
PROCESSING Yêu cầu đang được xử lý.
CANCELLING Yêu cầu đang trong quá trình bị huỷ sau khi người dùng có tên là google.longRunning.Operations.CancelOperation thực hiện.
FINALIZING Yêu cầu đã được xử lý và đang trong giai đoạn hoàn tất.
SUCCESSFUL Yêu cầu đã hoàn tất thành công.
FAILED Yêu cầu đã được xử lý xong nhưng gặp lỗi.
CANCELLED Yêu cầu đã bị huỷ sau khi người dùng có tên là google.longRunning.Operations.CancelOperation.

Tiến độ

Đo lường tiến trình của một chỉ số cụ thể.

Trường
work_completed

int64

Số liệu ước tính về lượng công việc đã hoàn thành. Xin lưu ý rằng giá trị này có thể lớn hơn work_estimated.
work_estimated

int64

Số liệu ước tính về khối lượng công việc cần thực hiện. Bằng 0 nếu không có ước tính công việc. Có thể thay đổi theo tiến trình công việc.