REST Resource: projects.databases

Tài nguyên: Cơ sở dữ liệu

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

Biểu diễn JSON 
{
  "name": string,
  "uid": string,
  "createTime": string,
  "updateTime": string,
  "locationId": string,
  "type": enum (DatabaseType),
  "concurrencyMode": enum (ConcurrencyMode),
  "versionRetentionPeriod": string,
  "earliestVersionTime": string,
  "pointInTimeRecoveryEnablement": enum (PointInTimeRecoveryEnablement),
  "appEngineIntegrationMode": enum (AppEngineIntegrationMode),
  "keyPrefix": string,
  "deleteProtectionState": enum (DeleteProtectionState),
  "cmekConfig": {
    object (CmekConfig)
  },
  "etag": string
}
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. UUID4 do hệ thống tạo cho Cơ sở dữ liệu này.
createTime

string (Timestamp format)

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

Dấu thời gian ở định dạng "Zulu" RFC3339 UTC, với độ phân giải nano giây và tối đa 9 chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z" và "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

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. Lưu ý rằng phương án này chỉ áp dụng cho 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 trong cơ sở dữ liệu.

Dấu thời gian ở định dạng "Zulu" RFC3339 UTC, với độ phân giải nano giây và tối đa 9 chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z" và "2014-10-02T15:01:23.045123456Z".
locationId

string

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

enum (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.
concurrencyMode

enum (ConcurrencyMode)

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

string (Duration format)

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 readTime 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ữ là 7 ngày. Nếu không, khoảng thời gian lưu giữ sẽ là 1 giờ.

Thời lượng tính bằng giây với tối đa 9 chữ số thập phân, kết thúc bằng "s". Ví dụ: "3.5s".
earliestVersionTime

string (Timestamp format)

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 [versionservingPeriod] ở trên; trường này được điền bằng now - versionRetentionPeriod.

Giá trị này được cập nhật liên tục và trở nên lỗi thời vào 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 từ thời điểm giá trị được truy vấn đến thời điểm bạn bắt đầu quá trình khôi phục.

Dấu thời gian ở định dạng "Zulu" RFC3339 UTC, với độ phân giải nano giây và tối đa 9 chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z" và "2014-10-02T15:01:23.045123456Z".
pointInTimeRecoveryEnablement

enum (PointInTimeRecoveryEnablement)

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

enum (AppEngineIntegrationMode)

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

string

Chỉ có đầu ra. keyPrefix cho cơ sở dữ liệu này. KeyPrefix này được sử 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ệ đầu tiên của Google App Engine.

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

enum (DeleteProtectionState)

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

object (CmekConfig)

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

string

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

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 trên Firestore
DATASTORE_MODE Firestore ở Chế độ Datastore.

Chế độ đồng thời

Loại chế độ kiểm soát đồng thời cho các 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 tối ưu theo mặc định. Chế độ này dành cho cơ sở dữ liệu 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 Cloud Firestore.

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

Sử dụng chế độ 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 hiện có cho Cloud Datastore.

Bạn cũng có thể sử dụng chế độ này cho Cloud Firestore ở Chế độ kho dữ liệu nhưng không nên dùng.

PointInTimeRecoveryEnablement

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

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

Hoạt động đọc được hỗ trợ trên những phiên bản dữ liệu đã chọn trong vòng 7 ngày qua:

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

Bạn có thể sử dụng versionRetentionPeriod và earliestVersionTime để xác định các phiên bản được hỗ trợ.
POINT_IN_TIME_RECOVERY_DISABLED Hỗ trợ đọc dữ liệu trên mọi phiên bản dữ liệu trong vòng 1 giờ qua.

AppEngineIntegrationMode

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 và cơ sở dữ liệu, cũng như vô hiệu hoá hoạt độ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 các yêu cầu của cơ sở dữ liệu này.

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

DeleteProtectionState

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ệ
DELETE_PROTECTION_DISABLED Tính năng xoá tính năng bảo vệ đã bị tắt
DELETE_PROTECTION_ENABLED Tính năng xoá bảo vệ đã bật

Cấu hình Cmek

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

Biểu diễn JSON 
{
  "kmsKeyName": string,
  "activeKeyVersion": [
    string
  ]
}
Trường
kmsKeyName

string

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

Đối với vùng đa vùng nam5 của Firestore, thuộc tính này tương ứng với vùng đa vùng Hoa Kỳ của Cloud KMS. Đối với khu vực đa vùng eur3 của Firestore, tỷ lệ này tương ứng với Cloud KMS đa vùng ở Châu Âu. Hãy tham khảo tại https://cloud.google.com/km/docs/locations để biết thêm thông tin.

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

string

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

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

Phương thức

create

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

delete

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

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.

get

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

importDocuments

 Nhập tài liệu vào Google Cloud Firestore.

list

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

patch

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

restore

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