Package google.firestore.v1beta1

map<string, Value>

एग्रीगेशन फ़ंक्शन से मिलने वाला नतीजा, जैसे: COUNT(*) AS total_docs.

कुंजी, इनपुट पर एग्रीगेशन फ़ंक्शन को असाइन की गई alias होती है. इस मैप का साइज़, क्वेरी में मौजूद एग्रीगेशन फ़ंक्शन की संख्या के बराबर होता है.

Value

अरे में मौजूद वैल्यू.

string

ज़रूरी है. डेटाबेस का नाम. फ़ॉर्मैट: projects/{project_id}/databases/{database_id}.

string

उन दस्तावेज़ों के नाम जिन्हें फिर से हासिल करना है. फ़ॉर्मैट: projects/{project_id}/databases/{database_id}/documents/{document_path}. अगर कोई भी दस्तावेज़ दिए गए database का चाइल्ड रिसॉर्स नहीं है, तो अनुरोध रद्द कर दिया जाएगा. डुप्लीकेट नामों को हटा दिया जाएगा.

DocumentMask

लौटाए जाने वाले फ़ील्ड. अगर यह नीति सेट नहीं है, तो सभी फ़ील्ड दिखाता है.

अगर किसी दस्तावेज़ में ऐसा फ़ील्ड है जो इस मास्क में मौजूद नहीं है, तो जवाब में वह फ़ील्ड नहीं दिखेगा.

bytes

किसी लेन-देन में दस्तावेज़ों को पढ़ता है.

TransactionOptions

नया लेन-देन शुरू करता है और दस्तावेज़ों को पढ़ता है. डिफ़ॉल्ट तौर पर, यह लेन-देन सिर्फ़ पढ़ने के लिए होता है. नया लेन-देन आईडी, स्ट्रीम में पहले जवाब के तौर पर दिखाया जाएगा.

Timestamp

दस्तावेज़ों को उसी समय पढ़ता है जैसे वे दिए गए समय पर थे.

यह पिछले एक घंटे के अंदर का माइक्रोसेकंड का सटीक टाइमस्टैंप होना चाहिए. इसके अलावा, अगर पॉइंट-इन-टाइम रिकवरी चालू है, तो यह पिछले सात दिनों में पूरे मिनट का टाइमस्टैंप भी हो सकता है.

bytes

वह लेन-देन, जो इस अनुरोध के तहत शुरू किया गया था. सिर्फ़ पहले जवाब में सेट की जाएगी और सिर्फ़ तब सेट की जाएगी, जब अनुरोध में BatchGetDocumentsRequest.new_transaction को सेट किया गया हो.

Timestamp

दस्तावेज़ को पढ़े जाने का समय. ऐसा हो सकता है कि यह बढ़ोतरी एक बार में हो. इस वजह से, नतीजे स्ट्रीम में पिछले दस्तावेज़ों के पढ़ने से इस बात की गारंटी मिलती है कि उनके Read_time और इसके बीच में कोई बदलाव नहीं होगा.

Document

अनुरोध किया गया दस्तावेज़.

string

दस्तावेज़ का वह नाम है जिसका अनुरोध किया गया था, लेकिन वह मौजूद नहीं है. फ़ॉर्मैट: projects/{project_id}/databases/{database_id}/documents/{document_path}.

string

ज़रूरी है. डेटाबेस का नाम. फ़ॉर्मैट: projects/{project_id}/databases/{database_id}.

Write

लागू करने के लिए लेख.

मेथड, ऐटमली लिखने के लिए लागू नहीं होता और न ही यह गारंटी के साथ ऑर्डर देता है. हर लेख अपने-आप काम करता है या नहीं. एक ही दस्तावेज़ में हर अनुरोध के लिए, एक से ज़्यादा बार कॉन्टेंट नहीं लिखा जा सकता.

map<string, string>

इस बैच में लिखने से जुड़े लेबल.

WriteResult

लेख लागू करने का नतीजा.

i-वां लिखने का यह नतीजा, अनुरोध में मौजूद i-th राइट के हिसाब से होता है.

Status

लेख लागू करने की स्थिति.

i-th लिखने की यह स्थिति, अनुरोध में मौजूद i-th राइट के हिसाब से होती है.

string

ज़रूरी है. डेटाबेस का नाम. फ़ॉर्मैट: projects/{project_id}/databases/{database_id}.

TransactionOptions

लेन-देन के विकल्प. डिफ़ॉल्ट तौर पर, रीड-राइट ट्रांज़ैक्शन होता है.

bytes

शुरू किया गया लेन-देन.

bytes

वे बाइट जो बिट सीक्वेंस को कोड में बदलते हैं. वैल्यू की लंबाई शून्य हो सकती है.

int32

"पैडिंग" के रूप में अनदेखा करने के लिए bitmap में अंतिम बाइट के बिट की संख्या. अगर bitmap की लंबाई शून्य है, तो यह वैल्यू 0 होनी चाहिए. अगर ऐसा नहीं है, तो यह वैल्यू 0 और 7 के बीच होनी चाहिए.

BitSequence

ब्लूम फ़िल्टर डेटा.

int32

एल्गोरिदम में इस्तेमाल किए गए हैश की संख्या.

string

ज़रूरी है. डेटाबेस का नाम. फ़ॉर्मैट: projects/{project_id}/databases/{database_id}.

Write

लागू करने के लिए लेख.

इसे हमेशा एटॉमिक तरीके से और क्रम में लागू किया जाता है.

bytes

अगर यह नीति सेट है, तो इस ट्रांज़ैक्शन में शामिल सभी टेक्स्ट लागू करता है और इसे प्रोसेस कर देता है.

WriteResult

लेख लागू करने का नतीजा.

i-वां लिखने का यह नतीजा, अनुरोध में मौजूद i-th राइट के हिसाब से होता है.

Timestamp

वह समय जब कार्रवाई हुई. read_time के बराबर या उससे ज़्यादा वैल्यू वाले टेक्स्ट को पढ़ने से, अनुबंध के असर की जानकारी मिलती है.

string

ज़रूरी है. पैरंट रिसॉर्स. उदाहरण के लिए: projects/{project_id}/databases/{database_id}/documents या projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}

string

ज़रूरी है. सूची में मौजूद, parent से जुड़ा कलेक्शन आईडी. उदाहरण के लिए: chatrooms.

string

इस दस्तावेज़ के लिए इस्तेमाल करने के लिए, क्लाइंट को असाइन किया गया दस्तावेज़ आईडी.

ज़रूरी नहीं. अगर इसके बारे में नहीं बताया गया है, तो सेवा देने वाली कंपनी एक आईडी असाइन करेगी.

Document

ज़रूरी है. वह दस्तावेज़ जिसे बनाना है. name सेट नहीं होनी चाहिए.

DocumentMask

लौटाए जाने वाले फ़ील्ड. अगर यह नीति सेट नहीं है, तो सभी फ़ील्ड दिखाता है.

अगर दस्तावेज़ में ऐसा फ़ील्ड है जो इस मास्क में मौजूद नहीं है, तो जवाब में वह फ़ील्ड नहीं दिखेगा.

Value

वे वैल्यू जो किसी पोज़िशन को दिखाती हैं. वे क्वेरी के क्लॉज़ के हिसाब से क्रम में दिखती हैं.

इसमें क्लॉज़ के हिसाब से क्रम में तय की गई वैल्यू से कम वैल्यू हो सकती हैं.

bool

अगर क्रम दी गई वैल्यू के ठीक पहले या बाद में है, तो क्वेरी में तय किए गए क्रम से लगाएं.

string

ज़रूरी है. मिटाए जाने वाले दस्तावेज़ के संसाधन का नाम. फ़ॉर्मैट: projects/{project_id}/databases/{database_id}/documents/{document_path}.

Precondition

दस्तावेज़ पर पहले से तय की गई एक वैकल्पिक शर्त. अगर यह सेट किया जाता है और टारगेट दस्तावेज़ से इसे पूरा नहीं किया जाता है, तो अनुरोध रद्द हो जाएगा.

string

दस्तावेज़ का संसाधन नाम, जैसे कि projects/{project_id}/databases/{database_id}/documents/{document_path}.

map<string, Value>

Timestamp

सिर्फ़ आउटपुट के लिए. वह समय जब दस्तावेज़ बनाया गया था.

जब एक दस्तावेज़ को मिटाया जाता है और फिर से बनाया जाता है, तब यह वैल्यू एक-एक करके बढ़ जाती है. इसकी तुलना अन्य दस्तावेज़ों की वैल्यू और किसी क्वेरी के read_time से भी की जा सकती है.

Timestamp

सिर्फ़ आउटपुट के लिए. वह समय जब दस्तावेज़ को पिछली बार बदला गया था.

शुरुआत में यह वैल्यू create_time पर सेट होती है. इसके बाद, दस्तावेज़ में किए जाने वाले हर बदलाव के साथ यह वैल्यू एक महीने के हिसाब से बढ़ जाती है. इसकी तुलना अन्य दस्तावेज़ों की वैल्यू और किसी क्वेरी के read_time से भी की जा सकती है.

Document

Document की नई स्थिति.

अगर mask सेट है, तो इसमें सिर्फ़ अपडेट किए गए या जोड़े गए फ़ील्ड शामिल होते हैं.

int32

टारगेट आईडी का सेट, जो इस दस्तावेज़ से मैच होता हो.

int32

उन टारगेट के लिए टारगेट आईडी का सेट जो अब इस दस्तावेज़ से मेल नहीं खाता.

string

मिटाए गए Document का संसाधन नाम.

int32

उन टारगेट के लिए टारगेट आईडी का सेट जो पहले इस इकाई से मेल खाते थे.

Timestamp

पढ़े जाने का वह टाइमस्टैंप जब डेटा को मिटाए जाने का पता चला था.

मिटाए गए में से commit_time के बराबर या इससे ज़्यादा.

string

मास्क में फ़ील्ड पाथ की सूची. फ़ील्ड पाथ के सिंटैक्स के रेफ़रंस के लिए, Document.fields देखें.

string

उस Document का संसाधन नाम जो अब उपलब्ध नहीं है.

int32

उन टारगेट के लिए टारगेट आईडी का सेट जो पहले इस दस्तावेज़ से मैच करते थे.

Timestamp

पढ़ने का वह टाइमस्टैंप जब हटाया गया था.

बदलाव करने/मिटाने/हटाने के commit_time के बराबर या उससे ज़्यादा.

string

उस दस्तावेज़ का नाम जिसे बदलना है.

FieldTransform

दस्तावेज़ के फ़ील्ड पर लागू किए जाने वाले ट्रांसफ़ॉर्मेशन की सूची. यह खाली नहीं होना चाहिए.

string

फ़ील्ड का पाथ. फ़ील्ड पाथ के सिंटैक्स के रेफ़रंस के लिए, Document.fields देखें.

ServerValue

फ़ील्ड को दिए गए सर्वर वैल्यू पर सेट करता है.

Value

दी गई वैल्यू को फ़ील्ड की मौजूदा वैल्यू में जोड़ता है.

यह एक पूर्णांक या डबल वैल्यू होनी चाहिए. अगर फ़ील्ड, पूर्णांक या डबल नहीं है या फ़ील्ड मौजूद नहीं है, तो ट्रांसफ़ॉर्मेशन ऐक्शन, फ़ील्ड को दी गई वैल्यू पर सेट कर देगा. अगर दी गई वैल्यू या मौजूदा फ़ील्ड की वैल्यू, दोनों में से कोई भी वैल्यू दोगुनी हो, तो दोनों वैल्यू को डबल वैल्यू माना जाएगा. डबल अंकगणित और डबल वैल्यू को दिखाने से, आईईईई 754 के सिमैंटिक का पालन होता है. अगर यह पॉज़िटिव/नेगेटिव पूर्णांक ओवरफ़्लो है, तो फ़ील्ड को सबसे बड़े मैग्निट्यूड पॉज़िटिव/नेगेटिव पूर्णांक के तौर पर सेट किया जाता है.

Value

फ़ील्ड को उसकी मौजूदा वैल्यू और दी गई वैल्यू में से ज़्यादा से ज़्यादा पर सेट करता है.

यह एक पूर्णांक या डबल वैल्यू होनी चाहिए. अगर फ़ील्ड, पूर्णांक या डबल नहीं है या फ़ील्ड मौजूद नहीं है, तो ट्रांसफ़ॉर्मेशन ऐक्शन, फ़ील्ड को दी गई वैल्यू पर सेट कर देगा. अगर फ़ील्ड और इनपुट वैल्यू के मिले-जुले टाइप (जैसे, एक पूर्णांक है और दूसरा डबल है) और उस फ़ील्ड में, सबसे ज़्यादा ऑपरेशन लागू होता है, तो फ़ील्ड बड़े ऑपरेंड के टाइप पर आ जाता है. अगर ऑपरेंड बराबर हैं (उदाहरण के लिए, 3 और 3.0), तो फ़ील्ड में बदलाव नहीं होता है. 0, 0.0, और -0.0 शून्य हैं. स्टोर में सेव की गई ज़्यादा से ज़्यादा वैल्यू और शून्य इनपुट वैल्यू, हमेशा स्टोर की गई वैल्यू होती है. किसी भी संख्या वाली वैल्यू x और NaN की ज़्यादा से ज़्यादा वैल्यू NaN होती है.

Value

फ़ील्ड को उसकी मौजूदा वैल्यू और दी गई वैल्यू के कम से कम पर सेट करता है.

यह एक पूर्णांक या डबल वैल्यू होनी चाहिए. अगर फ़ील्ड, पूर्णांक या डबल नहीं है या फ़ील्ड अब तक मौजूद नहीं है, तो ट्रांसफ़ॉर्मेशन ऐक्शन, फ़ील्ड को इनपुट वैल्यू पर सेट कर देगा. अगर फ़ील्ड और इनपुट वैल्यू के मिले-जुले टाइप (इसका मतलब है कि एक पूर्णांक है और एक डबल है) और यहां पर एक कम से कम ऑपरेशन लागू किया जाता है, तो फ़ील्ड छोटे ऑपरैंड के टाइप पर काम करता है. अगर ऑपरेंड बराबर हैं (उदाहरण के लिए, 3 और 3.0), तो फ़ील्ड में बदलाव नहीं होता है. 0, 0.0, और -0.0 शून्य हैं. स्टोर की गई वैल्यू के तौर पर कम से कम वैल्यू, स्टोर की गई वैल्यू के तौर पर और शून्य इनपुट वैल्यू को हमेशा स्टोर की गई वैल्यू के तौर पर दिखाया जाता है. किसी भी संख्या वाली वैल्यू x और NaN के बीच की कम से कम वैल्यू NaN होती है.

ArrayValue

अगर दिए गए एलिमेंट मौजूदा फ़ील्ड वैल्यू में पहले से मौजूद नहीं हैं, तो उन्हें क्रम में जोड़ें. अगर फ़ील्ड कोई अरे नहीं है या फ़ील्ड अब तक मौजूद नहीं है, तो सबसे पहले उसे खाली अरे पर सेट किया जाता है.

अगर कोई वैल्यू मौजूद नहीं है, तो अलग-अलग टाइप की मिलती-जुलती संख्याओं (जैसे कि 3L और 3.0) को एक जैसा माना जाता है. NaN के बराबर होता है और NaN के बराबर, और शून्य के बराबर होता है. अगर इनपुट में एक जैसी कई वैल्यू हैं, तो सिर्फ़ पहले वैल्यू को ही माना जाएगा.

इससे जुड़ा transform_result शून्य मान होगा.

ArrayValue

फ़ील्ड में अरे से सभी दिए गए एलिमेंट हटाएं. अगर फ़ील्ड कोई अरे नहीं है या फ़ील्ड अब तक मौजूद नहीं है, तो उसे खाली अरे पर सेट कर दिया जाता है.

किसी एलिमेंट को हटाया जाना चाहिए या नहीं, यह तय करते समय अलग-अलग टाइप की मिलती-जुलती संख्याओं (जैसे, 3L और 3.0) को बराबर माना जाता है. NaN के बराबर होता है और NaN के बराबर, और शून्य के बराबर होता है. डुप्लीकेट वैल्यू होने पर, एक जैसी सभी वैल्यू हटा दी जाएंगी.

इससे जुड़ा transform_result शून्य मान होगा.

int64

लौटाए गए नतीजों की कुल संख्या, जिनमें दस्तावेज़, प्रोजेक्शन, एग्रीगेशन के नतीजे, कुंजियां शामिल हैं.

Duration

बैकएंड में क्वेरी चलाने का कुल समय.

int64

बिल करने लायक कुल रीड ऑपरेशन.

Struct

क्वेरी के निष्पादन से आंकड़ों को डीबग करना. ध्यान दें कि Firestore के बेहतर होने पर, डीबग करने के आंकड़ों में बदलाव हो सकता है. It could include: { "indexes_entries_scanned": "1000", "documents_scanned": "20", "billing_details" : { "documents_billable": "20", "index_entries_billable": "1000", "min_query_cost": "0" } }

int32

वह टारगेट आईडी जिस पर यह फ़िल्टर लागू होता है.

int32

target_id से मेल खाने वाले दस्तावेज़ों की कुल संख्या.

क्लाइंट में मौजूद दस्तावेज़ों की संख्या मेल खाने वाले दस्तावेज़ों की संख्या से अलग होने पर, क्लाइंट को मैन्युअल रूप से यह तय करना होगा कि कौनसे दस्तावेज़ अब टारगेट से मेल नहीं खाते.

फ़िल्टर के ख़िलाफ़ सभी दस्तावेज़ों के नामों की जांच करके क्लाइंट, unchanged_names ब्लूम फ़िल्टर का इस्तेमाल कर सकता है. अगर दस्तावेज़ का नाम फ़िल्टर में नहीं है, तो इसका मतलब है कि दस्तावेज़, टारगेट से मेल नहीं खाता.

BloomFilter

एक ब्लूम फ़िल्टर, जिसके नाम के बावजूद, इसमें target_id से मेल खाने वाले सभी दस्तावेज़ों के रिसॉर्स के नाम की, UTF-8 बाइट एन्कोडिंग, projects/{project_id}/databases/{database_id}/documents/{document_path} के तौर पर होती हैं.

इस ब्लू फ़िल्टर को सर्वर के विवेक पर हटाया जा सकता है, जैसे कि अगर ऐसा लगता है कि क्लाइंट इसका इस्तेमाल नहीं करेगा या यह गणना या ट्रांसमिट करने के लिए बहुत महंगा है, तो ऐसा हो सकता है. क्लाइंट को यह फ़ील्ड मौजूद न होने पर, इस फ़ील्ड के मौजूद होने से पहले इस्तेमाल किए गए लॉजिक पर वापस जाकर इसे मैनेज करना होगा. इसका मतलब है कि क्लाइंट की कैश मेमोरी में मौजूद कौनसे दस्तावेज़ सिंक नहीं हैं, यह पता लगाने के लिए कि रिज़्यूमे टोकन के बिना टारगेट को फिर से जोड़ें.

PlanSummary

क्वेरी के प्लानिंग फ़ेज़ की जानकारी.

ExecutionStats

क्वेरी के चलने से इकट्ठा किए गए आंकड़े. सिर्फ़ तब मौजूद होता है, जब ExplainOptions.analyze को 'सही है' पर सेट किया जाता है.

bool

ज़रूरी नहीं. इस क्वेरी को लागू करना है या नहीं.

'गलत है' (डिफ़ॉल्ट तौर पर) होने पर, क्वेरी प्लान की जाएगी और इसमें सिर्फ़ प्लानिंग स्टेज से मेट्रिक दिखाई जाएंगी.

सही होने पर, क्वेरी को प्लान करके लागू किया जाएगा. साथ ही, इससे क्वेरी के पूरे नतीजे मिलेंगे. साथ ही, प्लान बनाने और उसे लागू करने की मेट्रिक के बारे में भी पता चलेगा.

string

ज़रूरी है. जो दस्तावेज़ पाना है उसका संसाधन नाम. फ़ॉर्मैट: projects/{project_id}/databases/{database_id}/documents/{document_path}.

DocumentMask

लौटाए जाने वाले फ़ील्ड. अगर यह नीति सेट नहीं है, तो सभी फ़ील्ड दिखाता है.

अगर दस्तावेज़ में ऐसा फ़ील्ड है जो इस मास्क में मौजूद नहीं है, तो जवाब में वह फ़ील्ड नहीं दिखेगा.

bytes

लेन-देन में दस्तावेज़ को पढ़ता है.

Timestamp

दिए गए समय पर, दस्तावेज़ के वर्शन को पढ़ता है.

यह पिछले एक घंटे के अंदर का माइक्रोसेकंड का सटीक टाइमस्टैंप होना चाहिए. इसके अलावा, अगर पॉइंट-इन-टाइम रिकवरी चालू है, तो यह पिछले सात दिनों में पूरे मिनट का टाइमस्टैंप भी हो सकता है.

string

ज़रूरी है. पैरंट दस्तावेज़. फ़ॉर्मैट: projects/{project_id}/databases/{database_id}/documents/{document_path}. उदाहरण के लिए: projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

int32

दिखाए जाने वाले नतीजों की ज़्यादा से ज़्यादा संख्या.

string

पेज का टोकन. ListCollectionIdsResponse का मान होना चाहिए.

Timestamp

दस्तावेज़ों को उसी समय पढ़ता है जैसे वे दिए गए समय पर थे.

यह पिछले एक घंटे के अंदर का माइक्रोसेकंड का सटीक टाइमस्टैंप होना चाहिए. इसके अलावा, अगर पॉइंट-इन-टाइम रिकवरी चालू है, तो यह पिछले सात दिनों में पूरे मिनट का टाइमस्टैंप भी हो सकता है.

string

कलेक्शन आईडी.

string

पेज का टोकन, जिसका इस्तेमाल सूची को जारी रखने के लिए किया जा सकता है.

string

ज़रूरी है. पैरंट रिसॉर्स का नाम. फ़ॉर्मैट: projects/{project_id}/databases/{database_id}/documents या projects/{project_id}/databases/{database_id}/documents/{document_path}.

उदाहरण के लिए: projects/my-project/databases/my-database/documents या projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

string

ज़रूरी नहीं. सूची में मौजूद, parent से जुड़ा कलेक्शन आईडी.

उदाहरण के लिए: chatrooms या messages.

ऐसा करना ज़रूरी नहीं है. अगर इसे उपलब्ध नहीं कराया जाता, तो Firestore दिए गए parent के तहत सभी कलेक्शन के दस्तावेज़ों की सूची बना देगा.

int32

ज़रूरी नहीं. एक जवाब में लौटाए जाने वाले दस्तावेज़ों की ज़्यादा से ज़्यादा संख्या.

Firestore, इस वैल्यू से कम वैल्यू दिखा सकता है.

string

ज़रूरी नहीं. ListDocuments के पिछले जवाब से मिला पेज टोकन.

बाद वाला पेज फिर से पाने के लिए यह विकल्प दें. पेज पर नंबर डालकर, page_size को छोड़कर अन्य सभी पैरामीटर, पेज टोकन जनरेट करने वाले अनुरोध में सेट की गई वैल्यू से मैच होना चाहिए.

string

ज़रूरी नहीं. लौटाए जाने वाले दस्तावेज़ों का वैकल्पिक क्रम.

उदाहरण के लिए: priority desc, __name__ desc.

यह Firestore क्वेरी में इस्तेमाल किए गए ORDER BY के डेटा की डुप्लीकेट कॉपी बनाता है, लेकिन स्ट्रिंग प्रज़ेंटेशन में करता है. मौजूद नहीं होने पर, दस्तावेज़ों का क्रम __name__ ASC के हिसाब से लगाया जाता है.

DocumentMask

ज़रूरी नहीं. लौटाए जाने वाले फ़ील्ड. अगर यह नीति सेट नहीं है, तो सभी फ़ील्ड दिखाता है.

अगर किसी दस्तावेज़ में ऐसा फ़ील्ड है जो इस मास्क में मौजूद नहीं है, तो जवाब में वह फ़ील्ड नहीं दिखेगा.

bool

क्या सूची में वे दस्तावेज़ दिखेंगे जो मौजूद नहीं हैं.

कोई दस्तावेज़ मौजूद न होने पर वह मौजूद नहीं होता है. हालांकि, उसके नीचे उप-दस्तावेज़ मौजूद होते हैं. सही होने पर, ऐसे दस्तावेज़ एक कुंजी के साथ दिए जाएंगे, लेकिन उनमें फ़ील्ड, create_time या update_time सेट नहीं होगा.

show_missing से किए गए अनुरोधों में where या order_by के बारे में जानकारी नहीं दी जा सकती.

bytes

पहले से चालू किसी लेन-देन के हिस्से के तौर पर रीड करें.

Timestamp

दिए गए समय पर रीड ऐक्शन करें.

यह पिछले एक घंटे के अंदर का माइक्रोसेकंड का सटीक टाइमस्टैंप होना चाहिए. इसके अलावा, अगर पॉइंट-इन-टाइम रिकवरी चालू है, तो यह पिछले सात दिनों में पूरे मिनट का टाइमस्टैंप भी हो सकता है.

Document

दस्तावेज़ मिल गए हैं.

string

दस्तावेज़ों का अगला पेज फिर से पाने के लिए टोकन.

अगर इस फ़ील्ड को खाली छोड़ा जाता है, तो इसके बाद कोई पेज नहीं होगा.

string

ज़रूरी है. डेटाबेस का नाम. फ़ॉर्मैट: projects/{project_id}/databases/{database_id}.

map<string, string>

इस टारगेट से जुड़े लेबल.

Target

इस स्ट्रीम में जोड़ने के लिए टारगेट.

int32

इस स्ट्रीम से हटाए जाने वाले टारगेट का आईडी.

TargetChange

टारगेट बदल गए हैं.

DocumentChange

Document बदल गया है.

DocumentDelete

Document मिटाया गया.

DocumentRemove

टारगेट से Document हटा दिया गया है (क्योंकि यह अब उस टारगेट के लिए काम का नहीं है).

ExistenceFilter

किसी टारगेट के लिए, पहले दिखाए गए दस्तावेज़ों के सेट पर लागू करने वाला फ़िल्टर.

दिए गए टारगेट से दस्तावेज़ों को हटाए जाने पर वापस लौटाया जाता है, लेकिन सटीक दस्तावेज़ों की जानकारी नहीं है.

map<string, Value>

मैप के फ़ील्ड.

मैप कुंजियां, फ़ील्ड के नाम दिखाती हैं. रेगुलर एक्सप्रेशन __.*__ से मेल खाने वाले फ़ील्ड नाम रिज़र्व हैं. दस्तावेज़ में दर्ज कॉन्टेक्स्ट को छोड़कर, रिज़र्व किए गए फ़ील्ड के नामों का इस्तेमाल नहीं किया जा सकता है. UTF-8 के रूप में दिखाई जाने वाली मैप कुंजियों की साइज़ 1,500 बाइट से ज़्यादा नहीं होनी चाहिए और यह खाली नहीं हो सकती.

string

ज़रूरी है. पैरंट रिसॉर्स का नाम. फ़ॉर्मैट: projects/{project_id}/databases/{database_id}/documents. दस्तावेज़ के रिसॉर्स के नाम काम नहीं करते. सिर्फ़ डेटाबेस रिसॉर्स के नाम तय किए जा सकते हैं.

int64

विभाजन बिंदुओं की पसंदीदा अधिकतम संख्या. सेगमेंट, नतीजों के कई पेजों पर दिखाए जा सकते हैं. संख्या धनात्मक होनी चाहिए. हो सकता है कि लौटाए गए बंटवारे की असल संख्या कम हो.

उदाहरण के लिए, इसे चलाई जाने वाली पैरलल क्वेरी की संख्या से एक कम पर सेट किया जा सकता है या डेटा पाइपलाइन काम चलाने के दौरान उपलब्ध वर्कर या कंप्यूट इंस्टेंस की संख्या से कम पर सेट किया जा सकता है.

string

पार्टिशन क्वेरी को किए गए पिछले कॉल से लौटाया गया next_page_token मान, जिसका इस्तेमाल नतीजों का और भी सेट पाने के लिए किया जा सकता है. नतीजों के सेट के बीच ऑर्डर के क्रम की कोई गारंटी नहीं है. इसलिए, नतीजों के कई सेट का इस्तेमाल करने के लिए, नतीजों के अलग-अलग सेट को मर्ज करना होगा.

उदाहरण के लिए, page_token का इस्तेमाल करके बाद में किए जाने वाले दो कॉल वापस आ सकते हैं:

• कर्सर B, कर्सर M, कर्सर Q
• कर्सर A, कर्सर U, कर्सर W

पार्टिशन क्वेरी को दी गई क्वेरी के नतीजों के हिसाब से, नतीजों का पूरा सेट पाने के लिए, नतीजों के सेट मर्ज किए जाने चाहिए: कर्सर A, कर्सर B, कर्सर M, कर्सर Q, कर्सर U, कर्सर W

int32

इस कॉल में ज़्यादा से ज़्यादा partition_count पार्टीशन किए जा सकते हैं.

उदाहरण के लिए, अगर partition_count = 10 और page_size = 8 है, तो पार्टिशन क्वेरी का पहला कॉल 8 पार्टीशन तक दिखाएगा और ज़्यादा नतीजे मौजूद होने पर next_page_token दिखाएगा. पार्टिशन क्वेरी को दूसरी कॉल करने पर 2 पार्टीशन तक दिखाई देंगे, ताकि partition_count में दिए गए कुल 10 सेगमेंट को पूरा किया जा सके.

StructuredQuery

स्ट्रक्चर्ड क्वेरी. क्वेरी में सभी डिसेंडेंट के साथ कलेक्शन तय होना चाहिए और नाम को बढ़ते क्रम में उनके क्रम में रखा जाना चाहिए. अन्य फ़िल्टर, क्रम, सीमा, ऑफ़सेट, और स्टार्ट/एंड कर्सर का इस्तेमाल नहीं किया जा सकता.

Timestamp

दस्तावेज़ों को उसी समय पढ़ता है जैसे वे दिए गए समय पर थे.

यह पिछले एक घंटे के अंदर का माइक्रोसेकंड का सटीक टाइमस्टैंप होना चाहिए. इसके अलावा, अगर पॉइंट-इन-टाइम रिकवरी चालू है, तो यह पिछले सात दिनों में पूरे मिनट का टाइमस्टैंप भी हो सकता है.

Cursor

विभाजन के नतीजे. हर विभाजन एक स्प्लिट पॉइंट होता है, जिसका इस्तेमाल RunQuery क्वेरी के नतीजों के लिए शुरुआती या आखिरी पॉइंट के रूप में कर सकता है. RunQuery अनुरोध उसी क्वेरी के साथ किए जाने चाहिए जो इसPartitionQuery अनुरोध की दी गई क्वेरी के साथ दी गई है. पार्टिशन क्वेरी के लिए दी गई क्वेरी के नतीजों के क्रम के मुताबिक ही सेगमेंट में कर्सर रखा जाएगा.

उदाहरण के लिए, अगर कोई FamilyitionQuery अनुरोध पार्टीशन कर्सर A और B दिखाता है, तो नीचे दी गई तीन क्वेरी चलाने पर मूल क्वेरी का पूरा नतीजा दिखेगा:

• क्वेरी, end_at A
• क्वेरी, start_at A, end_at B
• क्वेरी, start_at B

एक खाली नतीजे का मतलब यह हो सकता है कि क्वेरी में बांटने के लिए बहुत कम नतीजे हैं या क्वेरी को सेगमेंट में बांटने के लिए फ़िलहाल काम नहीं किया जा सकता.

string

पेज का टोकन, जिसका इस्तेमाल नतीजों के अतिरिक्त सेट का अनुरोध करने के लिए किया जा सकता है. यह पार्टिशन क्वेरी अनुरोध में partition_count से बताई गई संख्या तक हो सकता है. अगर यह फ़ील्ड खाली है, तो कोई और नतीजा नहीं दिखेगा.

Struct

क्वेरी के लिए चुने गए इंडेक्स. For example: [ {"query_scope": "Collection", "properties": "(foo ASC, name ASC)"}, {"query_scope": "Collection", "properties": "(bar ASC, name ASC)"} ]

bool

अगर नीति को true पर सेट किया जाता है, तो टारगेट दस्तावेज़ मौजूद होना चाहिए. अगर नीति को false पर सेट किया जाता है, तो टारगेट दस्तावेज़ मौजूद नहीं होना चाहिए.

Timestamp

सेट होने पर, टारगेट दस्तावेज़ मौजूद होना चाहिए. साथ ही, उसे उस समय आखिरी बार अपडेट किया गया हो. टाइमस्टैंप को माइक्रोसेकंड में अलाइन किया जाना चाहिए.

string

ज़रूरी है. डेटाबेस का नाम. फ़ॉर्मैट: projects/{project_id}/databases/{database_id}.

bytes

ज़रूरी है. रोल बैक किया जाने वाला लेन-देन.

string

ज़रूरी है. पैरंट रिसॉर्स का नाम. फ़ॉर्मैट: projects/{project_id}/databases/{database_id}/documents या projects/{project_id}/databases/{database_id}/documents/{document_path}. उदाहरण के लिए: projects/my-project/databases/my-database/documents या projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

ExplainOptions

ज़रूरी नहीं. क्वेरी के विकल्पों के बारे में बताएं. अगर यह सेट हो, तो क्वेरी के और आंकड़े दिखाए जाएंगे. अगर ऐसा नहीं है, तो सिर्फ़ क्वेरी के नतीजे दिखाए जाएंगे.

StructuredAggregationQuery

एग्रीगेशन क्वेरी.

bytes

पहले से चालू ट्रांज़ैक्शन में एग्रीगेशन चलाएं.

यहां दी गई वैल्यू, क्वेरी को एक्ज़ीक्यूट करने के लिए ओपेक ट्रांज़ैक्शन आईडी है.

TransactionOptions

क्वेरी के हिस्से के तौर पर नया लेन-देन शुरू करता है, जो डिफ़ॉल्ट तौर पर सिर्फ़ रीड-ओनली मोड पर सेट है.

नया लेन-देन आईडी, स्ट्रीम में पहले जवाब के तौर पर दिखाया जाएगा.

Timestamp

दिए गए टाइमस्टैंप पर क्वेरी को एक्ज़ीक्यूट करता है.

यह पिछले एक घंटे के अंदर का माइक्रोसेकंड का सटीक टाइमस्टैंप होना चाहिए. इसके अलावा, अगर पॉइंट-इन-टाइम रिकवरी चालू है, तो यह पिछले सात दिनों में पूरे मिनट का टाइमस्टैंप भी हो सकता है.

AggregationResult

एग्रीगेशन का सिर्फ़ एक नतीजा.

आंशिक प्रगति की रिपोर्ट करते समय मौजूद नहीं.

bytes

वह लेन-देन, जो इस अनुरोध के तहत शुरू किया गया था.

पहली बार जवाब देने पर सिर्फ़ तब मौजूद होगा, जब नया लेन-देन शुरू करने के अनुरोध का अनुरोध किया गया हो.

Timestamp

वह समय जब सभी नतीजों का हिसाब लगाया गया था. यह हमेशा एक ही तरह से बढ़ता रहता है. इस मामले में, नतीजे की स्ट्रीम में मौजूद पिछले Aggregatनतीजे में, यह गारंटी मिलती है कि वह read_time और इसके बीच में कोई बदलाव नहीं करेगा.

अगर क्वेरी का कोई नतीजा नहीं मिलता है, तो read_time वाला जवाब भेजा जाएगा और कोई result नहीं भेजा जाएगा. इससे पता चलता है कि क्वेरी कब चलाई गई थी.

ExplainMetrics

क्वेरी से मेट्रिक के बारे में जानकारी मिलती है. यह जानकारी सिर्फ़ तब दिखती है, जब RunAggregationQueryRequest.explain_options दिया गया हो. साथ ही, स्ट्रीम में आखिरी जवाब के साथ इसे सिर्फ़ एक बार भेजा जाता है.

string

ज़रूरी है. पैरंट रिसॉर्स का नाम. फ़ॉर्मैट: projects/{project_id}/databases/{database_id}/documents या projects/{project_id}/databases/{database_id}/documents/{document_path}. उदाहरण के लिए: projects/my-project/databases/my-database/documents या projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

ExplainOptions

ज़रूरी नहीं. क्वेरी के विकल्पों के बारे में बताएं. अगर यह सेट हो, तो क्वेरी के और आंकड़े दिखाए जाएंगे. अगर ऐसा नहीं है, तो सिर्फ़ क्वेरी के नतीजे दिखाए जाएंगे.

StructuredQuery

स्ट्रक्चर्ड क्वेरी.

bytes

पहले से चालू ट्रांज़ैक्शन में क्वेरी चलाएं.

यहां दी गई वैल्यू, क्वेरी को एक्ज़ीक्यूट करने के लिए ओपेक ट्रांज़ैक्शन आईडी है.

TransactionOptions

नया लेन-देन शुरू करता है और दस्तावेज़ों को पढ़ता है. डिफ़ॉल्ट तौर पर, यह लेन-देन सिर्फ़ पढ़ने के लिए होता है. नया लेन-देन आईडी, स्ट्रीम में पहले जवाब के तौर पर दिखाया जाएगा.

Timestamp

दस्तावेज़ों को उसी समय पढ़ता है जैसे वे दिए गए समय पर थे.

यह पिछले एक घंटे के अंदर का माइक्रोसेकंड का सटीक टाइमस्टैंप होना चाहिए. इसके अलावा, अगर पॉइंट-इन-टाइम रिकवरी चालू है, तो यह पिछले सात दिनों में पूरे मिनट का टाइमस्टैंप भी हो सकता है.

bytes

वह लेन-देन, जो इस अनुरोध के तहत शुरू किया गया था. इसे सिर्फ़ पहले जवाब में सेट किया जा सकता है. साथ ही, इसे सिर्फ़ तब सेट किया जा सकता है, जब अनुरोध में RunQueryRequest.new_transaction को सेट किया गया हो. अगर यह नीति सेट है, तो इस जवाब में कोई और फ़ील्ड सेट नहीं किया जाएगा.

Document

क्वेरी का एक नतीजा, जो अधूरी प्रोग्रेस की रिपोर्ट करते समय सेट नहीं किया गया है.

Timestamp

दस्तावेज़ को पढ़े जाने का समय. ऐसा हो सकता है कि यह बढ़ोतरी एक ही बार हो. ऐसे में, इस बात की गारंटी है कि नतीजे स्ट्रीम में पिछले दस्तावेज़ों के read_time और इस दस्तावेज़ के बीच कोई बदलाव नहीं होगा.

अगर क्वेरी का कोई नतीजा नहीं मिलता है, तो read_time वाला जवाब भेजा जाएगा और कोई document नहीं भेजा जाएगा. इससे पता चलता है कि क्वेरी कब चलाई गई थी.

int32

आखिरी जवाब और मौजूदा जवाब के बीच ऑफ़सेट की वजह से छोड़े गए नतीजों की संख्या.

ExplainMetrics

क्वेरी से मेट्रिक के बारे में जानकारी मिलती है. यह जानकारी सिर्फ़ तब दिखती है, जब RunQueryRequest.explain_options दिया गया हो. साथ ही, स्ट्रीम में आखिरी जवाब के साथ इसे सिर्फ़ एक बार भेजा जाता है.

bool

अगर यह मौजूद है, तो Firestore ने अनुरोध को पूरी तरह से पूरा कर दिया है और कोई और दस्तावेज़ नहीं लौटाया जाएगा.

Aggregation

ज़रूरी नहीं. structured_query के नतीजों पर लागू करने के लिए एग्रीगेशन की सीरीज़.

ज़रूरी है:

• हर क्वेरी के लिए कम से कम एक और ज़्यादा से ज़्यादा पांच एग्रीगेशन.

StructuredQuery

नेस्ट की गई स्ट्रक्चर्ड क्वेरी.

string

ज़रूरी नहीं. एग्रीगेशन के नतीजे को सेव करने के लिए, फ़ील्ड का वैकल्पिक नाम.

अगर यह नाम नहीं दिया गया है, तो Firestore field_<incremental_id++> फ़ॉर्मैट के हिसाब से कोई डिफ़ॉल्ट नाम चुन लेगा. उदाहरण के लिए:

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

बन जाता है:

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

ज़रूरी है:

• यह सभी एग्रीगेशन उपनाम में खास होना चाहिए.
• document field name सीमाओं के मुताबिक.

Count

एग्रीगेटर की गिनती.

Sum

सम एग्रीगेटर.

Avg

औसत एग्रीगेटर.

FieldReference

वह फ़ील्ड जिसके लिए डेटा इकट्ठा करना है.

Int64Value

ज़रूरी नहीं. गिनती के लिए दस्तावेज़ों की ज़्यादा से ज़्यादा संख्या की वैकल्पिक सीमा.

इसकी मदद से, स्कैन करने के लिए दस्तावेज़ों की संख्या के लिए ऊपरी सीमा सेट की जा सकती है. साथ ही, शिपिंग के लिए लगने वाले समय को कम किया जा सकता है और शिपिंग के लिए लगने वाला शुल्क कम किया जा सकता है.

अनिर्दिष्ट का अर्थ कोई सीमा नहीं है.

हाई-लेवल का उदाहरण:

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

ज़रूरी है:

• मौजूद होने पर शून्य से ज़्यादा होना चाहिए.

FieldReference

वह फ़ील्ड जिसके लिए डेटा इकट्ठा करना है.

Projection

लौटाए जाने वाले फ़ील्ड का वैकल्पिक सब-सेट.

यह क्वेरी के जवाब में मिले दस्तावेज़ों पर DocumentMask की तरह काम करता है. इस नीति को सेट न करने पर, यह मान लिया जाता है कि कॉलर सभी फ़ील्ड वापस लाना चाहता है.

CollectionSelector

वे कलेक्शन, जिनके बारे में क्वेरी की जानी है.

Filter

लागू किया जाने वाला फ़िल्टर.

Order

क्वेरी के नतीजों पर लागू करने का क्रम.

Firestore की मदद से, कॉल करने वाले लोग पूरा क्रम दे सकते हैं. साथ ही, वे किसी भी क्रम में या कोई क्रम नहीं दे सकते. सभी मामलों में, Firestore इन नियमों के ज़रिए एक स्थिर क्रम की गारंटी देता है:

• order_by, इनइक्वालिटी फ़िल्टर के साथ इस्तेमाल किए जाने वाले सभी फ़ील्ड का रेफ़रंस देने के लिए ज़रूरी है.
• ऐसे सभी फ़ील्ड जिन्हें order_by में शामिल करना ज़रूरी है, लेकिन जो पहले से मौजूद नहीं हैं उन्हें फ़ील्ड के नाम के शब्दकोश के क्रम में जोड़ा जाता है.
• अगर __name__ पर कोई ऑर्डर तय नहीं किया गया है, तो उसे डिफ़ॉल्ट रूप से जोड़ा जाता है.

फ़ील्ड को आखिरी ऑर्डर के क्रम में ही जोड़ा जाता है या अगर कोई क्रम तय नहीं किया गया है, तो उन्हें 'ASCENDING' के तौर पर जोड़ा जाता है. उदाहरण के लिए:

• ORDER BY a, ORDER BY a ASC, __name__ ASC हो जाता है
• ORDER BY a DESC, ORDER BY a DESC, __name__ DESC हो जाता है
• WHERE a > 1, WHERE a > 1 ORDER BY a ASC, __name__ ASC हो जाता है
• WHERE __name__ > ... AND a > 1, WHERE __name__ > ... AND a > 1 ORDER BY a ASC, __name__ ASC हो जाता है

Cursor

नतीजे में किसी पोज़िशन का संभावित प्रीफ़िक्स, जिससे क्वेरी शुरू होती है.

नतीजे के सेट का क्रम, ओरिजनल क्वेरी के ORDER BY क्लॉज़ पर आधारित होता है.

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

इस क्वेरी के नतीजे (b ASC, __name__ ASC) के हिसाब से क्रम में लगाए गए हैं.

कर्सर, जगह के पूरे क्रम या प्रीफ़िक्स का रेफ़रंस दे सकते हैं. हालांकि, इनमें दिए गए ORDER BY फ़ील्ड से ज़्यादा फ़ील्ड का रेफ़रंस नहीं दिया जा सकता.

ऊपर दिए गए उदाहरण को जारी रखते हुए, नीचे दिए गए स्टार्ट कर्सर अटैच करने से अलग-अलग असर होगा:

• START BEFORE (2, /k/123): क्वेरी को a = 1 AND b > 2 AND __name__ > /k/123 से ठीक पहले शुरू करें.
• START AFTER (10): क्वेरी को a = 1 AND b > 10 के तुरंत बाद शुरू करें.

शुरुआत में N नतीजों को स्किप करने के लिए, OFFSET को स्कैन करना पड़ता है, जबकि स्टार्ट कर्सर, क्वेरी को लॉजिकल पोज़िशन से शुरू करने की अनुमति देता है. किसी असल नतीजे से मैच करने के लिए, इस पोज़िशन की ज़रूरत नहीं होती. यह अगले दस्तावेज़ को ढूंढने के लिए, इस पोज़िशन से आगे की ओर स्कैन करता है.

ज़रूरी है:

• वैल्यू की संख्या, ORDER BY क्लॉज़ में बताई गई फ़ील्ड की संख्या से ज़्यादा नहीं हो सकती.

Cursor

नतीजे में किसी पोज़िशन का संभावित प्रीफ़िक्स, जिसे क्वेरी को खत्म करने के लिए सेट किया गया है.

यह START_AT से मिलता-जुलता है. हालांकि, यह शुरुआती पोज़िशन के बजाय आखिरी पोज़िशन को कंट्रोल करता है.

ज़रूरी है:

• वैल्यू की संख्या, ORDER BY क्लॉज़ में बताई गई फ़ील्ड की संख्या से ज़्यादा नहीं हो सकती.

int32

पहला नतीजा लौटाने से पहले स्किप किए जाने वाले दस्तावेज़ों की संख्या.

यह WHERE, START AT, और END AT में तय की गई पाबंदियों के बाद, लेकिन LIMIT क्लॉज़ से पहले लागू होता है.

ज़रूरी है:

• अगर वैल्यू तय की गई है, तो वैल्यू शून्य से ज़्यादा या उसके बराबर होनी चाहिए.

Int32Value

दिखाए जाने वाले नतीजों की ज़्यादा से ज़्यादा संख्या.

अन्य सभी पाबंदियों के बाद लागू होता है.

ज़रूरी है:

• अगर वैल्यू तय की गई है, तो वैल्यू शून्य से ज़्यादा या उसके बराबर होनी चाहिए.

FindNearest

ज़रूरी नहीं. एक संभावित नज़दीकी पड़ोसी खोज.

दूसरे सभी फ़िल्टर और ऑर्डर करने के बाद लागू होता है.

दिए गए क्वेरी वेक्टर से सबसे नज़दीकी वेक्टर एम्बेड करता है.

string

कलेक्शन आईडी. सेट होने पर, सिर्फ़ इस आईडी वाले कलेक्शन चुने जाते हैं.

bool

गलत होने पर, सिर्फ़ ऐसे कलेक्शन चुनता है जो RunQueryRequest में बताए गए parent के करीबी होते हैं. सही होने पर, सभी डिसेंडेंट कलेक्शन चुनता है.

Operator

एक से ज़्यादा फ़िल्टर को मिलाने वाला ऑपरेटर.

Filter

जोड़े जाने वाले फ़िल्टर की सूची.

ज़रूरी है:

• कम से कम एक फ़िल्टर मौजूद है.

FieldReference

वह फ़ील्ड जिसके हिसाब से फ़िल्टर करना है.

Operator

वह ऑपरेटर जिसके हिसाब से फ़िल्टर करना है.

Value

वह वैल्यू जिससे तुलना करनी है.

string

दस्तावेज़ में किसी फ़ील्ड का रेफ़रंस.

ज़रूरी है:

• सेगमेंट की ऐसी स्ट्रिंग होनी चाहिए जिसमें डॉट डिलिमिटेड (.) वाली स्ट्रिंग हो. साथ ही, जहां हर सेगमेंट document field name सीमाओं के मुताबिक हो.

CompositeFilter

कंपोज़िट फ़िल्टर.

FieldFilter

दस्तावेज़ वाले फ़ील्ड पर मौजूद फ़िल्टर.

UnaryFilter

सिर्फ़ एक आर्ग्युमेंट लेने वाला फ़िल्टर.

FieldReference

ज़रूरी है. खोज करने के लिए, इंडेक्स किया गया वेक्टर फ़ील्ड. सिर्फ़ वे दस्तावेज़ दिखाए जा सकते हैं जिनमें वेक्टर वाले डाइमेंशन, query_वेक्टर से मेल खाते हैं.

Value

ज़रूरी है. वह क्वेरी वेक्टर जिस पर हम खोज कर रहे हैं. 2048 से ज़्यादा डाइमेंशन का वेक्टर नहीं होना चाहिए.

DistanceMeasure

ज़रूरी है. इस्तेमाल की जाने वाली दूरी की माप ज़रूरी है.

Int32Value

ज़रूरी है. वापस आने वाले पड़ोसियों की संख्या. 1,000 से ज़्यादा का पॉज़िटिव पूर्णांक होना चाहिए.

FieldReference

वह फ़ील्ड जिसके हिसाब से ऑर्डर करना है.

Direction

ऑर्डर करने के लिए निर्देश. डिफ़ॉल्ट वैल्यू ASCENDING होती है.

FieldReference

लौटाए जाने वाले फ़ील्ड.

अगर कोई फ़ील्ड खाली है, तो सभी फ़ील्ड दिखाए जाते हैं. सिर्फ़ दस्तावेज़ का नाम दिखाने के लिए, ['__name__'] का इस्तेमाल करें.

Operator

लागू किया जाने वाला यूनरी ऑपरेटर.

FieldReference

वह फ़ील्ड जिस पर ऑपरेटर लागू करना है.

int32

टारगेट आईडी, जिससे स्ट्रीम पर टारगेट की पहचान होती है. यह एक धनात्मक संख्या होनी चाहिए और शून्य नहीं होनी चाहिए.

अगर target_id की वैल्यू 0 है या इसकी जानकारी नहीं दी गई है, तो सर्वर इस टारगेट के लिए एक आईडी असाइन करेगा और उसे TargetChange::ADD के इवेंट में दिखाएगा. target_id=0 वाला टारगेट जोड़ने के बाद, बाद के सभी टारगेट में भी target_id=0 होना चाहिए. अगर target_id=0 वाले टारगेट जोड़ने के बाद, सर्वर को target_id != 0 के साथ AddTarget का अनुरोध भेजा जाता है, तो सर्वर तुरंत TargetChange::Remove इवेंट के साथ जवाब भेज देगा.

ध्यान दें कि अगर क्लाइंट बिना किसी आईडी के कई AddTarget अनुरोध भेजता है, तो TargetChage.target_ids में दिए गए आईडी का क्रम तय नहीं होता. इसलिए, क्लाइंट को कोई टारगेट आईडी असाइन करने के लिए सर्वर पर निर्भर रहने के बजाय, उसे एक टारगेट आईडी देना चाहिए.

अगर target_id ज़ीरो नहीं है, तो इस स्ट्रीम पर उसी आईडी वाला कोई मौजूदा चालू टारगेट नहीं होना चाहिए.

bool

क्या टारगेट के मौजूदा और एक जैसा होने के बाद उसे हटा देना चाहिए.

Int32Value

रिज़्यूमे टोकन या पढ़ने के समय पर की गई क्वेरी से आखिरी बार मेल खाने वाले दस्तावेज़ों की संख्या.

यह वैल्यू सिर्फ़ तब काम की होती है, जब resume_type दिया गया हो. यह वैल्यू मौजूद होती है और शून्य से ज़्यादा सिग्नल पर सेट होती है. इससे पता चलता है कि क्लाइंट, जवाब में ExistenceFilter.unchanged_names को शामिल करना चाहता है.

QueryTarget

किसी क्वेरी से तय किया गया टारगेट.

DocumentsTarget

दस्तावेज़ के नामों के सेट से तय किया गया टारगेट.

bytes

इसी टारगेट के लिए, पिछले TargetChange का रिज़्यूमे टोकन.

किसी दूसरे टारगेट के साथ रेज़्यूमे टोकन का इस्तेमाल नहीं किया जा सकता और यह काम नहीं भी कर सकता है.

Timestamp

किसी खास read_time के बाद सुनना शुरू करें.

क्लाइंट को इस समय, मेल खाने वाले दस्तावेज़ों की स्थिति के बारे में पता होना चाहिए.

string

उन दस्तावेज़ों के नाम जिन्हें फिर से हासिल करना है. फ़ॉर्मैट: projects/{project_id}/databases/{database_id}/documents/{document_path}. अगर कोई भी दस्तावेज़ दिए गए database का चाइल्ड रिसॉर्स नहीं है, तो अनुरोध रद्द कर दिया जाएगा. डुप्लीकेट नामों को हटा दिया जाएगा.

string

पैरंट रिसॉर्स का नाम. फ़ॉर्मैट: projects/{project_id}/databases/{database_id}/documents या projects/{project_id}/databases/{database_id}/documents/{document_path}. उदाहरण के लिए: projects/my-project/databases/my-database/documents या projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

StructuredQuery

स्ट्रक्चर्ड क्वेरी.

TargetChangeType

किस तरह का बदलाव हुआ है.

int32

उन टारगेट के टारगेट आईडी जिनमें बदलाव हुआ है.

खाली होने पर, बदलाव सभी टारगेट पर लागू होता है.

टारगेट आईडी का क्रम तय नहीं किया गया है.

Status

वह गड़बड़ी जिसकी वजह से यह बदलाव हुआ है, अगर लागू हो.

bytes

इस टोकन का इस्तेमाल करके, दिए गए target_ids के लिए स्ट्रीम को फिर से शुरू किया जा सकता है. इसके अलावा, अगर target_ids खाली है, तो सभी टारगेट का इस्तेमाल किया जा सकता है.

हर बार टारगेट बदलाव पर सेट नहीं है.

Timestamp

दिए गए target_ids के लिए एक जैसा read_time (जब target_ids एक जैसे स्नैपशॉट में न हों).

जब भी पूरी स्ट्रीम के लिए एक नया स्नैपशॉट मिलेगा, तब स्ट्रीम का target_ids खाली होने पर भी read_time भेजा जाएगा. मैसेज जोड़ें, मौजूदा, और रीसेट करें की गारंटी दी जाती है (आखिरकार) एक नया स्नैपशॉट मिलेगा (जबकि NO_CHANGE और REMOVE मैसेज नहीं मिलेंगे).

किसी स्ट्रीम के लिए, read_time की वैल्यू एक महीने के हिसाब से बढ़ती है.

ReadOnly

लेन-देन का इस्तेमाल सिर्फ़ रीड ऑपरेशन के लिए किया जा सकता है.

ReadWrite

ट्रांज़ैक्शन का इस्तेमाल पढ़ने और लिखने, दोनों के लिए किया जा सकता है.

Timestamp

दिए गए समय में दस्तावेज़ों को पढ़ता है.

यह पिछले एक घंटे के अंदर का माइक्रोसेकंड का सटीक टाइमस्टैंप होना चाहिए. इसके अलावा, अगर पॉइंट-इन-टाइम रिकवरी चालू है, तो यह पिछले सात दिनों में पूरे मिनट का टाइमस्टैंप भी हो सकता है.

bytes

फिर से कोशिश करने के लिए, लेन-देन किया जा सकता है. हालांकि, ऐसा करना ज़रूरी नहीं है.

Document

ज़रूरी है. अपडेट किया गया दस्तावेज़. अगर दस्तावेज़ पहले से मौजूद नहीं है, तो इसे बनाता है.

DocumentMask

अपडेट किए जाने वाले फ़ील्ड. मास्क के किसी भी फ़ील्ड पाथ में, रिज़र्व किया गया नाम नहीं हो सकता.

अगर दस्तावेज़ सर्वर पर मौजूद है और उसके कुछ फ़ील्ड मास्क में रेफ़र नहीं किए गए हैं, तो उनमें कोई बदलाव नहीं किया जाता. मास्क में दिए गए फ़ील्ड, लेकिन इनपुट दस्तावेज़ में मौजूद नहीं हैं. ऐसे फ़ील्ड को सर्वर पर मौजूद दस्तावेज़ से मिटा दिया जाता है.

DocumentMask

लौटाए जाने वाले फ़ील्ड. अगर यह नीति सेट नहीं है, तो सभी फ़ील्ड दिखाता है.

अगर दस्तावेज़ में ऐसा फ़ील्ड है जो इस मास्क में मौजूद नहीं है, तो जवाब में वह फ़ील्ड नहीं दिखेगा.

Precondition

दस्तावेज़ पर पहले से तय की गई एक वैकल्पिक शर्त. अगर यह सेट किया जाता है और टारगेट दस्तावेज़ से इसे पूरा नहीं किया जाता है, तो अनुरोध रद्द हो जाएगा.

NullValue

शून्य वैल्यू.

bool

एक बूलियन वैल्यू.

int64

कोई इंटीजर वैल्यू.

double

डबल वैल्यू.

Timestamp

टाइमस्टैंप की वैल्यू.

सिर्फ़ माइक्रोसेकंड तक सटीक. स्टोर करने पर, किसी भी अतिरिक्त सटीक को राउंड ऑफ़ कर दिया जाता है.

string

स्ट्रिंग की वैल्यू.

UTF-8 के तौर पर दिखाई जाने वाली स्ट्रिंग का साइज़, 1 MiB - 89 बाइट से ज़्यादा नहीं होना चाहिए. क्वेरी में, UTF-8 प्रज़ेंटेशन के सिर्फ़ पहले 1,500 बाइट को शामिल किया जाता है.

bytes

एक बाइट वैल्यू.

इसका साइज़ 1 एमबी से 89 बाइट के बीच होना चाहिए. क्वेरी में सिर्फ़ शुरुआती 1,500 बाइट पर ध्यान दिया जाता है.

string

किसी दस्तावेज़ का रेफ़रंस. उदाहरण के लिए: projects/{project_id}/databases/{database_id}/documents/{document_path}.

LatLng

भौगोलिक बिंदु की वैल्यू, जो पृथ्वी की सतह पर मौजूद एक पॉइंट को दिखाती है.

ArrayValue

अरे वैल्यू.

कोई अन्य अरे मान सीधे तौर पर शामिल नहीं किया जा सकता. हालांकि, इसमें कोई दूसरा अरे हो सकता है.

MapValue

कोई मैप वैल्यू.

DocumentMask

इस अपडेट में अपडेट किए जाने वाले फ़ील्ड.

इस फ़ील्ड को सिर्फ़ तब सेट किया जा सकता है, जब कार्रवाई update हो. अगर update के लिए मास्क सेट नहीं है और दस्तावेज़ मौजूद है, तो मौजूदा डेटा बदल जाएगा. अगर मास्क सेट है और सर्वर पर मौजूद दस्तावेज़ में ऐसे फ़ील्ड हैं जो मास्क से कवर नहीं किए गए हैं, तो उन फ़ील्ड में कोई बदलाव नहीं किया जाता. मास्क में दिए गए फ़ील्ड, लेकिन इनपुट दस्तावेज़ में मौजूद नहीं हैं. ऐसे फ़ील्ड को सर्वर पर मौजूद दस्तावेज़ से मिटा दिया जाता है. इस मास्क के फ़ील्ड पाथ में, रिज़र्व किए गए फ़ील्ड का नाम नहीं होना चाहिए.

FieldTransform

वे ट्रांसफ़ॉर्म जिन्हें अपडेट करने के बाद लागू किया जाता है.

इस फ़ील्ड को सिर्फ़ तब सेट किया जा सकता है, जब कार्रवाई update हो. अगर यह फ़ाइल मौजूद होती है, तो यह update और transform को एक ही दस्तावेज़ पर ऐटमली और क्रम में करने के बराबर होती है.

Precondition

दस्तावेज़ पर पहले से तय की गई एक वैकल्पिक शर्त.

अगर यह सेट किया जाता है और टारगेट दस्तावेज़ से पूरा नहीं होता है, तो लेखन विफल हो जाएगा.

Document

लिखने के लिए दस्तावेज़.

string

मिटाने के लिए दस्तावेज़ का नाम. फ़ॉर्मैट: projects/{project_id}/databases/{database_id}/documents/{document_path}.

DocumentTransform

यह किसी दस्तावेज़ में बदलाव को लागू करता है.

string

ज़रूरी है. डेटाबेस का नाम. फ़ॉर्मैट: projects/{project_id}/databases/{database_id}. ऐसा सिर्फ़ पहले मैसेज में ज़रूरी है.

string

फिर से शुरू करने के लिए राइट स्ट्रीम का आईडी. इसे सिर्फ़ पहले मैसेज में सेट किया जा सकता है. इसे खाली छोड़ने पर, लिखने के लिए एक नई स्ट्रीम बनाई जाएगी.

Write

लागू करने के लिए लेख.

इसे हमेशा एटॉमिक तरीके से और क्रम में लागू किया जाता है. पहले अनुरोध पर यह फ़ील्ड खाली होना चाहिए. यह आखिरी अनुरोध पर खाली हो सकता है. दूसरे सभी अनुरोधों के लिए, यह फ़ील्ड खाली नहीं होना चाहिए.

bytes

ऐसा स्ट्रीम टोकन जिसे पहले सर्वर से भेजा गया था.

क्लाइंट को इस फ़ील्ड को, सबसे हाल ही में मिले WriteResponse से मिले टोकन के हिसाब से सेट करना चाहिए. इससे यह पता चलेगा कि क्लाइंट को इस टोकन तक के जवाब मिल गए हैं. यह टोकन भेजने के बाद, हो सकता है कि पहले के टोकन इस्तेमाल न किए जाएं.

अगर बहुत ज़्यादा जवाब स्वीकार नहीं किए जाते हैं, तो सर्वर स्ट्रीम को बंद कर सकता है.

नई स्ट्रीम बनाते समय, इस फ़ील्ड को सेट न करें. किसी तय समय पर स्ट्रीम को फिर से शुरू करने के लिए, इस फ़ील्ड और stream_id फ़ील्ड को सेट करें.

नई स्ट्रीम बनाते समय, इस फ़ील्ड को सेट न करें.

map<string, string>

लिखने के इस अनुरोध से जुड़े लेबल.

string

स्ट्रीम का आईडी. नई स्ट्रीम बनाते समय, सिर्फ़ पहले मैसेज पर सेट की जाती है.

bytes

ऐसा टोकन जो स्ट्रीम में इस रिस्पॉन्स की पोज़िशन को दिखाता है. क्लाइंट, इसका इस्तेमाल स्ट्रीम को इस समय फिर से शुरू करने के लिए कर सकता है.

यह फ़ील्ड हमेशा सेट होता है.

WriteResult

लेख लागू करने का नतीजा.

i-वां लिखने का यह नतीजा, अनुरोध में मौजूद i-th राइट के हिसाब से होता है.

Timestamp

वह समय जब कार्रवाई हुई. read_time के बराबर या उससे ज़्यादा वैल्यू वाले टेक्स्ट को पढ़ने से, लिखने का असर दिख सकता है.

Timestamp

लिखने के बाद दस्तावेज़ को अपडेट करने का आखिरी समय. delete के बाद सेट नहीं है.

अगर दस्तावेज़ में बदलाव नहीं किया गया है, तो अपडेट का समय पिछला होगा.

Value

हर DocumentTransform.FieldTransform को एक ही क्रम में लागू करने से मिलने वाले नतीजे.