Chỉ mục
FirestoreAdmin
(giao diện)CreateIndexRequest
(thông báo)DeleteIndexRequest
(thông báo)ExportDocumentsMetadata
(thông báo)ExportDocumentsRequest
(thông báo)ExportDocumentsResponse
(thông báo)Field
(thông báo)Field.IndexConfig
(thông báo)FieldOperationMetadata
(thông báo)FieldOperationMetadata.IndexConfigDelta
(thông báo)FieldOperationMetadata.IndexConfigDelta.ChangeType
(enum)GetFieldRequest
(thông báo)GetIndexRequest
(thông báo)ImportDocumentsMetadata
(thông báo)ImportDocumentsRequest
(thông báo)Index
(thông báo)Index.IndexField
(thông báo)Index.IndexField.ArrayConfig
(enum)Index.IndexField.Order
(enum)Index.QueryScope
(enum)Index.State
(enum)IndexOperationMetadata
(thông báo)ListFieldsRequest
(thông báo)ListFieldsResponse
(thông báo)ListIndexesRequest
(thông báo)ListIndexesResponse
(thông báo)OperationState
(enum)Progress
(thông báo)UpdateFieldRequest
(thông báo)
FirestoreAdmin
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 |
---|
Tạo chỉ mục tổng hợp. Thao tác này sẽ trả về một
|
DeleteIndex |
---|
Xoá chỉ mục tổng hợp.
|
ExportDocuments |
---|
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.
|
GetField |
---|
Lấy siêu dữ liệu và cấu hình cho một Trường.
|
GetIndex |
---|
Nhận chỉ mục tổng hợp.
|
ImportDocuments |
---|
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.
|
ListFields |
---|
Liệt kê siêu dữ liệu và cấu hình của trường cho cơ sở dữ liệu này. Hiện tại,
|
ListIndexes |
---|
Liệt kê các chỉ mục tổng hợp.
|
UpdateField |
---|
Cập nhật cấu hình trường. Hiện tại, việc cập nhật trường chỉ áp dụng cho cấu hình chỉ mục trường đơn. Tuy nhiên, các lệnh gọi đến Lệnh gọi này trả về một Để định cấu hình chế độ cài đặt trường mặc định cho cơ sở dữ liệu, hãy sử dụng
|
CreateIndexRequest
Yêu cầu đối với FirestoreAdmin.CreateIndex
.
Trường | |
---|---|
parent |
Tên cha mẹ của biểu mẫu |
index |
Chỉ mục tổng hợp cần tạo. |
DeleteIndexRequest
Yêu cầu đối với FirestoreAdmin.DeleteIndex
.
Trường | |
---|---|
name |
Tên của biểu mẫu |
ExportDocumentsMetadata
Siêu dữ liệu về các kết quả bằng google.longrunning.Operation
từ FirestoreAdmin.ExportDocuments
.
Trường | |
---|---|
start_time |
Thời gian bắt đầu thao tác này. |
end_time |
Thời gian hoàn tất thao tác này. Giá trị này sẽ không được đặt nếu bạn vẫn đang thực hiện thao tác. |
operation_state |
Trạng thái của hoạt động xuất. |
progress_documents |
Tiến trình của hoạt động này (trong các tài liệu). |
progress_bytes |
Tiến trình, tính bằng byte, của thao tác này. |
collection_ids[] |
Mã bộ sưu tập nào đang được xuất. |
output_uri_prefix |
Nơi thực thể đang được xuất sang. |
ExportDocumentsRequest
Yêu cầu đối với FirestoreAdmin.ExportDocuments
.
Trường | |
---|---|
name |
Cơ sở dữ liệu để xuất. Phải có dạng: |
collection_ids[] |
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 |
URI đầu ra. Hiện chỉ hỗ trợ các URI Google Cloud Storage có dạng: |
ExportDocumentsResponse
Được trả về trong trường phản hồi google.longrunning.Operation
.
Trường | |
---|---|
output_uri_prefix |
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. |
Kỹ thuật
Đại diện cho một trường duy nhất trong cơ sở dữ liệu.
Các trường được nhóm theo "Nhóm thu thập" đại diện cho tất cả các tập hợp trong cơ sở dữ liệu bằng cùng một mã nhận dạng.
Trường | |
---|---|
name |
Tên trường của biểu mẫu Đường dẫn trường có thể là một tên trường đơn giản, ví dụ: Đường dẫn trường có thể được trích dẫn bằng cách sử dụng Ví dụ: (Lưu ý: Phần ghi chú ở đây được viết theo cú pháp markdown, vì vậy sẽ có thêm một lớp dấu phẩy ngược đại diện cho một khối mã)
|
index_config |
Cấu hình chỉ mục của trường này. Nếu bạn không đặt chính sách này, thì hoạt động lập chỉ mục trường sẽ chuyển về cấu hình do |
IndexConfig
Cấu hình chỉ mục của trường này.
Trường | |
---|---|
indexes[] |
Chỉ mục được hỗ trợ cho trường này. |
uses_ancestor_config |
Chỉ có đầu ra. Nếu đúng, cấu hình chỉ mục của |
ancestor_field |
Chỉ có đầu ra. Chỉ định tên tài nguyên của |
reverting |
Chỉ xuất khi giá trị true (đúng), cấu hình chỉ mục của |
FieldOperationMetadata
Siêu dữ liệu về các kết quả bằng google.longrunning.Operation
từ FirestoreAdmin.UpdateField
.
Trường | |
---|---|
start_time |
Thời gian bắt đầu thao tác này. |
end_time |
Thời gian hoàn tất thao tác này. Giá trị này sẽ không được đặt nếu bạn vẫn đang thực hiện thao tác. |
field |
Tài nguyên trường mà toán tử này đang hoạt động. Ví dụ: |
index_config_deltas[] |
Danh sách |
state |
Trạng thái của hoạt động. |
document_progress |
Tiến trình của hoạt động này (trong các tài liệu). |
bytes_progress |
Tiến trình, tính bằng byte, của thao tác này. |
IndexConfigDelta
Thông tin về thay đổi cấu hình chỉ mục.
Trường | |
---|---|
change_type |
Chỉ định cách chỉ mục thay đổi. |
index |
Chỉ mục đang được thay đổi. |
ChangeType
Chỉ định cách chỉ mục thay đổi.
Enum | |
---|---|
CHANGE_TYPE_UNSPECIFIED |
Loại thay đổi chưa được chỉ định hoặc chưa được xác định. |
ADD |
Đang thêm chỉ mục trường duy nhất. |
REMOVE |
Chỉ mục trường đơn đang bị xoá. |
GetFieldRequest
Yêu cầu đối với FirestoreAdmin.GetField
.
Trường | |
---|---|
name |
Tên của biểu mẫu |
GetIndexRequest
Yêu cầu đối với FirestoreAdmin.GetIndex
.
Trường | |
---|---|
name |
Tên của biểu mẫu |
ImportDocumentsMetadata
Siêu dữ liệu về các kết quả bằng google.longrunning.Operation
từ FirestoreAdmin.ImportDocuments
.
Trường | |
---|---|
start_time |
Thời gian bắt đầu thao tác này. |
end_time |
Thời gian hoàn tất thao tác này. Giá trị này sẽ không được đặt nếu bạn vẫn đang thực hiện thao tác. |
operation_state |
Trạng thái của thao tác nhập. |
progress_documents |
Tiến trình của hoạt động này (trong các tài liệu). |
progress_bytes |
Tiến trình, tính bằng byte, của thao tác này. |
collection_ids[] |
Mã bộ sưu tập nào đang được nhập. |
input_uri_prefix |
Vị trí của chứng từ đang được nhập. |
ImportDocumentsRequest
Yêu cầu đối với FirestoreAdmin.ImportDocuments
.
Trường | |
---|---|
name |
Cơ sở dữ liệu để nhập vào. Phải có dạng: |
collection_ids[] |
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 |
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: |
Chỉ mục
Chỉ mục Cloud Firestore hỗ trợ các truy vấn đơn giản và phức tạp đối với tài liệu trong cơ sở dữ liệu.
Trường | |
---|---|
name |
Chỉ có đầu ra. Tên do máy chủ xác định cho chỉ mục này. Tên này cho chỉ mục tổng hợp sẽ là: |
query_scope |
Các chỉ mục có phạm vi truy vấn bộ sưu tập được chỉ định sẽ cho phép truy vấn đối với một tập hợp là phần tử con của một tài liệu cụ thể, được chỉ định tại thời điểm truy vấn và có cùng mã bộ sưu tập. Các chỉ mục có phạm vi truy vấn nhóm bộ sưu tập được chỉ định sẽ cho phép truy vấn đối với tất cả các bộ sưu tập là bắt nguồn từ một tài liệu cụ thể, được chỉ định tại thời điểm truy vấn và có cùng mã bộ sưu tập với chỉ mục này. |
fields[] |
Các trường mà chỉ mục này hỗ trợ. Đối với chỉ mục tổng hợp, đây luôn là 2 trường trở lên. Mục nhập trường cuối cùng luôn dành cho đường dẫn trường Đối với các chỉ mục trường đơn, đây sẽ luôn là một mục nhập có đường dẫn trường bằng với đường dẫn trường của trường được liên kết. |
state |
Chỉ có đầu ra. Trạng thái phân phát của chỉ mục. |
IndexField
Một trường trong chỉ mục. Trường_path mô tả trường nào được lập chỉ mục, còn value_mode mô tả cách hệ thống lập chỉ mục giá trị của trường.
Trường | |
---|---|
field_path |
Có thể là name. Đối với các chỉ mục trường đơn, giá trị này phải khớp với tên của trường hoặc có thể bị bỏ qua. |
Trường hợp value_mode . Cách Google lập chỉ mục giá trị của trường. value_mode chỉ có thể là một trong những trạng thái sau: |
|
order |
Cho biết rằng trường này hỗ trợ sắp xếp theo thứ tự đã chỉ định hoặc so sánh bằng cách sử dụng =, <, <=, >, >=. |
array_config |
Cho biết rằng trường này hỗ trợ các thao tác trên |
ArrayConfig
Các cấu hình giá trị mảng được hỗ trợ.
Enum | |
---|---|
ARRAY_CONFIG_UNSPECIFIED |
Chỉ mục không hỗ trợ các truy vấn mảng bổ sung. |
CONTAINS |
Chỉ mục hỗ trợ các truy vấn vùng chứa mảng. |
Đặt
Các thứ tự được hỗ trợ.
Enum | |
---|---|
ORDER_UNSPECIFIED |
Chưa xác định thứ tự. Không phải là lựa chọn hợp lệ. |
ASCENDING |
Trường này được sắp xếp theo giá trị của trường tăng dần. |
DESCENDING |
Trường này được sắp xếp theo giá trị của trường giảm dần. |
QueryScope
Phạm vi truy vấn xác định phạm vi chạy truy vấn. Nội dung này được chỉ định trong trường from
của Truy vấn có cấu trúc.
Enum | |
---|---|
QUERY_SCOPE_UNSPECIFIED |
Chưa chỉ định phạm vi truy vấn. Không phải là lựa chọn hợp lệ. |
COLLECTION |
Chỉ mục có phạm vi truy vấn tập hợp được chỉ định cho phép truy vấn đối với một tập hợp là phần tử con của một tài liệu cụ thể, được chỉ định tại thời điểm truy vấn và có mã bộ sưu tập do chỉ mục chỉ định. |
COLLECTION_GROUP |
Các chỉ mục có phạm vi truy vấn nhóm bộ sưu tập được chỉ định sẽ cho phép truy vấn đối với tất cả các tập hợp có mã bộ sưu tập do chỉ mục chỉ định. |
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 quá trình tạo chỉ mục gặp sự cố, thì chỉ mục sẽ chuyển sang trạng thái NEEDS_REPAIR
.
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. |
NEEDS_REPAIR |
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. Sử dụng API google.longRunning.Operations để xác định lý do khiến hoạt động gần đây nhất nhằm tạo chỉ mục này không thành công, sau đó tạo lại chỉ mục. |
IndexOperationMetadata
Siêu dữ liệu về các kết quả bằng google.longrunning.Operation
từ FirestoreAdmin.CreateIndex
.
Trường | |
---|---|
start_time |
Thời gian bắt đầu thao tác này. |
end_time |
Thời gian hoàn tất thao tác này. Giá trị này sẽ không được đặt nếu bạn vẫn đang thực hiện thao tác. |
index |
Tài nguyên chỉ mục mà toán tử này đang xử lý. Ví dụ: |
state |
Trạng thái của hoạt động. |
progress_documents |
Tiến trình của hoạt động này (trong các tài liệu). |
progress_bytes |
Tiến trình, tính bằng byte, của thao tác này. |
ListFieldsRequest
Yêu cầu đối với FirestoreAdmin.ListFields
.
Trường | |
---|---|
parent |
Tên cha mẹ của biểu mẫu |
filter |
Bộ lọc để áp dụng cho kết quả danh sách. Hiện tại, |
page_size |
Số lượng kết quả trả về. |
page_token |
Mã thông báo trang, được trả về từ lệnh gọi trước đó đến |
ListFieldsResponse
Câu trả lời cho FirestoreAdmin.ListFields
.
Trường | |
---|---|
fields[] |
Các trường được yêu cầu. |
next_page_token |
Mã thông báo trang có thể được dùng để yêu cầu một trang kết quả khác. Nếu trang trống, thì đây là trang cuối cùng. |
ListIndexesRequest
Yêu cầu đối với FirestoreAdmin.ListIndexes
.
Trường | |
---|---|
parent |
Tên cha mẹ của biểu mẫu |
filter |
Bộ lọc để áp dụng cho kết quả danh sách. |
page_size |
Số lượng kết quả trả về. |
page_token |
Mã thông báo trang, được trả về từ lệnh gọi trước đó đến |
ListIndexesResponse
Câu trả lời cho FirestoreAdmin.ListIndexes
.
Trường | |
---|---|
indexes[] |
Chỉ mục được yêu cầu. |
next_page_token |
Mã thông báo trang có thể được dùng để yêu cầu một trang kết quả khác. Nếu trang trống, thì đây là trang cuối cùng. |
OperationState
Mô tả trạng thái của hoạt động.
Enum | |
---|---|
OPERATION_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 độ
Mô tả tiến trình của thao tác. Đơn vị công việc là khái niệm chung và phải được diễn giải dựa trên nơi sử dụng Progress
.
Trường | |
---|---|
estimated_work |
Khối lượng công việc ước tính. |
completed_work |
Khối lượng công việc đã hoàn thành. |
UpdateFieldRequest
Yêu cầu đối với FirestoreAdmin.UpdateField
.
Trường | |
---|---|
field |
Trường sẽ được cập nhật. |
update_mask |
Một mặt nạ, so với trường. Nếu được chỉ định, chỉ cấu hình do trường_mặt nạ (field_mask) chỉ định mới được cập nhật trong trường này. |