REST Resource: projects.databases.documents

المرجع: مستند

مستند Firestore

يجب ألا تتجاوز 1 مبيبايت إلى 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

 لتنفيذ استعلام.