الفهرس
Firestore
(واجهة)AggregationResult
(رسالة)ArrayValue
(رسالة)BatchGetDocumentsRequest
(رسالة)BatchGetDocumentsResponse
(رسالة)BatchWriteRequest
(رسالة)BatchWriteResponse
(رسالة)BeginTransactionRequest
(رسالة)BeginTransactionResponse
(رسالة)BitSequence
(رسالة)BloomFilter
(رسالة)CommitRequest
(رسالة)CommitResponse
(رسالة)CreateDocumentRequest
(رسالة)Cursor
(رسالة)DeleteDocumentRequest
(رسالة)Document
(رسالة)DocumentChange
(رسالة)DocumentDelete
(رسالة)DocumentMask
(رسالة)DocumentRemove
(رسالة)DocumentTransform
(رسالة)DocumentTransform.FieldTransform
(رسالة)DocumentTransform.FieldTransform.ServerValue
(تعداد)ExecutionStats
(رسالة)ExistenceFilter
(رسالة)ExplainMetrics
(رسالة)ExplainOptions
(رسالة)GetDocumentRequest
(رسالة)ListCollectionIdsRequest
(رسالة)ListCollectionIdsResponse
(رسالة)ListDocumentsRequest
(رسالة)ListDocumentsResponse
(رسالة)ListenRequest
(رسالة)ListenResponse
(رسالة)MapValue
(رسالة)PartitionQueryRequest
(رسالة)PartitionQueryResponse
(رسالة)PlanSummary
(رسالة)Precondition
(رسالة)RollbackRequest
(رسالة)RunAggregationQueryRequest
(رسالة)RunAggregationQueryResponse
(رسالة)RunQueryRequest
(رسالة)RunQueryResponse
(رسالة)StructuredAggregationQuery
(رسالة)StructuredAggregationQuery.Aggregation
(رسالة)StructuredAggregationQuery.Aggregation.Avg
(رسالة)StructuredAggregationQuery.Aggregation.Count
(رسالة)StructuredAggregationQuery.Aggregation.Sum
(رسالة)StructuredQuery
(رسالة)StructuredQuery.CollectionSelector
(رسالة)StructuredQuery.CompositeFilter
(رسالة)StructuredQuery.CompositeFilter.Operator
(تعداد)StructuredQuery.Direction
(تعداد)StructuredQuery.FieldFilter
(رسالة)StructuredQuery.FieldFilter.Operator
(تعداد)StructuredQuery.FieldReference
(رسالة)StructuredQuery.Filter
(رسالة)StructuredQuery.FindNearest
(رسالة)StructuredQuery.FindNearest.DistanceMeasure
(تعداد)StructuredQuery.Order
(رسالة)StructuredQuery.Projection
(رسالة)StructuredQuery.UnaryFilter
(رسالة)StructuredQuery.UnaryFilter.Operator
(تعداد)Target
(رسالة)Target.DocumentsTarget
(رسالة)Target.QueryTarget
(رسالة)TargetChange
(رسالة)TargetChange.TargetChangeType
(تعداد)TransactionOptions
(رسالة)TransactionOptions.ReadOnly
(رسالة)TransactionOptions.ReadWrite
(رسالة)UpdateDocumentRequest
(رسالة)Value
(رسالة)Write
(رسالة)WriteRequest
(رسالة)WriteResponse
(رسالة)WriteResult
(رسالة)
Firestore
خدمة Cloud Firestore.
Cloud Firestore هي قاعدة بيانات مستندات NoSQL سريعة وإدارتها بالكامل بدون خادم ومستنِدة إلى السحابة الإلكترونية، وتسهِّل عملية تخزين البيانات ومزامنتها والاستعلام عنها لتطبيقات الأجهزة الجوّالة والويب وإنترنت الأشياء (IoT) على نطاق عالمي. وتوفّر مكتبات العملاء الخاصة بها إمكانية المزامنة المباشرة والدعم بلا اتصال بالإنترنت، في حين تعمل ميزات الأمان وعمليات الدمج مع Firebase وGoogle Cloud Platform على تسريع عملية إنشاء تطبيقات بدون خوادم.
BatchGetDocuments |
---|
الحصول على مستندات متعددة لا تضمن هذه الطريقة إرجاع المستندات بالترتيب نفسه الذي تم طلبه بها.
|
BatchWrite |
---|
تطبيق مجموعة من عمليات الكتابة. لا تطبق طريقة BatchWrite عمليات الكتابة بشكل كامل ويمكن أن تطبقها بدون ترتيب. لا تسمح الطريقة بأكثر من كتابة واحدة لكل مستند. وتنجح كل عملية كتابة أو تفشل بشكل مستقل. اطّلِع على إذا كنت تتطلّب مجموعة من عمليات الكتابة المطبَّقة على أجزاء شاملة، استخدِم
|
BeginTransaction |
---|
بدء معاملة جديدة
|
عدم التغيير |
---|
إتمام معاملة وتعديل المستندات اختياريًا
|
CreateDocument |
---|
ينشئ مستندًا جديدًا.
|
DeleteDocument |
---|
لحذف مستند
|
GetDocument |
---|
الحصول على مستند واحد
|
ListCollectionIds |
---|
يسرد جميع معرّفات المجموعات أسفل المستند.
|
ListDocuments |
---|
يسرد المستندات.
|
استماع |
---|
يرصد الميكروفون التغييرات. لا تتوفر هذه الطريقة إلا عبر gRPC أو WebChannel (وليس عبر REST).
|
PartitionQuery |
---|
لتقسيم استعلام عن طريق عرض مؤشرات الأقسام التي يمكن استخدامها لتشغيل الاستعلام بالتوازي. مؤشرات الأقسام المعروضة هي نقاط تقسيم يمكن استخدامها بواسطة RunQuery كنقاط بداية/نهاية لنتائج الاستعلام.
|
العودة إلى الإصدار السابق |
---|
التراجع عن معاملة
|
RunAggregationQuery |
---|
لتشغيل استعلام تجميع. بدلاً من عرض نتائج مثال عالي المستوى:
|
RunQuery |
---|
تنفيذ استعلام.
|
UpdateDocument |
---|
لتعديل مستند أو إدراجه
|
كتابة |
---|
تدفق مجموعات من تعديلات المستندات وحذفها بالترتيب. لا تتوفر هذه الطريقة إلا عبر gRPC أو WebChannel (وليس عبر REST).
|
AggregationResult
نتيجة لمجموعة واحدة من استعلام تجميع Firestore.
مفاتيح aggregate_fields
هي نفسها لجميع النتائج في طلب بحث التجميع، على عكس طلبات بحث المستند التي يمكن أن تحتوي على حقول مختلفة لكل نتيجة.
الحقول | |
---|---|
aggregate_fields |
نتيجة وظائف التجميع، مثل: المفتاح هو |
ArrayValue
تمثّل هذه السمة قيمة مصفوفة.
الحقول | |
---|---|
values[] |
القيم في الصفيف |
BatchGetDocumentsRequest
الحقول | |
---|---|
database |
مطلوبة. اسم قاعدة البيانات بالتنسيق: |
documents[] |
أسماء المستندات المراد استردادها. بالتنسيق: |
mask |
الحقول المطلوب عرضها. وفي حال تم ترك السياسة بدون ضبط، سيتم عرض جميع الحقول. إذا كان المستند يحتوي على حقل غير متوفّر في هذا القناع، لن يتم عرض هذا الحقل في الاستجابة. |
حقل الاتحاد consistency_selector وضع الاتّساق لهذه المعاملة وفي حال تم ترك هذه السياسة بدون ضبط، سيتم ضبط الإعدادات التلقائية على تناسق قوي. يمكن أن يكون الحقل "consistency_selector " واحدًا فقط مما يلي: |
|
transaction |
لقراءة المستندات في معاملة. |
new_transaction |
يبدأ معاملة جديدة ويقرأ المستندات. يكون الإعداد التلقائي هو معاملة القراءة فقط. سيظهر معرِّف المعاملة الجديد كأول ردّ في ساحة المشاركات. |
read_time |
يقرأ المستندات كما كانت في الوقت المحدَّد. يجب أن يكون هذا الطابع الزمني بدقة ميكرو ثانية خلال الساعة الماضية، أو إذا تم تفعيل ميزة "استرداد نقطة زمنية"، يمكن أيضًا أن يكون طابعًا زمنيًا لدقيقة كاملة خلال آخر 7 أيام. |
BatchGetDocumentsResponse
الاستجابة المباشرة لـ Firestore.BatchGetDocuments
.
الحقول | |
---|---|
transaction |
المعاملة التي بدأت كجزء من هذا الطلب سيتم ضبطها فقط في الردّ الأول، وفقط في حال ضبط |
read_time |
الوقت الذي تمت فيه قراءة المستند. قد يكون هذا الأمر متزايدًا بشكل أحادي، وفي هذه الحالة يمكننا ضمان عدم تغيير المستندات السابقة في تدفق النتائج بين read_time وهذا الوقت. |
حقل الاتحاد result نتيجة واحدة وقد يكون هذا الحقل فارغًا إذا كان الخادم يعرض معاملة فقط. يمكن أن يكون الحقل "result " واحدًا فقط مما يلي: |
|
found |
المستند الذي تم طلبه. |
missing |
اسم المستند الذي تم طلبه لكنه غير موجود. بالتنسيق: |
BatchWriteRequest
طلب Firestore.BatchWrite
.
الحقول | |
---|---|
database |
مطلوبة. اسم قاعدة البيانات بالتنسيق: |
writes[] |
التعليمات المطلوب تطبيقها. لا تطبق الطريقة عمليات الكتابة بشكل كامل ولا تضمن الترتيب. وتنجح كل عملية كتابة أو تفشل بشكل مستقل. لا يمكنك الكتابة في المستند نفسه أكثر من مرة لكل طلب. |
labels |
التصنيفات المرتبطة بالكتابة المجمّعة هذه |
BatchWriteResponse
الردّ من Firestore.BatchWrite
الحقول | |
---|---|
write_results[] |
نتيجة تطبيق عمليات الكتابة. تتجاوب نتيجة الكتابة i هذه مع الكتابة i-th في الطلب. |
status[] |
حالة تطبيق عمليات الكتابة. تتجاوب حالة كتابة i-th هذه مع كتابة i-th في الطلب. |
BeginTransactionRequest
الحقول | |
---|---|
database |
مطلوبة. اسم قاعدة البيانات بالتنسيق: |
options |
خيارات المعاملة. يتم ضبط القيمة التلقائية على معاملة القراءة والكتابة. |
BeginTransactionResponse
الردّ على Firestore.BeginTransaction
.
الحقول | |
---|---|
transaction |
المعاملة التي بدأت |
BitSequence
يشير ذلك المصطلح إلى تسلسل من وحدات البت يتم ترميزه في مصفوفة بايت.
تخزِّن كل بايت في مصفوفة البايت bitmap
8 بت من التسلسل. الاستثناء الوحيد هو البايت الأخير الذي قد يخزِّن 8 وحدات بت أو أقل. تحدّد padding
عدد وحدات البت الأخيرة التي سيتم تجاهلها باعتبارها "مساحة متروكة". قيم وحدات بت "المساحة المتروكة" هذه غير محددة ويجب تجاهلها.
لاسترداد البت الأول، البت 0، احسب: (bitmap[0] & 0x01) != 0
. لاسترداد البت الثاني، البت 1، احسب القيمة: (bitmap[0] & 0x02) != 0
. لاسترداد البت الثالث، البت 2، احسب: (bitmap[0] & 0x04) != 0
. لاسترداد البت الرابع، البت 3، احسب القيمة: (bitmap[0] & 0x08) != 0
. لاسترداد البت n، احسب: (bitmap[n / 8] & (0x01 << (n % 8))) != 0
.
يتم احتساب "حجم" BitSequence
(عدد وحدات البت التي تحتوي عليها) من خلال هذه الصيغة: (bitmap.length * 8) - padding
.
الحقول | |
---|---|
bitmap |
وحدات البايت التي تشفّر تسلسل البت. قد يكون طولها صفر. |
padding |
عدد وحدات البت من البايت الأخير في |
BloomFilter
فلتر زهور (https://en.wikipedia.org/wiki/Bloom_filter)
يُجزِّئ فلتر bloom الإدخالات باستخدام خوارزمية MD5 ويتعامل مع تجزئة 128 بت الناتجة كقيمتَي تجزئة مختلفتَين 64 بت، ويتم تفسيرهما كأعداد صحيحة غير موقَّعة باستخدام ترميز 2 المكمّل.
بعد ذلك، تُستخدَم قيمتا التجزئة هاتين، باسم h1
وh2
، لاحتساب قيم التجزئة hash_count
باستخدام الصيغة، بدءًا من i=0
:
h(i) = h1 + (i * h2)
وتُؤخذ هذه القيم الناتجة في معامل عدد وحدات البت في فلتر التألق للحصول على وحدات بت هذا الفلتر لاختبار الإدخال المحدّد.
الحقول | |
---|---|
bits |
بيانات فلتر Bloom |
hash_count |
عدد التجزئات التي تستخدمها الخوارزمية. |
CommitRequest
طلب Firestore.Commit
.
الحقول | |
---|---|
database |
مطلوبة. اسم قاعدة البيانات بالتنسيق: |
writes[] |
التعليمات المطلوب تطبيقها. يتم تنفيذها بشكل شامل وبالترتيب دائمًا. |
transaction |
في حال الضبط، يتم تطبيق جميع عمليات الكتابة في هذه المعاملة وتنفيذها. |
CommitResponse
الردّ على Firestore.Commit
.
الحقول | |
---|---|
write_results[] |
نتيجة تطبيق عمليات الكتابة. تتجاوب نتيجة الكتابة i هذه مع الكتابة i-th في الطلب. |
commit_time |
وقت حدوث الاشتراك. من خلال أيّ قراءة تتضمّن قيمة |
CreateDocumentRequest
الحقول | |
---|---|
parent |
مطلوبة. المورد الرئيسي. على سبيل المثال: السمة |
collection_id |
مطلوبة. رقم تعريف المجموعة المرتبط بـ |
document_id |
رقم تعريف المستند الذي عيّنه العميل لاستخدامه في هذا المستند. اختياريّ. في حال عدم تحديد ذلك، ستعيّن الخدمة معرّفًا. |
document |
مطلوبة. المستند المطلوب إنشاؤه يجب عدم ضبط |
mask |
الحقول المطلوب عرضها. وفي حال تم ترك السياسة بدون ضبط، سيتم عرض جميع الحقول. إذا كان المستند يحتوي على حقل غير متوفّر في هذا القناع، لن يتم عرض هذا الحقل في الاستجابة. |
المؤشر
موضع في مجموعة نتائج طلب بحث.
الحقول | |
---|---|
values[] |
القيم التي تمثل موضعًا، بالترتيب الذي تظهر به بالترتيب حسب عبارة الاستعلام. يمكن أن يحتوي على قيم أقل من القيم المحددة في الترتيب حسب العبارة. |
before |
إذا كان الموضع قبل القيم المحدّدة أو بعدها مباشرةً، وذلك بالنسبة إلى ترتيب الترتيب المحدّد في طلب البحث. |
DeleteDocumentRequest
الحقول | |
---|---|
name |
مطلوبة. اسم المورد للمستند المطلوب حذفه. بالتنسيق: |
current_document |
شرط مسبق اختياري في المستند. سيفشل الطلب إذا تم ضبط هذا الإعداد ولم يتم استيفاء هذا الطلب من خلال المستند المستهدَف. |
مستند
مستند Firestore
يجب ألا يتجاوز حجمه 1 مبيبايت و4 بايت.
الحقول | |
---|---|
name |
تمثّل هذه السمة اسم مورد المستند، على سبيل المثال |
fields |
|
create_time |
النتائج فقط. الوقت الذي تم فيه إنشاء المستند. تزيد هذه القيمة بشكل رتيب عند حذف مستند ثم إعادة إنشائه. ويمكن مقارنتها أيضًا بالقيم من مستندات أخرى و |
update_time |
النتائج فقط. الوقت الذي تم فيه تغيير المستند آخر مرة. يتم ضبط هذه القيمة في البداية على |
DocumentChange
تم تغيير Document
.
وقد يكون ذلك نتيجة استخدام عدة عناصر writes
، بما في ذلك عمليات الحذف، والتي أدّت في النهاية إلى إضافة قيمة جديدة للسمة Document
.
قد يتم عرض رسائل DocumentChange
متعددة للتغيير المنطقي نفسه، إذا تأثرت عدة أهداف.
الحقول | |
---|---|
document |
الحالة الجديدة لـ في حال ضبط السمة |
target_ids[] |
مجموعة من أرقام تعريف الاستهدافات التي تتطابق مع هذا المستند. |
removed_target_ids[] |
مجموعة من أرقام تعريف الاستهدافات للأهداف التي لم تعُد مطابقة لهذا المستند. |
DocumentDelete
تم حذف Document
.
قد يكون ذلك نتيجة عدة أخطاء في writes
، بما في ذلك التعديلات، كان آخرها حذف Document
.
قد يتم عرض رسائل DocumentDelete
متعددة لعملية الحذف المنطقي نفسها، إذا تأثّرت أهداف متعدّدة.
الحقول | |
---|---|
document |
اسم المورد لـ |
removed_target_ids[] |
مجموعة من أرقام تعريف الاستهدافات للأهداف التي سبق أن تطابقت مع هذا الكيان. |
read_time |
الطابع الزمني للقراءة الذي تمت ملاحظة الحذف عنده. أكبر من أو يساوي |
DocumentMask
مجموعة من مسارات الحقول في مستند يُستخدم لتقييد عملية الحصول على مستند أو تعديله على مجموعة فرعية من حقوله. ويختلف ذلك عن أقنعة الحقول العادية، إذ يتم ضبطها دائمًا على Document
، مع مراعاة الطبيعة الديناميكية للسمة Value
.
الحقول | |
---|---|
field_paths[] |
قائمة مسارات الحقول في القناع. اطّلِع على |
DocumentRemove
تمت إزالة Document
من عرض الأهداف.
يتم إرساله إذا لم يعد المستند ذا صلة بهدف معين وخارجه. يمكن إرسالها بدلاً من DocumentDelete أو DocumentChange (تغيير المستند) إذا لم يتمكن الخادم من إرسال القيمة الجديدة للمستند.
قد يتم عرض رسائل DocumentRemove
متعددة لعملية الكتابة أو الحذف المنطقية نفسها، إذا تأثرت عدة أهداف.
الحقول | |
---|---|
document |
اسم المورد لـ |
removed_target_ids[] |
مجموعة من أرقام تعريف الاستهدافات للأهداف التي تطابقت في السابق مع هذا المستند. |
read_time |
الطابع الزمني للقراءة الذي تمت عنده ملاحظة الإزالة. أكبر أو يساوي |
DocumentTransform
تحويل مستند.
الحقول | |
---|---|
document |
اسم المستند المطلوب تحويله |
field_transforms[] |
قائمة عمليات التحويل المطلوب تطبيقها على حقول المستند بالترتيب يجب ألا يكون هذا الحقل فارغًا. |
FieldTransform
تحويل حقل من المستند.
الحقول | |
---|---|
field_path |
مسار الحقل. اطّلِع على |
حقل الاتحاد transform_type التحويل المطلوب تطبيقه على الحقل. يمكن أن يكون الحقل "transform_type " واحدًا فقط مما يلي: |
|
set_to_server_value |
لضبط الحقل على قيمة الخادم المحددة. |
increment |
لإضافة القيمة المحدّدة إلى القيمة الحالية للحقل يجب أن يكون هذا العدد عددًا صحيحًا أو قيمة مزدوجة. إذا لم يكن الحقل عددًا صحيحًا أو مزدوجًا، أو إذا لم يكن الحقل متوفرًا بعد، ستؤدّي عملية التحويل إلى ضبط الحقل على القيمة المحدّدة. إذا كان أي من القيمة المقدَّمة أو قيمة الحقل الحالي مضاعفة، سيتم تفسير كلتا القيمتين على أنهما مزدوجتان. يتبع الحساب المزدوج وتمثيل القيم المزدوجة دلالات معهد الهندسة الكهربائية والإلكترونية IEEE 754. إذا كان هناك تجاوز سعة عدد صحيح موجب/سالب، يتم حل الحقل إلى أكبر عدد صحيح موجب/سالب للمقدار الأكبر. |
maximum |
لضبط الحقل على الحد الأقصى لقيمته الحالية والقيمة المحدّدة. يجب أن يكون هذا العدد عددًا صحيحًا أو قيمة مزدوجة. إذا لم يكن الحقل عددًا صحيحًا أو مزدوجًا، أو إذا لم يكن الحقل متوفرًا بعد، ستؤدّي عملية التحويل إلى ضبط الحقل على القيمة المحدّدة. في حال تطبيق عملية حد أقصى حيث كان الحقل وقيمة الإدخال من أنواع مختلطة (أي أنّ أحدهما عدد صحيح والآخر مزدوج)، سيتخذ الحقل نوع المعامل الأكبر. إذا كانت المعاملان متكافئة (مثل 3 و3.0)، فلن يتغير الحقل. 0 و0.0 و-0.0 كلها صفر. الحد الأقصى للقيمة المخزنة بقيمة صفرية وقيمة الإدخال صفر هو دائمًا القيمة المخزَّنة. الحد الأقصى لأي قيمة رقمية x وNaN هو NaN. |
minimum |
لضبط الحقل على الحد الأدنى من قيمته الحالية والقيمة المحدّدة. يجب أن يكون هذا العدد عددًا صحيحًا أو قيمة مزدوجة. إذا لم يكن الحقل عددًا صحيحًا أو مزدوجًا، أو إذا لم يكن الحقل متوفرًا بعد، ستؤدّي عملية التحويل إلى ضبط الحقل على قيمة الإدخال. في حال تطبيق حد أدنى من العملية حيث كان الحقل وقيمة الإدخال من أنواع مختلطة (أي أنّ أحدهما عدد صحيح والآخر مزدوج)، سيتخذ الحقل نوع المعامل الأصغر. إذا كانت المعاملان متكافئة (مثل 3 و3.0)، فلن يتغير الحقل. 0 و0.0 و-0.0 كلها صفر. الحد الأدنى لأي قيمة مخزّنة بقيمة صفرية وقيمة الإدخال صفر هو دائمًا القيمة المخزَّنة. الحد الأدنى لأي قيمة رقمية x وNaN هو NaN. |
append_missing_elements |
ألحِق العناصر المحدّدة بالترتيب إذا لم تكن متوفّرة في قيمة الحقل الحالي. إذا لم يكن الحقل صفيفًا، أو إذا لم يكن الحقل موجودًا بعد، يتم ضبطه أولاً على الصفيف الفارغ. تعتبر الأعداد المكافئة من الأنواع المختلفة (مثل 3L و3.0) متساوية عند التحقق من عدم وجود قيمة. NaN تساوي NaN وNull تساوي Null. إذا كان الإدخال يحتوي على قيم مكافئة متعددة، سيتم النظر في القيمة الأولى فقط. ستكون نتيجة Convert_result المقابلة هي القيمة الفارغة. |
remove_all_from_array |
يجب إزالة جميع العناصر المحددة من الصفيفة في الحقل. إذا لم يكن الحقل صفيفًا أو إذا لم يكن الحقل موجودًا بعد، يتم ضبطه على الصفيف الفارغ. تعتبر الأعداد المكافئة للأنواع المختلفة (مثل 3L و3.0) متساوية عند تحديد ما إذا كان يجب إزالة أحد العناصر أم لا. NaN تساوي NaN وNull تساوي Null. سيؤدي هذا إلى إزالة جميع القيم المكافئة في حال وجود تكرارات. ستكون نتيجة Convert_result المقابلة هي القيمة الفارغة. |
ServerValue
يشير ذلك إلى قيمة يُحتسبها الخادم.
عمليات التعداد | |
---|---|
SERVER_VALUE_UNSPECIFIED |
غير محدد يجب عدم استخدام هذه القيمة. |
REQUEST_TIME |
الوقت الذي يعالج فيه الخادم الطلب، بدقة بالمللي ثانية. في حال استخدامها في حقول متعددة (في المستندات نفسها أو في مستندات مختلفة) ضمن معاملة، سيتم منح الطابع الزمني نفسه للخادم في جميع الحقول. |
ExecutionStats
إحصاءات التنفيذ لطلب البحث.
الحقول | |
---|---|
results_returned |
إجمالي عدد النتائج التي تم إرجاعها، بما في ذلك المستندات والتوقعات ونتائج التجميع والمفاتيح. |
execution_duration |
إجمالي الوقت لتنفيذ الاستعلام في الخلفية. |
read_operations |
إجمالي عمليات القراءة القابلة للفوترة |
debug_stats |
تصحيح أخطاء الإحصائيات من تنفيذ الاستعلام. تجدر الإشارة إلى أنّ إحصاءات تصحيح الأخطاء عرضة للتغيير مع تطوّر Firestore. It could include: { "indexes_entries_scanned": "1000", "documents_scanned": "20", "billing_details" : { "documents_billable": "20", "index_entries_billable": "1000", "min_query_cost": "0" } } |
ExistenceFilter
ملخص لجميع المستندات التي تطابق هدفًا معينًا.
الحقول | |
---|---|
target_id |
رقم تعريف الاستهداف الذي ينطبق عليه هذا الفلتر. |
count |
إجمالي عدد المستندات التي تتطابق مع في حال اختلاف عدد المستندات عن عدد المستندات المتطابقة، يجب أن يحدد العميل يدويًا المستندات التي لم تعد تطابق الهدف. يمكن للعميل استخدام فلتر |
unchanged_names |
فلتر bloom، على الرغم من اسمه، يحتوي على ترميزات بايت UTF-8 لأسماء الموارد لجميع المستندات المطابقة مع وقد يتم حذف فلتر Bloom هذا وفقًا لتقدير الخادم، كأن يتم اعتبار أن العميل لن يستفيد من استخدامه أو إذا كان حسابه أو إرساله مكلفًا جدًا من الناحية الحسابية. على العملاء التعامل بسلاسة مع هذا الحقل المفقود عن طريق الرجوع إلى المنطق الذي كان مستخدَمًا قبل وجود هذا الحقل، أي إعادة إضافة الهدف بدون رمز مميَّز للسيرة الذاتية لمعرفة المستندات غير المتزامنة في ذاكرة التخزين المؤقت للعميل. |
ExplainMetrics
شرح مقاييس طلب البحث.
الحقول | |
---|---|
plan_summary |
معلومات مرحلة التخطيط للاستعلام. |
execution_stats |
إحصاءات مجمعة من تنفيذ طلب البحث. لا يتم عرضها إلا عند ضبط |
ExplainOptions
شرح خيارات الاستعلام.
الحقول | |
---|---|
analyze |
اختياريّ. ما إذا كان سيتم تنفيذ هذا الاستعلام أم لا. أما عندما يكون الخيار "خطأ" (الخيار التلقائي)، سيتم التخطيط لطلب البحث، مع عرض المقاييس من مراحل التخطيط فقط. عندما يكون الخيار "صحيحًا"، سيتم التخطيط لطلب البحث وتنفيذه، ما يؤدي إلى عرض نتائج طلب البحث الكاملة إلى جانب مقاييس مرحلة التخطيط والتنفيذ. |
GetDocumentRequest
الحقول | |
---|---|
name |
مطلوبة. اسم مورد المستند الذي تريد الحصول عليه. بالتنسيق: |
mask |
الحقول المطلوب عرضها. وفي حال تم ترك السياسة بدون ضبط، سيتم عرض جميع الحقول. إذا كان المستند يحتوي على حقل غير متوفّر في هذا القناع، لن يتم عرض هذا الحقل في الاستجابة. |
حقل الاتحاد consistency_selector وضع الاتّساق لهذه المعاملة وفي حال تم ترك هذه السياسة بدون ضبط، سيتم ضبط الإعدادات التلقائية على تناسق قوي. يمكن أن يكون الحقل "consistency_selector " واحدًا فقط مما يلي: |
|
transaction |
قراءة المستند في معاملة. |
read_time |
يقرأ نسخة المستند في الوقت المحدّد. يجب أن يكون هذا الطابع الزمني بدقة ميكرو ثانية خلال الساعة الماضية، أو إذا تم تفعيل ميزة "استرداد نقطة زمنية"، يمكن أيضًا أن يكون طابعًا زمنيًا لدقيقة كاملة خلال آخر 7 أيام. |
ListCollectionIdsRequest
الحقول | |
---|---|
parent |
مطلوبة. المستند الرئيسي. بالتنسيق: |
page_size |
تمثّل هذه السمة الحد الأقصى لعدد النتائج المطلوب عرضها. |
page_token |
الرمز المميز للصفحة. يجب أن تكون القيمة من |
حقل الاتحاد consistency_selector وضع التناسق لهذا الطلب. وفي حال تم ترك هذه السياسة بدون ضبط، سيتم ضبط الإعدادات التلقائية على تناسق قوي. يمكن أن يكون الحقل "consistency_selector " واحدًا فقط مما يلي: |
|
read_time |
يقرأ المستندات كما كانت في الوقت المحدَّد. يجب أن يكون هذا الطابع الزمني بدقة ميكرو ثانية خلال الساعة الماضية، أو إذا تم تفعيل ميزة "استرداد نقطة زمنية"، يمكن أيضًا أن يكون طابعًا زمنيًا لدقيقة كاملة خلال آخر 7 أيام. |
ListCollectionIdsResponse
الردّ من Firestore.ListCollectionIds
الحقول | |
---|---|
collection_ids[] |
معرّفات المجموعات |
next_page_token |
رمز الصفحة الذي يمكن استخدامه لمتابعة القائمة. |
ListDocumentsRequest
الحقول | |
---|---|
parent |
مطلوبة. اسم المورد الرئيسي. بالتنسيق: على سبيل المثال: السمة |
collection_id |
اختياريّ. رقم تعريف المجموعة المرتبط بـ على سبيل المثال: هذه الخطوة اختيارية، وفي حال عدم توفيرها، ستعرض Firestore المستندات من كل المجموعات ضمن |
page_size |
اختياريّ. الحد الأقصى لعدد المستندات التي يمكن عرضها في ردّ واحد. قد تعرِض Firestore أقل من هذه القيمة. |
page_token |
اختياريّ. رمز مميّز للصفحة تم استلامه من ردّ سابق من يُرجى توفير هذا الحقل لاسترداد الصفحة التالية. عند التقسيم على صفحات، يجب أن تتطابق جميع المَعلمات الأخرى (باستثناء |
order_by |
اختياريّ. الترتيب الاختياري للمستندات التي يتم إرجاعها. مثلاً: يتطابق هذا مع |
mask |
اختياريّ. الحقول المطلوب عرضها. وفي حال تم ترك السياسة بدون ضبط، سيتم عرض جميع الحقول. إذا كان المستند يحتوي على حقل غير متوفّر في هذا القناع، لن يتم عرض هذا الحقل في الاستجابة. |
show_missing |
إذا كان من المفترض أن تعرض القائمة المستندات المفقودة يكون المستند مفقودًا إذا لم يكن متوفرًا، ولكن توجد مستندات فرعية متداخلة أسفله. عند ضبط القيمة على "صحيح"، سيتم عرض هذه المستندات الناقصة باستخدام مفتاح، ولكن لن يتم ضبط حقول أو إنّ الطلبات التي تتضمّن |
حقل الاتحاد consistency_selector وضع الاتّساق لهذه المعاملة وفي حال تم ترك هذه السياسة بدون ضبط، سيتم ضبط الإعدادات التلقائية على تناسق قوي. يمكن أن يكون الحقل "consistency_selector " واحدًا فقط مما يلي: |
|
transaction |
يمكنك إجراء القراءة كجزء من معاملة نشطة حاليًا. |
read_time |
اقرأ القراءة في الوقت المحدَّد. يجب أن يكون هذا الطابع الزمني بدقة ميكرو ثانية خلال الساعة الماضية، أو إذا تم تفعيل ميزة "استرداد نقطة زمنية"، يمكن أيضًا أن يكون طابعًا زمنيًا لدقيقة كاملة خلال آخر 7 أيام. |
ListDocumentsResponse
الردّ على Firestore.ListDocuments
.
الحقول | |
---|---|
documents[] |
المستندات التي تم العثور عليها |
next_page_token |
رمز مميز لاسترداد الصفحة التالية من المستندات. إذا تم حذف هذا الحقل، لن تكون هناك صفحات لاحقة. |
ListenRequest
طلب بقيمة Firestore.Listen
الحقول | |
---|---|
database |
مطلوبة. اسم قاعدة البيانات بالتنسيق: |
labels |
التصنيفات المرتبطة بهذا التغيير في الهدف. |
حقل الاتحاد target_change يتم تغيير الاستهداف المتوافق. يمكن أن يكون الحقل "target_change " واحدًا فقط مما يلي: |
|
add_target |
هدف مطلوب إضافته إلى مصدر البيانات هذا. |
remove_target |
رقم تعريف الاستهداف المطلوب إزالته من مصدر البيانات هذا. |
ListenResponse
الردّ على Firestore.Listen
.
الحقول | |
---|---|
حقل الاتحاد response_type تمثّل هذه السمة الردود المتوافقة. يمكن أن يكون الحقل "response_type " واحدًا فقط مما يلي: |
|
target_change |
تم تغيير الأهداف. |
document_change |
تم تغيير |
document_delete |
تم حذف |
document_remove |
تمت إزالة |
filter |
فلتر ليتم تطبيقه على مجموعة المستندات التي تم عرضها سابقًا للهدف المحدّد. يتم إرجاعه عندما ربما تمت إزالة المستندات من الهدف المحدد، ولكن المستندات الدقيقة غير معروفة. |
MapValue
قيمة خريطة
الحقول | |
---|---|
fields |
حقول الخريطة. تمثل مفاتيح الخريطة أسماء الحقول. أسماء الحقول التي تتطابق مع التعبير العادي |
PartitionQueryRequest
الحقول | |
---|---|
parent |
مطلوبة. اسم المورد الرئيسي. بالتنسيق: |
partition_count |
تمثّل هذه السمة الحد الأقصى المطلوب لعدد نقاط التقسيم. وقد يتم عرض الأقسام على مستوى عدة صفحات من النتائج. يجب أن يكون الرقم موجبًا. وقد يكون العدد الفعلي للأقسام التي يتم عرضها أقل. على سبيل المثال، يمكن ضبط ذلك على عدد أقل من عدد طلبات البحث المتوازية المطلوب تنفيذها، أو عند تشغيل مهمة مسار بيانات، أقل بمقدار واحد من عدد العاملين أو مثيلات الحوسبة المتاحة. |
page_token |
القيمة على سبيل المثال، قد يكون ناتج طلبين تاليين يستخدمان page_token هو:
للحصول على مجموعة نتائج كاملة مرتبة بالنسبة إلى نتائج طلب البحث المقدم إلى PartitionQuery، يجب دمج مجموعات النتائج: المؤشر A، المؤشر B، المؤشر M، المؤشر Q، المؤشر U، المؤشر W |
page_size |
الحد الأقصى لعدد الأقسام المطلوب عرضها في هذه المكالمة، ويخضع ذلك إلى على سبيل المثال، إذا كانت |
حقل الاتحاد query_type الاستعلام المطلوب تقسيمه. يمكن أن يكون الحقل "query_type " واحدًا فقط مما يلي: |
|
structured_query |
طلب بحث مركبة. يجب أن يحدد طلب البحث المجموعة مع كل العناصر التابعة وأن يتم ترتيبه حسب الاسم تصاعديًا. لا تتوفّر الفلاتر الأخرى وعمليات ترتيب القيم حسب النتائج والإزاحة ومؤشرات البدء/النهاية. |
حقل الاتحاد consistency_selector وضع التناسق لهذا الطلب. وفي حال تم ترك هذه السياسة بدون ضبط، سيتم ضبط الإعدادات التلقائية على تناسق قوي. يمكن أن يكون الحقل "consistency_selector " واحدًا فقط مما يلي: |
|
read_time |
يقرأ المستندات كما كانت في الوقت المحدَّد. يجب أن يكون هذا الطابع الزمني بدقة ميكرو ثانية خلال الساعة الماضية، أو إذا تم تفعيل ميزة "استرداد نقطة زمنية"، يمكن أيضًا أن يكون طابعًا زمنيًا لدقيقة كاملة خلال آخر 7 أيام. |
PartitionQueryResponse
الردّ على Firestore.PartitionQuery
.
الحقول | |
---|---|
partitions[] |
نتائج التقسيم. كل قسم هو نقطة تقسيم يمكن استخدامها بواسطة RunQuery كنقطة بداية أو نهاية لنتائج الاستعلام. يجب إجراء طلبات RunQuery باستخدام الاستعلام نفسه المُقدَّم إلى طلب PartitionQuery هذا. سيتم ترتيب مؤشرات الأقسام وفقًا لترتيب نتائج الاستعلام المقدم في PartitionQuery. على سبيل المثال، إذا كان طلب PartitionQuery يعرض مؤشري القسم A وB، سيؤدي تشغيل الاستعلامات الثلاثة التالية إلى عرض مجموعة النتائج الكاملة للاستعلام الأصلي:
قد تشير النتيجة الفارغة إلى أنّ طلب البحث يحتوي على عدد قليل جدًا من النتائج التي لا يمكن تقسيمها، أو إلى أنّ طلب البحث غير متاح للتقسيم بعد. |
next_page_token |
يشير هذا المصطلح إلى الرمز المميّز للصفحة الذي يمكن استخدامه لطلب مجموعة إضافية من النتائج، بما يصل إلى الرقم الذي يحدّده |
PlanSummary
معلومات مرحلة التخطيط للاستعلام.
الحقول | |
---|---|
indexes_used[] |
الفهارس التي تم اختيارها لطلب البحث For example: [ {"query_scope": "Collection", "properties": "(foo ASC, name ASC)"}, {"query_scope": "Collection", "properties": "(bar ASC, name ASC)"} ] |
الشرط المُسبَق
يشير ذلك المصطلح إلى شرط مسبق في مستند يُستخدم في العمليات الشرطية.
الحقول | |
---|---|
حقل الاتحاد condition_type نوع الشرط المُسبَق. يمكن أن يكون الحقل "condition_type " واحدًا فقط مما يلي: |
|
exists |
عند ضبط السياسة على |
update_time |
عند ضبط هذه السياسة، يجب أن يتوفّر المستند الهدف وأن يكون قد تم إجراء آخر تعديل له في ذلك الوقت. يجب محاذاة الطابع الزمني بالميكرو ثانية. |
RollbackRequest
طلب Firestore.Rollback
.
الحقول | |
---|---|
database |
مطلوبة. اسم قاعدة البيانات بالتنسيق: |
transaction |
مطلوبة. المعاملة المطلوب العودة إليها |
RunAggregationQueryRequest
الحقول | |
---|---|
parent |
مطلوبة. اسم المورد الرئيسي. بالتنسيق: |
explain_options |
اختياريّ. شرح خيارات الاستعلام. وفي حال ضبطها، سيتم عرض إحصاءات إضافية لطلبات البحث. إذا لم يكن مضمّنًا، سيتم عرض نتائج طلب البحث فقط. |
حقل الاتحاد query_type الاستعلام المراد تشغيله. يمكن أن يكون الحقل "query_type " واحدًا فقط مما يلي: |
|
structured_aggregation_query |
استعلام تجميع. |
حقل الاتحاد consistency_selector يتم تعيين وضع التناسق للاستعلام بشكل افتراضي على التناسق القوي. يمكن أن يكون الحقل "consistency_selector " واحدًا فقط مما يلي: |
|
transaction |
ويمكنك تنفيذ التجميع ضمن معاملة نشطة حاليًا. القيمة هنا هي معرِّف المعاملة المبهم لتنفيذ الطلب. |
new_transaction |
تبدأ معاملة جديدة كجزء من طلب البحث، مع ضبطها تلقائيًا على "للقراءة فقط". سيظهر معرِّف المعاملة الجديد كأول ردّ في ساحة المشاركات. |
read_time |
ينفّذ الطلب في الطابع الزمني المحدّد. يجب أن يكون هذا الطابع الزمني بدقة ميكرو ثانية خلال الساعة الماضية، أو إذا تم تفعيل ميزة "استرداد نقطة زمنية"، يمكن أيضًا أن يكون طابعًا زمنيًا لدقيقة كاملة خلال آخر 7 أيام. |
RunAggregationQueryResponse
الردّ على Firestore.RunAggregationQuery
.
الحقول | |
---|---|
result |
هي نتيجة تجميع واحدة. غير موجود عند الإبلاغ عن التقدم الجزئي. |
transaction |
المعاملة التي بدأت كجزء من هذا الطلب لا يتوفّر هذا الخيار إلا عند الردّ الأول عندما تم طلب بدء معاملة جديدة. |
read_time |
الوقت الذي تم فيه احتساب النتيجة الإجمالية. هذه النتيجة تتزايد دائمًا بشكل رتيب، وفي هذه الحالة، تكون نتيجة التجميع السابقة في ساحة مشاركات النتائج مضمونة لعدم تغييرها بين إذا لم يعرض طلب البحث أي نتائج، سيتم إرسال ردّ يتضمّن |
explain_metrics |
مقاييس لشرح طلبات البحث ولا تتوفّر هذه السمة إلا عند توفير السمة |
RunQueryRequest
طلب Firestore.RunQuery
.
الحقول | |
---|---|
parent |
مطلوبة. اسم المورد الرئيسي. بالتنسيق: |
explain_options |
اختياريّ. شرح خيارات الاستعلام. وفي حال ضبطها، سيتم عرض إحصاءات إضافية لطلبات البحث. إذا لم يكن مضمّنًا، سيتم عرض نتائج طلب البحث فقط. |
حقل الاتحاد query_type الاستعلام المراد تشغيله. يمكن أن يكون الحقل "query_type " واحدًا فقط مما يلي: |
|
structured_query |
طلب بحث مركبة. |
حقل الاتحاد consistency_selector وضع الاتّساق لهذه المعاملة وفي حال تم ترك هذه السياسة بدون ضبط، سيتم ضبط الإعدادات التلقائية على تناسق قوي. يمكن أن يكون الحقل "consistency_selector " واحدًا فقط مما يلي: |
|
transaction |
قم بتشغيل الاستعلام داخل معاملة نشطة بالفعل. القيمة هنا هي معرِّف المعاملة المبهم لتنفيذ الطلب. |
new_transaction |
يبدأ معاملة جديدة ويقرأ المستندات. يكون الإعداد التلقائي هو معاملة القراءة فقط. سيظهر معرِّف المعاملة الجديد كأول ردّ في ساحة المشاركات. |
read_time |
يقرأ المستندات كما كانت في الوقت المحدَّد. يجب أن يكون هذا الطابع الزمني بدقة ميكرو ثانية خلال الساعة الماضية، أو إذا تم تفعيل ميزة "استرداد نقطة زمنية"، يمكن أيضًا أن يكون طابعًا زمنيًا لدقيقة كاملة خلال آخر 7 أيام. |
RunQueryResponse
الردّ على Firestore.RunQuery
.
الحقول | |
---|---|
transaction |
المعاملة التي بدأت كجزء من هذا الطلب لا يمكن الضبط إلا في الردّ الأول، وفقط في حال ضبط |
document |
نتيجة طلب بحث، لا يتم الضبط عند الإبلاغ عن التقدم الجزئي. |
read_time |
الوقت الذي تمت فيه قراءة المستند. قد يكون هذا الأمر في تزايد مستمر، وفي هذه الحالة، نضمن عدم تغيير المستندات السابقة في سلسلة النتائج بين إذا لم يعرض طلب البحث أي نتائج، سيتم إرسال ردّ يتضمّن |
skipped_results |
عدد النتائج التي تم تخطّيها بسبب معادلة بين الردّ الأخير والحالي |
explain_metrics |
مقاييس لشرح طلبات البحث ولا تتوفّر هذه السمة إلا عند توفير السمة |
حقل الاتحاد continuation_selector وضع المتابعة لطلب البحث. في حال توفّرها، يشير ذلك إلى انتهاء بث الردّ الحالي على طلب البحث. يمكن ضبط هذه السياسة مع توفّر document أو بدونها، ولكن عند ضبطها، لا يتم عرض المزيد من النتائج. يمكن أن يكون الحقل "continuation_selector " واحدًا فقط مما يلي: |
|
done |
في حال توفُّره، يكون متجر Firestore قد أنهى الطلب بالكامل ولن يتم إرجاع المزيد من المستندات. |
StructuredAggregationQuery
استعلام Firestore لتشغيل تجميع عبر StructuredQuery
.
الحقول | |
---|---|
aggregations[] |
اختياريّ. سلسلة من التجميعات ليتم تطبيقها على نتائج المتطلبات:
|
حقل الاتحاد query_type الاستعلام الأساسي المطلوب التجميع عليه. يمكن أن يكون الحقل "query_type " واحدًا فقط مما يلي: |
|
structured_query |
الاستعلام المنظم المتداخل. |
التجميع
وتحدد عملية تجميع ينتج عنها نتيجة واحدة.
الحقول | |
---|---|
alias |
اختياريّ. اسم اختياري للحقل لتخزين نتيجة التجميع فيه. وفي حال عدم توفيره، ستختار Firestore اسمًا تلقائيًا يكون بالتنسيق
يصبح:
المتطلبات:
|
حقل الاتحاد operator نوع التجميع المطلوب تنفيذه. يمكن أن يكون الحقل "operator " واحدًا فقط مما يلي: |
|
count |
عدد مجمّعي السلع |
sum |
مجمّع تجميع المجموع |
avg |
مجمّع سلع متوسط |
Avg
متوسط قيم الحقل المطلوب.
سيتم تجميع القيم الرقمية فقط. يتم تخطّي جميع القيم غير الرقمية بما في ذلك
NULL
.وإذا كانت القيم المجمّعة تحتوي على
NaN
، سيتم عرضNaN
. تتبع رياضيات اللانهاية معايير IEEE-754.إذا كانت القيمة المجمّعة فارغة، يتم عرض
NULL
.يتم عرض النتيجة دائمًا في شكل مزدوج.
الحقول | |
---|---|
field |
الحقل المطلوب التجميع عليه. |
الإحصاء
عدد المستندات التي تطابق طلب البحث.
تعمل دالة التجميع COUNT(*)
على المستند بأكمله، لذا لا تتطلب مرجعًا للحقل.
الحقول | |
---|---|
up_to |
اختياريّ. قيد اختياري على الحد الأقصى لعدد المستندات المطلوب حسابها. يوفر هذا طريقة لتعيين حد أقصى لعدد المستندات المطلوب مسحها ضوئيًا، مما يقلل من وقت الاستجابة والتكلفة. يتم تفسير القيمة غير المحدّدة على أنّها بلا حدود. مثال عالي المستوى:
المتطلبات:
|
المجموع
مجموع قيم الحقل المطلوب.
سيتم تجميع القيم الرقمية فقط. يتم تخطّي جميع القيم غير الرقمية بما في ذلك
NULL
.وإذا كانت القيم المجمّعة تحتوي على
NaN
، سيتم عرضNaN
. تتبع رياضيات اللانهاية معايير IEEE-754.وإذا كانت مجموعة القيم المجمّعة فارغة، يتم عرض 0.
لعرض عدد صحيح 64 بت إذا كانت جميع الأرقام المجمّعة أعدادًا صحيحة ولم تتتجاوز نتيجة المجموع. وإلا، يتم عرض النتيجة كدالة مزدوجة. لاحظ أنه حتى إذا كانت جميع القيم المجمّعة أعدادًا صحيحة، يتم عرض النتيجة كمضاعفة إذا كان لا يمكن وضعها ضمن عدد صحيح موقَّع 64 بت. وعند حدوث ذلك، ستفقد القيمة التي تم إرجاعها الدقة.
عند حدوث تدفق أقل، يكون تجميع النقاط العائمة غير حتمية. هذا يعني أن تشغيل نفس الاستعلام بشكل متكرر بدون أي تغييرات على القيم الأساسية قد ينتج عنه نتائج مختلفة قليلاً في كل مرة. في هذه الحالات، يجب تخزين القيم كأعداد صحيحة فوق أرقام النقاط العائمة.
الحقول | |
---|---|
field |
الحقل المطلوب التجميع عليه. |
StructuredQuery
استعلام عن Firestore.
يتم تنفيذ مراحل الاستعلام بالترتيب التالي: 1. من 2. حيث 3. حدد 4. order_by + start_at + end_at 5. الإزاحة 6. الحد
الحقول | |
---|---|
select |
مجموعة فرعية اختيارية من الحقول المطلوب عرضها. ويكون هذا الإجراء بمثابة |
from[] |
المجموعات المطلوب البحث عنها. |
where |
الفلتر المطلوب تطبيقه. |
order_by[] |
الترتيب الذي سيتم تطبيقه على نتائج الاستعلام. تسمح Firestore للمتصلين بتقديم طلب كامل أو طلب جزئي أو عدم تقديم أي طلب على الإطلاق. في جميع الحالات، تضمن Firestore ترتيبًا مستقرًا من خلال القواعد التالية:
يتم إلحاق الحقول بنفس اتجاه الترتيب المستخدَم في الترتيب الأخير المحدَّد، أو بالحقل "ASCENDING" إذا لم يتم تحديد ترتيب. مثال:
|
start_at |
بادئة محتملة لموضع معين في مجموعة النتائج لبدء طلب البحث. يستند ترتيب مجموعة النتائج إلى عبارة
تم ترتيب نتائج طلب البحث هذا حسب ويمكن أن تشير المؤشرات إلى الترتيب الكامل أو بادئة الموقع الجغرافي، ولكنّها لا يمكن أن تشير إلى حقول أكثر من الحقول المتوفّرة في استمرارًا للمثال أعلاه، سيكون لإرفاق مؤشرات البدء التالية تأثير متفاوت:
على عكس المتطلبات:
|
end_at |
بادئة محتملة لموضع معين في النتيجة التي يتم تعيينها لإنهاء طلب البحث في. يشبه هذا العمود المتطلبات:
|
offset |
عدد المستندات المطلوب تخطيها قبل عرض النتيجة الأولى. ينطبق ذلك بعد القيود المحدَّدة في المتطلبات:
|
limit |
تمثّل هذه السمة الحد الأقصى لعدد النتائج المطلوب عرضها. ينطبق هذا الإعداد بعد جميع القيود الأخرى. المتطلبات:
|
find_nearest |
اختياريّ. بحث محتمل عن الجيران الأقرب. ينطبق بعد جميع الفلاتر والطلبات الأخرى. للعثور على أقرب تضمينات متجهة لمتجه الاستعلام المحدد. |
CollectionSelector
مجموعة من المختارات، مثل messages as m1
.
الحقول | |
---|---|
collection_id |
معرِّف المجموعة. عند ضبط السياسة، يتم اختيار المجموعات التي تحمل هذا المعرّف فقط. |
all_descendants |
عند اختيار قيمة "خطأ"، تختار فقط المجموعات التي تشكّل عناصر فرعية مباشرة لـ |
CompositeFilter
فلتر يدمج عدة فلاتر أخرى باستخدام عامل تشغيل معين.
الحقول | |
---|---|
op |
العامل للجمع بين فلاتر متعددة. |
filters[] |
قائمة الفلاتر المطلوب دمجها. المتطلبات:
|
مُشغِّل
عامل تشغيل عامل تصفية مركب.
عمليات التعداد | |
---|---|
OPERATOR_UNSPECIFIED |
غير محدد يجب عدم استخدام هذه القيمة. |
AND |
يجب توفير المستندات لاستيفاء جميع الفلاتر المجمّعة. |
OR |
يجب أن تستوفي المستندات فلترًا واحدًا على الأقل من الفلاتر المجمّعة. |
توجيه المشاهدين لاتخاذ إجراء
اتجاه الترتيب.
عمليات التعداد | |
---|---|
DIRECTION_UNSPECIFIED |
غير محدد |
ASCENDING |
تصاعدي. |
DESCENDING |
تنازلي. |
FieldFilter
فلتر على حقل معين.
الحقول | |
---|---|
field |
الحقل المطلوب الفلترة حسبه. |
op |
عامل التشغيل المطلوب الفلترة حسبه. |
value |
القيمة المطلوب المقارنة بها. |
مُشغِّل
عامل تشغيل لفلتر الحقول.
عمليات التعداد | |
---|---|
OPERATOR_UNSPECIFIED |
غير محدد يجب عدم استخدام هذه القيمة. |
LESS_THAN |
قيمة المتطلبات:
|
LESS_THAN_OR_EQUAL |
قيمة المتطلبات:
|
GREATER_THAN |
قيمة المتطلبات:
|
GREATER_THAN_OR_EQUAL |
قيمة المتطلبات:
|
EQUAL |
قيمة field المحدّدة تساوي value المحدّدة. |
NOT_EQUAL |
قيمة المتطلبات:
|
ARRAY_CONTAINS |
السمة field المحدّدة هي مصفوفة تتضمّن القيمة value المحدّدة. |
IN |
قيمة المتطلبات:
|
ARRAY_CONTAINS_ANY |
المتطلبات:
|
NOT_IN |
قيمة المتطلبات:
|
FieldReference
مرجع إلى حقل في مستند، على سبيل المثال: stats.operations
الحقول | |
---|---|
field_path |
مرجع إلى حقل في مستند. المتطلبات:
|
تصفية
عامل التصفية.
الحقول | |
---|---|
حقل الاتحاد filter_type نوع الفلتر. يمكن أن يكون الحقل "filter_type " واحدًا فقط مما يلي: |
|
composite_filter |
عامل تصفية مركب. |
field_filter |
عامل تصفية في حقل مستند. |
unary_filter |
يشير ذلك المصطلح إلى فلتر يستخدم وسيطة واحدة فقط. |
FindNearest
إعداد البحث عن الجيران الأقرب.
الحقول | |
---|---|
vector_field |
مطلوبة. حقل متجه مفهرس للبحث عنه لا يمكن عرض سوى المستندات التي تحتوي على متجهات تطابق أبعادها مع query_font. |
query_vector |
مطلوبة. متجه الاستعلام الذي نبحث عنه. يجب ألا يزيد حجم الخط المتجه عن 2048. |
distance_measure |
مطلوبة. يجب توفير مقياس المسافة المطلوب استخدامه. |
limit |
مطلوبة. عدد الجيران الأقرب المراد إرجاعهم. يجب أن يكون عددًا صحيحًا موجبًا لا يزيد عن 1000. |
DistanceMeasure
يشير ذلك المصطلح إلى مقياس المسافة المطلوب استخدامه عند مقارنة المتجهات.
عمليات التعداد | |
---|---|
DISTANCE_MEASURE_UNSPECIFIED |
يجب عدم ضبطها. |
EUCLIDEAN |
تقيس مسافة EUCLIDEAN بين المتجهات. يمكنك الاطّلاع على الإقليدية لمعرفة المزيد. |
COSINE |
تقارن المتجهات بناءً على الزاوية بينها، مما يسمح لك بقياس التشابه الذي لا يعتمد على مقدار المتجهات. نوصي باستخدام DOT_PRODUCT مع وحدة المتجهات التي تمت تسويتها بدلا من مسافة COSINE، وهي مكافئة رياضيًا مع أداء أفضل. راجِع تشابه جيب التمام لمعرفة المزيد من المعلومات. |
DOT_PRODUCT |
تشبه جيب التمام، ولكنها تتأثر بحجم المتجهات. راجِع المنتج النقطي للاطّلاع على مزيد من المعلومات. |
طلب
طلب في حقل.
الحقول | |
---|---|
field |
الحقل المطلوب الترتيب وفقًا له. |
direction |
تمثّل هذه السمة اتجاه الطلب. وتكون الإعدادات التلقائية |
الإسقاط
إسقاط حقول المستند للرجوع إليها
الحقول | |
---|---|
fields[] |
الحقول المطلوب عرضها. إذا كانت فارغة، يتم عرض جميع الحقول. لعرض اسم المستند فقط، استخدِم " |
UnaryFilter
فلتر يحتوي على معامل واحد.
الحقول | |
---|---|
op |
عامل التشغيل الأحادي المطلوب تطبيقه. |
حقل الاتحاد operand_type الوسيطة إلى عامل التصفية. يمكن أن يكون الحقل "operand_type " واحدًا فقط مما يلي: |
|
field |
الحقل الذي سيتم تطبيق عامل التشغيل عليه. |
مُشغِّل
عامل تشغيل أحادي.
عمليات التعداد | |
---|---|
OPERATOR_UNSPECIFIED |
غير محدد يجب عدم استخدام هذه القيمة. |
IS_NAN |
قيمة field المحدّدة تساوي NaN . |
IS_NULL |
قيمة field المحدّدة تساوي NULL . |
IS_NOT_NAN |
قيمة المتطلبات:
|
IS_NOT_NULL |
قيمة المتطلبات:
|
الهدف
هي عبارة عن مواصفات مجموعة من المستندات للاستماع إليها.
الحقول | |
---|---|
target_id |
رقم تعريف الاستهداف الذي يحدِّد الهدف في مصدر البيانات. يجب أن تكون القيمة رقمًا موجبًا وغير صفرية. وإذا كانت القيمة يُرجى العلم أنّه إذا أرسل العميل عدة طلبات إذا كانت قيمة |
once |
ما إذا كان يجب إزالة الهدف بعد أن يصبح حديثًا ومتسقًا. |
expected_count |
عدد المستندات التي تطابقت مع طلب البحث مؤخرًا في الرمز المميّز للسيرة الذاتية أو وقت القراءة. وهذه القيمة مناسبة فقط عند تقديم |
حقل الاتحاد target_type تمثّل هذه السمة نوع الهدف الذي تريد الاستماع إليه. يمكن أن يكون الحقل "target_type " واحدًا فقط مما يلي: |
|
query |
هدف محدد بطلب بحث. |
documents |
هدف محدد من خلال مجموعة من أسماء المستندات. |
حقل الاتحاد وفي حال تحديد هذه السياسة، سيتم عرض المستندات المطابقة التي تم تعديلها بعد |
|
resume_token |
رمز مميّز لاستئناف من ولا يُسمح باستخدام رمز مميّز للسيرة الذاتية مع هدف مختلف، وقد يتعذّر ذلك. |
read_time |
يمكنك بدء الاستماع بعد يجب أن يعرف العميل حالة المستندات المطابقة في الوقت الحالي. |
DocumentsTarget
هدف محدد من خلال مجموعة من أسماء المستندات.
الحقول | |
---|---|
documents[] |
أسماء المستندات المراد استردادها. بالتنسيق: |
QueryTarget
هدف محدد بطلب بحث.
الحقول | |
---|---|
parent |
اسم المورد الرئيسي. بالتنسيق: |
حقل الاتحاد query_type الاستعلام المراد تشغيله. يمكن أن يكون الحقل "query_type " واحدًا فقط مما يلي: |
|
structured_query |
طلب بحث مركبة. |
TargetChange
لقد تغيّرت الأهداف التي تتم مشاهدتها.
الحقول | |
---|---|
target_change_type |
نوع التغيير الذي حدث. |
target_ids[] |
أرقام تعريف الاستهدافات التي تم تغييرها. وإذا كان هذا الحقل فارغًا، سيسري التغيير على جميع الاستهدافات. لم يتم تحديد ترتيب أرقام تعريف الاستهداف. |
cause |
تمثّل هذه السمة الخطأ الذي أدى إلى هذا التغيير، إذا كان ذلك منطبقًا. |
resume_token |
يشير هذا المصطلح إلى رمز مميّز يمكن استخدامه لاستئناف البث من أجل لا يتم الضبط على كل تغيير في الهدف. |
read_time |
سمة يمكن أن تضمن مجموعة البث إرسال بالنسبة إلى بث معيّن، نضمن لك زيادة قيمة " |
TargetChangeType
نوع التغيير.
عمليات التعداد | |
---|---|
NO_CHANGE |
لم يحدث أي تغيير. تُستخدَم فقط لإرسال resume_token معدَّل. |
ADD |
تمت إضافة الاستهدافات. |
REMOVE |
تمت إزالة الاستهدافات. |
CURRENT |
تعكس الاستهدافات كل التغييرات التي تمّ تنفيذها قبل إضافة الاستهدافات إلى البث. وسيتم إرسال هذه القيم بعد أو باستخدام يمكن للمستمعين انتظار هذا التغيير إذا كانت دلالات القراءة بعد الكتابة مطلوبة. |
RESET |
تمت إعادة ضبط الاستهدافات، وسيتم عرض حالة أولية جديدة للاستهدافات في التغييرات اللاحقة. وبعد اكتمال الحالة الأولية، سيتم عرض |
TransactionOptions
خيارات إنشاء معاملة جديدة
الحقول | |
---|---|
حقل الاتحاد mode وضع المعاملة. يمكن أن يكون الحقل "mode " واحدًا فقط مما يلي: |
|
read_only |
يمكن استخدام المعاملة لعمليات القراءة فقط. |
read_write |
يمكن استخدام المعاملة لكل من عمليات القراءة والكتابة. |
ReadOnly
خيارات لمعاملة لا يمكن استخدامها إلا لقراءة المستندات.
الحقول | |
---|---|
حقل الاتحاد consistency_selector وضع الاتّساق لهذه المعاملة وفي حال تم ترك هذه السياسة بدون ضبط، سيتم ضبط الإعدادات التلقائية على تناسق قوي. يمكن أن يكون الحقل "consistency_selector " واحدًا فقط مما يلي: |
|
read_time |
يقرأ المستندات في الوقت المحدَّد. يجب أن يكون هذا الطابع الزمني بدقة ميكرو ثانية خلال الساعة الماضية، أو إذا تم تفعيل ميزة "استرداد نقطة زمنية"، يمكن أيضًا أن يكون طابعًا زمنيًا لدقيقة كاملة خلال آخر 7 أيام. |
ReadWrite
خيارات للمعاملة يمكن استخدامها لقراءة المستندات وكتابتها
لا تسمح Firestore بطلبات المصادقة من جهات خارجية لإنشاء معاملات للقراءة.
الحقول | |
---|---|
retry_transaction |
معاملة اختيارية لإعادة المحاولة. |
UpdateDocumentRequest
الحقول | |
---|---|
document |
مطلوبة. المستند المعدَّل. ينشئ المستند إذا لم يكن موجودًا من قبل. |
update_mask |
الحقول المطلوب تعديلها. لا يجوز أن يحتوي أي من مسارات الحقول في القناع على اسم محجوز. إذا كان المستند متوفّرًا على الخادم وبه حقول لا تتم الإشارة إليها في القناع، يتم تركها بدون تغيير. يتم حذف الحقول المُشار إليها في القناع ولكنها غير متوفرة في مستند الإدخال، من المستند على الخادم. |
mask |
الحقول المطلوب عرضها. وفي حال تم ترك السياسة بدون ضبط، سيتم عرض جميع الحقول. إذا كان المستند يحتوي على حقل غير متوفّر في هذا القناع، لن يتم عرض هذا الحقل في الاستجابة. |
current_document |
شرط مسبق اختياري في المستند. سيفشل الطلب إذا تم ضبط هذا الإعداد ولم يتم استيفاء هذا الطلب من خلال المستند المستهدَف. |
القيمة
رسالة قد تتضمن أيًا من أنواع القيم المسموح بها.
الحقول | |
---|---|
حقل الاتحاد value_type يجب ضبط قيمة. يمكن أن يكون الحقل "value_type " واحدًا فقط مما يلي: |
|
null_value |
قيمة فارغة. |
boolean_value |
تمثّل هذه السمة قيمة منطقية. |
integer_value |
تمثّل هذه السمة قيمة عدد صحيح. |
double_value |
تمثّل هذه السمة قيمة مزدوجة. |
timestamp_value |
قيمة طابع زمني. الدقة فقط بالميكرو ثانية. عند التخزين، يتم تقريب أي دقة إضافية إلى قيمة أقل. |
string_value |
قيمة سلسلة. يجب ألا تتجاوز السلسلة الممثَّلة بالترميز UTF-8، 1 ميغا بايت - 89 بايت. لا تضع طلبات البحث سوى أول 1,500 بايت من تمثيل UTF-8. |
bytes_value |
قيمة بايت. يجب ألا يتجاوز 1 مبيبايت و89 بايت. لا تضع طلبات البحث سوى أول 1500 بايت. |
reference_value |
مرجع إلى مستند. مثلاً: |
geo_point_value |
يشير ذلك المصطلح إلى قيمة نقطة جغرافية تمثّل نقطة على سطح الأرض. |
array_value |
تمثّل هذه السمة قيمة مصفوفة. لا يمكن أن يحتوي على قيمة صفيف أخرى مباشرةً، ولكن يمكن أن يحتوي على خريطة تحتوي على صفيف آخر. |
map_value |
قيمة خريطة |
كتابة
الكتابة على مستند.
الحقول | |
---|---|
update_mask |
الحقول المطلوب تعديلها في هذه الكتابة. لا يمكن ضبط هذا الحقل إلا عندما تكون العملية |
update_transforms[] |
عمليات التحويل المطلوب تنفيذها بعد التحديث. لا يمكن ضبط هذا الحقل إلا عندما تكون العملية |
current_document |
شرط مسبق اختياري في المستند. ستتعذّر الكتابة إذا تم ضبط ذلك ولم يتم استيفاء هذا الشرط من خلال المستند الهدف. |
حقل الاتحاد operation العملية المطلوب تنفيذها. يمكن أن يكون الحقل "operation " واحدًا فقط مما يلي: |
|
update |
وثيقة للكتابة. |
delete |
اسم المستند الذي تريد حذفه. بالتنسيق: |
transform |
يتم تطبيق عملية تحويل على مستند. |
WriteRequest
طلب Firestore.Write
.
ينشئ الطلب الأول ساحة مشاركات أو يستأنف بثًا حاليًا من رمز مميّز.
عند إنشاء بث جديد، يردّ الخادم بتقديم استجابة تحتوي فقط على معرّف ورمز مميّز لاستخدامها في الطلب التالي.
عند استئناف البث، يبث الخادم أولاً أي استجابات بعد الرمز المميّز المحدّد، ثم ردّ يحتوي على رمز مميّز محدّث فقط لاستخدامها في الطلب التالي.
الحقول | |
---|---|
database |
مطلوبة. اسم قاعدة البيانات بالتنسيق: |
stream_id |
رقم تعريف مصدر البيانات المطلوب استئنافه. يمكن ضبط هذا الخيار في الرسالة الأولى فقط. عندما يتم ترك هذا الحقل فارغًا، سيتم إنشاء ساحة مشاركات جديدة للكتابة. |
writes[] |
التعليمات المطلوب تطبيقها. يتم تنفيذها بشكل شامل وبالترتيب دائمًا. يجب أن يكون هذا الحقل فارغًا عند الطلب الأول. قد يكون هذا الحقل فارغًا في الطلب الأخير. يجب ألا يكون هذا الحقل فارغًا في جميع الطلبات الأخرى. |
stream_token |
رمز مميز للبث أرسله سابقًا الخادم. على العميل ضبط هذا الحقل على رمز مميّز من آخر قد يغلق الخادم مجموعة البث إذا كان هناك عدد كبير جدًا من الاستجابات التي تم الإبلاغ عنها. يجب عدم ضبط هذا الحقل عند إنشاء بث جديد. لاستئناف البث عند نقطة معيّنة، اضبط هذا الحقل والحقل يجب عدم ضبط هذا الحقل عند إنشاء بث جديد. |
labels |
التصنيفات المرتبطة بطلب الكتابة هذا |
WriteResponse
الردّ على Firestore.Write
.
الحقول | |
---|---|
stream_id |
رقم تعريف مصدر البيانات. يتم ضبط السياسة على الرسالة الأولى فقط عند إنشاء ساحة مشاركات جديدة. |
stream_token |
رمز مميّز يمثّل موضع هذه الاستجابة في ساحة المشاركات يمكن للعميل استخدام هذا الإجراء لاستئناف البث. يتم ضبط هذا الحقل دائمًا. |
write_results[] |
نتيجة تطبيق عمليات الكتابة. تتجاوب نتيجة الكتابة i هذه مع الكتابة i-th في الطلب. |
commit_time |
وقت حدوث الاشتراك. من خلال أيّ عملية قراءة تتضمّن |
WriteResult
نتيجة تطبيق كتابة.
الحقول | |
---|---|
update_time |
تمثّل هذه السمة وقت آخر تعديل للمستند بعد تطبيق الكتابة. لم يتم ضبطه بعد إذا لم تؤدي الكتابة إلى تغيير المستند فعليًا، سيكون هذا هو update_time السابق. |
transform_results[] |
نتائج تطبيق كل |