Method: projects.databases.documents.listDocuments

নথির তালিকা করে।

HTTP অনুরোধ

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

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

collectionId

string

ঐচ্ছিক। সংগ্রহ আইডি, parent আপেক্ষিক , তালিকা.

যেমন: chatrooms বা messages ।

এটি ঐচ্ছিক, এবং প্রদান করা না হলে, Firestore প্রদত্ত parent অধীনে সমস্ত সংগ্রহ থেকে নথি তালিকাভুক্ত করবে৷

ক্যোয়ারী প্যারামিটার

পরামিতি
pageSize

integer

ঐচ্ছিক। একক প্রতিক্রিয়ায় ফেরত দেওয়ার জন্য সর্বাধিক সংখ্যক নথি।

Firestore এই মানের থেকে কম রিটার্ন দিতে পারে।

pageToken

string

ঐচ্ছিক। একটি পৃষ্ঠা টোকেন, একটি পূর্ববর্তী documents.list প্রতিক্রিয়া থেকে প্রাপ্ত।

পরবর্তী পৃষ্ঠাটি পুনরুদ্ধার করতে এটি প্রদান করুন। পেজিনেটিং করার সময়, অন্যান্য সমস্ত প্যারামিটার ( pageSize ব্যতীত) অবশ্যই পৃষ্ঠা টোকেন তৈরি করা অনুরোধে সেট করা মানগুলির সাথে মেলে।

orderBy

string

ঐচ্ছিক। নথি ফেরত দিতে ঐচ্ছিক আদেশ.

যেমন: priority desc, __name__ desc ।

এটি Firestore কোয়েরিতে ব্যবহৃত ORDER BY কিন্তু একটি স্ট্রিং উপস্থাপনায় মিরর করে। অনুপস্থিত হলে, নথিগুলি __name__ ASC এর উপর ভিত্তি করে অর্ডার করা হয়।

mask

object ( DocumentMask )

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

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

showMissing

boolean

তালিকা অনুপস্থিত নথি প্রদর্শন করা উচিত.

একটি দস্তাবেজ অনুপস্থিত যদি এটি বিদ্যমান না থাকে তবে এটির নীচে উপ-দস্তাবেজ রয়েছে৷ সত্য হলে, এই ধরনের অনুপস্থিত নথিগুলি একটি কী দিয়ে ফেরত দেওয়া হবে কিন্তু ক্ষেত্র, createTime বা updateTime সেট থাকবে না।

showMissing সহ অনুরোধগুলি where বা orderBy নির্দিষ্ট নাও করতে পারে৷

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

string ( bytes format)

একটি ইতিমধ্যে সক্রিয় লেনদেনের অংশ হিসাবে পড়া সঞ্চালন.

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

readTime

string ( Timestamp format)

প্রদত্ত সময়ে পড়া সঞ্চালন.

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

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

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

অনুরোধের বডি খালি হতে হবে।

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

সফল হলে, প্রতিক্রিয়া বডিতে ListDocumentsResponse এর একটি উদাহরণ থাকে।

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

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

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

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