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 "Zulu" ، مع دقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "2014-10-02T15:01:23Z" و"2014-10-02T15:01:23.045123456Z"

updateTime

string (Timestamp format)

النتائج فقط. الوقت الذي تم فيه تغيير المستند آخر مرة.

يتم ضبط هذه القيمة في البداية على createTime ثم تزيد بشكل رتيب مع كل تغيير يتم إجراؤه على المستند. ويمكن مقارنتها أيضًا بالقيم من مستندات أخرى وreadTime لطلب بحث.

طابع زمني بتنسيق RFC3339 UTC "Zulu" ، مع دقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "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

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