Method: projects.databases.documents.runQuery

একটি প্রশ্ন চালায়।

HTTP অনুরোধ

POST https://firestore.googleapis.com/v1beta1/{parent=projects/*/databases/*/documents}:runQuery

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

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

পরামিতি
parent

string

প্রয়োজন। মূল সম্পদের নাম। বিন্যাসে: projects/{projectId}/databases/{databaseId}/documents or projects/{projectId}/databases/{databaseId}/documents/{document_path} । যেমন: projects/my-project/databases/my-database/documents বা projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

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

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

JSON প্রতিনিধিত্ব
{
  "explainOptions": {
    object (ExplainOptions)
  },

  // Union field query_type can be only one of the following:
  "structuredQuery": {
    object (StructuredQuery)
  }
  // End of list of possible types for union field query_type.

  // 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.
}
ক্ষেত্র
explainOptions

object ( ExplainOptions )

ঐচ্ছিক। প্রশ্নের জন্য বিকল্প ব্যাখ্যা করুন। সেট করা হলে, অতিরিক্ত ক্যোয়ারী পরিসংখ্যান ফেরত দেওয়া হবে। যদি না হয়, শুধুমাত্র প্রশ্নের ফলাফল ফেরত দেওয়া হবে.

ইউনিয়ন ক্ষেত্র query_type । চালানোর জন্য প্রশ্ন. query_type নিম্নলিখিতগুলির মধ্যে একটি হতে পারে:
structuredQuery

object ( StructuredQuery )

একটি কাঠামোগত প্রশ্ন।

ইউনিয়ন ক্ষেত্রের 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.RunQuery এর প্রতিক্রিয়া।

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

JSON প্রতিনিধিত্ব
{
  "transaction": string,
  "document": {
    object (Document)
  },
  "readTime": string,
  "skippedResults": integer,
  "explainMetrics": {
    object (ExplainMetrics)
  },

  // Union field continuation_selector can be only one of the following:
  "done": boolean
  // End of list of possible types for union field continuation_selector.
}
ক্ষেত্র
transaction

string ( bytes format)

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

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

document

object ( Document )

একটি প্রশ্নের ফলাফল, আংশিক অগ্রগতি রিপোর্ট করার সময় সেট করা হয় না।

readTime

string ( Timestamp format)

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

যদি ক্যোয়ারী কোন ফলাফল না দেয়, তাহলে readTime সহ একটি প্রতিক্রিয়া এবং কোন document পাঠানো হবে না এবং এটি সেই সময়ের প্রতিনিধিত্ব করে যে সময়ে ক্যোয়ারী চালানো হয়েছিল।

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

skippedResults

integer

শেষ প্রতিক্রিয়া এবং বর্তমান প্রতিক্রিয়ার মধ্যে একটি অফসেটের কারণে এড়িয়ে যাওয়া ফলাফলের সংখ্যা৷

explainMetrics

object ( ExplainMetrics )

প্রশ্ন মেট্রিক্স ব্যাখ্যা. এটি শুধুমাত্র তখনই উপস্থিত থাকে যখন RunQueryRequest.explain_options প্রদান করা হয় এবং এটি স্ট্রীমের শেষ প্রতিক্রিয়ার সাথে শুধুমাত্র একবার পাঠানো হয়।

ইউনিয়ন ক্ষেত্র continuation_selector । কোয়েরির জন্য ধারাবাহিকতা মোড। উপস্থিত থাকলে, এটি নির্দেশ করে যে বর্তমান ক্যোয়ারী রেসপন্স স্ট্রীম শেষ হয়েছে। এটি উপস্থিত একটি document সাথে বা ছাড়া সেট করা যেতে পারে, কিন্তু সেট করা হলে, আর কোনো ফলাফল ফেরত দেওয়া হয় না। continuation_selector নিম্নলিখিতগুলির মধ্যে একটি হতে পারে:
done

boolean

উপস্থিত থাকলে, Firestore অনুরোধটি সম্পূর্ণভাবে শেষ করেছে এবং আর কোনো নথি ফেরত দেওয়া হবে না।

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

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

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

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