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),
  "etag": string
}
Lĩnh vực
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ỉ đầu ra. UUID4 do hệ thống tạo cho Cơ sở dữ liệu này.

createTime

string ( Timestamp format)

Chỉ đầu ra. Dấu thời gian mà 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 được điền vào createTime.

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

updateTime

string ( Timestamp format)

Chỉ đầ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 ý điều 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 ở định dạng RFC3339 UTC "Zulu", với độ phân giải nano giây và tối đa chín chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z" .

locationId

string

Vị trí của cơ sở dữ liệu. Các vị trí có sẵn được liệt kê tại https://cloud.google.com/firestore/docs/locations .

type

enum ( DatabaseType )

Loại cơ sở dữ liệu. Xem 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ỉ đầu ra. Khoảng thời gian trong đó 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 tính năng PITR được bật thì thời gian lưu giữ là 7 ngày. Nếu không, thời gian lưu giữ là 1 giờ.

Khoảng thời gian tính bằng giây với tối đa chín chữ số phân số, kết thúc bằng ' s '. Ví dụ: "3.5s" .

earliestVersionTime

string ( Timestamp format)

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

Giá trị này được cập nhật liên tục và trở nên cũ ngay khi được truy vấn. Nếu bạn đang sử dụng giá trị này để khôi phục dữ liệu, hãy đảm bảo tính đến thời gian 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 ở định dạng RFC3339 UTC "Zulu", với độ phân giải nano giây và tối đa chín chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z" .

pointInTimeRecoveryEnablement

enum ( PointInTimeRecoveryEnablement )

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ỉ đầu ra. KeyPrefix cho cơ sở dữ liệu này. KeyPrefix này được sử dụng kết hợp với id dự án (" ~ ") để xây dựng id ứng dụng được trả về từ API kho dữ liệu đám mây 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 ứng dụng được sử dụng cho các khóa được mã hóa URL là projectId (ví dụ: foo thay vì v~foo).

deleteProtectionState

enum ( DeleteProtectionState )

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

etag

string

Tổng kiểm tra 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 theo yêu cầu cập nhật và xóa để đả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. Xem https://cloud.google.com/datastore/docs/firestore-or-datastore để biết thông tin về cách chọn.

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

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

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

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

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

OPTIMISTIC_WITH_ENTITY_GROUPS

Sử dụ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ế độ khả dụng duy nhất cho Cloud Datastore.

Chế độ này cũng có sẵn cho Cloud Firestore với Chế độ kho dữ liệu nhưng không được khuyến khích.

PointInTimeRecoveryEnablement

Kích hoạt tính năng Khôi phục điểm theo thời gian.

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

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

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

versionRetentionPeriodearliestVersionTime có thể được sử dụng để xác định các phiên bản được hỗ trợ.

POINT_IN_TIME_RECOVERY_DISABLED Việc đọc được hỗ trợ trên mọi phiên bản 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 ứ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 App Engine sẽ tác động đến cơ sở dữ liệu này. Điều này bao gồm việc vô hiệu hóa ứng dụng và cơ sở dữ liệu cũng như vô hiệu hóa việc ghi vào cơ sở dữ liệu.
DISABLED

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

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

XóaBảo vệTrạng thái

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

Enum
DELETE_PROTECTION_STATE_UNSPECIFIED Giá trị mặc định. Xóa loại bảo vệ không được chỉ định
DELETE_PROTECTION_DISABLED Bảo vệ xóa bị vô hiệu hóa
DELETE_PROTECTION_ENABLED Bảo vệ xóa được kích hoạt

phương pháp

create

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

delete

Xóa một cơ sở dữ liệu.

exportDocuments

Xuất bản sao của tất cả hoặc một tập hợp con tài liệu từ Google Cloud Firestore sang hệ thống lưu trữ khác, chẳng hạn như Google Cloud Storage.

get

Nhận 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á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ó.