REST Resource: projects.databases

משאב: מסד נתונים

מסד נתונים של Cloud Firestore.

ייצוג 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
}
שדות
name

string

שם המשאב של מסד הנתונים. פורמט: projects/{project}/databases/{database}
uid

string

פלט בלבד. מזהה UUID4 שנוצר על ידי המערכת למסד הנתונים הזה.
createTime

string (Timestamp format)

פלט בלבד. חותמת הזמן שבה נוצר מסד הנתונים. מסדי נתונים שנוצרו לפני 2016 לא מאכלסים את createTime.

חותמת זמן בפורמט "זולו" RFC3339 UTC, עם רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

פלט בלבד. חותמת הזמן שבה מסד הנתונים הזה עודכן לאחרונה. שים לב שהעדכון כולל רק עדכונים למשאב מסד הנתונים ולא נתונים שמסד הנתונים מכיל.

חותמת זמן בפורמט "זולו" RFC3339 UTC, עם רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".
locationId

string

מיקום מסד הנתונים. רשימת המיקומים הזמינים מפורטים בכתובת https://cloud.google.com/firestore/docs/locations.
type

enum (DatabaseType)

סוג מסד הנתונים. איך בוחרים אפשרות כזו: https://cloud.google.com/datastore/docs/firestore-or-datastore.
concurrencyMode

enum (ConcurrencyMode)

מצב השליטה בו-זמנית לשימוש במסד הנתונים הזה.
versionRetentionPeriod

string (Duration format)

פלט בלבד. התקופה שבמהלכה גרסאות קודמות של הנתונים נשמרות במסד הנתונים.

כל read או query יכולים לציין readTime בתוך חלון זה, ויקראו את מצב מסד הנתונים באותו זמן.

אם התכונה PITR מופעלת, תקופת השמירה היא 7 ימים. אחרת, תקופת השמירה היא שעה אחת.

משך זמן בשניות עם עד תשע ספרות עשרוניות, המסתיים ב-'s'. דוגמה: "3.5s".
earliestVersionTime

string (Timestamp format)

פלט בלבד. חותמת הזמן המוקדמת ביותר שבה ניתן לקרוא גרסאות ישנות יותר של הנתונים ממסד הנתונים. פרטים נוספים מופיעים בקטע [versionRetentionPeriod] שלמעלה; שדה זה מאוכלס עם now - versionRetentionPeriod.

הערך הזה מתעדכן באופן קבוע, והופך למיושן ברגע שמתקבלת שאילתה. אם אתם משתמשים בערך הזה כדי לשחזר נתונים, הקפידו להביא בחשבון את פרק הזמן מהרגע שבו השאילתה לגבי הערך ועד לרגע שבו התחלתם את תהליך השחזור.

חותמת זמן בפורמט "זולו" RFC3339 UTC, עם רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".
pointInTimeRecoveryEnablement

enum (PointInTimeRecoveryEnablement)

האם להפעיל את התכונה PITR במסד הנתונים הזה.
appEngineIntegrationMode

enum (AppEngineIntegrationMode)

מצב השילוב של App Engine שבו יש להשתמש עבור מסד הנתונים הזה.
keyPrefix

string

פלט בלבד. KeyPrefix למסד הנתונים הזה. המערכת משתמשת ב-keyPrefix הזה, בשילוב עם מזהה הפרויקט ("~") כדי ליצור את מזהה האפליקציה שהוחזר מממשקי ה-API של Cloud Datastore בשעות הריצה של Google App Engine מדור ראשון.

הערך הזה עשוי להיות ריק. במקרה כזה, ה-appid שיש להשתמש בו עבור מפתחות מקודדים לכתובות URL הוא projectId (למשל: foo במקום v~foo).
deleteProtectionState

enum (DeleteProtectionState)

מצב ההגנה מפני מחיקה של מסד הנתונים.
etag

string

סיכום הביקורת הזה מחושב על ידי השרת על סמך הערך של שדות אחרים, ויכול להיות שיישלח בזמן בקשות עדכון ומחיקה כדי לוודא שללקוח יש ערך עדכני לפני המשך התהליך.

DatabaseType

סוג מסד הנתונים. איך בוחרים אפשרות כזו: https://cloud.google.com/datastore/docs/firestore-or-datastore.

שינויי מצב מותרים רק אם מסד הנתונים ריק.

טיפוסים בני מנייה (enums)
DATABASE_TYPE_UNSPECIFIED ערך ברירת המחדל. נעשה שימוש בערך הזה אם סוג מסד הנתונים מושמט.
FIRESTORE_NATIVE מצב מקורי של Firestore
DATASTORE_MODE Firestore במצב Datastore.

ConcurrencyMode

הסוג של מצב בקרת בו-זמנית בטרנזקציות.

טיפוסים בני מנייה (enums)
CONCURRENCY_MODE_UNSPECIFIED לא בשימוש.
OPTIMISTIC השתמש בבקרה אופטימית על בו-זמניות כברירת מחדל. המצב הזה זמין למסדי נתונים של Cloud Firestore.
PESSIMISTIC

השתמש בבקרה פסימית של בו-זמניות כברירת מחדל. המצב הזה זמין למסדי נתונים של Cloud Firestore.

זוהי הגדרת ברירת המחדל של Cloud Firestore.
OPTIMISTIC_WITH_ENTITY_GROUPS

כברירת מחדל, כדאי להשתמש בשליטה אופטימית בו-זמנית עם קבוצות ישויות.

זהו המצב היחיד שזמין ל-Cloud Datastore.

המצב הזה זמין גם ב-Cloud Firestore עם מצב Datastore, אבל לא מומלץ.

PointInTimeRecoveryEnablement

הפעלת התכונה 'שחזור נקודת זמן'.

טיפוסים בני מנייה (enums)
POINT_IN_TIME_RECOVERY_ENABLEMENT_UNSPECIFIED לא בשימוש.
POINT_IN_TIME_RECOVERY_ENABLED

יש תמיכה בקריאות בגרסאות נבחרות של הנתונים מ-7 הימים האחרונים:

  • קריאה לפי חותמת זמן מהשעה האחרונה
  • קריאה כנגד תמונות מצב של דקה אחת מעבר לשעה ותוך 7 ימים

כדי לקבוע מהן הגרסאות הנתמכות, אפשר להשתמש ב-versionRetentionPeriod וב-earliestVersionTime.
POINT_IN_TIME_RECOVERY_DISABLED יש תמיכה בקריאות בכל גרסה של הנתונים מהשעה האחרונה.

AppEngineIntegrationMode

מצב השילוב של App Engine.

טיפוסים בני מנייה (enums)
APP_ENGINE_INTEGRATION_MODE_UNSPECIFIED לא בשימוש.
ENABLED אם אפליקציה של App Engine קיימת באותו אזור שבו נמצא מסד הנתונים הזה, ההגדרה של App Engine תשפיע על מסד הנתונים הזה. זה כולל השבתה של האפליקציה ומסד הנתונים, וכן השבתת הכתיבה במסד הנתונים.
DISABLED

ל-App Engine אין השפעה על היכולת של מסד הנתונים הזה למלא בקשות.

זוהי הגדרת ברירת המחדל למסדי נתונים שנוצרו באמצעות Firestore API.

DeleteProtectionState

מצב ההגנה מפני מחיקה של מסד הנתונים.

טיפוסים בני מנייה (enums)
DELETE_PROTECTION_STATE_UNSPECIFIED ערך ברירת המחדל. לא צוין סוג הגנה מפני מחיקה
DELETE_PROTECTION_DISABLED ההגנה מפני מחיקה מושבתת
DELETE_PROTECTION_ENABLED ההגנה מפני מחיקה מופעלת

שיטות

create

 יצירת מסד נתונים.

delete

 מחיקת מסד נתונים.

exportDocuments

 ייצוא עותק של כל המסמכים או של קבוצת משנה שלהם מ-Google Cloud Firestore למערכת אחסון אחרת, כמו Google Cloud Storage.

get

 מקבלת מידע על מסד נתונים.

importDocuments

 מייבאת מסמכים אל Google Cloud Firestore.

list

 רשימה של כל מסדי הנתונים בפרויקט.

patch

 מעדכן מסד נתונים.

restore

 יצירת מסד נתונים חדש על ידי שחזור מגיבוי קיים.