Method: projects.databases.documents.batchGet

একাধিক নথি পায়।

এই পদ্ধতিতে প্রত্যাবর্তিত নথিগুলি যে ক্রমে অনুরোধ করা হয়েছিল সেই ক্রমে ফেরত দেওয়ার নিশ্চয়তা নেই৷

HTTP অনুরোধ

POST https://firestore.googleapis.com/v1/{database=projects/*/databases/*}/documents:batchGet

URL gRPC ট্রান্সকোডিং সিনট্যাক্স ব্যবহার করে।

পাথ প্যারামিটার

পরামিতি
database

string

প্রয়োজন। ডাটাবেসের নাম। ফর্ম্যাটে: projects/{projectId}/databases/{databaseId} ।

শরীরের অনুরোধ

অনুরোধের অংশে নিম্নলিখিত কাঠামো সহ ডেটা রয়েছে:

JSON প্রতিনিধিত্ব
{
  "documents": [
    string
  ],
  "mask": {
    object (DocumentMask)
  },

  // Union field consistency_selector can be only one of the following:
  "transaction": string,
  "newTransaction": {
    object (TransactionOptions)
  },
  "readTime": string
  // End of list of possible types for union field consistency_selector.
}
ক্ষেত্র
documents[]

string

পুনরুদ্ধার করার জন্য নথির নাম। বিন্যাসে: projects/{projectId}/databases/{databaseId}/documents/{document_path} । কোনো ডকুমেন্ট প্রদত্ত database একটি চাইল্ড রিসোর্স না হলে অনুরোধটি ব্যর্থ হবে। সদৃশ নাম বাদ দেওয়া হবে।

mask

object ( DocumentMask )

ক্ষেত্র ফিরে. সেট করা না থাকলে, সমস্ত ক্ষেত্র ফেরত দেয়।

যদি একটি নথিতে এমন একটি ক্ষেত্র থাকে যা এই মাস্কে উপস্থিত না থাকে তবে সেই ক্ষেত্রটি প্রতিক্রিয়াতে ফেরত দেওয়া হবে না।

ইউনিয়ন ক্ষেত্রের consistency_selector । এই লেনদেনের জন্য ধারাবাহিকতা মোড। যদি সেট না করা হয়, ডিফল্ট দৃঢ় ধারাবাহিকতা. consistency_selector নিম্নলিখিতগুলির মধ্যে একটি হতে পারে:
transaction

string ( bytes format)

একটি লেনদেনের নথি পড়ে।

একটি base64-এনকোডেড স্ট্রিং।

newTransaction

object ( TransactionOptions )

একটি নতুন লেনদেন শুরু করে এবং নথিগুলি পড়ে। একটি শুধুমাত্র-পঠন লেনদেনে ডিফল্ট। স্ট্রীমের প্রথম প্রতিক্রিয়া হিসাবে নতুন লেনদেন আইডি ফেরত দেওয়া হবে।

readTime

string ( Timestamp format)

প্রদত্ত সময়ে নথিগুলি যেমন ছিল সেগুলি পড়ে।

এটি অবশ্যই গত এক ঘন্টার মধ্যে একটি মাইক্রোসেকেন্ড নির্ভুল টাইমস্ট্যাম্প হতে হবে, অথবা যদি পয়েন্ট-ইন-টাইম পুনরুদ্ধার সক্ষম করা থাকে, অতিরিক্তভাবে গত 7 দিনের মধ্যে পুরো মিনিটের টাইমস্ট্যাম্প হতে পারে৷

RFC3339 UTC "জুলু" ফর্ম্যাটে একটি টাইমস্ট্যাম্প, ন্যানোসেকেন্ড রেজোলিউশন এবং নয়টি পর্যন্ত ভগ্নাংশের সংখ্যা। উদাহরণ: "2014-10-02T15:01:23Z" এবং "2014-10-02T15:01:23.045123456Z" ।

প্রতিক্রিয়া শরীর

Firestore.BatchGetDocuments এর জন্য প্রবাহিত প্রতিক্রিয়া।

সফল হলে, প্রতিক্রিয়া বডিতে নিম্নলিখিত কাঠামোর সাথে ডেটা থাকে:

JSON প্রতিনিধিত্ব
{
  "transaction": string,
  "readTime": string,

  // Union field result can be only one of the following:
  "found": {
    object (Document)
  },
  "missing": string
  // End of list of possible types for union field result.
}
ক্ষেত্র
transaction

string ( bytes format)

এই অনুরোধের অংশ হিসাবে লেনদেন শুরু হয়েছিল। শুধুমাত্র প্রথম প্রতিক্রিয়াতে সেট করা হবে, এবং শুধুমাত্র যদি BatchGetDocumentsRequest.new_transaction অনুরোধে সেট করা হয়।

একটি base64-এনকোডেড স্ট্রিং।

readTime

string ( Timestamp format)

যে সময়ে নথিটি পড়া হয়েছিল। এটি এককভাবে বৃদ্ধি পেতে পারে, এই ক্ষেত্রে ফলাফল স্ট্রীমের পূর্ববর্তী নথিগুলি তাদের পড়ার সময় এবং এটির মধ্যে পরিবর্তন না হওয়ার গ্যারান্টি দেওয়া হয়।

RFC3339 UTC "জুলু" ফর্ম্যাটে একটি টাইমস্ট্যাম্প, ন্যানোসেকেন্ড রেজোলিউশন এবং নয়টি পর্যন্ত ভগ্নাংশের সংখ্যা। উদাহরণ: "2014-10-02T15:01:23Z" এবং "2014-10-02T15:01:23.045123456Z" ।

ইউনিয়ন ক্ষেত্রের result । একটি একক ফলাফল. সার্ভার শুধুমাত্র একটি লেনদেন ফেরত দিলে এটি খালি হতে পারে। result শুধুমাত্র নিম্নলিখিত একটি হতে পারে:
found

object ( Document )

একটি নথি যা অনুরোধ করা হয়েছিল।

missing

string

একটি নথির নাম যা অনুরোধ করা হয়েছিল কিন্তু বিদ্যমান নেই৷ বিন্যাসে: projects/{projectId}/databases/{databaseId}/documents/{document_path} ।

অনুমোদনের সুযোগ

নিম্নলিখিত OAuth সুযোগগুলির মধ্যে একটি প্রয়োজন:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

আরও তথ্যের জন্য, প্রমাণীকরণ ওভারভিউ দেখুন।