Package google.firestore.admin.v1

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.

Dự án, Cơ sở dữ liệu, Không gian tên, Bộ sưu tập, Nhóm 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 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.

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 đã 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. Vận hành là rác được thu thập sau 30 ngày. Theo mặc định, ListOperations sẽ chỉ trả về các hoạt động đang diễn ra và các hoạt động không thành công. Để liệt kê hoạt động đã hoàn tất, hãy đưa ra yêu cầu ListOperations với bộ lọc done: true.

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.

Tạo lịch biểu sao lưu

rpc CreateBackupSchedule(CreateBackupScheduleRequest) returns (BackupSchedule)

Tạo lịch sao lưu trên cơ sở dữ liệu. Bạn có thể định cấu hình tối đa hai lịch sao lưu trên cơ sở dữ liệu, một lịch biểu sao lưu hằng ngày và một lịch biểu sao lưu hằng tuần.

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

rpc CreateDatabase(CreateDatabaseRequest) returns (Operation)

Tạo cơ sở dữ liệu.

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

rpc CreateIndex(CreateIndexRequest) returns (Operation)

Tạo chỉ mục tổng hợp. Thao tác này sẽ trả về một google.longrunning.Operation có thể dùng để theo dõi trạng thái của quá trình tạo. Siêu dữ liệu của thao tác sẽ là kiểu IndexOperationMetadata.

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.
Xoá bản sao lưu

rpc DeleteBackup(DeleteBackupRequest) returns (Empty)

Xoá một bản sao lưu.

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.
Xoá lịch biểu sao lưu

rpc DeleteBackupSchedule(DeleteBackupScheduleRequest) returns (Empty)

Xoá lịch sao lưu.

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.
Xoá cơ sở dữ liệu

rpc DeleteDatabase(DeleteDatabaseRequest) returns (Operation)

Xoá cơ sở dữ liệu.

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)

Xóa chỉ mục tổng hợp.

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.

Để biết thêm thông tin chi tiết về hành vi xuất và định dạng đầu ra, hãy tham khảo: https://cloud.google.com/firestore/docs/manage-data/export-nhập

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.
Tải dữ liệu sao lưu

rpc GetBackup(GetBackupRequest) returns (Backup)

Nhận thông tin về bản sao lưu.

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ận lịch biểu sao lưu

rpc GetBackupSchedule(GetBackupScheduleRequest) returns (BackupSchedule)

Lấy thông tin về lịch sao lưu.

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

rpc GetDatabase(GetDatabaseRequest) returns (Database)

Lấy thông tin về cơ sở dữ liệu.

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

rpc GetField(GetFieldRequest) returns (Field)

Lấy siêu dữ liệu và cấu hình cho một Trường.

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 chỉ mục tổng hợp.

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

rpc ListBackupSchedules(ListBackupSchedulesRequest) returns (ListBackupSchedulesResponse)

Liệt kê lịch sao lưu.

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.
Sao lưu danh sách

rpc ListBackups(ListBackupsRequest) returns (ListBackupsResponse)

Liệt kê tất cả các bản sao lưu.

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

rpc ListDatabases(ListDatabasesRequest) returns (ListDatabasesResponse)

Liệt kê tất cả cơ sở dữ liệu trong dự án.

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.
ListField (Trường danh sách)

rpc ListFields(ListFieldsRequest) returns (ListFieldsResponse)

Liệt kê cấu hình của trường và siêu dữ liệu của cơ sở dữ liệu này.

Hiện tại, FirestoreAdmin.ListFields chỉ hỗ trợ các trường danh sách đã bị ghi đè rõ ràng. Để đưa ra truy vấn này, hãy gọi FirestoreAdmin.ListFields với bộ lọc được đặt thành indexConfig.usesAncestorConfig:false hoặc ttlConfig:*.

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 tổng hợp.

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.
Khôi phục cơ sở dữ liệu

rpc RestoreDatabase(RestoreDatabaseRequest) returns (Operation)

Tạo cơ sở dữ liệu mới bằng cách khôi phục từ bản sao lưu hiện có.

Cơ sở dữ liệu mới phải ở cùng một khu vực đám mây hoặc vị trí nhiều vùng với bản sao lưu hiện có. Cách hoạt động này tương tự như [FirestoreAdmin.CreateDatabase][google.firestore.admin.v1.CreateDatabase] ngoại trừ việc thay vì tạo cơ sở dữ liệu trống mới, cơ sở dữ liệu mới được tạo với loại cơ sở dữ liệu, cấu hình chỉ mục và tài liệu từ bản sao lưu hiện có.

Bạn có thể sử dụng long-running operation để theo dõi tiến trình khôi phục, với loại trường metadata của Thao tác là RestoreDatabaseMetadata. Loại response là Database nếu khôi phục thành công. Cơ sở dữ liệu mới không thể đọc hoặc ghi được cho đến khi LRO hoàn tấ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.
Cập nhật lịch biểu

rpc UpdateBackupSchedule(UpdateBackupScheduleRequest) returns (BackupSchedule)

Cập nhật lịch sao lưu.

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

rpc UpdateDatabase(UpdateDatabaseRequest) returns (Operation)

Cập nhật cơ sở dữ liệu.

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.
Trường cập nhật

rpc UpdateField(UpdateFieldRequest) returns (Operation)

Cập nhật một cấu hình trường. Hiện tại, nội dung cập nhật về trường chỉ áp dụng cho cấu hình chỉ mục trường duy nhất. Tuy nhiên, các lệnh gọi đến FirestoreAdmin.UpdateField phải cung cấp mặt nạ trường để tránh thay đổi bất kỳ cấu hình nào mà phương thức gọi không biết. Bạn phải chỉ định mặt nạ trường là: { paths: "index_config" }.

Lệnh gọi này trả về một google.longrunning.Operation có thể dùng để theo dõi trạng thái cập nhật trường. Siêu dữ liệu của thao tác sẽ là kiểu FieldOperationMetadata.

Để đị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 Field đặc biệt có tên tài nguyên: projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*.

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.

Dự phòng

Bản sao lưu của cơ sở dữ liệu trên Cloud Firestore.

Bản sao lưu chứa tất cả các tài liệu và cấu hình chỉ mục cho cơ sở dữ liệu nhất định tại một thời điểm cụ thể.

Trường
name

string

Chỉ có đầu ra. Tên tài nguyên duy nhất của Bản sao lưu.

Định dạng là projects/{project}/locations/{location}/backups/{backup}.
database

string

Chỉ có đầu ra. Tên của cơ sở dữ liệu Firestore chứa bản sao lưu.

Định dạng là projects/{project}/databases/{database}.
database_uid

string

Chỉ có đầu ra. Mã nhận dạng duy nhất (UUID4) do hệ thống tạo cho cơ sở dữ liệu Firestore chứa bản sao lưu.
snapshot_time

Timestamp

Chỉ có đầu ra. Bản sao lưu chứa một bản sao cơ sở dữ liệu nhất quán bên ngoài tại thời điểm này.
expire_time

Timestamp

Chỉ có đầu ra. Dấu thời gian mà bản sao lưu này hết hạn.
state

State

Chỉ có đầu ra. Trạng thái hiện tại của bản sao lưu.

Tiểu bang

Cho biết trạng thái hiện tại của bản sao lưu.

Enum
STATE_UNSPECIFIED Bạn chưa xác định trạng thái.
CREATING Hệ thống vẫn đang tạo bản sao lưu đang chờ xử lý. Các hoạt động sao lưu sẽ bị từ chối trong trạng thái này.
READY Quá trình sao lưu đã hoàn tất và sẵn sàng cho bạn sử dụng.
NOT_AVAILABLE Bản sao lưu không khả dụng tại thời điểm này.

Lịch biểu sao lưu

Lịch sao lưu cho Cơ sở dữ liệu trên Cloud Firestore.

Tài nguyên này thuộc sở hữu của cơ sở dữ liệu mà nó đang sao lưu và bị xoá cùng với cơ sở dữ liệu. Tuy nhiên, các bản sao lưu thực tế thì không.

Trường
name

string

Chỉ có đầu ra. Giá trị nhận dạng lịch biểu sao lưu duy nhất trên tất cả vị trí và cơ sở dữ liệu của dự án cụ thể.

Dữ liệu này sẽ được chỉ định tự động.

Định dạng là projects/{project}/databases/{database}/backupSchedules/{backup_schedule}
create_time

Timestamp

Chỉ có đầu ra. Dấu thời gian mà lịch sao lưu được tạo và có hiệu lực kể từ đó.

Hệ thống sẽ không tạo bản sao lưu cho lịch biểu này trước thời điểm này.
update_time

Timestamp

Chỉ có đầu ra. Dấu thời gian của lần cập nhật lịch sao lưu gần đây nhất. Khi tạo lịch sao lưu lần đầu tiên, lịch này cũng giống như create_time.
retention

Duration

Vào thời điểm tương đối trong tương lai, so với thời gian tạo, bản sao lưu sẽ bị xoá, ví dụ: lưu giữ bản sao lưu trong 7 ngày.

Khoảng thời gian lưu giữ tối đa được hỗ trợ là 14 tuần.
Trường kết hợp recurrence. Trường một trong hai để thể hiện thời điểm hệ thống thực hiện sao lưu. recurrence chỉ có thể là một trong những trạng thái sau đây:
daily_recurrence

DailyRecurrence

Đối với lịch chạy hằng ngày.
weekly_recurrence

WeeklyRecurrence

Dành cho lịch biểu chạy hằng tuần vào một ngày cụ thể.

CreateBackupScheduleRequest

Yêu cầu cho FirestoreAdmin.CreateBackupSchedule.

Trường
parent

string

Bắt buộc. Cơ sở dữ liệu mẹ.

Định dạng projects/{project}/databases/{database}
backup_schedule

BackupSchedule

Bắt buộc. Lịch biểu sao lưu cần tạo.

Tạo siêu dữ liệu cơ sở dữ liệu

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

Siêu dữ liệu liên quan đến thao tác tạo cơ sở dữ liệu.

CreateDatabaseRequest

Yêu cầu cho FirestoreAdmin.CreateDatabase.

Trường
parent

string

Bắt buộc. Tên gốc của biểu mẫu projects/{project_id}
database

Database

Bắt buộc. Cơ sở dữ liệu cần tạo.
database_id

string

Bắt buộc. Mã nhận dạng để sử dụng cho cơ sở dữ liệu. Mã này sẽ trở thành thành phần cuối cùng trong tên tài nguyên của cơ sở dữ liệu.

Giá trị này phải có từ 4 đến 63 ký tự. Các ký tự hợp lệ là /[a-z][0-9]-/ với ký tự đầu tiên là một chữ cái và cuối cùng là một chữ cái hoặc một số. Không được giống với UUID /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/.

"(mặc định)" mã cơ sở dữ liệu cũng hợp lệ.

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

Yêu cầu cho FirestoreAdmin.CreateIndex.

Trường
parent

string

Bắt buộc. Tên gốc của biểu mẫu projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}
index

Index

Bắt buộc. Chỉ mục tổng hợp cần tạo.

Việc cần làm định kỳ hằng ngày

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

Đại diện cho một lịch biểu định kỳ chạy hằng ngày.

Múi giờ theo giờ UTC.

Cơ sở dữ liệu

Cơ sở dữ liệu trên Cloud Firestore.

Trường
name

string

Tên tài nguyên của Cơ sở dữ liệu. Định dạng: projects/{project}/databases/{database}
uid

string

Chỉ có đầu ra. Mã nhận dạng duy nhất (UUID) do hệ thống tạo cho Cơ sở dữ liệu này.
create_time

Timestamp

Chỉ có đầu ra. Dấu thời gian khi cơ sở dữ liệu này được tạo. Cơ sở dữ liệu được tạo trước năm 2016 không điền sẵn create_time.
update_time

Timestamp

Chỉ có đầu ra. Dấu thời gian mà cơ sở dữ liệu này được cập nhật gần đây nhất. Xin lưu ý rằng thao tác này chỉ bao gồm các bản cập nhật cho tài nguyên cơ sở dữ liệu chứ không bao gồm dữ liệu có trong cơ sở dữ liệu.
delete_time

Timestamp

Chỉ có đầu ra. Dấu thời gian khi cơ sở dữ liệu này bị xoá. Chỉ đặt nếu cơ sở dữ liệu đã bị xoá.
location_id

string

Vị trí của cơ sở dữ liệu. Bạn có thể xem danh sách các vị trí hiện có tại https://cloud.google.com/firestore/docs/locations.
type

DatabaseType

Loại cơ sở dữ liệu. Hãy truy cập vào https://cloud.google.com/datastore/docs/firestore-or-datastore để biết thông tin về cách chọn.
concurrency_mode

ConcurrencyMode

Chế độ kiểm soát đồng thời để sử dụng cho cơ sở dữ liệu này.
version_retention_period

Duration

Chỉ có đầu ra. Khoảng thời gian mà các phiên bản dữ liệu trước đây được lưu giữ trong cơ sở dữ liệu.

Mọi read hoặc query đều có thể chỉ định read_time trong cửa sổ này và sẽ đọc trạng thái của cơ sở dữ liệu tại thời điểm đó.

Nếu bạn bật tính năng PITR, khoảng thời gian lưu giữ sẽ là 7 ngày. Nếu không, khoảng thời gian lưu giữ sẽ là 1 giờ.
earliest_version_time

Timestamp

Chỉ có đầu ra. Dấu thời gian sớm nhất mà tại đó các phiên bản cũ hơn của dữ liệu có thể được đọc từ cơ sở dữ liệu. Hãy xem phần [version_retention_period] ở trên; trường này được điền bằng now - version_retention_period.

Giá trị này được cập nhật liên tục và trở thành giá trị lỗi thời tại thời điểm truy vấn. Nếu bạn đang sử dụng giá trị này để khôi phục dữ liệu, hãy nhớ tính đến thời điểm kể từ thời điểm giá trị được truy vấn đến thời điểm bạn bắt đầu khôi phục.
point_in_time_recovery_enablement

PointInTimeRecoveryEnablement

Liệu có bật tính năng PITR trên cơ sở dữ liệu này hay không.
app_engine_integration_mode

AppEngineIntegrationMode

Chế độ tích hợp App Engine để sử dụng cho cơ sở dữ liệu này.
key_prefix

string

Chỉ có đầu ra. key_prefix cho cơ sở dữ liệu này. Key_prefix này được dùng kết hợp với mã dự án ("~") để tạo mã ứng dụng được trả về từ Cloud Datastore API trong thời gian chạy thế hệ thứ nhất của Google App Engine.

Giá trị này có thể trống, trong trường hợp này appid cần sử dụng cho các khoá được mã hoá URL là project_id (ví dụ: foo thay vì v~foo).
delete_protection_state

DeleteProtectionState

Trạng thái của biện pháp bảo vệ xoá cơ sở dữ liệu.
cmek_config

CmekConfig

Không bắt buộc. Sự hiện diện cho biết CMEK đã được bật cho cơ sở dữ liệu này.
previous_id

string

Chỉ có đầu ra. Mã cơ sở dữ liệu trước đây của tài nguyên cơ sở dữ liệu. Trường này chỉ được điền sẵn cho các cơ sở dữ liệu đã xoá.
etag

string

Giá trị tổng kiểm này do máy chủ tính toán dựa trên giá trị của các trường khác, đồng thời có thể được gửi khi cập nhật và xoá yêu cầu để đảm bảo máy khách có giá trị đã cập nhật trước khi tiếp tục.

Chế độ tích hợp AppEngine

Loại chế độ tích hợp App Engine.

Enum
APP_ENGINE_INTEGRATION_MODE_UNSPECIFIED Không được sử dụng.
ENABLED Nếu một ứng dụng App Engine tồn tại trong cùng khu vực với cơ sở dữ liệu này, thì cấu hình của App Engine sẽ ảnh hưởng đến cơ sở dữ liệu này. Điều này bao gồm việc vô hiệu hoá ứng dụng & cơ sở dữ liệu, cũng như tắt tính năng ghi vào cơ sở dữ liệu.
DISABLED

App Engine không ảnh hưởng đến khả năng phân phát yêu cầu của cơ sở dữ liệu này.

Đây là chế độ cài đặt mặc định cho các cơ sở dữ liệu được tạo bằng API Firestore.

CmekConfig

Cấu hình CMEK (Khoá mã hoá do khách hàng quản lý) cho một cơ sở dữ liệu Firestore. Nếu không, cơ sở dữ liệu sẽ được bảo mật bằng khoá mã hoá mặc định của Google.

Trường
kms_key_name

string

Bắt buộc. Chỉ các khoá ở cùng vị trí với cơ sở dữ liệu này mới được phép dùng để mã hoá.

Đối với nhiều khu vực nam5 của Firestore, điều này tương ứng với việc chúng tôi sử dụng Cloud KMS đa khu vực. Đối với đa vùng eur3 của Firestore, định dạng này tương ứng với Cloud KMS đa vùng ở Châu Âu. Hãy truy cập vào https://cloud.google.com/KM/docs/locations để tìm hiểu thêm.

Định dạng hợp lệ là projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.
active_key_version[]

string

Chỉ có đầu ra. Các phiên bản khoá KMS hiện đang được sử dụng. Trong quá trình xoay vòng khoá, có thể có nhiều phiên bản khoá được sử dụng.

Định dạng hợp lệ là projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{key_version}.

ConcurrencyMode

Loại chế độ kiểm soát đồng thời cho giao dịch.

Enum
CONCURRENCY_MODE_UNSPECIFIED Không được sử dụng.
OPTIMISTIC Sử dụng chế độ kiểm soát đồng thời lạc quan theo mặc định. Chế độ này dành cho cơ sở dữ liệu trên Cloud Firestore.
PESSIMISTIC

Sử dụng chế độ kiểm soát đồng thời bi quan theo mặc định. Chế độ này dành cho cơ sở dữ liệu trên Cloud Firestore.

Đây là chế độ cài đặt mặc định cho Cloud Firestore.
OPTIMISTIC_WITH_ENTITY_GROUPS

Sử dụng tính năng kiểm soát đồng thời lạc quan với các nhóm thực thể theo mặc định.

Đây là chế độ duy nhất dành cho Cloud Datastore.

Bạn cũng có thể sử dụng chế độ này trong Cloud Firestore ở Chế độ Datastore nhưng không nên dùng.

Loại cơ sở dữ liệu

Loại cơ sở dữ liệu. Hãy truy cập vào https://cloud.google.com/datastore/docs/firestore-or-datastore để biết thông tin về cách chọn.

Chỉ cho phép thay đổi chế độ nếu cơ sở dữ liệu trống.

Enum
DATABASE_TYPE_UNSPECIFIED Giá trị mặc định. Giá trị này được dùng nếu loại cơ sở dữ liệu bị bỏ qua.
FIRESTORE_NATIVE Chế độ gốc Firestore
DATASTORE_MODE Firestore ở Chế độ Datastore.

Xoá trạng thái bảo vệ

Trạng thái bảo vệ xoá của cơ sở dữ liệu.

Enum
DELETE_PROTECTION_STATE_UNSPECIFIED Giá trị mặc định. Chưa chỉ định loại bảo vệ xoá
DELETE_PROTECTION_DISABLED Chế độ bảo vệ xoá đã bị tắt
DELETE_PROTECTION_ENABLED Tính năng xoá bảo vệ đang bật

Bật tính năng PointInTimeRecovery

Bật tính năng Khôi phục theo thời điểm.

Enum
POINT_IN_TIME_RECOVERY_ENABLEMENT_UNSPECIFIED Không được sử dụng.
POINT_IN_TIME_RECOVERY_ENABLED

Dữ liệu được hỗ trợ đọc trên các phiên bản đã chọn của dữ liệu trong vòng 7 ngày qua:

  • Đọc dựa trên bất kỳ dấu thời gian nào trong vòng một giờ qua
  • Đọc so với ảnh chụp nhanh 1 phút sau 1 giờ và trong vòng 7 ngày

Bạn có thể dùng version_retention_period và earliest_version_time để xác định các phiên bản được hỗ trợ.
POINT_IN_TIME_RECOVERY_DISABLED Dữ liệu được hỗ trợ đọc trên mọi phiên bản của dữ liệu trong vòng 1 giờ qua.

Xoá BackupRequest

Yêu cầu cho FirestoreAdmin.DeleteBackup.

Trường
name

string

Bắt buộc. Tên của bản sao lưu cần xoá.

là projects/{project}/locations/{location}/backups/{backup}.

Xoá BackupScheduleRequest

Yêu cầu đối với [FirestoreAdmin.DeleteBackupSchedules][].

Trường
name

string

Bắt buộc. Tên của lịch biểu sao lưu.

Định dạng projects/{project}/databases/{database}/backupSchedules/{backup_schedule}

Xoá cơ sở dữ liệu siêu dữ liệu

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

Siêu dữ liệu liên quan đến thao tác xoá cơ sở dữ liệu.

DeleteDatabaseRequest

Yêu cầu cho FirestoreAdmin.DeleteDatabase.

Trường
name

string

Bắt buộc. Tên biểu mẫu projects/{project_id}/databases/{database_id}
etag

string

Etag hiện tại của Cơ sở dữ liệu. Nếu bạn cung cấp một thẻ etag nhưng giá trị này không khớp với thẻ etag hiện tại của cơ sở dữ liệu, thì thao tác xoá sẽ bị chặn và thông báo lỗi FAILED_PREPRE sẽ xuất hiện.

Yêu cầu chỉ mục

Yêu cầu cho FirestoreAdmin.DeleteIndex.

Trường
name

string

Bắt buộc. Tên biểu mẫu projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

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

Siêu dữ liệu về google.longrunning.Operation kết quả từ FirestoreAdmin.ExportDocuments.

Trường
start_time

Timestamp

Thời điểm bắt đầu hoạt động này.
end_time

Timestamp

Thời gian hoạt động này hoàn tất. 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

OperationState

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

Progress

Tiến trình, trong tài liệu, của thao tác này.
progress_bytes

Progress

Tiến trình, tính bằng byte, của thao tác này.
collection_ids[]

string

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

string

Nơi xuất tài liệu.
namespace_ids[]

string

Những mã không gian tên nào đang được xuất.
snapshot_time

Timestamp

Dấu thời gian tương ứng với phiên bản của cơ sở dữ liệu đang được xuất. Nếu bạn không chỉ định, chúng tôi không đảm bảo về tính nhất quán của những tài liệu được xuất.

Xuất tài liệuRequest

Yêu cầu cho FirestoreAdmin.ExportDocuments.

Trường
name

string

Bắt buộc. 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.
namespace_ids[]

string

Danh sách trống đại diện cho tất cả không gian tên. Đây là cách sử dụng ưu tiên cho các cơ sở dữ liệu không sử dụng không gian tên.

Một phần tử chuỗi trống đại diện cho không gian tên mặc định. Bạn nên sử dụng thuộc tính này nếu cơ sở dữ liệu có dữ liệu trong không gian tên không phải vùng chứa mặc định nhưng không muốn đưa dữ liệu vào vùng chứa tên đó. Mỗi không gian tên trong danh sách này phải là duy nhất.
snapshot_time

Timestamp

Dấu thời gian tương ứng với phiên bản của cơ sở dữ liệu sẽ được xuất. Dấu thời gian phải ở trong quá khứ, được làm tròn đến phút và không được cũ hơn earliestVersionTime. Nếu được chỉ định, các tài liệu đã xuất sẽ thể hiện một chế độ xem cơ sở dữ liệu nhất quán tại thời điểm được cung cấp. Nếu không, chúng tôi không đảm bảo về tính nhất quán của các tài liệu đã xuất.

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.

Trường

Đạ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 bộ sưu tập" tương ứng. Nhóm này đại diện cho tất cả các bộ sưu tập trong cơ sở dữ liệu có cùng mã nhận dạng.

Trường
name

string

Bắt buộc. Tên trường của biểu mẫu projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}

Đường dẫn trường có thể là một tên trường đơn giản, ví dụ: address hoặc một đường dẫn đến các trường trong map_value , ví dụ: address.city hoặc một đường dẫn trường đặc biệt. Trường đặc biệt hợp lệ duy nhất là *, đại diện cho trường bất kỳ.

Bạn có thể trích dẫn các đường dẫn trường bằng cách dùng (backtick). The only character that needs to be escaped within a quoted field path is the backtick character itself, escaped using a backslash. Special characters in field paths that must be quoted include:*,., ``` (backtick),[,]`, cũng như các ký tự tượng trưng trong bảng mã ASCII.

Ví dụ: (Lưu ý: Nhận xét ở đây được viết theo cú pháp Markdown, do đó, có thêm một lớp dấu phẩy ngược để thể hiện khối mã) \address.city`represents a field namedaddress.city, not the map key cityin the fieldaddress. `*`represents a field named*`, không phải bất kỳ trường nào.

Một Field đặc biệt chứa các chế độ cài đặt lập chỉ mục mặc định cho mọi trường. Tên tài nguyên của trường này là: projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/* Chỉ mục được xác định trên Field này sẽ được áp dụng cho tất cả các trường không có cấu hình chỉ mục Field riêng.
index_config

IndexConfig

Cấu hình chỉ mục cho trường này. Nếu bạn không đặt chính sách này, việc lập chỉ mục trường sẽ chuyển về cấu hình do ancestor_field xác định. Để xoá tất cả chỉ mục cho trường này một cách rõ ràng, hãy chỉ định cấu hình chỉ mục có danh sách chỉ mục trống.
ttl_config

TtlConfig

Cấu hình TTL cho Field này. Việc đặt hoặc huỷ đặt chính sách này sẽ bật hoặc tắt TTL cho các tài liệu có Field này.

Cấu hình chỉ mục

Cấu hình chỉ mục cho trường này.

Trường
indexes[]

Index

Các chỉ mục được hỗ trợ cho trường này.
uses_ancestor_config

bool

Chỉ có đầu ra. Nếu đúng, cấu hình chỉ mục của Field được đặt từ cấu hình do ancestor_field chỉ định. Khi đặt là false, cấu hình chỉ mục của Field sẽ được xác định rõ ràng.
ancestor_field

string

Chỉ có đầu ra. Chỉ định tên tài nguyên của Field mà từ đó cấu hình chỉ mục của trường này được đặt (khi uses_ancestor_config là true) hoặc từ đó sẽ được đặt nếu trường này không có cấu hình chỉ mục (khi uses_ancestor_config là false).
reverting

bool

Chỉ đầu ra Khi đúng, cấu hình chỉ mục của Field đang trong quá trình bị huỷ bỏ. Sau khi hoàn tất, cấu hình chỉ mục sẽ chuyển sang trạng thái giống như trường do ancestor_field chỉ định, khi đó uses_ancestor_config sẽ là true và reverting sẽ là false.

Cấu hình Ttl

Cấu hình TTL (thời gian tồn tại) cho các tài liệu đã đặt Field này.

Việc lưu trữ giá trị dấu thời gian vào trường bật TTL sẽ được coi là thời gian hết hạn tuyệt đối của tài liệu. Giá trị dấu thời gian trong quá khứ cho biết tài liệu đủ điều kiện để hết hạn ngay lập tức. Việc sử dụng bất kỳ loại dữ liệu nào khác hoặc không điền vào trường này sẽ vô hiệu hoá thời hạn cho từng chứng từ.

Trường
state

State

Chỉ có đầu ra. Trạng thái của cấu hình TTL.

Tiểu bang

Trạng thái áp dụng cấu hình TTL cho tất cả tài liệu.

Enum
STATE_UNSPECIFIED Trạng thái chưa được xác định hoặc không xác định.
CREATING TTL đang được áp dụng. Có một hoạt động diễn ra trong thời gian dài để theo dõi thay đổi. Các tài liệu mới viết sẽ được áp dụng TTL theo yêu cầu. TTL được yêu cầu trên các tài liệu hiện có vẫn đang được xử lý. Khi TTL trên tất cả các tài liệu hiện có đã được xử lý, trạng thái sẽ chuyển sang "HOẠT ĐỘNG".
ACTIVE TTL hoạt động cho tất cả các tài liệu.
NEEDS_REPAIR Không thể bật cấu hình TTL cho tất cả tài liệu hiện có. Các tài liệu mới viết sẽ tiếp tục áp dụng TTL. LRO được trả về khi cố gắng bật TTL gần đây nhất cho Field này không thành công. Có thể có thêm thông tin chi tiết.

Siêu dữ liệu thực địa

Siêu dữ liệu về google.longrunning.Operation kết quả từ FirestoreAdmin.UpdateField.

Trường
start_time

Timestamp

Thời điểm bắt đầu hoạt động này.
end_time

Timestamp

Thời gian hoạt động này hoàn tất. Giá trị này sẽ không được đặt nếu bạn vẫn đang thực hiện thao tác.
field

string

Tài nguyên trường mà thao tác này đang thực hiện. Ví dụ: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}
index_config_deltas[]

IndexConfigDelta

Danh sách IndexConfigDelta mô tả ý định của thao tác này.
state

OperationState

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

Progress

Tiến trình, trong tài liệu, của thao tác này.
progress_bytes

Progress

Tiến trình, tính bằng byte, của thao tác này.
ttl_config_delta

TtlConfigDelta

Mô tả delta của cấu hình TTL.

IndexConfigDelta

Thông tin về việc thay đổi cấu hình chỉ mục.

Trường
change_type

ChangeType

Chỉ định cách chỉ mục thay đổi.
index

Index

Chỉ mục đang được thay đổi.

Loại thay đổi

Chỉ định cách chỉ mục thay đổi.

Enum
CHANGE_TYPE_UNSPECIFIED Loại thay đổi chưa được chỉ định hoặc xác định.
ADD Đang thêm chỉ mục trường duy nhất.
REMOVE Chỉ mục trường duy nhất sẽ bị xoá.

TtlConfigDelta

Thông tin về thay đổi cấu hình TTL.

Trường
change_type

ChangeType

Chỉ định cách cấu hình TTL thay đổi.

Loại thay đổi

Chỉ định cách cấu hình TTL sẽ thay đổi.

Enum
CHANGE_TYPE_UNSPECIFIED Loại thay đổi chưa được chỉ định hoặc xác định.
ADD Đang thêm cấu hình TTL.
REMOVE Cấu hình TTL đang bị xoá.

GetBackupRequest

Yêu cầu cho FirestoreAdmin.GetBackup.

Trường
name

string

Bắt buộc. Tên của bản sao lưu cần tìm nạp.

Định dạng là projects/{project}/locations/{location}/backups/{backup}.

GetBackupScheduleRequest

Yêu cầu cho FirestoreAdmin.GetBackupSchedule.

Trường
name

string

Bắt buộc. Tên của lịch biểu sao lưu.

Định dạng projects/{project}/databases/{database}/backupSchedules/{backup_schedule}

GetDatabaseRequest

Yêu cầu cho FirestoreAdmin.GetDatabase.

Trường
name

string

Bắt buộc. Tên biểu mẫu projects/{project_id}/databases/{database_id}

Yêu cầu trường

Yêu cầu cho FirestoreAdmin.GetField.

Trường
name

string

Bắt buộc. Tên biểu mẫu projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_id}

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

Yêu cầu cho FirestoreAdmin.GetIndex.

Trường
name

string

Bắt buộc. Tên biểu mẫu projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

Siêu dữ liệu ImportDocuments

Siêu dữ liệu về google.longrunning.Operation kết quả từ FirestoreAdmin.ImportDocuments.

Trường
start_time

Timestamp

Thời điểm bắt đầu hoạt động này.
end_time

Timestamp

Thời gian hoạt động này hoàn tất. 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

OperationState

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

Progress

Tiến trình, trong tài liệu, của thao tác này.
progress_bytes

Progress

Tiến trình, tính bằng byte, của thao tác này.
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.
namespace_ids[]

string

Những mã không gian tên nào đ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

Bắt buộc. 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.v1.ExportDocumentsResponse.output_uri_prefix.
namespace_ids[]

string

Danh sách trống đại diện cho tất cả không gian tên. Đây là cách sử dụng ưu tiên cho các cơ sở dữ liệu không sử dụng không gian tên.

Một phần tử chuỗi trống đại diện cho không gian tên mặc định. Bạn nên sử dụng thuộc tính này nếu cơ sở dữ liệu có dữ liệu trong không gian tên không phải vùng chứa mặc định nhưng không muốn đưa dữ liệu vào vùng chứa tên đó. Mỗi không gian tên trong danh sách này phải là duy nhất.

Chỉ mục

Chỉ mục trên Cloud Firestore cho phép thực hiện các truy vấn đơn giản và phức tạp dựa trên các tài liệu trong cơ sở dữ liệu.

Trường
name

string

Chỉ có đầu ra. Tên do máy chủ xác định cho chỉ mục này. Dạng thức của tên này cho các chỉ mục kết hợp sẽ là: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id} Đối với các chỉ mục trường đơn, trường này sẽ trống.
query_scope

QueryScope

Các chỉ mục có phạm vi truy vấn tập hợp được chỉ định sẽ cho phép truy vấn tập hợp là 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ã nhận dạng tập hợp.

Các chỉ mục có phạm vi truy vấn nhóm tập hợp được chỉ định cho phép truy vấn đối với tất cả các tập hợp 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ã nhận dạng tập hợp với chỉ mục này.
api_scope

ApiScope

Phạm vi API mà chỉ mục này hỗ trợ.
fields[]

IndexField

Các trường mà chỉ mục này hỗ trợ.

Đối với chỉ mục tổng hợp, bạn phải có tối thiểu 2 trường và tối đa là 100 trường. Mục nhập trường cuối cùng luôn dành cho đường dẫn trường __name__. Nếu khi tạo, __name__ không được chỉ định làm trường cuối cùng, thì trường này sẽ tự động được thêm theo cùng hướng với trường cuối cùng được xác định. Nếu trường cuối cùng trong một chỉ mục tổng hợp không có hướng, __name__ sẽ được sắp xếp theo thứ tự TĂNG CƯỜNG (trừ phi có chỉ định rõ ràng).

Đối với các chỉ mục trường đơn, đây sẽ luôn là chính xác một mục nhập có đường dẫn trường bằng đường dẫn trường của trường được liên kết.
state

State

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

ApiScope

Phạm vi API xác định những API (Firestore Native hoặc Firestore ở Chế độ Datastore) được hỗ trợ cho các truy vấn.

Enum
ANY_API Chỉ mục này chỉ có thể được API truy vấn gốc Firestore sử dụng. Đây là tuỳ chọn mặc định.
DATASTORE_MODE_API Chỉ mục Firestore trong API truy vấn Chế độ kho dữ liệu mới có thể sử dụng chỉ mục này.

Trường chỉ mục

Một trường trong chỉ mục. Trường_path mô tả trường nào được lập chỉ mục, value_mode mô tả cách giá trị của trường được lập chỉ mục.

Trường
field_path

string

Có thể là name. Đối với các chỉ mục trường đơn, tên này phải khớp với tên của trường, nếu không thì chỉ mục có thể bị bỏ qua.
Trường kết 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 đây:
order

Order

Cho biết trường này hỗ trợ sắp xếp thứ tự theo thứ tự đã chỉ định hoặc so sánh bằng =, !=, <, <=, >, >=.
array_config

ArrayConfig

Cho biết rằng trường này hỗ trợ các thao tác trên array_value.
vector_config

VectorConfig

Cho biết rằng trường này hỗ trợ các phép toán lân cận và khoảng cách gần nhất trên vectơ.

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ợ truy vấn mảng bổ sung.
CONTAINS Chỉ mục hỗ trợ các truy vấn về vùng chứa mảng.

Gọi món

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ị trường tăng dần.
DESCENDING Trường này được sắp xếp theo giá trị trường giảm dần.

VectorConfig

Cấu hình chỉ mục để hỗ trợ các hoạt động tìm kiếm vectơ

Trường
dimension

int32

Bắt buộc. Kích thước vectơ áp dụng cho cấu hình này.

Chỉ mục thu được sẽ chỉ bao gồm các vectơ của chiều này và có thể dùng để tìm kiếm vectơ có cùng chiều.
Trường kết hợp type. Loại chỉ mục được sử dụng. type chỉ có thể là một trong những trạng thái sau đây:
flat

FlatIndex

Cho biết chỉ mục vectơ là một chỉ số cố định.

Chỉ số phẳng

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

Chỉ mục lưu trữ các vectơ trong cấu trúc dữ liệu phẳng và hỗ trợ tìm kiếm toàn diện.

Phạm vi truy vấn

Phạm vi truy vấn xác định phạm vi chạy truy vấn. Thông tin này được chỉ định trên trường from của CompositionQuery.

Enum
QUERY_SCOPE_UNSPECIFIED Phạm vi truy vấn chưa được xác định. Không phải là lựa chọn hợp lệ.
COLLECTION Các 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 tập hợp 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ã nhận dạng tập hợ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 cho phép truy vấn dựa vào tất cả các bộ sưu tập có id bộ sưu tập do chỉ mục chỉ định.
COLLECTION_RECURSIVE Đưa đối tượng cấp trên của tất cả tập hợp vào chỉ mục. Chỉ dành cho cơ sở dữ liệu ở Chế độ Datastore.

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 việc tạo chỉ mục gặp sự cố, chỉ mục sẽ chuyển sang trạng thái NEEDS_REPAIR.

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ó.
NEEDS_REPAIR Đ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. Hãy sử dụng google.longRunning.Operations API để xác định nguyên nhân khiến thao tác gần đây nhất cố gắng tạo chỉ mục này không thành công, sau đó tạo lại chỉ mục.

Siêu dữ liệu IndexOperation

Siêu dữ liệu về google.longrunning.Operation kết quả từ FirestoreAdmin.CreateIndex.

Trường
start_time

Timestamp

Thời điểm bắt đầu hoạt động này.
end_time

Timestamp

Thời gian hoạt động này hoàn tất. Giá trị này sẽ không được đặt nếu bạn vẫn đang thực hiện thao tác.
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}/collectionGroups/{collection_id}/indexes/{index_id}
state

OperationState

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

Progress

Tiến trình, trong tài liệu, của thao tác này.
progress_bytes

Progress

Tiến trình, tính bằng byte, của thao tác này.

Yêu cầu ListBackupSchedules

Yêu cầu cho FirestoreAdmin.ListBackupSchedules.

Trường
parent

string

Bắt buộc. Cơ sở dữ liệu mẹ.

Định dạng là projects/{project}/databases/{database}.

ListBackupSchedulesResponse

Phản hồi cho FirestoreAdmin.ListBackupSchedules.

Trường
backup_schedules[]

BackupSchedule

Danh sách tất cả lịch biểu sao lưu.

Yêu cầu sao lưu danh sách

Yêu cầu cho FirestoreAdmin.ListBackups.

Trường
parent

string

Bắt buộc. Vị trí để liệt kê các bản sao lưu.

Định dạng là projects/{project}/locations/{location}. Sử dụng {location} = '-' để liệt kê các bản sao lưu từ tất cả các vị trí của dự án cụ thể. Điều này cho phép liệt kê các bản sao lưu từ một vị trí hoặc từ tất cả các vị trí.

Phản hồi ListBackups

Phản hồi cho FirestoreAdmin.ListBackups.

Trường
backups[]

Backup

Danh sách tất cả bản sao lưu cho dự án.
unreachable[]

string

Danh sách vị trí không thể tìm nạp các bản sao lưu hiện có.

Thay vì không thực hiện được toàn bộ yêu cầu khi không thể truy cập vào một vị trí duy nhất, phản hồi này trả về tập hợp kết quả một phần và danh sách vị trí không thể truy cập được tại đây. Bạn có thể thử lại yêu cầu đối với một vị trí duy nhất để gặp lỗi cụ thể.

ListDatabasesRequest (Yêu cầu cơ sở dữ liệu danh sách)

Yêu cầu liệt kê các Cơ sở dữ liệu Firestore ở mọi vị trí của một dự án.

Trường
parent

string

Bắt buộc. Tên gốc của biểu mẫu projects/{project_id}
show_deleted

bool

Nếu đúng, hàm này cũng sẽ trả về các tài nguyên đã xoá.

Phản hồi ListDatabases

Danh sách cơ sở dữ liệu của một dự án.

Trường
databases[]

Database

Các cơ sở dữ liệu trong dự án.
unreachable[]

string

Trong trường hợp không thể liệt kê dữ liệu về từng cơ sở dữ liệu riêng lẻ, thì các dữ liệu đó sẽ được ghi lại tại đây.

Ví dụ về mục: dự án/some_project/locations/some_location có thể xảy ra nếu Khu vực đám mây chứa Cơ sở dữ liệu hiện không hoạt động. Trong trường hợp này, chúng tôi không thể tìm nạp tất cả thông tin về cơ sở dữ liệu. Bạn có thể nhận được thông báo lỗi chi tiết hơn (hoặc tìm nạp tài nguyên) bằng cách gửi thông báo "Get" (Nhận) yêu cầu tài nguyên hoặc 'Danh sách' yêu cầu đối với vị trí cụ thể.

Yêu cầu các trường danh sách

Yêu cầu cho FirestoreAdmin.ListFields.

Trường
parent

string

Bắt buộc. Tên gốc của biểu mẫu projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}
filter

string

Bộ lọc để áp dụng cho kết quả dạng danh sách. Hiện tại, FirestoreAdmin.ListFields chỉ hỗ trợ các trường danh sách đã bị ghi đè rõ ràng. Để đưa ra truy vấn này, hãy gọi FirestoreAdmin.ListFields bằng bộ lọc bao gồm indexConfig.usesAncestorConfig:false hoặc ttlConfig:*.
page_size

int32

Số lượng kết quả cần trả về.
page_token

string

Mã thông báo trang (được trả về từ lệnh gọi trước đó đến FirestoreAdmin.ListFields) có thể được dùng để nhận trang kết quả tiếp theo.

Phản hồi ListFields

Phản hồi cho FirestoreAdmin.ListFields.

Trường
fields[]

Field

Các trường bắt buộc.
next_page_token

string

Mã thông báo trang có thể dùng để yêu cầu một trang kết quả khác. Nếu trống thì đây là trang cuối cùng.

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

Yêu cầu cho FirestoreAdmin.ListIndexes.

Trường
parent

string

Bắt buộc. Tên gốc của biểu mẫu projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}
filter

string

Bộ lọc để áp dụng cho kết quả dạng danh sách.
page_size

int32

Số lượng kết quả cần trả về.
page_token

string

Mã thông báo trang (được trả về từ lệnh gọi trước đó đến FirestoreAdmin.ListIndexes) có thể được dùng để nhận trang kết quả tiếp theo.

Phản hồi ListIndexes

Phản hồi cho FirestoreAdmin.ListIndexes.

Trường
indexes[]

Index

Các chỉ mục được yêu cầu.
next_page_token

string

Mã thông báo trang có thể dùng để yêu cầu một trang kết quả khác. Nếu trống thì đây là trang cuối cùng.

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

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

Mô tả tiến trình của thao tác. Đơn vị công việc mang tính chung chung và phải được diễn giải dựa vào trường hợp sử dụng Progress.

Trường
estimated_work

int64

Lượng công việc đã ước tính.
completed_work

int64

Lượng công việc đã hoàn tất.

Khôi phục siêu dữ liệu của cơ sở dữ liệu

Siêu dữ liệu cho long-running operation từ yêu cầu [RestoreDatabase][google.firestore.admin.v1.RestoreDatabase].

Trường
start_time

Timestamp

Thời gian bắt đầu khôi phục.
end_time

Timestamp

Thời gian hoàn tất quá trình khôi phục, không đặt cho các quá trình khôi phục đang diễn ra.
operation_state

OperationState

Trạng thái hoạt động của việc khôi phục.
database

string

Tên của cơ sở dữ liệu đang được khôi phục.
backup

string

Tên của bản sao lưu đang khôi phục.
progress_percentage

Progress

Khoảng thời gian khôi phục là tỷ lệ phần trăm ước tính của thời gian còn lại.

RestoreDatabaseRequest

Thông báo yêu cầu cho [FirestoreAdmin.RestoreDatabase][google.firestore.admin.v1.RestoreDatabase].

Trường
parent

string

Bắt buộc. Dự án khôi phục cơ sở dữ liệu. Định dạng là projects/{project_id}.
database_id

string

Bắt buộc. Mã nhận dạng để sử dụng cho cơ sở dữ liệu. Mã này sẽ trở thành thành phần cuối cùng trong tên tài nguyên của cơ sở dữ liệu. Không được liên kết mã cơ sở dữ liệu này với cơ sở dữ liệu hiện có.

Giá trị này phải có từ 4 đến 63 ký tự. Các ký tự hợp lệ là /[a-z][0-9]-/ với ký tự đầu tiên là một chữ cái và cuối cùng là một chữ cái hoặc một số. Không được giống với UUID /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/.

"(mặc định)" mã cơ sở dữ liệu cũng hợp lệ.

Trường kết hợp source.

source chỉ có thể là một trong những trạng thái sau đây:
backup

string

Từ bản sao lưu cần khôi phục. Phải thuộc cùng một dự án với dự án gốc.

Định dạng là: projects/{project_id}/locations/{location}/backups/{backup}

UpdateBackupScheduleRequest

Yêu cầu cho FirestoreAdmin.UpdateBackupSchedule.

Trường
backup_schedule

BackupSchedule

Bắt buộc. Lịch biểu sao lưu cần cập nhật.
update_mask

FieldMask

Danh sách các trường cần cập nhật.

Siêu dữ liệu UpdateDatabase

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

Siêu dữ liệu liên quan đến thao tác cập nhật cơ sở dữ liệu.

UpdateDatabaseRequest

Yêu cầu cho FirestoreAdmin.UpdateDatabase.

Trường
database

Database

Bắt buộc. Cơ sở dữ liệu cần cập nhật.
update_mask

FieldMask

Danh sách các trường cần cập nhật.

Yêu cầu cập nhật trường

Yêu cầu cho FirestoreAdmin.UpdateField.

Trường
field

Field

Bắt buộc. Trường cần cập nhật.
update_mask

FieldMask

Một mặt nạ, so với trường. Nếu bạn chỉ định, chỉ cấu hình do trường này chỉ định mới được cập nhật trong trường.

Tần suất định kỳ hằng tuần

Đại diện cho lịch biểu định kỳ chạy vào một ngày cụ thể trong tuần.

Múi giờ theo giờ UTC.

Trường
day

DayOfWeek

Ngày trong tuần để chạy.

DAY_OF_WEEK_UNSPECIFIED không được cho phép.