Package google.firestore.v1beta1

map<string, Value>

نتيجة دوال التجميع، مثل: COUNT(*) AS total_docs.

المفتاح هو alias المعيّن لدالة التجميع عند الإدخال، ويساوي حجم هذه الخريطة عدد دوال التجميع في الاستعلام.

Value

القيم في الصفيف

string

مطلوب. اسم قاعدة البيانات. بالتنسيق: projects/{project_id}/databases/{database_id}.

string

أسماء المستندات المطلوب استردادها بالتنسيق: projects/{project_id}/databases/{database_id}/documents/{document_path}. سيتعذر الطلب إذا لم يكن أي من المستند موردًا فرعيًا لـ database المحدَّد. سيتم إلغاء الأسماء المكررة.

DocumentMask

الحقول المطلوب عرضها. وفي حال تم تركها بدون ضبط، سيتم عرض جميع الحقول.

إذا كان المستند يحتوي على حقل غير موجود في هذا القناع، لن يتم عرض هذا الحقل في الرد.

bytes

يقرأ المستندات في المعاملة.

TransactionOptions

يبدأ معاملة جديدة ويقرأ المستندات. يتم استخدام القيمة التلقائية لمعاملة القراءة فقط. سيتم عرض معرِّف المعاملة الجديد كأول ردّ في مصدر البيانات.

Timestamp

يقرأ المستندات كما هي في الوقت المحدد.

ويجب أن يكون هذا الطابع الزمني للدقة بالميكرو ثانية خلال الساعة الماضية، أو إذا كانت ميزة "الاسترداد في نقطة زمنية" مفعَّلة، يمكن أن يكون أيضًا طابعًا زمنيًا لدقيقة كاملة خلال آخر 7 أيام.

bytes

المعاملة التي بدأت كجزء من هذا الطلب. سيتم ضبطه في الردّ الأول فقط وفي حال ضبط السمة BatchGetDocumentsRequest.new_transaction في الطلب فقط.

Timestamp

تمثّل هذه السمة وقت قراءة المستند. قد يكون هذا في ازدياد أحادي، وفي هذه الحالة، نضمن عدم تغيير المستندات السابقة في تدفق النتائج بين read_time وهذا الوقت.

Document

المستند الذي تم طلبه

string

اسم المستند الذي تم طلبه ولكنه غير موجود. بالتنسيق: projects/{project_id}/databases/{database_id}/documents/{document_path}.

string

مطلوب. اسم قاعدة البيانات. بالتنسيق: projects/{project_id}/databases/{database_id}.

Write

العبارات التي سيتم تطبيقها.

لا تنطبق الطريقة على الكتابة بشكل كامل ولا تضمن الطلب. تنجح كل عملية كتابة أو تفشل بشكل مستقل. لا يمكنك الكتابة إلى المستند نفسه أكثر من مرة لكل طلب.

map<string, string>

التصنيفات المرتبطة بالكتابة المجمّعة

WriteResult

هي نتيجة تطبيق عمليات الكتابة.

تتوافق نتيجة i-th write هذه مع الكتابة i-th في الطلب.

Status

حالة تطبيق عمليات الكتابة.

تتوافق حالة i-th write هذه مع i-th write في الطلب.

string

مطلوب. اسم قاعدة البيانات. بالتنسيق: projects/{project_id}/databases/{database_id}.

TransactionOptions

خيارات المعاملة يتم ضبط الإعدادات التلقائية على معاملة قراءة وكتابة.

bytes

المعاملة التي بدأت.

bytes

وحدات البايت التي تشفِّر تسلسل البت. وقد يكون طولها صفرًا.

int32

عدد وحدات بت للبايت الأخير في bitmap المطلوب تجاهلها كـ "مساحة متروكة". إذا كان طول الدالة bitmap صفرًا، يجب أن تكون هذه القيمة 0. وبخلاف ذلك، يجب أن تكون هذه القيمة بين 0 و7، بشكل شامل.

BitSequence

بيانات فلتر الزهور

int32

عدد علامات التجزئة التي تستخدمها الخوارزمية.

string

مطلوب. اسم قاعدة البيانات. بالتنسيق: projects/{project_id}/databases/{database_id}.

Write

العبارات التي سيتم تطبيقها.

يتم تنفيذها دائمًا بشكل كامل وبالترتيب.

bytes

في حال ضبط هذه السياسة، يتم تطبيق جميع عمليات الشراء في هذه المعاملة والالتزام بها.

WriteResult

هي نتيجة تطبيق عمليات الكتابة.

تتوافق نتيجة i-th write هذه مع الكتابة i-th في الطلب.

Timestamp

وقت حدوث الالتزام. يمكن ضمان ظهور تأثيرات إتمام عملية الشراء عند قراءة قيمة مساوية لقيمة read_time أو أكبر.

string

مطلوب. المرجع الرئيسي. على سبيل المثال: projects/{project_id}/databases/{database_id}/documents أو projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}

string

مطلوب. رقم تعريف المجموعة المرتبط بـ parent في القائمة. مثلاً: chatrooms

string

رقم تعريف المستند الذي خصّصه العميل لاستخدامه لهذا المستند.

هذه السمة اختيارية. إذا لم يتم تحديد هذا الحقل، سيتم تخصيص معرّف من قِبل الخدمة.

Document

مطلوب. المستند المراد إنشاؤه. يجب عدم ضبط name.

DocumentMask

الحقول المطلوب عرضها. وفي حال تم تركها بدون ضبط، سيتم عرض جميع الحقول.

إذا كان المستند يحتوي على حقل غير موجود في هذا القناع، لن يتم عرض هذا الحقل في الرد.

Value

القيم التي تمثل موضعًا، بالترتيب الذي تظهر به بالترتيب حسب عبارة الاستعلام.

يمكن أن يحتوي على قيم أقل مما هو محدّد في الترتيب حسب العبارة.

bool

إذا كان الموضع قبل القيم المحددة مباشرةً أو بعدها مباشرةً، نسبةً إلى ترتيب الترتيب المحدّد في طلب البحث.

string

مطلوب. اسم المورد للمستند المطلوب حذفه. بالتنسيق: projects/{project_id}/databases/{database_id}/documents/{document_path}.

Precondition

شرط مُسبَق اختياري في المستند. سيتعذّر الطلب إذا تم ضبط ذلك ولم يتم استيفاؤه من خلال المستند المستهدف.

string

اسم المورد للمستند، على سبيل المثال projects/{project_id}/databases/{database_id}/documents/{document_path}.

map<string, Value>

Timestamp

النتائج فقط. وقت إنشاء المستند.

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

Timestamp

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

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

Document

الحالة الجديدة لـ Document.

في حال ضبط السياسة mask، لن يحتوي إلا على الحقول التي تم تعديلها أو إضافتها.

int32

مجموعة من أرقام تعريف الاستهدافات المستهدفة التي تتطابق مع هذا المستند.

int32

مجموعة من أرقام التعريف المستهدفة للأهداف التي لم تعُد تتطابق مع هذا المستند.

string

اسم المورد Document الذي تم حذفه.

int32

مجموعة من أرقام التعريف المستهدفة للأهداف التي تطابقت سابقًا مع هذا الكيان.

Timestamp

الطابع الزمني للقراءة الذي تم فيه رصد عملية الحذف.

أكبر من أو يساوي commit_time للحذف.

string

قائمة مسارات الحقول في القناع اطّلِع على Document.fields للحصول على مرجع بنية مسار الحقل.

string

اسم مورد Document الذي تعذَّر عرضه.

int32

مجموعة من أرقام التعريف المستهدفة للأهداف التي تطابقت سابقًا مع هذا المستند.

Timestamp

الطابع الزمني للقراءة الذي تم فيه رصد عملية الإزالة

أكبر أو يساوي commit_time للتغيير/الحذف/الإزالة.

string

اسم المستند المطلوب تحويله.

FieldTransform

قائمة عمليات التحويل المطلوب تطبيقها على حقول المستند بالترتيب. يجب ألا يكون هذا الحقل فارغًا.

string

مسار الحقل. راجِع Document.fields للاطّلاع على مرجع بنية مسار الحقل.

ServerValue

لضبط الحقل على قيمة الخادم المحدّدة.

Value

لإضافة القيمة المحددة إلى القيمة الحالية للحقل

يجب أن تكون هذه القيمة عددًا صحيحًا أو قيمة مزدوجة. إذا لم يكن الحقل عددًا صحيحًا أو مزدوجًا، أو إذا لم يكن الحقل متوفّرًا بعد، ستضبط عملية التحويل الحقل على القيمة المحدّدة. إذا كانت أي من القيمة المحددة أو قيمة الحقل الحالي مزدوجة، فسيتم تفسير كلتا القيمتين على أنهما زوجيتان. العمليات الحسابية المزدوجة وتمثيل القيم المزدوجة تتبع دلالات IEEE 754. إذا كان هناك فائض عدد صحيح موجب/سالب، يتم التعامل مع الحقل إلى أكبر عدد صحيح موجب/سالب.

Value

لضبط الحقل على الحد الأقصى لقيمته الحالية والقيمة المحدّدة.

يجب أن تكون هذه القيمة عددًا صحيحًا أو قيمة مزدوجة. إذا لم يكن الحقل عددًا صحيحًا أو مزدوجًا، أو إذا لم يكن الحقل متوفّرًا بعد، ستضبط عملية التحويل الحقل على القيمة المحدّدة. إذا تم تطبيق عملية الحد الأقصى حيث يكون الحقل وقيمة الإدخال من أنواع مختلطة (أي - واحد يمثل عددًا صحيحًا والآخر مزدوج) سيتخذ الحقل نوع المعامل الأكبر. إذا كانت المعاملات متكافئة (مثل 3 و3.0)، لن يتغيّر الحقل. 0 و0.0 و-0.0 جميعها صفرية. الحد الأقصى لقيمة مخزنة يكون فيها صفر وقيمة إدخال صفرية هو دائمًا القيمة المخزّنة. الحد الأقصى لأي قيمة رقمية x وNaN هو NaN.

Value

لضبط الحقل على الحد الأدنى لقيمته الحالية والقيمة المحدّدة.

يجب أن تكون هذه القيمة عددًا صحيحًا أو قيمة مزدوجة. إذا لم يكن الحقل عددًا صحيحًا أو مزدوجًا، أو إذا لم يكن الحقل متاحًا بعد، ستضبط عملية التحويل الحقل على قيمة الإدخال. إذا تم تطبيق عملية أدنى حيث يكون الحقل وقيمة الإدخال من أنواع مختلطة (أي - واحد يمثل عددًا صحيحًا والآخر زوجيًا) يأخذ الحقل نوع المعامل الأصغر. إذا كانت المعاملات متكافئة (مثل 3 و3.0)، لن يتغيّر الحقل. 0 و0.0 و-0.0 جميعها صفرية. الحد الأدنى لقيمة مخزنة صفرية وقيمة إدخال صفرية هو دائمًا القيمة المخزنة. الحد الأدنى لأي قيمة رقمية x وNaN هو NaN.

ArrayValue

إلحاق العناصر المحددة بالترتيب إذا لم تكن موجودة من قبل في قيمة الحقل الحالي. إذا لم يكن الحقل صفيفًا، أو لم يكن الحقل متوفّرًا بعد، يتم تعيينه أولاً على الصفيف الفارغ.

تعتبر الأرقام المكافئة للأنواع المختلفة (مثل 3L و3.0) متساوية عند التحقق مما إذا كانت القيمة مفقودة. NaN تساوي NaN، وNull تساوي Null. إذا كان الإدخال يحتوي على قيم مكافئة متعددة، سيتم مراعاة القيمة الأولى فقط.

وستكون قيمة transform_result المقابلة هي القيمة الفارغة.

ArrayValue

إزالة كافة العناصر المحددة من الصفيف في الحقل. إذا لم يكن الحقل مصفوفة، أو لم يكن الحقل متاحًا بعد، سيتم ضبطه على مصفوفة فارغة.

وتُعد الأرقام المكافئة للأنواع المختلفة (مثل 3L و3.0) متساوية عند تحديد ما إذا كان يجب إزالة عنصر أم لا. NaN تساوي NaN، وNull تساوي Null. سيؤدي هذا إلى إزالة جميع القيم المكافئة في حالة وجود تكرارات.

وستكون قيمة transform_result المقابلة هي القيمة الفارغة.

int64

إجمالي عدد النتائج التي تم عرضها، بما في ذلك المستندات والتوقعات ونتائج التجميع والمفاتيح.

Duration

يشير ذلك المصطلح إلى الوقت الإجمالي اللازم لتنفيذ طلب البحث في الخلفية.

int64

إجمالي عمليات القراءة القابلة للفوترة.

Struct

تصحيح أخطاء الإحصاءات من تنفيذ طلب البحث. ويُرجى العِلم بأنّ إحصاءات تصحيح الأخطاء عرضة للتغيير مع تطوّر Firestore. يمكن أن يتضمن: { "indexes_entries_scan": "1000", "documents_scan": "20", "billing_details" : { "documents_billable": "20", "index_entries_billable": "1000", "min_query_cost": "0" } }

int32

رقم تعريف الاستهداف الذي ينطبق عليه هذا الفلتر.

int32

إجمالي عدد المستندات التي تطابق target_id.

إذا كان مختلفًا عن عدد المستندات المطابقة في البرنامج، على العميل أن يحدد يدويًا المستندات التي لم تعد تتطابق مع الهدف.

يمكن للعميل استخدام فلتر بلوم unchanged_names للمساعدة في هذا التحديد من خلال اختبار جميع أسماء المستندات وفقًا للفلتر. إذا لم يكُن اسم المستند مدرَجًا في الفلتر، هذا يعني أنّ المستند لم يعُد مطابقًا للهدف.

BloomFilter

فلتر Bloom يحتوي، على الرغم من اسمه، على ترميزات UTF-8 بايت لأسماء الموارد لجميع المستندات التي تطابق target_id، بالتنسيق projects/{project_id}/databases/{database_id}/documents/{document_path}.

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

PlanSummary

معلومات مرحلة التخطيط للاستعلام.

ExecutionStats

إحصاءات مجمعة من تنفيذ طلب البحث. لا تتوفّر هذه الميزة إلا عند ضبط السمة ExplainOptions.analyze على "صحيح".

bool

هذه السمة اختيارية. ما إذا كان سيتم تنفيذ هذا الاستعلام أم لا.

أمّا في حال اختيار القيمة "false" (القيمة التلقائية)، فسيتم التخطيط لطلب البحث، وسيتم عرض المقاييس من مراحل التخطيط فقط.

عندما تكون القيمة true، سيتم تخطيط طلب البحث وتنفيذه، وسيتم عرض نتائج طلب البحث الكاملة بالإضافة إلى مقاييس مرحلة التخطيط والتنفيذ.

string

مطلوب. اسم المورد للمستند الذي تريد الحصول عليه بالتنسيق: projects/{project_id}/databases/{database_id}/documents/{document_path}.

DocumentMask

الحقول المطلوب عرضها. وفي حال تم تركها بدون ضبط، سيتم عرض جميع الحقول.

إذا كان المستند يحتوي على حقل غير موجود في هذا القناع، لن يتم عرض هذا الحقل في الرد.

bytes

يقرأ المستند في إحدى المعاملات.

Timestamp

يقرأ نسخة المستند في الوقت المحدد.

ويجب أن يكون هذا الطابع الزمني للدقة بالميكرو ثانية خلال الساعة الماضية، أو إذا كانت ميزة "الاسترداد في نقطة زمنية" مفعَّلة، يمكن أن يكون أيضًا طابعًا زمنيًا لدقيقة كاملة خلال آخر 7 أيام.

string

مطلوب. المستند الرئيسي بالتنسيق: projects/{project_id}/databases/{database_id}/documents/{document_path}. مثلاً: projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

int32

الحد الأقصى لعدد النتائج المطلوب عرضها.

string

رمز مميّز للصفحة. يجب أن تكون القيمة من ListCollectionIdsResponse.

Timestamp

يقرأ المستندات كما هي في الوقت المحدد.

ويجب أن يكون هذا الطابع الزمني للدقة بالميكرو ثانية خلال الساعة الماضية، أو إذا كانت ميزة "الاسترداد في نقطة زمنية" مفعَّلة، يمكن أن يكون أيضًا طابعًا زمنيًا لدقيقة كاملة خلال آخر 7 أيام.

string

معرّفات المجموعات

string

هو رمز مميّز للصفحة يمكن استخدامه لمواصلة القائمة.

string

مطلوب. اسم المورد الرئيسي. بالتنسيق: projects/{project_id}/databases/{database_id}/documents أو projects/{project_id}/databases/{database_id}/documents/{document_path}.

على سبيل المثال: projects/my-project/databases/my-database/documents أو projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

string

هذه السمة اختيارية. رقم تعريف المجموعة المرتبط بـ parent في القائمة.

على سبيل المثال: chatrooms أو messages

هذا الإجراء اختياري، وفي حال عدم توفيره، سيُدرج Firestore المستندات من كل المجموعات ضمن parent المقدَّم.

int32

هذه السمة اختيارية. الحد الأقصى لعدد المستندات المطلوب عرضها في رد واحد.

قد تعرض Firestore عددًا أقل من هذه القيمة.

string

هذه السمة اختيارية. رمز مميّز للصفحة، تم تلقّيه من رد ListDocuments سابق.

يمكنك توفير هذا الحقل لاسترداد الصفحة التالية. عند التقسيم على صفحات، يجب أن تتطابق جميع المَعلمات الأخرى (باستثناء page_size) مع القيم المحدَّدة في الطلب الذي أنشأ الرمز المميّز للصفحة.

string

هذه السمة اختيارية. الترتيب الاختياري للمستندات المطلوب عرضها

مثلاً: priority desc, __name__ desc

يعكس هذا ORDER BY المستخدم في طلبات بحث Firestore ولكن في تمثيل سلسلة. عند عدم توفّر هذه المستندات، يتم ترتيب المستندات استنادًا إلى __name__ ASC.

DocumentMask

هذه السمة اختيارية. الحقول المطلوب عرضها. وفي حال تم تركها بدون ضبط، سيتم عرض جميع الحقول.

إذا كان المستند يحتوي على حقل غير موجود في هذا القناع، لن يتم عرض هذا الحقل في الرد.

bool

ما إذا كان يجب أن تُظهر القائمة المستندات المفقودة.

أحد المستندات مفقود إذا لم يكن موجودًا، ولكن توجد مستندات فرعية متداخلة أسفله. عندما تكون القيمة true، سيتم عرض هذه المستندات المفقودة باستخدام مفتاح ولكن لن تحتوي على مجموعة من الحقول، أو create_time أو update_time.

لا يجوز أن تحدّد الطلبات مع show_missing السمة where أو order_by.

bytes

يُرجى إجراء القراءة كجزء من معاملة نشطة حاليًا.

Timestamp

نفِّذ القراءة في الوقت المحدَّد.

ويجب أن يكون هذا الطابع الزمني للدقة بالميكرو ثانية خلال الساعة الماضية، أو إذا كانت ميزة "الاسترداد في نقطة زمنية" مفعَّلة، يمكن أن يكون أيضًا طابعًا زمنيًا لدقيقة كاملة خلال آخر 7 أيام.

Document

تم العثور على "المستندات"

string

رمز مميز لاسترداد الصفحة التالية من المستندات.

في حال إسقاط هذا الحقل، لن تظهر أي صفحات لاحقة.

string

مطلوب. اسم قاعدة البيانات. بالتنسيق: projects/{project_id}/databases/{database_id}.

map<string, string>

التصنيفات المرتبطة بهذا التغيير المستهدف.

Target

هدف مطلوب إضافته إلى مصدر البيانات هذا.

int32

رقم تعريف الهدف المطلوب إزالته من مصدر البيانات هذا.

TargetChange

تم تغيير الأهداف.

DocumentChange

تم تغيير Document.

DocumentDelete

تم حذف Document.

DocumentRemove

تمت إزالة Document من استهداف (لأنه لم يعد ذا صلة بذلك الهدف).

ExistenceFilter

عامل تصفية لتطبيقه على مجموعة المستندات التي تم عرضها سابقًا للهدف المحدّد.

يتم عرضه عندما ربما تمت إزالة المستندات من الهدف المحدد، لكن المستندات الدقيقة غير معروفة.

map<string, Value>

حقول الخريطة.

تمثل مفاتيح الخريطة أسماء الحقول. تم حجز أسماء الحقول التي تتطابق مع التعبير العادي __.*__. ويُحظر استخدام أسماء الحقول المحجوزة إلا في سياقات موثقة معينة. يجب ألا تتجاوز مفاتيح الخريطة، المُمثلة بترميز UTF-8، 1500 بايت ولا يمكن أن تكون فارغة.

string

مطلوب. اسم المورد الرئيسي. بالتنسيق: projects/{project_id}/databases/{database_id}/documents. أسماء موارد المستندات غير متوافقة؛ يمكن تحديد أسماء موارد قاعدة البيانات فقط.

int64

تمثّل هذه السمة الحد الأقصى المطلوب لعدد نقاط التقسيم. وقد يتم عرض الأقسام على مستوى صفحات نتائج متعددة. يجب أن يكون الرقم موجبًا. قد يكون العدد الفعلي للأقسام التي تم عرضها أقل.

على سبيل المثال، قد يتم ضبط ذلك على عدد أقل بمقدار واحد من عدد طلبات البحث المتوازية المراد تشغيلها، أو عند تشغيل مهمة مسار بيانات، أقل من عدد العاملين أو مثيلات الحوسبة المتاحة.

string

القيمة next_page_token التي تم عرضها من استدعاء سابق إلى PartitionQuery والتي يمكن استخدامها للحصول على مجموعة إضافية من النتائج. وليس هناك ضمانات ترتيب بين مجموعات النتائج. وبالتالي، سيتطلب استخدام مجموعات متعددة من النتائج دمج مجموعات النتائج المختلفة.

على سبيل المثال، قد يتم عرض طلبَين تاليَين يستخدمان page_token:

• المؤشر B، المؤشر M، المؤشر Q
• المؤشر A، المؤشر U، المؤشر W

للحصول على مجموعة نتائج كاملة مرتبة حسب نتائج طلب البحث المقدمة إلى PartitionQuery، يجب دمج مجموعات النتائج: المؤشر A والمؤشر B والمؤشر M والمؤشر Q والمؤشر U والمؤشر W

int32

الحد الأقصى لعدد الأقسام المطلوب عرضها في هذه المكالمة، ويخضع لـ partition_count.

على سبيل المثال، إذا كانت partition_count = 10 وpage_size = 8، سيعرض الاستدعاء الأول لـ PartitionQuery ما يصل إلى 8 أقسام وnext_page_token في حالة توفر المزيد من النتائج. سيؤدي الاستدعاء الثاني لـ PartitionQuery إلى قسمين مما يصل إلى قسمين لإكمال إجمالي 10 أقسام محددة في partition_count.

StructuredQuery

طلب بحث منظم. يجب أن يحدّد طلب البحث مجموعة تضم كل العناصر التابعة وأن يتم ترتيبها تصاعديًا حسب الاسم. لا تتوفّر الفلاتر الأخرى، والترتيب حسب، والحدود، والإزاحة، ومؤشرات البداية/النهاية.

Timestamp

يقرأ المستندات كما هي في الوقت المحدد.

ويجب أن يكون هذا الطابع الزمني للدقة بالميكرو ثانية خلال الساعة الماضية، أو إذا كانت ميزة "الاسترداد في نقطة زمنية" مفعَّلة، يمكن أن يكون أيضًا طابعًا زمنيًا لدقيقة كاملة خلال آخر 7 أيام.

Cursor

نتائج التقسيم كل قسم هو نقطة تقسيم يمكن استخدامها بواسطة RunQuery كنقطة بداية أو نهاية لنتائج الاستعلام. يجب إجراء طلبات RunQuery باستخدام طلب البحث نفسه المتوفّر في طلب PartitionQuery هذا. سيتم ترتيب مؤشرات أقسام التقسيم وفقًا للترتيب نفسه الخاص بنتائج طلب البحث المقدَّمة في PartitionQuery.

على سبيل المثال، إذا عرض طلب PartitionQuery مؤشري القسمين A وB، فإن تشغيل الاستعلامات الثلاثة التالية سيُرجع مجموعة نتائج الاستعلام الأصلي بالكامل:

• استعلام، end_at A
• استعلام، start_at A، end_at B
• استعلام، start_at B

قد تشير النتيجة الفارغة إلى أنّ عدد النتائج قليل جدًا ولا يمكن تقسيمها في طلب البحث، أو أنّ عملية التقسيم غير متاحة بعد.

string

يشير هذا المصطلح إلى رمز مميّز للصفحة يمكن استخدامه لطلب مجموعة إضافية من النتائج، بما يصل إلى العدد المحدَّد من خلال partition_count في طلب التقسيم. إذا كان هذا الحقل فارغًا، هذا يعني أنّه ما مِن نتائج أخرى.

Struct

الفهارس المحددة لطلب البحث. على سبيل المثال: [ {"query_scope": "Collection", "properties": "(foo ASC, name ASC)"}, {"query_scope": "Collection", "properties": "(bar ASC, name ASC)"} ]

bool

عند ضبط هذه السياسة على true، يجب أن يكون المستند الهدف متوفّرًا. عند الضبط على false، يجب ألا يتوفّر المستند الهدف.

Timestamp

عند ضبط هذه السياسة، يجب أن يكون المستند المستهدَف متاحًا وأن يكون آخر تعديل له في ذلك الوقت. يجب محاذاة الطابع الزمني بالميكرو ثانية.

string

مطلوب. اسم قاعدة البيانات. بالتنسيق: projects/{project_id}/databases/{database_id}.

bytes

مطلوب. المعاملة المطلوب العودة إليها

string

مطلوب. اسم المورد الرئيسي. بالتنسيق: projects/{project_id}/databases/{database_id}/documents أو projects/{project_id}/databases/{database_id}/documents/{document_path}. على سبيل المثال: projects/my-project/databases/my-database/documents أو projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

ExplainOptions

هذه السمة اختيارية. شرح خيارات الاستعلام. وفي حال ضبطها، سيتم عرض إحصاءات إضافية لطلبات البحث. وإذا لم يكن الأمر كذلك، فسيتم عرض نتائج الاستعلام فقط.

StructuredAggregationQuery

طلب تجميع.

bytes

تنفيذ التجميع ضمن معاملة نشطة بالفعل.

القيمة هنا هي معرّف المعاملة المبهم لتنفيذ الاستعلام فيه.

TransactionOptions

بدء معاملة جديدة كجزء من طلب البحث، مع ضبط الإعداد التلقائي على القراءة فقط.

سيتم عرض معرِّف المعاملة الجديد كأول ردّ في مصدر البيانات.

Timestamp

لتنفيذ طلب البحث عند الطابع الزمني المحدّد.

ويجب أن يكون هذا الطابع الزمني للدقة بالميكرو ثانية خلال الساعة الماضية، أو إذا كانت ميزة "الاسترداد في نقطة زمنية" مفعَّلة، يمكن أن يكون أيضًا طابعًا زمنيًا لدقيقة كاملة خلال آخر 7 أيام.

AggregationResult

نتيجة تجميع واحدة.

لا تتوفّر هذه الميزة عند الإبلاغ عن التقدّم الجزئي.

bytes

المعاملة التي بدأت كجزء من هذا الطلب.

لا تظهر إلا في الاستجابة الأولى عندما يطلب الطلب بدء معاملة جديدة.

Timestamp

وقت حساب النتيجة المجمّعة. وهذا يتزايد دائمًا بصورة رتيبة؛ في هذه الحالة، نضمن عدم تغيير نتيجة التجميع السابقة في ساحة مشاركات النتائج بين read_time وهذه النتيجة.

إذا لم يعرض طلب البحث أي نتائج، سيتم إرسال ردّ بـ read_time بدون result، ويمثّل ذلك وقت تنفيذ طلب البحث.

ExplainMetrics

مقاييس شرح طلب البحث ولا تتوفّر هذه السمة إلا عند توفير RunAggregationQueryRequest.explain_options، ويتم إرسالها مرة واحدة فقط مع آخر ردّ في ساحة المشاركات.

string

مطلوب. اسم المورد الرئيسي. بالتنسيق: projects/{project_id}/databases/{database_id}/documents أو projects/{project_id}/databases/{database_id}/documents/{document_path}. على سبيل المثال: projects/my-project/databases/my-database/documents أو projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

ExplainOptions

هذه السمة اختيارية. شرح خيارات الاستعلام. وفي حال ضبطها، سيتم عرض إحصاءات إضافية لطلبات البحث. وإذا لم يكن الأمر كذلك، فسيتم عرض نتائج الاستعلام فقط.

StructuredQuery

طلب بحث منظم.

bytes

نفِّذ الاستعلام ضمن معاملة نشطة بالفعل.

القيمة هنا هي معرّف المعاملة المبهم لتنفيذ الاستعلام فيه.

TransactionOptions

يبدأ معاملة جديدة ويقرأ المستندات. يتم استخدام القيمة التلقائية لمعاملة القراءة فقط. سيتم عرض معرِّف المعاملة الجديد كأول ردّ في مصدر البيانات.

Timestamp

يقرأ المستندات كما هي في الوقت المحدد.

ويجب أن يكون هذا الطابع الزمني للدقة بالميكرو ثانية خلال الساعة الماضية، أو إذا كانت ميزة "الاسترداد في نقطة زمنية" مفعَّلة، يمكن أن يكون أيضًا طابعًا زمنيًا لدقيقة كاملة خلال آخر 7 أيام.

bytes

المعاملة التي بدأت كجزء من هذا الطلب. لا يمكن ضبط هذا الإعداد إلا في الرد الأول، وفي حال ضبط السمة RunQueryRequest.new_transaction في الطلب فقط. في حال ضبط هذه السياسة، لن يتم ضبط أي حقول أخرى في هذه الاستجابة.

Document

نتيجة طلب بحث، لم يتم ضبطها عند الإبلاغ عن التقدّم الجزئي.

Timestamp

تمثّل هذه السمة وقت قراءة المستند. وقد يكون هذا يزداد بصورة رتيبة؛ في هذه الحالة، نضمن عدم تغيير المستندات السابقة في تدفق النتائج بين read_time وهذا المستند.

إذا لم يعرض طلب البحث أي نتائج، سيتم إرسال ردّ بـ read_time بدون document، ويمثّل ذلك وقت تنفيذ طلب البحث.

int32

عدد النتائج التي تم تخطّيها بسبب الفارق بين الردّ الأخير والاستجابة الحالية.

ExplainMetrics

مقاييس شرح طلب البحث ولا تتوفّر هذه السمة إلا عند توفير RunQueryRequest.explain_options، ويتم إرسالها مرة واحدة فقط مع آخر ردّ في ساحة المشاركات.

bool

في حال توفّره، يعني ذلك أنّ Firestore قد أنهى الطلب بالكامل ولن يتم إرجاع المزيد من المستندات.

Aggregation

هذه السمة اختيارية. سلسلة من التجميعات المطلوب تطبيقها على نتائج structured_query.

يتطلب:

• ما لا يقل عن خمس تجميعات أو خمس مجموعات كحد أقصى لكل طلب بحث.

StructuredQuery

استعلام منظم متداخل.

string

هذه السمة اختيارية. اسم اختياري للحقل لتخزين نتيجة التجميع فيه.

إذا لم يتم توفير الاسم، ستختار Firestore اسمًا تلقائيًا بالتنسيق field_<incremental_id++>. على سبيل المثال:

AGGREGATE
  COUNT_UP_TO(1) AS count_up_to_1,
  COUNT_UP_TO(2),
  COUNT_UP_TO(3) AS count_up_to_3,
  COUNT(*)
OVER (
  ...
);

يصبح:

AGGREGATE
  COUNT_UP_TO(1) AS count_up_to_1,
  COUNT_UP_TO(2) AS field_1,
  COUNT_UP_TO(3) AS count_up_to_3,
  COUNT(*) AS field_2
OVER (
  ...
);

يتطلب:

• يجب أن يكون فريدًا على مستوى جميع الأسماء المستعارة للتجميع.
• يجب الامتثال لقيود document field name.

Count

عدد مجمّع السلع.

Sum

مجمّع السلع.

Avg

متوسط مجمّع السلع.

FieldReference

الحقل المطلوب تجميعه.

Int64Value

هذه السمة اختيارية. قيد اختياري على الحد الأقصى لعدد المستندات المطلوب احتسابها.

يوفر ذلك طريقة لتعيين حد أقصى لعدد المستندات المطلوب مسحها ضوئيًا، والحد من وقت الاستجابة والتكلفة.

ويتم تفسير القيمة "غير محدّد" على أنّها غير مشروطة.

مثال على المستوى العالي:

AGGREGATE COUNT_UP_TO(1000) OVER ( SELECT * FROM k );

يتطلب:

• يجب أن تكون القيمة أكبر من صفر عند وجودها.

FieldReference

الحقل المطلوب تجميعه.

Projection

مجموعة فرعية اختيارية من الحقول المطلوب عرضها.

يعمل هذا الإجراء كـ DocumentMask على المستندات التي يتم عرضها من طلب البحث. في حال ترك هذه السياسة بدون ضبط، يتم افتراض أنّ المتصل يريد عرض جميع الحقول.

CollectionSelector

المجموعات المطلوب الاستعلام عنها.

Filter

الفلتر المطلوب تطبيقه.

Order

الترتيب الذي سيتم تطبيقه على نتائج الاستعلام.

يتيح Firestore للمتصلين تقديم طلب كامل أو طلب جزئي أو عدم تقديم أي طلب على الإطلاق. في جميع الحالات، تضمن Firestore ترتيبًا ثابتًا من خلال القواعد التالية:

• يجب توفير order_by للإشارة إلى جميع الحقول المستخدَمة مع فلتر عدم المساواة.
• يتم إلحاق جميع الحقول المطلوبة في order_by ولكن لم يتم توفيرها بعد بترتيب قاموس لاسم الحقل.
• إذا لم يتم تحديد طلب في __name__، سيتم إلحاقه تلقائيًا.

يتم إلحاق الحقول باتجاه الترتيب نفسه كآخر ترتيب محدّد، أو باستخدام "ASCENDING". إذا لم يتم تحديد أي طلب. على سبيل المثال:

• تغيّر اسم "ORDER BY a" ليصبح "ORDER BY a ASC, __name__ ASC"
• تغيّر اسم "ORDER BY a DESC" ليصبح "ORDER BY a DESC, __name__ DESC"
• تغيّر اسم "WHERE a > 1" ليصبح "WHERE a > 1 ORDER BY a ASC, __name__ ASC"
• تغيّر اسم "WHERE __name__ > ... AND a > 1" ليصبح "WHERE __name__ > ... AND a > 1 ORDER BY a ASC, __name__ ASC"

Cursor

بادئة محتملة لموضع في مجموعة النتائج لبدء طلب البحث عند.

ويعتمد ترتيب مجموعة النتائج على عبارة ORDER BY من طلب البحث الأصلي.

SELECT * FROM k WHERE a = 1 AND b > 2 ORDER BY b ASC, __name__ ASC;

يتم ترتيب نتائج هذا الطلب حسب (b ASC, __name__ ASC).

يمكن أن تشير المؤشرات إلى الترتيب الكامل أو بادئة الموقع الجغرافي، على الرغم من أنّه لا يمكن أن تشير إلى حقول أكثر من تلك المتوفّرة في سمة ORDER BY المقدَّمة.

متابعة للمثال أعلاه، سيكون لإرفاق مؤشرات البدء التالية تأثير متفاوت:

• START BEFORE (2, /k/123): بدء الاستعلام قبل a = 1 AND b > 2 AND __name__ > /k/123 مباشرة.
• START AFTER (10): بدء طلب البحث بعد a = 1 AND b > 10 مباشرةً

على عكس OFFSET الذي يتطلب فحص نتائج N الأولى لتخطيها، يسمح مؤشر البدء ببدء طلب البحث في موضع منطقي. هذا الموضع غير مطلوب ليطابق نتيجة فعلية، وسيتم فحصه بدءًا من هذا الموضع للعثور على المستند التالي.

يتطلب:

• لا يمكن أن يكون عدد القيم أكبر من عدد الحقول المحدّدة في عبارة ORDER BY.

Cursor

بادئة محتملة لموضع في مجموعة النتيجة لإنهاء طلب البحث عند.

يشبه هذا الإجراء START_AT ولكن يتحكّم في موضع النهاية بدلاً من موضع البداية.

يتطلب:

• لا يمكن أن يكون عدد القيم أكبر من عدد الحقول المحدّدة في عبارة ORDER BY.

int32

عدد المستندات المطلوب تخطيها قبل عرض النتيجة الأولى.

ينطبق ذلك بعد القيود المحدّدة في WHERE وSTART AT و END AT لكن قبل عبارة LIMIT.

يتطلب:

• يجب أن تكون القيمة أكبر من أو تساوي صفرًا إذا تم تحديدها.

Int32Value

الحد الأقصى لعدد النتائج المطلوب عرضها.

يُطبق بعد كل القيود الأخرى.

يتطلب:

• يجب أن تكون القيمة أكبر من أو تساوي صفرًا إذا تم تحديدها.

FindNearest

هذه السمة اختيارية. عملية بحث محتملة من الجيران الأقرب.

ينطبق ذلك بعد كل الفلاتر الأخرى والترتيب.

لإيجاد أقرب تضمينات المتجهة لمتجه الاستعلام المحدد.

string

معرّف المجموعة. وعند ضبط هذه السياسة، يتم فقط اختيار المجموعات التي تحمل هذا المعرّف.

bool

وعند ضبط هذه السياسة على "خطأ"، يتم فقط اختيار المجموعات الثانوية المباشرة للسمة parent المحدّدة في العنصر RunQueryRequest الذي يتضمّن هذا العنصر. عند ضبط القيمة على "صحيح"، يتم اختيار كل المجموعات التابعة.

Operator

عامل دمج عوامل تصفية متعددة.

Filter

قائمة الفلاتر المطلوب دمجها

يتطلب:

• هناك فلتر واحد على الأقل.

FieldReference

الحقل الذي تريد الفلترة حسبه.

Operator

العامل المطلوب الفلترة حسبه.

Value

القيمة المطلوب المقارنة بها.

string

مرجع إلى حقل في مستند.

يتطلب:

• يجب أن يكون سلسلة من المقاطع مفصولة بالنقاط (.)، حيث يتوافق كل مقطع مع قيود document field name.

CompositeFilter

عامل تصفية مُركّب

FieldFilter

فلتر على حقل مستند.

UnaryFilter

فلتر يأخذ وسيطة واحدة بالضبط.

FieldReference

مطلوب. حقل متّجه مفهرس للبحث عنه يمكن فقط عرض المستندات التي تحتوي على متجهات تتطابق أبعادها مع query_ect.

Value

مطلوب. متجه الاستعلام الذي نبحث عنه. يجب ألا يزيد طول الخط المتجه عن 2048.

DistanceMeasure

مطلوب. قياس المسافة المطلوب استخدامه، مطلوب.

Int32Value

مطلوب. عدد الجيران الأقرب المُراد إرجاعه. يجب أن يكون عددًا صحيحًا موجبًا لا يزيد عن 1000.

FieldReference

الحقل المطلوب الترتيب حسبه.

Direction

الاتجاه الذي يجب الطلب وفقًا له. وتكون القيمة التلقائية هي ASCENDING.

FieldReference

الحقول المطلوب عرضها.

إذا كانت فارغة، سيتم عرض جميع الحقول. لعرض اسم المستند فقط، استخدِم ['__name__'].

Operator

عامل التشغيل الأحادي المطلوب تطبيقه.

FieldReference

الحقل الذي تريد تطبيق عامل التشغيل عليه.

int32

رقم تعريف الهدف الذي يحدّد الهدف في البث يجب أن تكون القيمة عددًا موجبًا وغير صفري.

إذا كانت قيمة target_id هي 0 (أو غير محدّدة)، سيعيّن الخادم رقم تعريف لهذا الهدف ويعرضه في حدث TargetChange::ADD. بعد إضافة استهداف مع target_id=0، يجب أن تحتوي كل الاستهدافات اللاحقة على target_id=0 أيضًا. إذا تم إرسال طلب AddTarget مع target_id != 0 إلى الخادم بعد إضافة هدف مع target_id=0، سيرسل الخادم على الفور استجابة مع حدث TargetChange::Remove.

يُرجى العلم أنّه إذا أرسل العميل طلبات "AddTarget" متعدّدة بدون معرّف، لن يكون ترتيب المعرّفات المعروضة في "TargetChage.target_ids" محدّدًا. لذلك، يجب على العملاء تقديم معرّف هدف بدلاً من الاعتماد على الخادم لتخصيص معرّف.

إذا لم تكن قيمة target_id صفرًا، يجب ألا يكون هناك هدف نشط حالي في مصدر البيانات هذا برقم التعريف نفسه.

bool

ما إذا كان يجب إزالة الاستهداف بعد أن يصبح ساريًا ومتسقًا

Int32Value

عدد المستندات التي تطابقت مع الاستعلام آخر مرة في الرمز المميز للسيرة الذاتية أو وقت القراءة.

تكون هذه القيمة ذات صلة فقط عند توفير resume_type. هذه القيمة متوفّرة وأكبر من صفر يشير إلى أنّ العميل يريد تضمين ExistenceFilter.unchanged_names في الردّ.

QueryTarget

هدف محدّد بواسطة طلب بحث.

DocumentsTarget

هدف يتم تحديده من خلال مجموعة من أسماء المستندات.

bytes

رمز مميّز لاستئناف العمل من TargetChange سابق لهدف متطابق

لا يمكن استخدام رمز مميّز خاص بالسيرة الذاتية مع هدف مختلف، وقد يتعذّر استخدامها.

Timestamp

يمكنك بدء الاستماع بعد read_time محدّد.

يجب أن يعرف العميل حالة المستندات المطابقة في الوقت الحالي.

string

أسماء المستندات المطلوب استردادها بالتنسيق: projects/{project_id}/databases/{database_id}/documents/{document_path}. سيتعذر الطلب إذا لم يكن أي من المستند موردًا فرعيًا لـ database المحدَّد. سيتم إلغاء الأسماء المكررة.

string

اسم المورد الرئيسي. بالتنسيق: projects/{project_id}/databases/{database_id}/documents أو projects/{project_id}/databases/{database_id}/documents/{document_path}. على سبيل المثال: projects/my-project/databases/my-database/documents أو projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

StructuredQuery

طلب بحث منظم.

TargetChangeType

نوع التغيير الذي حدث.

int32

أرقام التعريف المستهدَفة للأهداف التي تغيّرت.

وإذا كانت فارغة، فسينطبق التغيير على جميع الاستهدافات.

لم يتم تحديد ترتيب أرقام تعريف الاستهداف.

Status

تمثّل هذه السمة الخطأ الذي أدّى إلى هذا التغيير، إذا كان ذلك منطبقًا.

bytes

هو رمز مميّز يمكن استخدامه لاستئناف البث في نطاق target_ids المحدَّد أو جميع الأهداف إذا كانت السمة target_ids فارغة.

لا يتم ضبطه عند كل تغيير مستهدَف.

Timestamp

تمثّل هذه السمة read_time المتسق للسمة target_ids المحدّدة (يتم حذفها عندما لا تكون قِيَم target_ids في نبذة متسقة).

نضمن لك أن يتم إرسال حقل "read_time" مع حقل "target_ids" فارغًا عندما يصل البث بأكمله إلى نبذة جديدة متسقة. نضمن لك أن تؤدي الرسائل ADD وCURRENT وRESET (في النهاية) إلى الحصول على لقطة جديدة متسقة (في حين أن الرسائل NO_change وREMOVE) ليست كذلك).

بالنسبة إلى مصدر بيانات معيّن، نضمن أن يزداد عنصر read_time بوتيرة رتيبة.

ReadOnly

يمكن استخدام المعاملة لإجراء عمليات القراءة فقط.

ReadWrite

ويمكن استخدام المعاملة في عمليتَي القراءة والكتابة على حدّ سواء.

Timestamp

يقرأ المستندات في الوقت المحدد.

ويجب أن يكون هذا الطابع الزمني للدقة بالميكرو ثانية خلال الساعة الماضية، أو إذا كانت ميزة "الاسترداد في نقطة زمنية" مفعَّلة، يمكن أن يكون أيضًا طابعًا زمنيًا لدقيقة كاملة خلال آخر 7 أيام.

bytes

معاملة اختيارية لإعادة المحاولة.

Document

مطلوب. المستند الذي تم تعديله يتم إنشاء المستند إذا لم يكن موجودًا من قبل.

DocumentMask

الحقول المطلوب تعديلها. لا يجوز أن يحتوي أي من مسارات الحقول في القناع على اسم محجوز.

إذا كان المستند موجودًا على الخادم ويحتوي على حقول لم تتم الإشارة إليها في القناع، يتم تركها بدون تغيير. يتم حذف الحقول المُشار إليها في القناع، ولكن غير المتوفّرة في مستند الإدخال، من المستند على الخادم.

DocumentMask

الحقول المطلوب عرضها. وفي حال تم تركها بدون ضبط، سيتم عرض جميع الحقول.

إذا كان المستند يحتوي على حقل غير موجود في هذا القناع، لن يتم عرض هذا الحقل في الرد.

Precondition

شرط مُسبَق اختياري في المستند. سيتعذّر الطلب إذا تم ضبط ذلك ولم يتم استيفاؤه من خلال المستند المستهدف.

NullValue

قيمة فارغة.

bool

قيمة منطقية.

int64

قيمة عدد صحيح.

double

قيمة مزدوجة.

Timestamp

قيمة طابع زمني.

الضبط بدقة تصل إلى ميكرو ثانية فقط. وعند تخزينها، يتم تقريب أي دقة إضافية إلى قيمة أقل.

string

قيمة سلسلة.

يجب ألا تتجاوز السلسلة، الممثلة بترميز UTF-8، بين 1 مبيبايت و89 بايت. تنظر طلبات البحث فقط في أول 1,500 بايت من تمثيل UTF-8.

bytes

قيمة بايت.

يجب ألا تتجاوز 1 مبيبايت إلى 89 بايت. تأخذ طلبات البحث أول 1,500 بايت فقط في الاعتبار.

string

مرجع لمستند مثلاً: projects/{project_id}/databases/{database_id}/documents/{document_path}

LatLng

يشير ذلك المصطلح إلى قيمة نقطة جغرافية تمثّل نقطة على سطح الأرض.

ArrayValue

قيمة مصفوفة.

لا يمكن أن يحتوي على قيمة صفيف أخرى مباشرةً، ولكن يمكن أن يحتوي على خريطة تحتوي على صفيف آخر.

MapValue

قيمة الخريطة.

DocumentMask

الحقول المطلوب تعديلها في هذه الكتابة.

لا يمكن ضبط هذا الحقل إلا عندما تكون العملية update. وإذا لم يتم ضبط القناع على update وكان المستند متوفّرًا، سيتم استبدال أي بيانات حالية. وإذا تم ضبط القناع وكان المستند على الخادم يحتوي على حقول لا يغطيها القناع، يتم تركها بدون تغيير. يتم حذف الحقول المُشار إليها في القناع، ولكن غير المتوفّرة في مستند الإدخال، من المستند على الخادم. يجب ألا تحتوي مسارات الحقول في هذا القناع على اسم حقل محجوز.

FieldTransform

تمثّل هذه السمة عمليات التحويل التي سيتم إجراؤها بعد التحديث.

لا يمكن ضبط هذا الحقل إلا عندما تكون العملية update. في حال توفُّر هذه الميزة، تكون هذه الكتابة تعادل إجراء update وtransform على المستند ذاته بالترتيب.

Precondition

شرط مُسبَق اختياري في المستند.

ستفشل الكتابة إذا تم ضبط ذلك ولم يتم الوفاء به من خلال المستند الهدف.

Document

مستند للكتابة

string

اسم المستند المطلوب حذفه بالتنسيق: projects/{project_id}/databases/{database_id}/documents/{document_path}.

DocumentTransform

تطبيق عملية تحويل على مستند

string

مطلوب. اسم قاعدة البيانات. بالتنسيق: projects/{project_id}/databases/{database_id}. هذا الإجراء مطلوب فقط في الرسالة الأولى.

string

رقم تعريف ساحة المشاركات للكتابة المطلوب استئنافها يمكن ضبط هذا الإعداد في الرسالة الأولى فقط. عند ترك هذا الحقل فارغًا، سيتم إنشاء ساحة مشاركات جديدة للكتابة.

Write

العبارات التي سيتم تطبيقها.

يتم تنفيذها دائمًا بشكل كامل وبالترتيب. يجب أن يكون هذا الحقل فارغًا في الطلب الأول. وقد يكون هذا الحقل فارغًا في الطلب الأخير. ويجب ألا يكون هذا الحقل فارغًا في جميع الطلبات الأخرى.

bytes

رمز مميّز للبث أرسله الخادم في السابق.

يجب أن يضبط العميل هذا الحقل على الرمز المميّز من آخر WriteResponse تلقّاه. ويعني ذلك أنّ العميل قد تلقّى ردودًا حول هذا الرمز المميّز. بعد إرسال هذا الرمز المميّز، قد لا يتم استخدام الرموز المميّزة السابقة بعد الآن.

وقد يغلق الخادم ساحة المشاركات في حال وجود عدد كبير جدًا من الردود التي لم يتم قبولها.

يُرجى إبقاء هذا الحقل بدون ضبط عند إنشاء بث جديد. لاستئناف بث عند وقت محدّد، يجب ضبط هذا الحقل والحقل stream_id.

يُرجى إبقاء هذا الحقل بدون ضبط عند إنشاء بث جديد.

map<string, string>

التصنيفات المرتبطة بطلب الكتابة هذا

string

رقم تعريف مصدر البيانات. يتم ضبط الإعداد على الرسالة الأولى فقط عند إنشاء بث جديد.

bytes

هو رمز مميّز يمثّل موضع هذه الاستجابة في ساحة المشاركات. ويمكن أن يستخدم العميل هذا الإجراء لاستئناف البث عند هذه المرحلة.

يتم ضبط هذا الحقل دائمًا.

WriteResult

هي نتيجة تطبيق عمليات الكتابة.

تتوافق نتيجة i-th write هذه مع الكتابة i-th في الطلب.

Timestamp

وقت حدوث الالتزام. يمكن ضمان ظهور تأثيرات الكتابة عند قراءة أي قراءة تساوي read_time أو أكبر.

Timestamp

تمثّل هذه السمة وقت آخر تحديث للمستند بعد تطبيق عملية الكتابة. لم يتم ضبط السياسة بعد delete.

إذا لم تكن الكتابة تغير المستند فعليًا، فسيكون هذا هو update_time السابق.

Value

تمثّل هذه السمة نتائج تطبيق كل DocumentTransform.FieldTransform بالترتيب نفسه.