REST Resource: projects.databases

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

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

Biểu diễn dưới dạng JSON 
{
  "name": string,
  "uid": string,
  "createTime": string,
  "updateTime": string,
  "deleteTime": 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)
  },
  "previousId": string,
  "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. Mã nhận dạng duy nhất (UUID) 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 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 createTime.

Dấu thời gian theo múi giờ "Zulu" RFC3339 (giờ UTC) với độ phân giải nano giây và lên đến 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. 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.

Dấu thời gian theo múi giờ "Zulu" RFC3339 (giờ UTC) với độ phân giải nano giây và lên đến 9 chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z" và "2014-10-02T15:01:23.045123456Z".
deleteTime

string (Timestamp format)

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

Dấu thời gian theo múi giờ "Zulu" RFC3339 (giờ UTC) với độ phân giải nano giây và lên đến 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 vị trí hiện có 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 để sử 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ữ sẽ 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ố phân số, 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 phần [versionKeepPeriod] ở 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ở 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.

Dấu thời gian theo múi giờ "Zulu" RFC3339 (giờ UTC) với độ phân giải nano giây và lên đến 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 để sử dụng cho cơ sở dữ liệu này.
keyPrefix

string

Chỉ có đầu ra. Tiền tố key cho cơ sở dữ liệu này. KeyPrefix này được dùng kết hợp với mã dự án ("~") để tạo mã ứng dụng được trả về từ API Cloud Datastore 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 appid cần 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 của biện pháp bảo vệ xoá cơ sở dữ liệu.
cmekConfig

object (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.
previousId

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.

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.

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.

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 versionRetentionPeriod và earliestVersionTime để 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.

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.

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

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.

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

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/{projectId}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.
activeKeyVersion[]

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/{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ỏ 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.

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