इंडेक्स
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
(enum)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
(enum)StructuredQuery.Direction
(enum)StructuredQuery.FieldFilter
(मैसेज)StructuredQuery.FieldFilter.Operator
(enum)StructuredQuery.FieldReference
(मैसेज)StructuredQuery.Filter
(मैसेज)StructuredQuery.FindNearest
(मैसेज)StructuredQuery.FindNearest.DistanceMeasure
(enum)StructuredQuery.Order
(मैसेज)StructuredQuery.Projection
(मैसेज)StructuredQuery.UnaryFilter
(मैसेज)StructuredQuery.UnaryFilter.Operator
(enum)Target
(मैसेज)Target.DocumentsTarget
(मैसेज)Target.QueryTarget
(मैसेज)TargetChange
(मैसेज)TargetChange.TargetChangeType
(enum)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
Firestore.BatchGetDocuments
का अनुरोध.
फ़ील्ड | |
---|---|
database |
ज़रूरी है. डेटाबेस का नाम. फ़ॉर्मैट: |
documents[] |
उन दस्तावेज़ों के नाम जिन्हें फिर से हासिल करना है. फ़ॉर्मैट: |
mask |
लौटाए जाने वाले फ़ील्ड. अगर यह नीति सेट नहीं है, तो सभी फ़ील्ड दिखाता है. अगर किसी दस्तावेज़ में ऐसा फ़ील्ड है जो इस मास्क में मौजूद नहीं है, तो जवाब में वह फ़ील्ड नहीं दिखेगा. |
यूनियन फ़ील्ड consistency_selector . इस लेन-देन के लिए अनुकूलता मोड. अगर यह नीति सेट नहीं है, तो डिफ़ॉल्ट रूप से अच्छी कंसिस्टेंसी होती है. consistency_selector इनमें से सिर्फ़ एक हो सकती है: |
|
transaction |
किसी लेन-देन में दस्तावेज़ों को पढ़ता है. |
new_transaction |
नया लेन-देन शुरू करता है और दस्तावेज़ों को पढ़ता है. डिफ़ॉल्ट तौर पर, यह लेन-देन सिर्फ़ पढ़ने के लिए होता है. नया लेन-देन आईडी, स्ट्रीम में पहले जवाब के तौर पर दिखाया जाएगा. |
read_time |
दस्तावेज़ों को उसी समय पढ़ता है जैसे वे दिए गए समय पर थे. यह पिछले एक घंटे के अंदर का माइक्रोसेकंड का सटीक टाइमस्टैंप होना चाहिए. इसके अलावा, अगर पॉइंट-इन-टाइम रिकवरी चालू है, तो यह पिछले सात दिनों में पूरे मिनट का टाइमस्टैंप भी हो सकता है. |
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
Firestore.BeginTransaction
का अनुरोध.
फ़ील्ड | |
---|---|
database |
ज़रूरी है. डेटाबेस का नाम. फ़ॉर्मैट: |
options |
लेन-देन के विकल्प. डिफ़ॉल्ट तौर पर, रीड-राइट ट्रांज़ैक्शन होता है. |
BeginTransactionResponse
Firestore.BeginTransaction
के लिए रिस्पॉन्स.
फ़ील्ड | |
---|---|
transaction |
शुरू किया गया लेन-देन. |
BitSequence
बिट का क्रम, जिसे बाइट अरे में एन्कोड किया जाता है.
bitmap
बाइट कलेक्शन के हर बाइट में, क्रम के आठ बिट सेव होते हैं. आखिरी बाइट इसका अपवाद है, जिसमें आठ या उससे कम बिट स्टोर हो सकते हैं. 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).
ब्लूम फ़िल्टर, एमडी5 वाली एंट्री को हैश करता है और इससे मिले 128-बिट हैश को दो अलग-अलग 64-बिट हैश वैल्यू के तौर पर देखता है. इन्हें, 2 की कॉम्पलिमेंट एन्कोडिंग का इस्तेमाल करके, बिना साइन वाले पूर्णांक के रूप में इंटरप्रेट किया जाता है.
इसके बाद, h1
और h2
नाम की इन दो हैश वैल्यू का इस्तेमाल, फ़ॉर्मूला की मदद से hash_count
हैश वैल्यू की गणना करने के लिए किया जाता है. यह फ़ॉर्मूला i=0
से शुरू होता है:
h(i) = h1 + (i * h2)
इसके बाद, नतीजे के तौर पर मिलने वाली इन वैल्यू को ब्लूम फ़िल्टर में बिट की संख्या के हिसाब से लिया जाता है, ताकि दी गई एंट्री की जांच करने के लिए, ब्लूम फ़िल्टर के बिट मिल सकें.
फ़ील्ड | |
---|---|
bits |
ब्लूम फ़िल्टर डेटा. |
hash_count |
एल्गोरिदम में इस्तेमाल किए गए हैश की संख्या. |
CommitRequest
Firestore.Commit
का अनुरोध.
फ़ील्ड | |
---|---|
database |
ज़रूरी है. डेटाबेस का नाम. फ़ॉर्मैट: |
writes[] |
लागू करने के लिए लेख. इसे हमेशा एटॉमिक तरीके से और क्रम में लागू किया जाता है. |
transaction |
अगर यह नीति सेट है, तो इस ट्रांज़ैक्शन में शामिल सभी टेक्स्ट लागू करता है और इसे प्रोसेस कर देता है. |
CommitResponse
Firestore.Commit
के लिए रिस्पॉन्स.
फ़ील्ड | |
---|---|
write_results[] |
लेख लागू करने का नतीजा. i-वां लिखने का यह नतीजा, अनुरोध में मौजूद i-th राइट के हिसाब से होता है. |
commit_time |
वह समय जब कार्रवाई हुई. |
CreateDocumentRequest
Firestore.CreateDocument
का अनुरोध.
फ़ील्ड | |
---|---|
parent |
ज़रूरी है. पैरंट रिसॉर्स. उदाहरण के लिए: |
collection_id |
ज़रूरी है. सूची में मौजूद, |
document_id |
इस दस्तावेज़ के लिए इस्तेमाल करने के लिए, क्लाइंट को असाइन किया गया दस्तावेज़ आईडी. ज़रूरी नहीं. अगर इसके बारे में नहीं बताया गया है, तो सेवा देने वाली कंपनी एक आईडी असाइन करेगी. |
document |
ज़रूरी है. वह दस्तावेज़ जिसे बनाना है. |
mask |
लौटाए जाने वाले फ़ील्ड. अगर यह नीति सेट नहीं है, तो सभी फ़ील्ड दिखाता है. अगर दस्तावेज़ में ऐसा फ़ील्ड है जो इस मास्क में मौजूद नहीं है, तो जवाब में वह फ़ील्ड नहीं दिखेगा. |
कर्सर
क्वेरी के नतीजे के सेट में कोई स्थिति.
फ़ील्ड | |
---|---|
values[] |
वे वैल्यू जो किसी पोज़िशन को दिखाती हैं. वे क्वेरी के क्लॉज़ के हिसाब से क्रम में दिखती हैं. इसमें क्लॉज़ के हिसाब से क्रम में तय की गई वैल्यू से कम वैल्यू हो सकती हैं. |
before |
अगर क्रम दी गई वैल्यू के ठीक पहले या बाद में है, तो क्वेरी में तय किए गए क्रम से लगाएं. |
DeleteDocumentRequest
Firestore.DeleteDocument
का अनुरोध.
फ़ील्ड | |
---|---|
name |
ज़रूरी है. मिटाए जाने वाले दस्तावेज़ के संसाधन का नाम. फ़ॉर्मैट: |
current_document |
दस्तावेज़ पर पहले से तय की गई एक वैकल्पिक शर्त. अगर यह सेट किया जाता है और टारगेट दस्तावेज़ से इसे पूरा नहीं किया जाता है, तो अनुरोध रद्द हो जाएगा. |
दस्तावेज़
Firestore दस्तावेज़.
1 एमआईबी से चार बाइट के बीच होना चाहिए.
फ़ील्ड | |
---|---|
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 |
दी गई वैल्यू को फ़ील्ड की मौजूदा वैल्यू में जोड़ता है. यह एक पूर्णांक या डबल वैल्यू होनी चाहिए. अगर फ़ील्ड, पूर्णांक या डबल नहीं है या फ़ील्ड मौजूद नहीं है, तो ट्रांसफ़ॉर्मेशन ऐक्शन, फ़ील्ड को दी गई वैल्यू पर सेट कर देगा. अगर दी गई वैल्यू या मौजूदा फ़ील्ड की वैल्यू, दोनों में से कोई भी वैल्यू दोगुनी हो, तो दोनों वैल्यू को डबल वैल्यू माना जाएगा. डबल अंकगणित और डबल वैल्यू को दिखाने से, आईईईई 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 के बराबर, और शून्य के बराबर होता है. अगर इनपुट में एक जैसी कई वैल्यू हैं, तो सिर्फ़ पहले वैल्यू को ही माना जाएगा. इससे जुड़ा transform_result शून्य मान होगा. |
remove_all_from_array |
फ़ील्ड में अरे से सभी दिए गए एलिमेंट हटाएं. अगर फ़ील्ड कोई अरे नहीं है या फ़ील्ड अब तक मौजूद नहीं है, तो उसे खाली अरे पर सेट कर दिया जाता है. किसी एलिमेंट को हटाया जाना चाहिए या नहीं, यह तय करते समय अलग-अलग टाइप की मिलती-जुलती संख्याओं (जैसे, 3L और 3.0) को बराबर माना जाता है. NaN के बराबर होता है और NaN के बराबर, और शून्य के बराबर होता है. डुप्लीकेट वैल्यू होने पर, एक जैसी सभी वैल्यू हटा दी जाएंगी. इससे जुड़ा transform_result शून्य मान होगा. |
ServerValue
सर्वर के ज़रिए कैलकुलेट की जाने वाली वैल्यू.
Enums | |
---|---|
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 |
एक ब्लूम फ़िल्टर, जिसके नाम के बावजूद, इसमें इस ब्लू फ़िल्टर को सर्वर के विवेक पर हटाया जा सकता है, जैसे कि अगर ऐसा लगता है कि क्लाइंट इसका इस्तेमाल नहीं करेगा या यह गणना या ट्रांसमिट करने के लिए बहुत महंगा है, तो ऐसा हो सकता है. क्लाइंट को यह फ़ील्ड मौजूद न होने पर, इस फ़ील्ड के मौजूद होने से पहले इस्तेमाल किए गए लॉजिक पर वापस जाकर इसे मैनेज करना होगा. इसका मतलब है कि क्लाइंट की कैश मेमोरी में मौजूद कौनसे दस्तावेज़ सिंक नहीं हैं, यह पता लगाने के लिए कि रिज़्यूमे टोकन के बिना टारगेट को फिर से जोड़ें. |
ExplainMetrics
क्वेरी की मेट्रिक के बारे में बताएं.
फ़ील्ड | |
---|---|
plan_summary |
क्वेरी के प्लानिंग फ़ेज़ की जानकारी. |
execution_stats |
क्वेरी के चलने से इकट्ठा किए गए आंकड़े. सिर्फ़ तब मौजूद होता है, जब |
ExplainOptions
क्वेरी के विकल्पों के बारे में बताएं.
फ़ील्ड | |
---|---|
analyze |
ज़रूरी नहीं. इस क्वेरी को लागू करना है या नहीं. 'गलत है' (डिफ़ॉल्ट तौर पर) होने पर, क्वेरी प्लान की जाएगी और इसमें सिर्फ़ प्लानिंग स्टेज से मेट्रिक दिखाई जाएंगी. सही होने पर, क्वेरी को प्लान करके लागू किया जाएगा. साथ ही, इससे क्वेरी के पूरे नतीजे मिलेंगे. साथ ही, प्लान बनाने और उसे लागू करने की मेट्रिक के बारे में भी पता चलेगा. |
GetDocumentRequest
Firestore.GetDocument
का अनुरोध.
फ़ील्ड | |
---|---|
name |
ज़रूरी है. जो दस्तावेज़ पाना है उसका संसाधन नाम. फ़ॉर्मैट: |
mask |
लौटाए जाने वाले फ़ील्ड. अगर यह नीति सेट नहीं है, तो सभी फ़ील्ड दिखाता है. अगर दस्तावेज़ में ऐसा फ़ील्ड है जो इस मास्क में मौजूद नहीं है, तो जवाब में वह फ़ील्ड नहीं दिखेगा. |
यूनियन फ़ील्ड consistency_selector . इस लेन-देन के लिए अनुकूलता मोड. अगर यह नीति सेट नहीं है, तो डिफ़ॉल्ट रूप से अच्छी कंसिस्टेंसी होती है. consistency_selector इनमें से सिर्फ़ एक हो सकती है: |
|
transaction |
लेन-देन में दस्तावेज़ को पढ़ता है. |
read_time |
दिए गए समय पर, दस्तावेज़ के वर्शन को पढ़ता है. यह पिछले एक घंटे के अंदर का माइक्रोसेकंड का सटीक टाइमस्टैंप होना चाहिए. इसके अलावा, अगर पॉइंट-इन-टाइम रिकवरी चालू है, तो यह पिछले सात दिनों में पूरे मिनट का टाइमस्टैंप भी हो सकता है. |
ListCollectionIdsRequest
Firestore.ListCollectionIds
का अनुरोध.
फ़ील्ड | |
---|---|
parent |
ज़रूरी है. पैरंट दस्तावेज़. फ़ॉर्मैट: |
page_size |
दिखाए जाने वाले नतीजों की ज़्यादा से ज़्यादा संख्या. |
page_token |
पेज का टोकन. |
यूनियन फ़ील्ड consistency_selector . इस अनुरोध के लिए कंसिस्टेंसी मोड. अगर यह नीति सेट नहीं है, तो डिफ़ॉल्ट रूप से अच्छी कंसिस्टेंसी होती है. consistency_selector इनमें से सिर्फ़ एक हो सकती है: |
|
read_time |
दस्तावेज़ों को उसी समय पढ़ता है जैसे वे दिए गए समय पर थे. यह पिछले एक घंटे के अंदर का माइक्रोसेकंड का सटीक टाइमस्टैंप होना चाहिए. इसके अलावा, अगर पॉइंट-इन-टाइम रिकवरी चालू है, तो यह पिछले सात दिनों में पूरे मिनट का टाइमस्टैंप भी हो सकता है. |
ListCollectionIdsResponse
Firestore.ListCollectionIds
से मिला जवाब.
फ़ील्ड | |
---|---|
collection_ids[] |
कलेक्शन आईडी. |
next_page_token |
पेज का टोकन, जिसका इस्तेमाल सूची को जारी रखने के लिए किया जा सकता है. |
ListDocumentsRequest
Firestore.ListDocuments
का अनुरोध.
फ़ील्ड | |
---|---|
parent |
ज़रूरी है. पैरंट रिसॉर्स का नाम. फ़ॉर्मैट: उदाहरण के लिए: |
collection_id |
ज़रूरी नहीं. सूची में मौजूद, उदाहरण के लिए: ऐसा करना ज़रूरी नहीं है. अगर इसे उपलब्ध नहीं कराया जाता, तो Firestore दिए गए |
page_size |
ज़रूरी नहीं. एक जवाब में लौटाए जाने वाले दस्तावेज़ों की ज़्यादा से ज़्यादा संख्या. Firestore, इस वैल्यू से कम वैल्यू दिखा सकता है. |
page_token |
ज़रूरी नहीं. बाद वाला पेज फिर से पाने के लिए यह विकल्प दें. पेज पर नंबर डालकर, |
order_by |
ज़रूरी नहीं. लौटाए जाने वाले दस्तावेज़ों का वैकल्पिक क्रम. उदाहरण के लिए: यह Firestore क्वेरी में इस्तेमाल किए गए |
mask |
ज़रूरी नहीं. लौटाए जाने वाले फ़ील्ड. अगर यह नीति सेट नहीं है, तो सभी फ़ील्ड दिखाता है. अगर किसी दस्तावेज़ में ऐसा फ़ील्ड है जो इस मास्क में मौजूद नहीं है, तो जवाब में वह फ़ील्ड नहीं दिखेगा. |
show_missing |
क्या सूची में वे दस्तावेज़ दिखेंगे जो मौजूद नहीं हैं. कोई दस्तावेज़ मौजूद न होने पर वह मौजूद नहीं होता है. हालांकि, उसके नीचे उप-दस्तावेज़ मौजूद होते हैं. सही होने पर, ऐसे दस्तावेज़ एक कुंजी के साथ दिए जाएंगे, लेकिन उनमें फ़ील्ड,
|
यूनियन फ़ील्ड consistency_selector . इस लेन-देन के लिए अनुकूलता मोड. अगर यह नीति सेट नहीं है, तो डिफ़ॉल्ट रूप से अच्छी कंसिस्टेंसी होती है. consistency_selector इनमें से सिर्फ़ एक हो सकती है: |
|
transaction |
पहले से चालू किसी लेन-देन के हिस्से के तौर पर रीड करें. |
read_time |
दिए गए समय पर रीड ऐक्शन करें. यह पिछले एक घंटे के अंदर का माइक्रोसेकंड का सटीक टाइमस्टैंप होना चाहिए. इसके अलावा, अगर पॉइंट-इन-टाइम रिकवरी चालू है, तो यह पिछले सात दिनों में पूरे मिनट का टाइमस्टैंप भी हो सकता है. |
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
Firestore.PartitionQuery
का अनुरोध.
फ़ील्ड | |
---|---|
parent |
ज़रूरी है. पैरंट रिसॉर्स का नाम. फ़ॉर्मैट: |
partition_count |
विभाजन बिंदुओं की पसंदीदा अधिकतम संख्या. सेगमेंट, नतीजों के कई पेजों पर दिखाए जा सकते हैं. संख्या धनात्मक होनी चाहिए. हो सकता है कि लौटाए गए बंटवारे की असल संख्या कम हो. उदाहरण के लिए, इसे चलाई जाने वाली पैरलल क्वेरी की संख्या से एक कम पर सेट किया जा सकता है या डेटा पाइपलाइन काम चलाने के दौरान उपलब्ध वर्कर या कंप्यूट इंस्टेंस की संख्या से कम पर सेट किया जा सकता है. |
page_token |
पार्टिशन क्वेरी को किए गए पिछले कॉल से लौटाया गया उदाहरण के लिए, page_token का इस्तेमाल करके बाद में किए जाने वाले दो कॉल वापस आ सकते हैं:
पार्टिशन क्वेरी को दी गई क्वेरी के नतीजों के हिसाब से, नतीजों का पूरा सेट पाने के लिए, नतीजों के सेट मर्ज किए जाने चाहिए: कर्सर A, कर्सर B, कर्सर M, कर्सर Q, कर्सर U, कर्सर W |
page_size |
इस कॉल में ज़्यादा से ज़्यादा उदाहरण के लिए, अगर |
यूनियन फ़ील्ड query_type . विभाजन के लिए क्वेरी. query_type इनमें से सिर्फ़ एक हो सकती है: |
|
structured_query |
स्ट्रक्चर्ड क्वेरी. क्वेरी में सभी डिसेंडेंट के साथ कलेक्शन तय होना चाहिए और नाम को बढ़ते क्रम में उनके क्रम में रखा जाना चाहिए. अन्य फ़िल्टर, क्रम, सीमा, ऑफ़सेट, और स्टार्ट/एंड कर्सर का इस्तेमाल नहीं किया जा सकता. |
यूनियन फ़ील्ड consistency_selector . इस अनुरोध के लिए कंसिस्टेंसी मोड. अगर यह नीति सेट नहीं है, तो डिफ़ॉल्ट रूप से अच्छी कंसिस्टेंसी होती है. consistency_selector इनमें से सिर्फ़ एक हो सकती है: |
|
read_time |
दस्तावेज़ों को उसी समय पढ़ता है जैसे वे दिए गए समय पर थे. यह पिछले एक घंटे के अंदर का माइक्रोसेकंड का सटीक टाइमस्टैंप होना चाहिए. इसके अलावा, अगर पॉइंट-इन-टाइम रिकवरी चालू है, तो यह पिछले सात दिनों में पूरे मिनट का टाइमस्टैंप भी हो सकता है. |
PartitionQueryResponse
Firestore.PartitionQuery
के लिए रिस्पॉन्स.
फ़ील्ड | |
---|---|
partitions[] |
विभाजन के नतीजे. हर विभाजन एक स्प्लिट पॉइंट होता है, जिसका इस्तेमाल RunQuery क्वेरी के नतीजों के लिए शुरुआती या आखिरी पॉइंट के रूप में कर सकता है. RunQuery अनुरोध उसी क्वेरी के साथ किए जाने चाहिए जो इसPartitionQuery अनुरोध की दी गई क्वेरी के साथ दी गई है. पार्टिशन क्वेरी के लिए दी गई क्वेरी के नतीजों के क्रम के मुताबिक ही सेगमेंट में कर्सर रखा जाएगा. उदाहरण के लिए, अगर कोई FamilyitionQuery अनुरोध पार्टीशन कर्सर 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
Firestore.RunAggregationQuery
का अनुरोध.
फ़ील्ड | |
---|---|
parent |
ज़रूरी है. पैरंट रिसॉर्स का नाम. फ़ॉर्मैट: |
explain_options |
ज़रूरी नहीं. क्वेरी के विकल्पों के बारे में बताएं. अगर यह सेट हो, तो क्वेरी के और आंकड़े दिखाए जाएंगे. अगर ऐसा नहीं है, तो सिर्फ़ क्वेरी के नतीजे दिखाए जाएंगे. |
यूनियन फ़ील्ड query_type . वह क्वेरी जिसे चलाना है. query_type इनमें से सिर्फ़ एक हो सकती है: |
|
structured_aggregation_query |
एग्रीगेशन क्वेरी. |
यूनियन फ़ील्ड consistency_selector . क्वेरी के लिए कंसिस्टेंसी मोड, डिफ़ॉल्ट रूप से अच्छी कंसिस्टेंसी से काम करता है. consistency_selector इनमें से सिर्फ़ एक हो सकती है: |
|
transaction |
पहले से चालू ट्रांज़ैक्शन में एग्रीगेशन चलाएं. यहां दी गई वैल्यू, क्वेरी को एक्ज़ीक्यूट करने के लिए ओपेक ट्रांज़ैक्शन आईडी है. |
new_transaction |
क्वेरी के हिस्से के तौर पर नया लेन-देन शुरू करता है, जो डिफ़ॉल्ट तौर पर सिर्फ़ रीड-ओनली मोड पर सेट है. नया लेन-देन आईडी, स्ट्रीम में पहले जवाब के तौर पर दिखाया जाएगा. |
read_time |
दिए गए टाइमस्टैंप पर क्वेरी को एक्ज़ीक्यूट करता है. यह पिछले एक घंटे के अंदर का माइक्रोसेकंड का सटीक टाइमस्टैंप होना चाहिए. इसके अलावा, अगर पॉइंट-इन-टाइम रिकवरी चालू है, तो यह पिछले सात दिनों में पूरे मिनट का टाइमस्टैंप भी हो सकता है. |
RunAggregationQueryResponse
Firestore.RunAggregationQuery
के लिए रिस्पॉन्स.
फ़ील्ड | |
---|---|
result |
एग्रीगेशन का सिर्फ़ एक नतीजा. आंशिक प्रगति की रिपोर्ट करते समय मौजूद नहीं. |
transaction |
वह लेन-देन, जो इस अनुरोध के तहत शुरू किया गया था. पहली बार जवाब देने पर सिर्फ़ तब मौजूद होगा, जब नया लेन-देन शुरू करने के अनुरोध का अनुरोध किया गया हो. |
read_time |
वह समय जब सभी नतीजों का हिसाब लगाया गया था. यह हमेशा एक ही तरह से बढ़ता रहता है. इस मामले में, नतीजे की स्ट्रीम में मौजूद पिछले Aggregatनतीजे में, यह गारंटी मिलती है कि वह अगर क्वेरी का कोई नतीजा नहीं मिलता है, तो |
explain_metrics |
क्वेरी से मेट्रिक के बारे में जानकारी मिलती है. यह जानकारी सिर्फ़ तब दिखती है, जब |
RunQueryRequest
Firestore.RunQuery
का अनुरोध.
फ़ील्ड | |
---|---|
parent |
ज़रूरी है. पैरंट रिसॉर्स का नाम. फ़ॉर्मैट: |
explain_options |
ज़रूरी नहीं. क्वेरी के विकल्पों के बारे में बताएं. अगर यह सेट हो, तो क्वेरी के और आंकड़े दिखाए जाएंगे. अगर ऐसा नहीं है, तो सिर्फ़ क्वेरी के नतीजे दिखाए जाएंगे. |
यूनियन फ़ील्ड query_type . वह क्वेरी जिसे चलाना है. query_type इनमें से सिर्फ़ एक हो सकती है: |
|
structured_query |
स्ट्रक्चर्ड क्वेरी. |
यूनियन फ़ील्ड consistency_selector . इस लेन-देन के लिए अनुकूलता मोड. अगर यह नीति सेट नहीं है, तो डिफ़ॉल्ट रूप से अच्छी कंसिस्टेंसी होती है. consistency_selector इनमें से सिर्फ़ एक हो सकती है: |
|
transaction |
पहले से चालू ट्रांज़ैक्शन में क्वेरी चलाएं. यहां दी गई वैल्यू, क्वेरी को एक्ज़ीक्यूट करने के लिए ओपेक ट्रांज़ैक्शन आईडी है. |
new_transaction |
नया लेन-देन शुरू करता है और दस्तावेज़ों को पढ़ता है. डिफ़ॉल्ट तौर पर, यह लेन-देन सिर्फ़ पढ़ने के लिए होता है. नया लेन-देन आईडी, स्ट्रीम में पहले जवाब के तौर पर दिखाया जाएगा. |
read_time |
दस्तावेज़ों को उसी समय पढ़ता है जैसे वे दिए गए समय पर थे. यह पिछले एक घंटे के अंदर का माइक्रोसेकंड का सटीक टाइमस्टैंप होना चाहिए. इसके अलावा, अगर पॉइंट-इन-टाइम रिकवरी चालू है, तो यह पिछले सात दिनों में पूरे मिनट का टाइमस्टैंप भी हो सकता है. |
RunQueryResponse
Firestore.RunQuery
के लिए रिस्पॉन्स.
फ़ील्ड | |
---|---|
transaction |
वह लेन-देन, जो इस अनुरोध के तहत शुरू किया गया था. इसे सिर्फ़ पहले जवाब में सेट किया जा सकता है. साथ ही, इसे सिर्फ़ तब सेट किया जा सकता है, जब अनुरोध में |
document |
क्वेरी का एक नतीजा, जो अधूरी प्रोग्रेस की रिपोर्ट करते समय सेट नहीं किया गया है. |
read_time |
दस्तावेज़ को पढ़े जाने का समय. ऐसा हो सकता है कि यह बढ़ोतरी एक ही बार हो. ऐसे में, इस बात की गारंटी है कि नतीजे स्ट्रीम में पिछले दस्तावेज़ों के अगर क्वेरी का कोई नतीजा नहीं मिलता है, तो |
skipped_results |
आखिरी जवाब और मौजूदा जवाब के बीच ऑफ़सेट की वजह से छोड़े गए नतीजों की संख्या. |
explain_metrics |
क्वेरी से मेट्रिक के बारे में जानकारी मिलती है. यह जानकारी सिर्फ़ तब दिखती है, जब |
यूनियन फ़ील्ड continuation_selector . क्वेरी के लिए कंटिन्यूशन मोड. अगर यह मौजूद है, तो इससे पता चलता है कि क्वेरी का मौजूदा जवाब स्ट्रीम खत्म हो गया है. इसे document के साथ या उसके बिना सेट किया जा सकता है. हालांकि, सेट होने पर और नतीजे नहीं मिलते. continuation_selector इनमें से सिर्फ़ एक हो सकती है: |
|
done |
अगर यह मौजूद है, तो Firestore ने अनुरोध को पूरी तरह से पूरा कर दिया है और कोई और दस्तावेज़ नहीं लौटाया जाएगा. |
StructuredAggregationQuery
StructuredQuery
पर एग्रीगेशन चलाने के लिए Firestore क्वेरी.
फ़ील्ड | |
---|---|
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 |
नतीजे में किसी पोज़िशन का संभावित प्रीफ़िक्स, जिससे क्वेरी शुरू होती है. नतीजे के सेट का क्रम, ओरिजनल क्वेरी के
इस क्वेरी के नतीजे कर्सर, जगह के पूरे क्रम या प्रीफ़िक्स का रेफ़रंस दे सकते हैं. हालांकि, इनमें दिए गए ऊपर दिए गए उदाहरण को जारी रखते हुए, नीचे दिए गए स्टार्ट कर्सर अटैच करने से अलग-अलग असर होगा:
शुरुआत में N नतीजों को स्किप करने के लिए, ज़रूरी है:
|
end_at |
नतीजे में किसी पोज़िशन का संभावित प्रीफ़िक्स, जिसे क्वेरी को खत्म करने के लिए सेट किया गया है. यह ज़रूरी है:
|
offset |
पहला नतीजा लौटाने से पहले स्किप किए जाने वाले दस्तावेज़ों की संख्या. यह ज़रूरी है:
|
limit |
दिखाए जाने वाले नतीजों की ज़्यादा से ज़्यादा संख्या. अन्य सभी पाबंदियों के बाद लागू होता है. ज़रूरी है:
|
find_nearest |
ज़रूरी नहीं. एक संभावित नज़दीकी पड़ोसी खोज. दूसरे सभी फ़िल्टर और ऑर्डर करने के बाद लागू होता है. दिए गए क्वेरी वेक्टर से सबसे नज़दीकी वेक्टर एम्बेड करता है. |
CollectionSelector
संग्रह का चुनाव, जैसे कि messages as m1
.
फ़ील्ड | |
---|---|
collection_id |
कलेक्शन आईडी. सेट होने पर, सिर्फ़ इस आईडी वाले कलेक्शन चुने जाते हैं. |
all_descendants |
गलत होने पर, सिर्फ़ ऐसे कलेक्शन चुनता है जो |
CompositeFilter
ऐसा फ़िल्टर जो दिए गए ऑपरेटर का इस्तेमाल करके, अन्य कई फ़िल्टर को मर्ज करता है.
फ़ील्ड | |
---|---|
op |
एक से ज़्यादा फ़िल्टर को मिलाने वाला ऑपरेटर. |
filters[] |
जोड़े जाने वाले फ़िल्टर की सूची. ज़रूरी है:
|
ऑपरेटर
कंपोज़िट फ़िल्टर ऑपरेटर.
Enums | |
---|---|
OPERATOR_UNSPECIFIED |
नहीं बताया गया है इस वैल्यू का इस्तेमाल नहीं किया जाना चाहिए. |
AND |
सभी मिले-जुले फ़िल्टर के इस्तेमाल के लिए दस्तावेज़ ज़रूरी हैं. |
OR |
दस्तावेज़, मिले-जुले कम से कम एक फ़िल्टर के हिसाब से होने चाहिए. |
डायरेक्शन
क्रम से लगाने की दिशा.
Enums | |
---|---|
DIRECTION_UNSPECIFIED |
नहीं बताया गया है |
ASCENDING |
बढ़ते क्रम में. |
DESCENDING |
घटते क्रम में. |
FieldFilter
किसी खास फ़ील्ड पर लागू फ़िल्टर.
फ़ील्ड | |
---|---|
field |
वह फ़ील्ड जिसके हिसाब से फ़िल्टर करना है. |
op |
वह ऑपरेटर जिसके हिसाब से फ़िल्टर करना है. |
value |
वह वैल्यू जिससे तुलना करनी है. |
ऑपरेटर
फ़ील्ड फ़िल्टर करने वाला ऑपरेटर.
Enums | |
---|---|
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_वेक्टर से मेल खाते हैं. |
query_vector |
ज़रूरी है. वह क्वेरी वेक्टर जिस पर हम खोज कर रहे हैं. 2048 से ज़्यादा डाइमेंशन का वेक्टर नहीं होना चाहिए. |
distance_measure |
ज़रूरी है. इस्तेमाल की जाने वाली दूरी की माप ज़रूरी है. |
limit |
ज़रूरी है. वापस आने वाले पड़ोसियों की संख्या. 1,000 से ज़्यादा का पॉज़िटिव पूर्णांक होना चाहिए. |
DistanceMeasure
वेक्टर की तुलना करते समय इस्तेमाल की जाने वाली दूरी की माप.
Enums | |
---|---|
DISTANCE_MEASURE_UNSPECIFIED |
सेट नहीं होना चाहिए. |
EUCLIDEAN |
वेक्टर के बीच EUCLIDEAN की दूरी को मापता है. ज़्यादा जानने के लिए यूक्लिडियन देखें |
COSINE |
सदिशों के बीच के कोण के आधार पर सदिशों की तुलना करता है. इससे आपको उन समानता को मापने की सुविधा मिलती है जो सदिशों के परिमाण पर आधारित नहीं होती. हमारा सुझाव है कि आप COSINE दूरी के बजाय, इकाई नॉर्मलाइज़ किए गए वेक्टर के साथ DOT_PRODUCT का इस्तेमाल करें. यह गणित के हिसाब से, बेहतर परफ़ॉर्मेंस के बराबर है. ज़्यादा जानने के लिए Cosine समानता देखें. |
DOT_PRODUCT |
कोसाइन के समान है लेकिन यह सदिशों के परिमाण से प्रभावित है. ज़्यादा जानने के लिए, Dot Product देखें. |
क्रम
फ़ील्ड पर मौजूद कोई ऑर्डर.
फ़ील्ड | |
---|---|
field |
वह फ़ील्ड जिसके हिसाब से ऑर्डर करना है. |
direction |
ऑर्डर करने के लिए निर्देश. डिफ़ॉल्ट वैल्यू |
अनुमान की रिपोर्ट
वापस किए जाने वाले दस्तावेज़ के फ़ील्ड का प्रोजेक्शन.
फ़ील्ड | |
---|---|
fields[] |
लौटाए जाने वाले फ़ील्ड. अगर कोई फ़ील्ड खाली है, तो सभी फ़ील्ड दिखाए जाते हैं. सिर्फ़ दस्तावेज़ का नाम दिखाने के लिए, |
UnaryFilter
एक ऑपरैंड वाला फ़िल्टर.
फ़ील्ड | |
---|---|
op |
लागू किया जाने वाला यूनरी ऑपरेटर. |
यूनियन फ़ील्ड operand_type . फ़िल्टर का तर्क. operand_type इनमें से सिर्फ़ एक हो सकती है: |
|
field |
वह फ़ील्ड जिस पर ऑपरेटर लागू करना है. |
ऑपरेटर
एक सिंगल ऑपरेटर.
Enums | |
---|---|
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
बदलाव किस तरह का है.
Enums | |
---|---|
NO_CHANGE |
कोई बदलाव नहीं हुआ. इसका इस्तेमाल सिर्फ़ अपडेट किया गया resume_token भेजने के लिए किया जाता है. |
ADD |
लक्ष्य जोड़ दिए गए हैं. |
REMOVE |
लक्ष्य निकाल दिए गए हैं. |
CURRENT |
ये टारगेट, स्ट्रीम में टारगेट जोड़ने से पहले किए गए सभी बदलाव दिखाते हैं. इसे अगर 'लिखने के बाद' सिमैंटिक चाहें, तो लिसनर इस बदलाव का इंतज़ार कर सकते हैं. |
RESET |
टारगेट रीसेट कर दिए गए हैं और बाद के बदलावों में टारगेट की नई शुरुआती स्थिति दिखेगी. शुरुआती स्थिति पूरी होने के बाद, |
TransactionOptions
नया लेन-देन बनाने के विकल्प.
फ़ील्ड | |
---|---|
यूनियन फ़ील्ड mode . लेन-देन का तरीका. mode इनमें से सिर्फ़ एक हो सकती है: |
|
read_only |
लेन-देन का इस्तेमाल सिर्फ़ रीड ऑपरेशन के लिए किया जा सकता है. |
read_write |
ट्रांज़ैक्शन का इस्तेमाल पढ़ने और लिखने, दोनों के लिए किया जा सकता है. |
ReadOnly
ऐसे लेन-देन के विकल्प जिनका इस्तेमाल, सिर्फ़ दस्तावेज़ों को पढ़ने के लिए किया जा सकता है.
फ़ील्ड | |
---|---|
यूनियन फ़ील्ड consistency_selector . इस लेन-देन के लिए अनुकूलता मोड. अगर यह नीति सेट नहीं है, तो डिफ़ॉल्ट रूप से अच्छी कंसिस्टेंसी होती है. consistency_selector इनमें से सिर्फ़ एक हो सकती है: |
|
read_time |
दिए गए समय में दस्तावेज़ों को पढ़ता है. यह पिछले एक घंटे के अंदर का माइक्रोसेकंड का सटीक टाइमस्टैंप होना चाहिए. इसके अलावा, अगर पॉइंट-इन-टाइम रिकवरी चालू है, तो यह पिछले सात दिनों में पूरे मिनट का टाइमस्टैंप भी हो सकता है. |
ReadWrite
लेन-देन के विकल्प, जिनका इस्तेमाल दस्तावेज़ों को पढ़ने और लिखने के लिए किया जा सकता है.
Firestore, तीसरे पक्ष के पुष्टि करने के अनुरोधों को रीड-राइट ट्रांज़ैक्शन बनाने की अनुमति नहीं देता.
फ़ील्ड | |
---|---|
retry_transaction |
फिर से कोशिश करने के लिए, लेन-देन किया जा सकता है. हालांकि, ऐसा करना ज़रूरी नहीं है. |
UpdateDocumentRequest
Firestore.UpdateDocument
का अनुरोध.
फ़ील्ड | |
---|---|
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 MiB - 89 बाइट से ज़्यादा नहीं होना चाहिए. क्वेरी में, UTF-8 प्रज़ेंटेशन के सिर्फ़ पहले 1,500 बाइट को शामिल किया जाता है. |
bytes_value |
एक बाइट वैल्यू. इसका साइज़ 1 एमबी से 89 बाइट के बीच होना चाहिए. क्वेरी में सिर्फ़ शुरुआती 1,500 बाइट पर ध्यान दिया जाता है. |
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 |
लिखने के बाद दस्तावेज़ को अपडेट करने का आखिरी समय. अगर दस्तावेज़ में बदलाव नहीं किया गया है, तो अपडेट का समय पिछला होगा. |
transform_results[] |
हर |