Package google.firestore.admin.v1beta1

Chỉ mục

Quản trị viên trên Firestore

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: 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.

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

Siêu dữ liệu

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 trong 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 hành động đã thực hiện cho Dự án được chỉ định (bao gồm mọi Hoạt động đang diễn ra). 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.

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 thời gian sau khi đưa ra yêu cầu huỷ.

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

Các thao tác do dịch vụ FirestoreAdmin tạo ra, 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 đã chỉ định. Trạng thái ban đầu của chỉ mục mới tạo là CREATING. Sau khi hoàn tất google.longrunning.Operation được trả về, trạng thái sẽ là READY. Nếu đã có chỉ mục này, 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, như vậy chỉ mục sẽ chuyển sang trạng thái ERROR. Bạn có thể khôi phục quy 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:

  • 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ề việc xác thực.
Xóa chỉ mục

rpc DeleteIndex(DeleteIndexRequest) returns (Empty)

Xoá một chỉ mục.

Phạm vi uỷ quyền

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

  • 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ề việc xác thực.
Xuất tài liệu

rpc ExportDocuments(ExportDocumentsRequest) returns (Operation)

Xuất bản sao của tất cả hoặc một nhóm nhỏ các 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 sẽ diễn ra ở chế độ nền và bạn có thể giám sát cũng như quản lý tiến trình xuất thông qua tài nguyên Vận hành được tạo. Bạn chỉ có thể sử dụng dữ liệu xuất ra sau khi thực hiện xong thao tác liên kết. Nếu quá trình xuất dữ liệu bị huỷ trước khi hoàn tất, thì 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:

  • 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ề việc xác thực.
GetIndex

rpc GetIndex(GetIndexRequest) returns (Index)

Lấy một chỉ mục.

Phạm vi uỷ quyền

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

  • 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ề việc xác thực.
Nhập tài liệu

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à bạn có thể giám sát cũng như quản lý tiến trình nhập thông qua tài nguyên Vận hành được tạo. Nếu thao tác ImportDocuments bị huỷ, thì có thể một nhóm nhỏ 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:

  • 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ề việc xác thực.
ListIndexes (Chỉ mục danh sách)

rpc ListIndexes(ListIndexesRequest) returns (ListIndexesResponse)

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

Phạm vi uỷ quyền

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

  • 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ề việc xác thực.

CreateIndexRequest (Yêu cầu chỉ mục)

Yêu cầu cho 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ỉ là dữ liệu đầu ra và sẽ bị bỏ qua. Bạn không thể tạo hoặc xoá một số chỉ mục trường đơn.

Yêu cầu chỉ mục

Yêu cầu cho FirestoreAdmin.DeleteIndex.

Trường
name

string

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

Xuất siêu dữ liệu tài liệu

Siêu dữ liệu cho các thao tác ExportDocuments.

Trường
start_time

Timestamp

Thời gian bắt đầu hoạt động.
end_time

Timestamp

Thời gian hoạt động đã kết thúc, thành công hoặc thời gian khác. Huỷ thiết lập nếu thao tác 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 tài liệu được xử lý.
progress_bytes

Progress

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

string

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

string

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

Xuất tài liệuRequest

Yêu cầu cho 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

Những mã nhận dạng bộ sưu tập cần xuất. Không 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 tại, chúng tôi chỉ hỗ trợ các URI của Google Cloud Storage ở 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à một đường dẫn không gian tên không bắt buộc trên Google Cloud Storage. Khi chọn tên, hãy nhớ cân nhắc đến 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ì một tiền tố sẽ được tạo dựa trên thời gian bắt đầu.

Xuất văn bản phản hồi

Đượ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ể dùng tính năng này để bắt đầu nhập dữ liệu vào Cloud Firestore (dự án này hoặc một dự án khác) sau khi thao tác này hoàn tất thành công.

GetIndexRequest (Yêu cầu chỉ mục)

Yêu cầu cho FirestoreAdmin.GetIndex.

Trường
name

string

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

Siêu dữ liệu ImportDocuments

Siêu dữ liệu cho các thao tác ImportDocuments.

Trường
start_time

Timestamp

Thời gian bắt đầu hoạt động.
end_time

Timestamp

Thời gian hoạt động đã kết thúc, thành công hoặc thời gian khác. Huỷ thiết lập nếu thao tác 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 tài liệu được xử lý.
progress_bytes

Progress

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

string

Các mã bộ sưu tập đang được nhập.
input_uri_prefix

string

Vị trí của tài liệu đang được nhập.

Nhập tài liệu yêu cầu

Yêu cầu cho 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 xác định có nghĩa là tất cả các tập hợp được đưa vào quá trình 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 một ExportDocumentsResponse trong một tệp xuất đã hoàn tất. 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 được á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 Bạn chưa xác định trạng thái.
CREATING Chỉ mục đang được tạo. Chỉ mục có một hoạt động diễn ra trong thời gian dài. Chỉ mục được cập nhật khi viết tài liệu. Có thể tồn tại một số dữ liệu về chỉ mục.
READY Chỉ mục đã sẵn sàng để sử dụng. Chỉ mục được cập nhật khi viết tài liệu. Chỉ mục được điền đầy đủ từ mọi tài liệu được lưu trữ có áp dụng nó.
ERROR Đang tạo chỉ mục nhưng đã xảy ra lỗi. Không có hoạt động dài hạn nào đang hoạt động cho chỉ mục và thao tác chạy trong thời gian dài được hoàn thành gần đây nhất cũng không thành công. Chỉ mục không được cập nhật khi viết tài liệu. Có thể tồn tại một số dữ liệu về chỉ mục.

Trường chỉ mục

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ả theo [google.firestore.v1beta1.Document.fields][fields]. Đường dẫn trường đặc biệt __name__ có thể được chính đường dẫn đó sử dụng hoặc ở cuối một đường dẫ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 xác định chế độ.
ASCENDING Các giá trị của trường được lập chỉ mục để hỗ trợ sắp xếp trình tự theo thứ tự tăng dần và cũng có thể 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 trình tự theo thứ tự giảm dần và cũng có thể 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_CONTAINS.

Siêu dữ liệu IndexOperation

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

Trường
start_time

Timestamp

Thời gian bắt đầu hoạt động.
end_time

Timestamp

Thời gian hoạt động đã kết thúc, thành công hoặc thời gian khác. Huỷ thiết lập nếu thao tác vẫn đang hoạt động.
index

string

Tài nguyên chỉ mục mà thao tác này đang thực hiện. Ví dụ: projects/{project_id}/databases/{database_id}/indexes/{index_id}
operation_type

OperationType

Loại thao tác 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ì giá trị huỷ sẽ là true nhưng google.longrunning.Operation.done sẽ là false.
document_progress

Progress

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

Loại toán tử

Loại thao tác lập chỉ mục.

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

Yêu cầu chỉ mục danh sách

Yêu cầu cho 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 chuẩn của trang Danh sách.
page_token

string

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

Phản hồi ListIndexes

Phản hồi cho FirestoreAdmin.ListIndexes.

Trường
indexes[]

Index

Chỉ mục.
next_page_token

string

Mã thông báo trang tiếp theo cho danh sách tiêu chuẩn.

Siêu dữ liệu vị trí

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

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

Trạng thái hoạt động

Các trạng thái 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 bị huỷ sau khi người dùng đã gọi google.longruntime.Operations.CancelOperation.
FINALIZING Yêu cầu đã được xử lý và đang trong giai đoạn kết thúc.
SUCCESSFUL Yêu cầu đã hoàn tất thành công.
FAILED Yêu cầu đã hoàn tất được xử lý nhưng gặp lỗi.
CANCELLED Yêu cầu đã bị huỷ sau khi người dùng đã gọi google.longRunning.Operations.CancelOperation.

Tiến trình

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

Trường
work_completed

int64

Một con số ướ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

Một con số ước tính về lượng công việc cần thực hiện. 0 nếu không có số liệu ước tính cho công việc. Có thể thay đổi khi công việc đang tiến hành.