REST Resource: projects.databases.documents

משאב: מסמך

מסמך של Firestore.

1MiB עד 4 בייטים.

ייצוג JSON 
{
  "name": string,
  "fields": {
    string: {
      object (Value)
    },
    ...
  },
  "createTime": string,
  "updateTime": string
}
שדות
name

string

שם המשאב של המסמך, למשל projects/{projectId}/databases/{databaseId}/documents/{document_path}.
fields

map (key: string, value: object (Value))

אובייקט שמכיל רשימה של "key": value זוגות. לדוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
createTime

string (Timestamp format)

פלט בלבד. השעה שבה המסמך נוצר.

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

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

string (Timestamp format)

פלט בלבד. מועד השינוי האחרון של המסמך.

הערך הזה מוגדר בהתחלה ל-createTime, ולאחר מכן הוא עולה באופן מונוטוני עם כל שינוי במסמך. אפשר גם להשוות אותו לערכים ממסמכים אחרים ול-readTime של שאילתה.

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

שיטות

batchGet

 מקבלת מספר מסמכים.

batchWrite

 מחיל קבוצה של פעולות כתיבה.

beginTransaction

 התחלת עסקה חדשה.

commit

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

createDocument

 יצירת מסמך חדש.

delete

 מחיקת מסמך.

get

 הפונקציה מקבלת מסמך אחד.

list

 הצגת רשימה של מסמכים.

listCollectionIds

 הצגת כל מזהי האוספים מתחת למסמך.

listDocuments

 הצגת רשימה של מסמכים.

partitionQuery

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

patch

 מעדכן או מוסיף מסמך.

rollback

 מבטל את העסקה.

runAggregationQuery

 מריצה שאילתת צבירה.

runQuery

 מריץ שאילתה.