@firebase/firestore

ফাংশন

ফাংশন বর্ণনা
ফাংশন (অ্যাপ, ...)
getFirestore(অ্যাপ) প্রদত্ত FirebaseApp- এর সাথে যুক্ত বিদ্যমান ডিফল্ট Firestore উদাহরণ প্রদান করে . যদি কোন দৃষ্টান্ত বিদ্যমান না থাকে, ডিফল্ট সেটিংস সহ একটি নতুন দৃষ্টান্ত শুরু করে।
getFirestore(অ্যাপ, ডেটাবেসআইডি) (বিটা) প্রদত্ত FirebaseApp- এর সাথে যুক্ত বিদ্যমান নামযুক্ত Firestore উদাহরণ প্রদান করে . যদি কোন দৃষ্টান্ত বিদ্যমান না থাকে, ডিফল্ট সেটিংস সহ একটি নতুন দৃষ্টান্ত শুরু করে।
ইনিশিয়ালাইজ ফায়ারস্টোর (অ্যাপ, সেটিংস, ডেটাবেসআইডি) প্রদত্ত সেটিংস সহ Firestore- এর একটি নতুন উদাহরণ শুরু করে৷ GetFirestore() সহ অন্য যেকোন ফাংশনের আগে শুধুমাত্র কল করা যাবে . কাস্টম সেটিংস খালি থাকলে, এই ফাংশনটি getFirestore() কল করার সমতুল্য .
ফাংশন (ফায়ারস্টোর, ...)
clearIndexedDbPersistence(ফায়ারস্টোর) ক্রমাগত স্টোরেজ সাফ করে। এর মধ্যে মুলতুবি লেখা এবং ক্যাশড নথি অন্তর্ভুক্ত রয়েছে। Firestore ইন্সট্যান্স শুরু না হওয়া অবস্থায় অবশ্যই কল করতে হবে (অ্যাপটি বন্ধ হয়ে যাওয়ার পরে বা অ্যাপটি প্রথম শুরু হলে)। স্টার্টআপে, এই ফাংশনটি অবশ্যই অন্য ফাংশনগুলির আগে কল করতে হবে ( initiizeFirestore() বা getFirestore() ছাড়া ))। যদি Firestore ইন্সট্যান্স এখনও চালু থাকে, তাহলে প্রতিশ্রুতি failed-precondition ত্রুটি কোডের সাথে প্রত্যাখ্যান করা হবে। দ্রষ্টব্য: clearIndexedDbPersistence() প্রাথমিকভাবে ক্লাউড ফায়ারস্টোর ব্যবহার করে এমন নির্ভরযোগ্য পরীক্ষা লিখতে সাহায্য করার উদ্দেশ্যে। এটি বিদ্যমান ডেটা ড্রপ করার জন্য একটি দক্ষ প্রক্রিয়া ব্যবহার করে কিন্তু নিরাপদে ওভাররাইট করার চেষ্টা করে না বা অন্যথায় ক্যাশে করা ডেটা পুনরুদ্ধারযোগ্য করে না। ব্যবহারকারীর সেশনের মধ্যে ক্যাশ করা ডেটা প্রকাশের প্রতি সংবেদনশীল অ্যাপ্লিকেশনগুলির জন্য, আমরা দৃঢ়ভাবে সুপারিশ করছি যে তারা অধ্যবসায় সক্ষম করবেন না।
সংগ্রহ (ফায়ারস্টোর, পথ, পথ বিভাগ) একটি CollectionReference ইনস্ট্যান্স পায় যা নির্দিষ্ট পরম পাথের সংগ্রহকে বোঝায়।
কালেকশন গ্রুপ (ফায়ারস্টোর, কালেকশন আইডি) একটি নতুন Query ইন্সট্যান্স তৈরি করে এবং ফেরত দেয় যাতে ডাটাবেসের সমস্ত নথি অন্তর্ভুক্ত থাকে যা প্রদত্ত collectionId সহ একটি সংগ্রহ বা উপ-সংকলনে রয়েছে।
কানেক্ট ফায়ারস্টোর ইমুলেটর (ফায়ারস্টোর, হোস্ট, পোর্ট, বিকল্প) ক্লাউড ফায়ারস্টোর এমুলেটরের সাথে যোগাযোগ করতে এই উদাহরণটি পরিবর্তন করুন। দ্রষ্টব্য: কোনো অপারেশন করতে এই উদাহরণটি ব্যবহার করার আগে এটিকে অবশ্যই কল করতে হবে।
নিষ্ক্রিয় নেটওয়ার্ক (ফায়ারস্টোর) এই উদাহরণের জন্য নেটওয়ার্ক ব্যবহার অক্ষম করে। এটি enableNetwork() এর মাধ্যমে পুনরায় সক্ষম করা যেতে পারে . নেটওয়ার্ক নিষ্ক্রিয় থাকাকালীন, যেকোনো স্ন্যাপশট শ্রোতা, getDoc() বা getDocs() কল ক্যাশে থেকে ফলাফল প্রদান করবে, এবং নেটওয়ার্ক পুনরুদ্ধার না হওয়া পর্যন্ত যেকোনো লেখার ক্রিয়াকলাপ সারিবদ্ধ থাকবে।
ডক (ফায়ারস্টোর, পাথ, পাথ সেগমেন্ট) একটি DocumentReference ইনস্ট্যান্স পায় যা নির্দিষ্ট পরম পাথে নথিটিকে বোঝায়।
ইনডেক্সডডিবি পারসিস্টেন্স সক্ষম করুন (ফায়ারস্টোর, পারসিস্টেন্স সেটিংস) অবিরাম সঞ্চয়স্থান সক্ষম করার প্রচেষ্টা, যদি সম্ভব হয়। ব্যর্থ হলে, enableIndexedDbPersistence() প্রতিশ্রুতি প্রত্যাখ্যান করবে বা একটি ব্যতিক্রম নিক্ষেপ করবে। এটি ব্যর্থ হওয়ার বিভিন্ন কারণ রয়েছে, যা ত্রুটির code দ্বারা চিহ্নিত করা যেতে পারে। * ব্যর্থ-পূর্ব শর্ত: অ্যাপটি ইতিমধ্যেই অন্য ব্রাউজার ট্যাবে খোলা আছে। * প্রয়োগ করা হয়নি: ব্রাউজারটি অফলাইন অধ্যবসায় বাস্তবায়নের সাথে বেমানান। মনে রাখবেন যে ব্যর্থতার পরেও, Firestore দৃষ্টান্ত ব্যবহারযোগ্য থাকবে, তবে অফলাইন স্থিরতা অক্ষম করা হবে। দ্রষ্টব্য: enableIndexedDbPersistence() অন্য কোন ফাংশনের আগে কল করতে হবে ( initiizeFirestore() ছাড়া , getFirestore() বা clearIndexedDbPersistence() . অধ্যবসায় একটি Node.js পরিবেশে ব্যবহার করা যাবে না.
মাল্টিট্যাব ইনডেক্সডডিবি পারসিস্টেন্স সক্ষম করুন(ফায়ারস্টোর) সম্ভব হলে মাল্টি-ট্যাব স্থায়ী সঞ্চয়স্থান সক্ষম করার প্রচেষ্টা। সমস্ত ট্যাব জুড়ে সক্রিয় থাকলে, সমস্ত ক্রিয়াকলাপগুলি সমস্ত সংযুক্ত দৃষ্টান্ত জুড়ে কোয়েরির ভাগ করা এবং লেটেন্সি-ক্ষতিপূরণ স্থানীয় নথি আপডেট সহ স্থানীয় অধ্যবসায় অ্যাক্সেস ভাগ করে। ব্যর্থ হলে, enableMultiTabIndexedDbPersistence() প্রতিশ্রুতি প্রত্যাখ্যান করবে বা একটি ব্যতিক্রম নিক্ষেপ করবে। এটি ব্যর্থ হওয়ার বিভিন্ন কারণ রয়েছে, যা ত্রুটির code দ্বারা চিহ্নিত করা যেতে পারে। * ব্যর্থ-পূর্বশর্ত: অ্যাপটি ইতিমধ্যেই অন্য ব্রাউজার ট্যাবে খোলা আছে এবং মাল্টি-ট্যাব সক্ষম করা নেই। * প্রয়োগ করা হয়নি: ব্রাউজারটি অফলাইন অধ্যবসায় বাস্তবায়নের সাথে বেমানান। মনে রাখবেন যে ব্যর্থতার পরেও, Firestore দৃষ্টান্ত ব্যবহারযোগ্য থাকবে, তবে অফলাইন স্থিরতা অক্ষম করা হবে।
সক্রিয় নেটওয়ার্ক (ফায়ারস্টোর) নিষ্ক্রিয়Network() কে পূর্বে কল করার পরে এই Firestore উদাহরণের জন্য নেটওয়ার্কের ব্যবহার পুনরায় সক্ষম করে .
getPersistentCacheIndexManager(ফায়ারস্টোর) প্রদত্ত Firestore অবজেক্ট দ্বারা ব্যবহৃত PersistentCache Index Manager ফেরত দেয়। PersistentCacheIndexManager দৃষ্টান্ত, অথবা স্থানীয় স্থায়ী সঞ্চয়স্থান ব্যবহার না হলে null ।
লোডবান্ডেল (ফায়ারস্টোর, বান্ডিল ডেটা) স্থানীয় ক্যাশে একটি ফায়ারস্টোর বান্ডিল লোড করে।
nameQuery (ফায়ারস্টোর, নাম) প্রদত্ত নাম দ্বারা চিহ্নিত স্থানীয় ক্যাশে থেকে একটি ফায়ারস্টোর ক্যোয়ারী পড়ে। নামযুক্ত প্রশ্নগুলি সার্ভারের পাশে বান্ডিলে প্যাকেজ করা হয় (ফলাফল নথি সহ), এবং loadBundle ব্যবহার করে স্থানীয় ক্যাশে লোড করা হয়। স্থানীয় ক্যাশে একবার, নামের দ্বারা একটি প্রশ্ন বের করতে এই পদ্ধতিটি ব্যবহার করুন।
onSnapshotsInSync(ফায়ারস্টোর, পর্যবেক্ষক) একটি স্ন্যাপশট-ইন-সিঙ্ক ইভেন্টের জন্য একজন শ্রোতাকে সংযুক্ত করে। স্ন্যাপশট-ইন-সিঙ্ক ইভেন্টটি নির্দেশ করে যে প্রদত্ত পরিবর্তনের দ্বারা প্রভাবিত সমস্ত শ্রোতাদের বরখাস্ত করা হয়েছে, এমনকি যদি একটি সার্ভার-উত্পন্ন পরিবর্তন একাধিক শ্রোতাকে প্রভাবিত করে। দ্রষ্টব্য: স্ন্যাপশট-ইন-সিঙ্ক ইভেন্টটি শুধুমাত্র ইঙ্গিত করে যে শ্রোতারা একে অপরের সাথে সিঙ্কে আছে, কিন্তু সেই স্ন্যাপশটগুলি সার্ভারের সাথে সিঙ্কে আছে কিনা তার সাথে সম্পর্কিত নয়৷ একটি স্ন্যাপশট ক্যাশে বা সার্ভার থেকে কিনা তা নির্ধারণ করতে পৃথক শ্রোতাদের মধ্যে স্ন্যাপশট মেটাডেটা ব্যবহার করুন।
onSnapshotsInSync(ফায়ারস্টোর, অনসিঙ্ক) একটি স্ন্যাপশট-ইন-সিঙ্ক ইভেন্টের জন্য একজন শ্রোতাকে সংযুক্ত করে। স্ন্যাপশট-ইন-সিঙ্ক ইভেন্টটি নির্দেশ করে যে প্রদত্ত পরিবর্তনের দ্বারা প্রভাবিত সমস্ত শ্রোতাদের বরখাস্ত করা হয়েছে, এমনকি যদি একটি সার্ভার-উত্পন্ন পরিবর্তন একাধিক শ্রোতাকে প্রভাবিত করে। দ্রষ্টব্য: স্ন্যাপশট-ইন-সিঙ্ক ইভেন্টটি শুধুমাত্র ইঙ্গিত করে যে শ্রোতারা একে অপরের সাথে সিঙ্কে আছে, কিন্তু সেই স্ন্যাপশটগুলি সার্ভারের সাথে সিঙ্কে আছে কিনা তার সাথে সম্পর্কিত নয়৷ একটি স্ন্যাপশট ক্যাশে বা সার্ভার থেকে কিনা তা নির্ধারণ করতে পৃথক শ্রোতাদের মধ্যে SnapshotMetadata ব্যবহার করুন।
রান লেনদেন (ফায়ারস্টোর, আপডেট ফাংশন, বিকল্প) প্রদত্ত updateFunction কার্যকর করে এবং তারপর লেনদেনের মধ্যে প্রয়োগ করা পরিবর্তনগুলি কমিট করার চেষ্টা করে। লেনদেনের মধ্যে পড়া কোনো নথি পরিবর্তিত হলে, ক্লাউড ফায়ারস্টোর updateFunction পুনরায় চেষ্টা করে। যদি এটি 5 প্রচেষ্টার পরেও কমিট করতে ব্যর্থ হয়, লেনদেন ব্যর্থ হয়। একটি একক লেনদেনে সর্বাধিক 500টি লেখা অনুমোদিত।
সেট ইনডেক্স কনফিগারেশন (ফায়ারস্টোর, কনফিগারেশন) (BETA) স্থানীয় ক্যোয়ারী এক্সিকিউশনের জন্য ইন্ডেক্সিং কনফিগার করে। কোনো পূর্ববর্তী সূচক কনফিগারেশন ওভাররাইড করা হয়। সূচী কনফিগারেশন অব্যাহত থাকলে Promise সমাধান হয়ে যায়। ইনডেক্স এন্ট্রিগুলি নিজেরাই অ্যাসিঙ্ক্রোনাসভাবে তৈরি করা হয়। সূচকগুলি এখনও উপলব্ধ না থাকলেও আপনি এমন প্রশ্নগুলি ব্যবহার করা চালিয়ে যেতে পারেন যাতে সূচীকরণের প্রয়োজন হয়৷ ইন্ডেক্স এন্ট্রি লেখা হয়ে গেলে ক্যোয়ারী এক্সিকিউশন স্বয়ংক্রিয়ভাবে সূচী ব্যবহার শুরু করবে। সূচকগুলি শুধুমাত্র IndexedDb স্থিরতার সাথে সমর্থিত। IndexedDb সক্ষম না থাকলে, যেকোনও সূচক কনফিগারেশন উপেক্ষা করা হয়।
সেট ইনডেক্স কনফিগারেশন (ফায়ারস্টোর, জেসন) (BETA) স্থানীয় ক্যোয়ারী এক্সিকিউশনের জন্য ইন্ডেক্সিং কনফিগার করে। কোনো পূর্ববর্তী সূচক কনফিগারেশন ওভাররাইড করা হয়। সূচী কনফিগারেশন অব্যাহত থাকলে Promise সমাধান হয়ে যায়। ইনডেক্স এন্ট্রিগুলি নিজেরাই অ্যাসিঙ্ক্রোনাসভাবে তৈরি করা হয়। সূচকগুলি এখনও উপলব্ধ না থাকলেও আপনি এমন প্রশ্নগুলি ব্যবহার করা চালিয়ে যেতে পারেন যাতে সূচীকরণের প্রয়োজন হয়৷ ইন্ডেক্স এন্ট্রি লেখা হয়ে গেলে ক্যোয়ারী এক্সিকিউশন স্বয়ংক্রিয়ভাবে সূচী ব্যবহার শুরু করবে। সূচকগুলি শুধুমাত্র IndexedDb স্থিরতার সাথে সমর্থিত। একটি সূচক কনফিগারেশন সেট করার আগে হয় enableIndexedDbPersistence() অথবা enableMultiTabIndexedDbPersistence() সক্ষম করুন। IndexedDb সক্ষম না থাকলে, যেকোনও সূচক কনফিগারেশন উপেক্ষা করা হয়। পদ্ধতিটি Firebase CLI ( firebase firestore:indexes ) দ্বারা রপ্তানি করা JSON বিন্যাস গ্রহণ করে। JSON বিন্যাসটি অবৈধ হলে, এই পদ্ধতিটি একটি ত্রুটি ছুড়ে দেয়।
বন্ধ (ফায়ারস্টোর) প্রদত্ত ফায়ারস্টোর দৃষ্টান্ত বন্ধ করে। terminate() কল করার পরে শুধুমাত্র clearIndexedDbPersistence() ফাংশন ব্যবহার করা যেতে পারে। অন্য কোন ফাংশন একটি FirestoreError নিক্ষেপ করবে। সমাপ্তির পরে পুনরায় চালু করতে, getFirestore() দিয়ে FirebaseFirestore-এর একটি নতুন উদাহরণ তৈরি করুন . সমাপ্তি কোনো মুলতুবি লেখা বাতিল করে না, এবং সার্ভার থেকে প্রতিক্রিয়ার অপেক্ষায় থাকা কোনো প্রতিশ্রুতি সমাধান করা হবে না। আপনি যদি অধ্যবসায় সক্ষম করে থাকেন, পরের বার যখন আপনি এই উদাহরণটি শুরু করবেন, এটি সার্ভারে এই লেখাগুলি পাঠানো আবার শুরু করবে। দ্রষ্টব্য: সাধারণ পরিস্থিতিতে, terminate() কল করার প্রয়োজন নেই। এই ফাংশনটি তখনই উপযোগী যখন আপনি এই দৃষ্টান্তটিকে এর সমস্ত সংস্থান প্রকাশ করতে বা clearIndexedDbPersistence() এর সাথে একত্রিত করে নিশ্চিত করতে চান যে সমস্ত স্থানীয় অবস্থা টেস্ট রানের মধ্যে ধ্বংস হয়ে গেছে।
waitForPendingWrites(ফায়ারস্টোর) সক্রিয় ব্যবহারকারীর জন্য বর্তমানে মুলতুবি থাকা সমস্ত লেখা ব্যাকএন্ড দ্বারা স্বীকৃত না হওয়া পর্যন্ত অপেক্ষা করুন। প্রত্যাবর্তিত প্রতিশ্রুতি অবিলম্বে সমাধান করা হয় যদি কোন অসামান্য লেখা না থাকে। অন্যথায়, প্রতিশ্রুতিটি পূর্বে জারি করা সমস্ত লেখার জন্য অপেক্ষা করে (আগের অ্যাপ সেশনে লেখাগুলি সহ), তবে এটি ফাংশন কল করার পরে যুক্ত করা লেখাগুলির জন্য অপেক্ষা করে না। আপনি যদি অতিরিক্ত লেখার জন্য অপেক্ষা করতে চান তবে waitForPendingWrites() আবার কল করুন। ব্যবহারকারীর পরিবর্তনের সময় কোনো অসামান্য waitForPendingWrites() প্রতিশ্রুতি প্রত্যাখ্যান করা হয়।
রাইটব্যাচ (ফায়ারস্টোর) একটি লেখার ব্যাচ তৈরি করে, একটি একক পারমাণবিক অপারেশন হিসাবে একাধিক লেখা সম্পাদনের জন্য ব্যবহৃত হয়। একটি একক WriteBatch- এ অনুমোদিত লেখার সর্বাধিক সংখ্যা 500। লেনদেনের বিপরীতে, লেখার ব্যাচগুলি অফলাইনে টিকে থাকে এবং সেইজন্য যখন আপনার লেখাগুলিকে পঠিত ডেটাতে শর্ত দেওয়ার প্রয়োজন হয় না তখন এটি বাঞ্ছনীয়।
ফাংশন()
গণনা() একটি AggregateField অবজেক্ট তৈরি করুন যা একটি প্রশ্নের ফলাফল সেটে নথির গণনা গণনা করতে ব্যবহার করা যেতে পারে।
ডিলিট ফিল্ড() মুছে ফেলার জন্য একটি ক্ষেত্র চিহ্নিত করতে updateDoc() অথবা {merge: true} সহ setDoc() ব্যবহার করার জন্য একটি সেন্টিনেল ফেরত দেয়।
ডকুমেন্ট আইডি() একটি নথির ID উল্লেখ করতে একটি বিশেষ সেন্টিনেল FieldPath প্রদান করে। এটি ডকুমেন্ট আইডি দ্বারা বাছাই বা ফিল্টার করার জন্য প্রশ্নগুলিতে ব্যবহার করা যেতে পারে।
getFirestore() ডিফল্ট FirebaseApp- এর সাথে যুক্ত বিদ্যমান ডিফল্ট Firestore উদাহরণ প্রদান করে . যদি কোন দৃষ্টান্ত বিদ্যমান না থাকে, ডিফল্ট সেটিংস সহ একটি নতুন দৃষ্টান্ত শুরু করে।
মেমরিএগারগার্বেজ কালেক্টর() MemoryEagerGarbageCollector এর একটি উদাহরণ তৈরি করে। এটিও ডিফল্ট আবর্জনা সংগ্রাহক যদি না এটি স্পষ্টভাবে অন্যথায় নির্দিষ্ট করা হয়।
অবিরাম মাল্টিপল ট্যাব ম্যানেজার() PersistentMultipleTabManager এর একটি উদাহরণ তৈরি করে।
সার্ভারটাইমস্ট্যাম্প() লিখিত ডেটাতে একটি সার্ভার-জেনারেটেড টাইমস্ট্যাম্প অন্তর্ভুক্ত করতে setDoc() বা updateDoc() এর সাথে ব্যবহৃত একটি সেন্টিনেল ফেরত দেয়।
ফাংশন (ডাটাবেসআইডি, ...)
getFirestore(ডাটাবেসআইডি) (বিটা) ডিফল্ট FirebaseApp- এর সাথে যুক্ত বিদ্যমান নামযুক্ত Firestore উদাহরণ প্রদান করে . যদি কোন দৃষ্টান্ত বিদ্যমান না থাকে, ডিফল্ট সেটিংস সহ একটি নতুন দৃষ্টান্ত শুরু করে।
ফাংশন (উপাদান, ...)
arrayRemove(উপাদান) একটি বিশেষ মান প্রদান করে যা setDoc() এর সাথে ব্যবহার করা যেতে পারে বা যেটি সার্ভারে আগে থেকেই বিদ্যমান যেকোনো অ্যারে মান থেকে প্রদত্ত উপাদানগুলিকে সরাতে বলে। নির্দিষ্ট করা প্রতিটি উপাদানের সমস্ত দৃষ্টান্ত অ্যারে থেকে সরানো হবে। যদি পরিবর্তিত ক্ষেত্রটি ইতিমধ্যে একটি অ্যারে না হয় তবে এটি একটি খালি অ্যারে দিয়ে ওভাররাইট করা হবে।
arrayUnion(উপাদান) একটি বিশেষ মান প্রদান করে যা setDoc() বা updateDoc() এর সাথে ব্যবহার করা যেতে পারে যা সার্ভারকে প্রদত্ত উপাদানগুলিকে সার্ভারে বিদ্যমান যেকোনো অ্যারে মানের সাথে সংযুক্ত করতে বলে। প্রতিটি নির্দিষ্ট উপাদান যা ইতিমধ্যে অ্যারেতে বিদ্যমান নেই শেষ পর্যন্ত যোগ করা হবে। যদি পরিবর্তিত ক্ষেত্রটি ইতিমধ্যে একটি অ্যারে না হয় তবে এটি নির্দিষ্ট উপাদানগুলি সমন্বিত একটি অ্যারে দিয়ে ওভাররাইট করা হবে।
ফাংশন (ক্ষেত্র, ...)
গড় (ক্ষেত্র) একটি AggregateField অবজেক্ট তৈরি করুন যা একটি কোয়েরির ফলাফল সেটে নথিগুলির একটি পরিসরে একটি নির্দিষ্ট ক্ষেত্রের গড় গণনা করতে ব্যবহার করা যেতে পারে।
যোগফল (ক্ষেত্র) একটি AggregateField অবজেক্ট তৈরি করুন যা একটি কোয়েরির ফলাফল সেটে নথিগুলির একটি পরিসরে একটি নির্দিষ্ট ক্ষেত্রের যোগফল গণনা করতে ব্যবহার করা যেতে পারে।
ফাংশন (ক্ষেত্রপথ, ...)
অর্ডারবাই (ক্ষেত্রপথ, নির্দেশিকা) একটি QueryOrderByConstraint তৈরি করে যা নির্দিষ্ট ক্ষেত্রের দ্বারা প্রশ্নের ফলাফলকে সাজায়, ঐচ্ছিকভাবে ঊর্ধ্বক্রমের পরিবর্তে অবরোহ ক্রমে। দ্রষ্টব্য: যে নথিগুলিতে নির্দিষ্ট ক্ষেত্র নেই সেগুলি প্রশ্নের ফলাফলে উপস্থিত থাকবে না৷
যেখানে (ক্ষেত্রপথ, opStr, মান) একটি QueryFieldFilterConstraint তৈরি করে যা প্রয়োগ করে যে নথিতে অবশ্যই নির্দিষ্ট ক্ষেত্র থাকতে হবে এবং মানটি প্রদত্ত সম্পর্কের সীমাবদ্ধতা পূরণ করবে।
ফাংশন (ক্ষেত্রের মান, ...)
endAt(ক্ষেত্রমূল্য) একটি QueryEndAtConstraint তৈরি করে যা কোয়েরির ক্রম অনুসারে প্রদত্ত ক্ষেত্রগুলিতে শেষ হতে সেট করা ফলাফলটিকে পরিবর্তন করে৷ ক্ষেত্রের মানগুলির ক্রম অবশ্যই কোয়েরির ধারাগুলির দ্বারা আদেশের ক্রমটির সাথে মিলবে৷
endBefore(ক্ষেত্রমূল্য) একটি QueryEndAtConstraint তৈরি করে যা কোয়েরির ক্রম অনুসারে প্রদত্ত ক্ষেত্রগুলির আগে শেষ হতে সেট করা ফলাফলটিকে পরিবর্তন করে৷ ক্ষেত্রের মানগুলির ক্রম অবশ্যই কোয়েরির ধারাগুলির দ্বারা আদেশের ক্রমটির সাথে মিলবে৷
startAfter(ক্ষেত্রমূল্য) একটি QueryStartAtConstraint তৈরি করে যা কোয়েরির ক্রম অনুসারে প্রদত্ত ক্ষেত্রগুলির পরে শুরু হতে ফলাফল সেটটিকে পরিবর্তন করে৷ ক্ষেত্রের মানগুলির ক্রম অবশ্যই কোয়েরির ধারাগুলির দ্বারা আদেশের ক্রমটির সাথে মিলবে৷
startAt(ক্ষেত্রমূল্য) একটি QueryStartAtConstraint তৈরি করে যা কোয়েরির ক্রম অনুসারে প্রদত্ত ক্ষেত্রগুলিতে শুরু করার জন্য ফলাফল সেটটিকে পরিবর্তন করে৷ ক্ষেত্রের মানগুলির ক্রম অবশ্যই কোয়েরির ধারাগুলির দ্বারা আদেশের ক্রমটির সাথে মিলবে৷
ফাংশন (ইনডেক্স ম্যানেজার, ...)
মুছে ফেলুন অলপ্রিসিস্টেন্ট ক্যাশ ইনডেক্স (ইনডেক্স ম্যানেজার) সমস্ত স্থায়ী ক্যাশে সূচী মুছে দেয়। অনুগ্রহ করে মনে রাখবেন এই ফাংশন setIndexConfiguration() দ্বারা উত্পন্ন সূচীগুলিকেও মুছে ফেলবে, যা অবমূল্যায়িত হয়েছে৷
নিষ্ক্রিয়PersistentCacheIndexAutoCreation(indexManager) স্থানীয় ক্যোয়ারী সম্পাদনের জন্য স্বয়ংক্রিয়ভাবে ক্রমাগত ক্যাশে সূচী তৈরি করা বন্ধ করে। enablePersistentCacheIndexAutoCreation() কল করে যে সূচীগুলি তৈরি করা হয়েছে তা এখনও কার্যকর হয়৷
সক্ষম করুনPersistentCacheIndexAutoCreation(indexManager) যখন SDK বিশ্বাস করে ক্যাশে সূচী কর্মক্ষমতা উন্নত করতে সাহায্য করতে পারে তখন স্থানীয় ক্যোয়ারী সম্পাদনের জন্য স্বয়ংক্রিয়ভাবে স্থায়ী ক্যাশে সূচী তৈরি করতে SDK-কে সক্ষম করে৷ এই বৈশিষ্ট্যটি ডিফল্টরূপে অক্ষম করা হয়৷
ফাংশন (বাম, ...)
সমষ্টিক্ষেত্র সমান(বাম, ডান) দুটি 'AggregateField তুলনা করে ' সমতার জন্য উদাহরণ।
aggregateQuerySnapshotEqual(বাম, ডান) সমতার জন্য দুটি AggregateQuerySnapshot উদাহরণ তুলনা করে। দুটি AggregateQuerySnapshot দৃষ্টান্তকে "সমান" হিসাবে বিবেচনা করা হয় যদি তাদের অন্তর্নিহিত প্রশ্ন থাকে যা সমান এবং একই ডেটা তুলনা করে।
প্রশ্ন সমান (বাম, ডান) প্রদত্ত প্রশ্নগুলি একই সংগ্রহের দিকে নির্দেশ করে এবং একই সীমাবদ্ধতা প্রয়োগ করলে সত্য ফেরত দেয়।
refEqual (বাম, ডান) প্রদত্ত রেফারেন্স সমান হলে সত্য প্রদান করে।
স্ন্যাপশট সমান (বাম, ডান) প্রদত্ত স্ন্যাপশট সমান হলে সত্য দেখায়।
ফাংশন (সীমা, ...)
সীমা (সীমা) একটি QueryLimitConstraint তৈরি করে যা শুধুমাত্র প্রথম মিলিত নথি প্রদান করে।
limitToLast(সীমা) একটি QueryLimitConstraint তৈরি করে যা শুধুমাত্র শেষ মিলিত নথি প্রদান করে। limitToLast ক্যোয়ারীগুলির জন্য আপনাকে অবশ্যই অন্তত একটি orderBy ধারা উল্লেখ করতে হবে, অন্যথায় কার্যকর করার সময় একটি ব্যতিক্রম নিক্ষেপ করা হবে।
ফাংশন (লগ লেভেল, ...)
সেটলগ লেভেল(লগ লেভেল) ক্লাউড ফায়ারস্টোর লগের ভারবোসিটি সেট করে (ডিবাগ, ত্রুটি, বা নীরব)।
ফাংশন(n, ...)
বৃদ্ধি (n) একটি বিশেষ মান প্রদান করে যা setDoc() বা updateDoc() এর সাথে ব্যবহার করা যেতে পারে যা সার্ভারকে প্রদত্ত মান দ্বারা ক্ষেত্রের বর্তমান মান বৃদ্ধি করতে বলে। যদি হয় অপারেন্ড বা বর্তমান ক্ষেত্রের মান ফ্লোটিং পয়েন্ট নির্ভুলতা ব্যবহার করে, তবে সমস্ত পাটিগণিত IEEE 754 শব্দার্থবিদ্যা অনুসরণ করে। যদি উভয় মানই পূর্ণসংখ্যা হয়, তাহলে JavaScript-এর নিরাপদ সংখ্যা সীমার বাইরের মানগুলি ( Number.MIN_SAFE_INTEGER থেকে Number.MAX_SAFE_INTEGER )ও নির্ভুলতা ক্ষতির সাপেক্ষে৷ উপরন্তু, একবার Firestore ব্যাকএন্ড দ্বারা প্রক্রিয়া করা হলে, সমস্ত পূর্ণসংখ্যা অপারেশন -2^63 এবং 2^63-1 এর মধ্যে সীমাবদ্ধ থাকে। যদি বর্তমান ক্ষেত্রের মানটি টাইপ number না হয়, অথবা যদি ক্ষেত্রটি এখনও বিদ্যমান না থাকে, তাহলে রূপান্তরটি ক্ষেত্রটিকে প্রদত্ত মানের সাথে সেট করে।
ফাংশন (কোয়েরি, ...)
getAggregateFromServer(ক্যোয়ারী, aggregateSpec) প্রকৃতপক্ষে নথিগুলি ডাউনলোড না করেই প্রদত্ত কোয়েরির ফলাফল সেটে নথিগুলির উপর নির্দিষ্ট সমষ্টি গণনা করে৷ একত্রীকরণ সম্পাদন করতে এই ফাংশনটি ব্যবহার করা কার্যকর কারণ শুধুমাত্র চূড়ান্ত সমষ্টি মান, নথির ডেটা নয়, ডাউনলোড করা হয়। এই ফাংশনটি নথির একত্রীকরণ সম্পাদন করতে পারে যেখানে ফলাফল সেট সম্পূর্ণরূপে ডাউনলোড করার জন্য নিষেধমূলকভাবে বড় হয় (হাজার হাজার নথি)। সার্ভার থেকে প্রাপ্ত ফলাফল উপস্থাপন করা হয়, অপরিবর্তিত, কোনো স্থানীয় অবস্থা বিবেচনা না করে। অর্থাৎ, স্থানীয় ক্যাশে নথিগুলি বিবেচনায় নেওয়া হয় না, স্থানীয় পরিবর্তনগুলি এখনও সার্ভারের সাথে সিঙ্ক্রোনাইজ করা হয় না। পূর্বে-ডাউনলোড করা ফলাফল, যদি থাকে, ব্যবহার করা হয় না। এই ফাংশনের প্রতিটি আমন্ত্রণ অগত্যা সার্ভারে একটি রাউন্ড ট্রিপ জড়িত।
getCountFromServer(কোয়েরি) প্রকৃতপক্ষে নথিগুলি ডাউনলোড না করেই প্রদত্ত প্রশ্নের ফলাফল সেটে নথির সংখ্যা গণনা করে৷ নথিগুলি গণনা করার জন্য এই ফাংশনটি ব্যবহার করা কার্যকর কারণ শুধুমাত্র চূড়ান্ত গণনা, নথির ডেটা নয়, ডাউনলোড করা হয়৷ এই ফাংশনটি সেই ক্ষেত্রে নথিগুলি গণনা করতে পারে যেখানে ফলাফল সেট সম্পূর্ণরূপে ডাউনলোড করার জন্য নিষেধমূলকভাবে বড় (হাজার হাজার নথি)। সার্ভার থেকে প্রাপ্ত ফলাফল উপস্থাপন করা হয়, অপরিবর্তিত, কোনো স্থানীয় অবস্থা বিবেচনা না করে। অর্থাৎ, স্থানীয় ক্যাশে নথিগুলি বিবেচনায় নেওয়া হয় না, স্থানীয় পরিবর্তনগুলি এখনও সার্ভারের সাথে সিঙ্ক্রোনাইজ করা হয় না। পূর্বে-ডাউনলোড করা ফলাফল, যদি থাকে, ব্যবহার করা হয় না। এই ফাংশনের প্রতিটি আমন্ত্রণ অগত্যা সার্ভারে একটি রাউন্ড ট্রিপ জড়িত।
getDocs(কোয়েরি) ক্যোয়ারীটি চালায় এবং একটি QuerySnapshot হিসাবে ফলাফল প্রদান করে। দ্রষ্টব্য: getDocs() সার্ভার থেকে ডেটার জন্য অপেক্ষা করে আপ-টু-ডেট ডেটা দেওয়ার চেষ্টা করে, কিন্তু এটি ক্যাশে ডেটা ফেরত দিতে পারে বা ব্যর্থ হতে পারে যদি আপনি অফলাইনে থাকেন এবং সার্ভারে পৌঁছানো যায় না। এই আচরণটি নির্দিষ্ট করতে, getDocsFromCache() বা getDocsFromServer() আহ্বান করুন .
getDocsFromCache(কোয়েরি) ক্যোয়ারীটি চালায় এবং ক্যাশে থেকে একটি QuerySnapshot হিসাবে ফলাফল প্রদান করে। কোয়েরির সাথে মেলে এমন কোনো নথি বর্তমানে ক্যাশে না থাকলে একটি খালি ফলাফল সেট প্রদান করে।
getDocsFromServer(কোয়েরি) ক্যোয়ারী এক্সিকিউট করে এবং সার্ভার থেকে QuerySnapshot হিসাবে ফলাফল প্রদান করে। নেটওয়ার্ক উপলব্ধ না হলে একটি ত্রুটি প্রদান করে।
অন ​​স্ন্যাপশট (কোয়েরি, পর্যবেক্ষক) QuerySnapshot ইভেন্টের জন্য একজন শ্রোতাকে সংযুক্ত করে। আপনি হয় ব্যক্তিগত onNext এবং onError কলব্যাক পাস করতে পারেন অথবা next এবং error কলব্যাক সহ একটি একক পর্যবেক্ষক বস্তু পাস করতে পারেন। onSnapshot কল করার সময় যে ফাংশনটি ফেরত দেওয়া হয় তাকে কল করে শ্রোতা বাতিল করা যেতে পারে। দ্রষ্টব্য: যদিও একটি onCompletion কলব্যাক প্রদান করা যেতে পারে, তবে এটি কখনই কল করা হবে না কারণ স্ন্যাপশট স্ট্রীম কখনই শেষ হয় না।
অন ​​স্ন্যাপশট (কোয়েরি, বিকল্প, পর্যবেক্ষক) QuerySnapshot ইভেন্টের জন্য একজন শ্রোতাকে সংযুক্ত করে। আপনি হয় ব্যক্তিগত onNext এবং onError কলব্যাক পাস করতে পারেন অথবা next এবং error কলব্যাক সহ একটি একক পর্যবেক্ষক বস্তু পাস করতে পারেন। onSnapshot কল করার সময় যে ফাংশনটি ফেরত দেওয়া হয় তাকে কল করে শ্রোতা বাতিল করা যেতে পারে। দ্রষ্টব্য: যদিও একটি onCompletion কলব্যাক প্রদান করা যেতে পারে, তবে এটি কখনই কল করা হবে না কারণ স্ন্যাপশট স্ট্রীম কখনই শেষ হয় না।
অনস্ন্যাপশট (ক্যোয়ারী, অন নেক্সট, অন ইরর, অন কমপ্লিশন) QuerySnapshot ইভেন্টের জন্য একজন শ্রোতাকে সংযুক্ত করে। আপনি হয় ব্যক্তিগত onNext এবং onError কলব্যাক পাস করতে পারেন অথবা next এবং error কলব্যাক সহ একটি একক পর্যবেক্ষক বস্তু পাস করতে পারেন। onSnapshot কল করার সময় যে ফাংশনটি ফেরত দেওয়া হয় তাকে কল করে শ্রোতা বাতিল করা যেতে পারে। দ্রষ্টব্য: যদিও একটি onCompletion কলব্যাক প্রদান করা যেতে পারে, তবে এটি কখনই কল করা হবে না কারণ স্ন্যাপশট স্ট্রীম কখনই শেষ হয় না।
অনস্ন্যাপশট (ক্যোয়ারী, বিকল্প, অন ​​নেক্সট, অনএরর, অন কমপ্লিশন) QuerySnapshot ইভেন্টের জন্য একজন শ্রোতাকে সংযুক্ত করে। আপনি হয় ব্যক্তিগত onNext এবং onError কলব্যাক পাস করতে পারেন অথবা next এবং error কলব্যাক সহ একটি একক পর্যবেক্ষক বস্তু পাস করতে পারেন। onSnapshot কল করার সময় যে ফাংশনটি ফেরত দেওয়া হয় তাকে কল করে শ্রোতা বাতিল করা যেতে পারে। দ্রষ্টব্য: যদিও একটি onCompletion কলব্যাক প্রদান করা যেতে পারে, তবে এটি কখনই কল করা হবে না কারণ স্ন্যাপশট স্ট্রীম কখনই শেষ হয় না।
ক্যোয়ারী (ক্যোয়ারী, কম্পোজিট ফিল্টার, ক্যোয়ারী কন্সট্রাইন্টস) কোয়েরির একটি নতুন অপরিবর্তনীয় উদাহরণ তৈরি করে যা অতিরিক্ত ক্যোয়ারী সীমাবদ্ধতা অন্তর্ভুক্ত করার জন্য প্রসারিত হয়।
প্রশ্ন (ক্যোয়ারী, ক্যোয়ারী সীমাবদ্ধতা) কোয়েরির একটি নতুন অপরিবর্তনীয় উদাহরণ তৈরি করে যা অতিরিক্ত ক্যোয়ারী সীমাবদ্ধতা অন্তর্ভুক্ত করার জন্য প্রসারিত হয়।
ফাংশন (কোয়েরি সীমাবদ্ধতা, ...)
এবং (কোয়েরি সীমাবদ্ধতা) একটি নতুন QueryCompositeFilterConstraint তৈরি করে যা প্রদত্ত ফিল্টার সীমাবদ্ধতার সংমিশ্রণ। একটি সংযোগ ফিল্টার একটি নথি অন্তর্ভুক্ত করে যদি এটি প্রদত্ত সমস্ত ফিল্টারকে সন্তুষ্ট করে।
অথবা (কোয়েরি সীমাবদ্ধতা) একটি নতুন QueryCompositeFilterConstraint তৈরি করে যা প্রদত্ত ফিল্টার সীমাবদ্ধতার একটি বিচ্ছিন্নতা। একটি বিচ্ছিন্নতা ফিল্টার একটি নথি অন্তর্ভুক্ত করে যদি এটি প্রদত্ত ফিল্টারগুলির যেকোনো একটিকে সন্তুষ্ট করে।
ফাংশন (রেফারেন্স, ...)
addDoc (রেফারেন্স, ডেটা) প্রদত্ত ডেটার সাথে নির্দিষ্ট CollectionReference একটি নতুন নথি যোগ করুন, এটিকে স্বয়ংক্রিয়ভাবে একটি নথি আইডি বরাদ্দ করুন।
সংগ্রহ (রেফারেন্স, পাথ, পাথ সেগমেন্ট) একটি CollectionReference ইনস্ট্যান্স পায় যা নির্দিষ্ট আপেক্ষিক পাথে reference একটি উপ-সংকলনকে বোঝায়।
সংগ্রহ (রেফারেন্স, পাথ, পাথ সেগমেন্ট) একটি CollectionReference ইনস্ট্যান্স পায় যা নির্দিষ্ট আপেক্ষিক পাথে reference একটি উপ-সংকলনকে বোঝায়।
ডিলিট ডক (রেফারেন্স) নির্দিষ্ট DocumentReference দ্বারা উল্লেখ করা নথিটি মুছে দেয়।
ডক (রেফারেন্স, পাথ, পাথ সেগমেন্ট) একটি DocumentReference উদাহরণ পায় যা নির্দিষ্ট আপেক্ষিক পাথে reference মধ্যে একটি নথিকে বোঝায়। যদি কোনো পাথ নির্দিষ্ট করা না থাকে, তাহলে প্রত্যাবর্তিত DocumentReference এর জন্য একটি স্বয়ংক্রিয়ভাবে তৈরি অনন্য আইডি ব্যবহার করা হবে।
ডক (রেফারেন্স, পাথ, পাথ সেগমেন্ট) একটি DocumentReference উদাহরণ পায় যা নির্দিষ্ট আপেক্ষিক পাথে reference মধ্যে একটি নথিকে বোঝায়।
getDoc(রেফারেন্স) এই DocumentReference দ্বারা উল্লেখিত নথিটি পড়ে। দ্রষ্টব্য: getDoc() সার্ভার থেকে ডেটার জন্য অপেক্ষা করে আপ-টু-ডেট ডেটা দেওয়ার চেষ্টা করে, কিন্তু এটি ক্যাশে ডেটা ফেরত দিতে পারে বা ব্যর্থ হতে পারে যদি আপনি অফলাইনে থাকেন এবং সার্ভারে পৌঁছানো যায় না। এই আচরণটি নির্দিষ্ট করতে, getDocFromCache() বা getDocFromServer() আহ্বান করুন .
getDocFromCache(রেফারেন্স) ক্যাশে থেকে এই DocumentReference দ্বারা উল্লেখিত নথিটি পড়ে। ডকুমেন্টটি বর্তমানে ক্যাশে না থাকলে একটি ত্রুটি প্রদান করে।
getDocFromServer(রেফারেন্স) সার্ভার থেকে এই DocumentReference দ্বারা উল্লেখিত নথিটি পড়ে। নেটওয়ার্ক উপলব্ধ না হলে একটি ত্রুটি প্রদান করে।
অন ​​স্ন্যাপশট (রেফারেন্স, পর্যবেক্ষক) DocumentSnapshot ইভেন্টের জন্য একজন শ্রোতাকে সংযুক্ত করে। আপনি হয় ব্যক্তিগত onNext এবং onError কলব্যাক পাস করতে পারেন অথবা next এবং error কলব্যাক সহ একটি একক পর্যবেক্ষক বস্তু পাস করতে পারেন। দ্রষ্টব্য: যদিও একটি onCompletion কলব্যাক প্রদান করা যেতে পারে, তবে এটি কখনই কল করা হবে না কারণ স্ন্যাপশট স্ট্রীম কখনই শেষ হয় না।
অন ​​স্ন্যাপশট (রেফারেন্স, বিকল্প, পর্যবেক্ষক) DocumentSnapshot ইভেন্টের জন্য একজন শ্রোতাকে সংযুক্ত করে। আপনি হয় ব্যক্তিগত onNext এবং onError কলব্যাক পাস করতে পারেন অথবা next এবং error কলব্যাক সহ একটি একক পর্যবেক্ষক বস্তু পাস করতে পারেন। দ্রষ্টব্য: যদিও একটি onCompletion কলব্যাক প্রদান করা যেতে পারে, তবে এটি কখনই কল করা হবে না কারণ স্ন্যাপশট স্ট্রীম কখনই শেষ হয় না।
অনস্ন্যাপশট (রেফারেন্স, অন নেক্সট, অনএরর, অন কমপ্লিশন) DocumentSnapshot ইভেন্টের জন্য একজন শ্রোতাকে সংযুক্ত করে। আপনি হয় ব্যক্তিগত onNext এবং onError কলব্যাক পাস করতে পারেন অথবা next এবং error কলব্যাক সহ একটি একক পর্যবেক্ষক বস্তু পাস করতে পারেন। দ্রষ্টব্য: যদিও একটি onCompletion কলব্যাক প্রদান করা যেতে পারে, তবে এটি কখনই কল করা হবে না কারণ স্ন্যাপশট স্ট্রীম কখনই শেষ হয় না।
অনস্ন্যাপশট (রেফারেন্স, অপশন, অন নেক্সট, অন ইরর, অন কমপ্লিশন) DocumentSnapshot ইভেন্টের জন্য একজন শ্রোতাকে সংযুক্ত করে। আপনি হয় ব্যক্তিগত onNext এবং onError কলব্যাক পাস করতে পারেন অথবা next এবং error কলব্যাক সহ একটি একক পর্যবেক্ষক বস্তু পাস করতে পারেন। দ্রষ্টব্য: যদিও একটি onCompletion কলব্যাক প্রদান করা যেতে পারে, তবে এটি কখনই কল করা হবে না কারণ স্ন্যাপশট স্ট্রীম কখনই শেষ হয় না।
সেটডক (রেফারেন্স, ডেটা) এই DocumentReference দ্বারা উল্লেখিত নথিতে লেখে। যদি নথিটি এখনও বিদ্যমান না থাকে তবে এটি তৈরি করা হবে।
সেটডক (রেফারেন্স, ডেটা, বিকল্প) নির্দিষ্ট DocumentReference দ্বারা উল্লেখিত নথিতে লেখে। যদি নথিটি এখনও বিদ্যমান না থাকে তবে এটি তৈরি করা হবে। আপনি যদি merge বা mergeFields প্রদান করেন, প্রদত্ত ডেটা একটি বিদ্যমান নথিতে মার্জ করা যেতে পারে।
আপডেট ডক (রেফারেন্স, ডেটা) নির্দিষ্ট DocumentReference দ্বারা উল্লেখ করা নথির আপডেট ক্ষেত্রগুলি। বিদ্যমান নেই এমন একটি নথিতে প্রয়োগ করা হলে আপডেটটি ব্যর্থ হবে।
আপডেট ডক (রেফারেন্স, ক্ষেত্র, মান, আরও ক্ষেত্র এবং মান) নির্দিষ্ট DocumentReference দ্বারা উল্লেখ করা নথিতে আপডেট ক্ষেত্রগুলি বিদ্যমান নেই এমন একটি নথিতে প্রয়োগ করা হলে আপডেট ব্যর্থ হবে৷ নেস্টেড ক্ষেত্রগুলিকে ডট-সপারেটেড ফিল্ড পাথ স্ট্রিং প্রদান করে বা FieldPath অবজেক্ট প্রদান করে আপডেট করা যেতে পারে।
ফাংশন (সেটিংস, ...)
memoryLocalCache(সেটিংস) MemoryLocalCache এর একটি উদাহরণ তৈরি করে। SDK কে কোন ক্যাশে লেয়ার ব্যবহার করতে হবে তা জানাতে দৃষ্টান্তটি FirestoreSettings.cache এ সেট করা যেতে পারে।
মেমরিLruGarbageCollector(সেটিংস) MemoryLruGarbageCollector এর একটি উদাহরণ তৈরি করে। সেটিং প্যারামিটারের অংশ হিসাবে একটি লক্ষ্য আকার নির্দিষ্ট করা যেতে পারে। ক্যাশের আকার প্রদত্ত আকারের চেয়ে বেশি হয়ে গেলে সংগ্রাহক নথি মুছে ফেলা শুরু করবেন। ডিফল্ট ক্যাশের আকার হল 40MB (40*1024*1024 বাইট)।
স্থায়ী লোকাল ক্যাশে (সেটিংস) PersistentLocalCache এর একটি উদাহরণ তৈরি করে। SDK কে কোন ক্যাশে লেয়ার ব্যবহার করতে হবে তা জানাতে দৃষ্টান্তটি FirestoreSettings.cache এ সেট করা যেতে পারে। একটি Node.js পরিবেশে স্থায়ী ক্যাশে ব্যবহার করা যাবে না।
অবিরাম SingleTabManager(সেটিংস) PersistentSingleTabManager এর একটি উদাহরণ তৈরি করে।
ফাংশন (স্ন্যাপশট, ...)
endAt(স্ন্যাপশট) একটি QueryEndAtConstraint তৈরি করে যা প্রদত্ত নথিতে (অন্তর্ভুক্ত) শেষ হতে সেট করা ফলাফল পরিবর্তন করে। শেষ অবস্থানটি প্রশ্নের ক্রম সম্পর্কিত। ডকুমেন্টে অবশ্যই ক্যোয়ারির অর্ডারে দেওয়া সমস্ত ক্ষেত্র থাকতে হবে।
endBefore(স্ন্যাপশট) একটি QueryEndAtConstraint তৈরি করে যা প্রদত্ত নথির (একচেটিয়া) আগে শেষ হতে সেট করা ফলাফলকে সংশোধন করে। শেষ অবস্থানটি প্রশ্নের ক্রম সম্পর্কিত। ডকুমেন্টে অবশ্যই ক্যোয়ারির অর্ডারে দেওয়া সমস্ত ক্ষেত্র থাকতে হবে।
startAfter(স্ন্যাপশট) একটি QueryStartAtConstraint তৈরি করে যা প্রদত্ত নথির (একচেটিয়া) পরে শুরু হতে ফলাফল সেটটিকে সংশোধন করে৷ শুরুর অবস্থানটি প্রশ্নের ক্রম অনুসারে। ডকুমেন্টে অবশ্যই ক্যোয়ারির অর্ডারে দেওয়া সমস্ত ক্ষেত্র থাকতে হবে।
startAt(স্ন্যাপশট) একটি QueryStartAtConstraint তৈরি করে যা প্রদত্ত নথিতে (অন্তর্ভুক্ত) শুরু করার জন্য ফলাফল সেটটিকে সংশোধন করে। শুরুর অবস্থানটি প্রশ্নের ক্রম অনুসারে। ডকুমেন্টে অবশ্যই এই ক্যোয়ারীটির মাধ্যমে orderBy প্রদত্ত সমস্ত ক্ষেত্র থাকতে হবে।

ক্লাস

ক্লাস বর্ণনা
Aggregatefield Firestore দ্বারা সঞ্চালিত হতে পারে এমন একটি সমষ্টির প্রতিনিধিত্ব করে৷
AggregateQuerySnapshot একটি সমষ্টি অনুসন্ধান চালানোর ফলাফল।
বাইট একটি অপরিবর্তনীয় বস্তু বাইটের একটি অ্যারের প্রতিনিধিত্ব করে।
সংগ্রহ রেফারেন্স একটি CollectionReference অবজেক্ট ডকুমেন্ট যোগ করার জন্য, ডকুমেন্টের রেফারেন্স পাওয়ার জন্য এবং ডকুমেন্টের জন্য ক্যোয়ারী করার জন্য ব্যবহার করা যেতে পারে ( query( ব্যবহার করে) )
ডকুমেন্ট রেফারেন্স একটি DocumentReference একটি ফায়ারস্টোর ডাটাবেসের একটি নথির অবস্থানকে বোঝায় এবং অবস্থান লিখতে, পড়তে বা শোনার জন্য ব্যবহার করা যেতে পারে। উল্লেখিত স্থানে নথিটি বিদ্যমান থাকতে পারে বা নাও থাকতে পারে।
ডকুমেন্টস্ন্যাপশট একটি DocumentSnapshot আপনার ফায়ারস্টোর ডাটাবেসের একটি নথি থেকে পড়া ডেটা রয়েছে। একটি নির্দিষ্ট ক্ষেত্র পেতে .data() বা .get(<field>) দিয়ে ডেটা বের করা যেতে পারে। একটি DocumentSnapshot জন্য যা একটি অ-বিদ্যমান নথির দিকে নির্দেশ করে, যেকোনো ডেটা অ্যাক্সেস 'অনির্ধারিত' ফিরে আসবে। আপনি একটি নথির অস্তিত্ব স্পষ্টভাবে যাচাই করতে exists() পদ্ধতি ব্যবহার করতে পারেন।
ফিল্ডপাথ একটি FieldPath একটি নথিতে একটি ক্ষেত্র বোঝায়। পাথ একটি একক ক্ষেত্রের নাম (নথিতে একটি শীর্ষ-স্তরের ক্ষেত্র উল্লেখ করে), বা ক্ষেত্রের নামের একটি তালিকা (নথিতে একটি নেস্টেড ক্ষেত্র উল্লেখ করে) নিয়ে গঠিত হতে পারে। ক্ষেত্রের নাম প্রদান করে একটি FieldPath তৈরি করুন। যদি একাধিক ক্ষেত্রের নাম প্রদান করা হয়, পাথটি একটি নথিতে একটি নেস্টেড ক্ষেত্রে নির্দেশ করবে।
ফিল্ড ভ্যালু সেন্টিনেল মান যা set() বা update() দিয়ে নথি ক্ষেত্র লেখার সময় ব্যবহার করা যেতে পারে।
ফায়ারস্টোর ক্লাউড ফায়ারস্টোর পরিষেবা ইন্টারফেস। এই কন্সট্রাকটরকে সরাসরি কল করবেন না। পরিবর্তে, getFirestore() ব্যবহার করুন .
ফায়ারস্টোর ত্রুটি একটি Firestore অপারেশন দ্বারা ফিরে একটি ত্রুটি.
জিওপয়েন্ট Firestore-এ একটি ভৌগলিক অবস্থানের প্রতিনিধিত্বকারী একটি অপরিবর্তনীয় বস্তু। অবস্থানটি অক্ষাংশ/দ্রাঘিমাংশ যুগল হিসাবে উপস্থাপিত হয়। অক্ষাংশের মানগুলি [-৯০, ৯০] এর পরিসরে। দ্রাঘিমাংশের মানগুলি [-180, 180] এর পরিসরে।
লোডবান্ডেল টাস্ক একটি Firestore বান্ডেল লোড করার কাজটি উপস্থাপন করে। এটি বান্ডিল লোডিংয়ের অগ্রগতি, সেইসাথে টাস্ক সমাপ্তি এবং ত্রুটি ইভেন্টগুলি প্রদান করে। API Promise<LoadBundleTaskProgress> এর সাথে সামঞ্জস্যপূর্ণ।
পারসিস্টেন্ট ক্যাচ ইনডেক্স ম্যানেজার স্থানীয় ক্যোয়ারী এক্সিকিউশনের জন্য ব্যবহৃত ক্রমাগত ক্যাশে ইনডেক্স কনফিগার করার জন্য একটি PersistentCacheIndexManager । ব্যবহার করতে, একটি উদাহরণ পেতে getPersistentCacheIndexManager() কল করুন।
প্রশ্ন একটি Query এমন একটি প্রশ্নকে বোঝায় যা আপনি পড়তে বা শুনতে পারেন। আপনি ফিল্টার যোগ করে এবং অর্ডার দিয়ে পরিমার্জিত Query অবজেক্টও তৈরি করতে পারেন।
QuerycompositeFilter Constraint একটি QueryCompositeFilterConstraint একাধিক QueryFieldFilterConstraint এর যৌক্তিক OR বা AND সম্পাদন করে একটি Firestore ক্যোয়ারী দ্বারা প্রত্যাবর্তিত নথির সেটকে সংকুচিত করতে ব্যবহৃত হয় s বা Query CompositeFilter Constraint s QueryCompositeFilterConstraint QueryCompositeFilterConstraint তৈরি করা হয় বা
ক্যোয়ারী কনস্ট্রেন্ট একটি QueryConstraint একটি Firestore ক্যোয়ারী দ্বারা প্রত্যাবর্তিত নথির সেট সংকীর্ণ করতে ব্যবহৃত হয়। QueryConstraint যেখানে () আহ্বান করে তৈরি করা হয় , অর্ডার দ্বারা() , শুরু হবে() , শুরু করার পরে() , endBefore() , endAt() , সীমা() , limitToLast() এবং তারপরে এই QueryConstraint ধারণ করে একটি নতুন ক্যোয়ারী উদাহরণ তৈরি করতে query() এ পাস করা যেতে পারে।
QueryDocumentSnapshot একটি QueryDocumentSnapshot একটি প্রশ্নের অংশ হিসাবে আপনার Firestore ডাটাবেসের একটি নথি থেকে পঠিত ডেটা রয়েছে৷ নথিটির অস্তিত্ব নিশ্চিত করা হয়েছে এবং একটি নির্দিষ্ট ক্ষেত্র পেতে এর ডেটা .data() বা .get(<field>) দিয়ে বের করা যেতে পারে। একটি QueryDocumentSnapshot একটি DocumentSnapshot হিসাবে একই API পৃষ্ঠ প্রদান করে। যেহেতু ক্যোয়ারী ফলাফল শুধুমাত্র বিদ্যমান নথি ধারণ করে, exists সম্পত্তি সর্বদা সত্য হবে এবং data() কখনই 'অনির্ধারিত' ফিরে আসবে না।
QueryEndAtConstraint একটি QueryEndAtConstraint একটি Firestore ক্যোয়ারী দ্বারা প্রত্যাবর্তিত ফলাফল সেটের শেষ থেকে নথি বাদ দিতে ব্যবহৃত হয়। QueryEndAtConstraint s তৈরি করা হয় endAt() বা endBefore() চালু করে এবং তারপর একটি নতুন ক্যোয়ারী উদাহরণ তৈরি করতে query() এ পাঠানো যেতে পারে যাতে এই QueryEndAtConstraint ও রয়েছে।
QueryFieldFilter Constraint একটি QueryFieldFilterConstraint এক বা একাধিক নথি ক্ষেত্রে ফিল্টার করে একটি Firestore ক্যোয়ারী দ্বারা প্রত্যাবর্তিত নথিগুলির সেটকে সংকুচিত করতে ব্যবহৃত হয়৷ QueryFieldFilterConstraint s তৈরি করা হয় where() আহ্বান করে এবং তারপর একটি নতুন কোয়েরি উদাহরণ তৈরি করতে query() এ পাস করা যেতে পারে যাতে এই QueryFieldFilterConstraint ও রয়েছে।
Query Limit Constraint একটি QueryLimitConstraint একটি Firestore ক্যোয়ারী দ্বারা প্রত্যাবর্তিত নথির সংখ্যা সীমিত করতে ব্যবহৃত হয়। QueryLimitConstraint গুলি limit() বা limitToLast() আহ্বান করে তৈরি করা হয় এবং তারপর একটি নতুন ক্যোয়ারী উদাহরণ তৈরি করতে query() এ পাস করা যেতে পারে যাতে এই QueryLimitConstraint ও রয়েছে।
QueryOrderByConstraint একটি QueryOrderByConstraint একটি Firestore ক্যোয়ারী দ্বারা প্রত্যাবর্তিত নথির সেট সাজানোর জন্য ব্যবহৃত হয়। QueryOrderByConstraint গুলি orderBy() চালু করার মাধ্যমে তৈরি করা হয় এবং তারপরে একটি নতুন কোয়েরি উদাহরণ তৈরি করতে query() এ পাঠানো যেতে পারে যাতে এই QueryOrderByConstraint ও রয়েছে। দ্রষ্টব্য: অর্ডারবি ক্ষেত্র না থাকা নথিগুলি ক্যোয়ারী ফলাফলের মধ্যে উপস্থিত থাকবে না।
কোয়েরি স্ন্যাপশট একটি QuerySnapshot শূন্য বা আরও বেশি DocumentSnapshot অবজেক্ট রয়েছে যা একটি ক্যোয়ারির ফলাফলের প্রতিনিধিত্ব করে। দস্তাবেজগুলি docs সম্পত্তিটির মাধ্যমে একটি অ্যারে হিসাবে অ্যাক্সেস করা যেতে পারে বা forEach পদ্ধতি ব্যবহার করে গণনা করা যেতে পারে। empty এবং size বৈশিষ্ট্যগুলির মাধ্যমে নথির সংখ্যা নির্ধারণ করা যেতে পারে।
ক্যোয়ারস্টার্ট্যাটকনস্ট্রেন্ট ফায়ারস্টোর ক্যোয়ারী দ্বারা ফিরে আসা ফলাফলের সেট শুরু থেকে নথিগুলি বাদ দিতে একটি QueryStartAtConstraint ব্যবহার করা হয়। QueryStartAtConstraint এস স্টার্ট () বা স্টার্টফটার () এর অনুরোধ করে তৈরি করা হয় এবং তারপরে একটি নতুন ক্যোয়ারী উদাহরণ তৈরি করতে ক্যোয়ারী () এ পাস করা যেতে পারে যাতে এই QueryStartAtConstraint রয়েছে।
স্ন্যাপশট মেটাডেটা স্ন্যাপশট সম্পর্কে মেটাডেটা, স্ন্যাপশটের অবস্থা বর্ণনা করে।
টাইমস্ট্যাম্প একটি Timestamp যে কোনও সময় অঞ্চল বা ক্যালেন্ডার থেকে পৃথক সময়ের মধ্যে একটি বিন্দু উপস্থাপন করে, ইউটিসি এপোচ টাইমে ন্যানোসেকেন্ড রেজোলিউশনে সেকেন্ড এবং সেকেন্ডের ভগ্নাংশ হিসাবে প্রতিনিধিত্ব করে। এটি প্রোলেপটিক গ্রেগরিয়ান ক্যালেন্ডার ব্যবহার করে এনকোড করা হয়েছে যা গ্রেগরিয়ান ক্যালেন্ডারটিকে এক বছর পিছনে প্রসারিত করে। এটি এনকোড করা হয়েছে যে সমস্ত মিনিটগুলি 60 সেকেন্ড দীর্ঘ, অর্থাৎ লিপ সেকেন্ডগুলি "গন্ধযুক্ত" হয় যাতে ব্যাখ্যার জন্য কোনও লিপ দ্বিতীয় টেবিলের প্রয়োজন হয় না। পরিসীমা 0001-01-01T00: 00: 00Z থেকে 9999-12-31T23: 59: 59.99999999999z থেকে। উদাহরণ এবং আরও নির্দিষ্টকরণের জন্য, টাইমস্ট্যাম্প সংজ্ঞাটি দেখুন .
লেনদেন একটি লেনদেনের একটি রেফারেন্স। Transaction updateFunction লেনদেনের অবজেক্টটি লেনদেনের প্রসঙ্গে ডেটা পড়তে এবং লেখার পদ্ধতি সরবরাহ করে। রান ট্রান্সঅ্যাকশন দেখুন () .
WriteBatch একক পারমাণবিক ইউনিট হিসাবে একাধিক লেখার জন্য ব্যবহৃত একটি রাইট ব্যাচ। একটি WriteBatch অবজেক্টটি রাইটিংব্যাচ () কল করে অর্জন করা যেতে পারে . এটি রাইটিং ব্যাচে লেখার যোগ করার পদ্ধতি সরবরাহ করে। লেখার কোনওটিই প্রতিশ্রুতিবদ্ধ হবে না (বা স্থানীয়ভাবে দৃশ্যমান) যতক্ষণ না রাইটব্যাচ.কমিট () বলা হয়।

ইন্টারফেস

ইন্টারফেস বর্ণনা
সমষ্টিগত সমষ্টিগুলির একটি সেট এবং তাদের উপনামগুলি নির্দিষ্ট করে।
নথি পরিবর্তন একটি DocumentChange একটি ক্যোয়ারির সাথে মেলে নথিগুলির পরিবর্তনের প্রতিনিধিত্ব করে। এটিতে ক্ষতিগ্রস্থ দস্তাবেজটি রয়েছে এবং যে ধরণের পরিবর্তিত হয়েছে তা রয়েছে।
ডকুমেন্টডাটা ডকুমেন্ট ডেটা ( সেটডোকের সাথে ব্যবহারের জন্য () ) মানগুলিতে ম্যাপযুক্ত ক্ষেত্রগুলি নিয়ে গঠিত।
এক্সপেরিমেন্টালংপলিংপশনস দীর্ঘ-পোলিং ব্যবহার করা হলে এসডিকে এর অন্তর্নিহিত নেটওয়ার্ক ট্রান্সপোর্ট (ওয়েবচ্যানেল) কনফিগার করে এমন বিকল্পগুলি। দ্রষ্টব্য: এই ইন্টারফেসটি "পরীক্ষামূলক" এবং এটি পরিবর্তনের সাপেক্ষে। FirestoreSettings.experimentalAutoDetectLongPolling দেখুন exe এক্সপেরিমেন্টালআউটোডেটেক্টলংপোলিং, FirestoreSettings.experimentalForceLongPolling , এবং FirestoreSettings.experimentalLongPollingOptions ।
ফায়ারস্টোরডেটাকনভার্টার withConverter() দ্বারা ব্যবহৃত AppModelType টাইপের ব্যবহারকারী অবজেক্টগুলিকে DbModelType টাইপের ফায়ারস্টোর ডেটাতে রূপান্তর করতে ব্যবহৃত হয়। রূপান্তরকারী ব্যবহার আপনাকে ফায়ারস্টোর থেকে অবজেক্টগুলি সংরক্ষণ এবং পুনরুদ্ধার করার সময় জেনেরিক টাইপ আর্গুমেন্টগুলি নির্দিষ্ট করতে দেয়। এই প্রসঙ্গে, একটি "অ্যাপমোডেল" এমন একটি শ্রেণি যা সম্পর্কিত তথ্য এবং কার্যকারিতা একসাথে প্যাকেজ করার জন্য একটি অ্যাপ্লিকেশনটিতে ব্যবহৃত হয়। এই জাতীয় শ্রেণীর উদাহরণস্বরূপ, জটিল, নেস্টেড ডেটা প্রকার, স্মৃতিচারণের জন্য ব্যবহৃত বৈশিষ্ট্য, ফায়ারস্টোর (যেমন symbol এবং bigint ) দ্বারা সমর্থিত নয় এমন ধরণের বৈশিষ্ট্য এবং যৌগিক ক্রিয়াকলাপ সম্পাদনকারী সহায়ক ফাংশনগুলির বৈশিষ্ট্য থাকতে পারে। এই জাতীয় ক্লাসগুলি ফায়ারস্টোর ডাটাবেসে সঞ্চয় করা উপযুক্ত এবং/অথবা সম্ভব নয়। পরিবর্তে, এই জাতীয় শ্রেণীর উদাহরণগুলি একচেটিয়াভাবে আদিম বৈশিষ্ট্যগুলির সাথে "প্লেইন ওল্ড জাভাস্ক্রিপ্ট অবজেক্টস" (পিওজো) এ রূপান্তর করা দরকার, অন্যান্য পোজো বা পোজোর অ্যারেগুলির মধ্যে সম্ভাব্যভাবে বাসা করা। এই প্রসঙ্গে, এই ধরণেরটিকে "ডিবি মোডেল" হিসাবে উল্লেখ করা হয় এবং এটি ফায়ারস্টোরে স্থির থাকার জন্য উপযুক্ত একটি বস্তু হবে। সুবিধার জন্য, অ্যাপ্লিকেশনগুলি FirestoreDataConverter প্রয়োগ করতে পারে এবং ফায়ারস্টোর অবজেক্টগুলির সাথে DocumentReference বা Query মতো নিবন্ধন করতে পারে, স্বয়ংক্রিয়ভাবে ফায়ারস্টোরে সংরক্ষণের সময় AppModel DbModel রূপান্তর করতে এবং ফায়ারস্টোর থেকে পুনরুদ্ধার করার সময় DbModel AppModel রূপান্তর করতে পারে।
ফায়ারস্টোর সেটিংস আপনার ক্লাউড ফায়ারস্টোর উদাহরণের জন্য কাস্টম কনফিগারেশনগুলি নির্দিষ্ট করে। অন্য কোনও পদ্ধতি আহ্বান করার আগে আপনাকে এগুলি সেট করতে হবে।
সূচক (বিটা) ফায়ারস্টোর সূচকের এসডিকে সংজ্ঞা।
সূচক কনফিগারেশন (বিটা) স্থানীয় ক্যোয়ারী এক্সিকিউশনকে গতি বাড়ানোর জন্য ফায়ারস্টোর সূচকগুলির একটি তালিকা। সূচক সংজ্ঞাটির বিন্যাসের বিবরণের জন্য JSON ফর্ম্যাটটি দেখুন।
ইনডেক্সফিল্ড (বিটা) একটি সূচক কনফিগারেশনে একটি একক ক্ষেত্রের উপাদান।
LoadBundleTaskProgress বান্ডিলগুলি লোড করা থেকে একটি অগ্রগতি আপডেট বা একটি চূড়ান্ত অবস্থার প্রতিনিধিত্ব করে।
মেমরি ক্যাশে সেটিংস একটি সেটিংস একটি MemoryLocalCache উদাহরণ কনফিগার করতে অবজেক্ট করে।
মেমোরিএগারগারব্যাগকোলেক্টর একটি আবর্জনা সংগ্রাহক যখনই কোনও সক্রিয় প্রশ্নের অংশ না হয় তখন নথিগুলি মুছে দেয় এবং তাদের সাথে কোনও স্থানীয় মিউটেশন সংযুক্ত থাকে না। এই সংগ্রাহক এসডিকে থেকে সর্বনিম্ন মেমরির পদচিহ্নগুলি নিশ্চিত করার চেষ্টা করে, ডকুমেন্টগুলি অফলাইন প্রশ্নের জন্য বা ক্যাশে সরাসরি প্রশ্নের জন্য ক্যাশে না করার ঝুঁকিতে। এই সংগ্রাহকের উদাহরণ তৈরি করতে কারখানার ফাংশন ব্যবহার করুন।
মেমরিলোকালক্যাচ এসডিকে একটি মেমরি ক্যাশে সরবরাহ করে। অন্যথায় স্পষ্টভাবে কনফিগার না করা হলে এটি ডিফল্ট ক্যাশে। ব্যবহার করতে, কারখানার ফাংশনটি ব্যবহার করে একটি উদাহরণ তৈরি করুন, তারপরে FirestoreSettings.cache উদাহরণটি সেট করুন এবং সেটিংস অবজেক্টটি ব্যবহার করে initializeFirestore কল করুন।
মেমোরিআরগারব্যাগিক্লেক্টর একটি আবর্জনা সংগ্রাহক একাধিক ব্যাচে সর্বনিম্ন-ব্যবহার-ব্যবহৃত নথি মুছে দেয়। এই সংগ্রাহক একটি লক্ষ্য আকারের সাথে কনফিগার করা হয়েছে এবং ক্যাশেড ডকুমেন্টগুলি লক্ষ্য আকারের চেয়ে বেশি হলে কেবল সংগ্রহ সম্পাদন করবে। এটি বৃহত্তর মেমরির পদচিহ্নের ঝুঁকিতে একই ক্যোয়ারী বা ডকুমেন্টের জন্য পুনরাবৃত্তি করা ব্যাকএন্ডকে জিজ্ঞাসা করা এড়ায়। এই সংগ্রাহকের উদাহরণ তৈরি করতে কারখানার ফাংশন ব্যবহার করুন।
স্থিরতা সেটিংস যা ফায়ারস্টোর অধ্যবসায় কনফিগার করতে enableIndexedDbPersistence() সক্ষম করে দেওয়া যেতে পারে। নোড.জেএস পরিবেশে অধ্যবসায় ব্যবহার করা যায় না।
স্থায়ী ক্যাশে সেটিংস একটি সেটিংস অবজেক্ট একটি PersistentLocalCache উদাহরণ কনফিগার করতে। নোড.জেএস পরিবেশে অবিরাম ক্যাশে ব্যবহার করা যায় না।
অবিরাম লোকালক্যাচ এসডিকে ইনডেক্সডিব দ্বারা সমর্থিত একটি অবিরাম ক্যাশে সরবরাহ করে। ব্যবহার করতে, কারখানার ফাংশনটি ব্যবহার করে একটি উদাহরণ তৈরি করুন, তারপরে FirestoreSettings.cache উদাহরণটি সেট করুন এবং সেটিংস অবজেক্টটি ব্যবহার করে initializeFirestore কল করুন।
অবিরামমিলিটিপলেটবম্যানেজার একাধিক ট্যাব সমর্থনকারী একটি ট্যাব ম্যানেজার। এসডিকে এসডিকে ব্যবহার করে সমস্ত ট্যাব জুড়ে করা প্রশ্ন এবং মিউটেশনগুলি সিঙ্ক্রোনাইজ করবে।
অবিচ্ছিন্নতা একটি ট্যাব ম্যানেজার কেবলমাত্র একটি ট্যাব সমর্থন করে, ট্যাবগুলিতে কোনও সিঙ্ক্রোনাইজেশন করা হবে না।
অবিচ্ছিন্নতা একটি PersistentSingleTabManager কনফিগার করতে টাইপ করুন।
স্ন্যাপশটলিস্টেনোপশনস ফলাফলের সেটটিতে কোন ধরণের পরিবর্তনগুলি অন্তর্ভুক্ত করতে পারে তা নিয়ন্ত্রণ করতে এমন একটি বিকল্প অবজেক্ট যা অনসনাপশট () এবং কুইরিসন্যাপশট.ডোস্ক্যাঞ্জস () এ পাস করা যেতে পারে।
স্ন্যাপশোটোপশনস বিকল্পগুলি যা কনফিগার করে যে কোনও DocumentSnapshot থেকে কীভাবে ডেটা পুনরুদ্ধার করা হয় (উদাহরণস্বরূপ সার্ভার টাইমস্ট্যাম্পগুলির জন্য কাঙ্ক্ষিত আচরণ যা এখনও তাদের চূড়ান্ত মানটিতে সেট করা হয়নি)।
লেনদেনের বিকল্প লেনদেনের আচরণ কাস্টমাইজ করার বিকল্পগুলি।
সদস্যতা ত্যাগ করুন onSnapshot() দ্বারা ফিরে আসা একটি ফাংশন যা শ্রোতাকে আহ্বান করা হলে সরিয়ে দেয়।

ভেরিয়েবল

পরিবর্তনশীল বর্ণনা
Cache_size_unlimitted এলআরইউ আবর্জনা সংগ্রহটি নির্দেশ করতে ধ্রুবক ব্যবহৃত হয় তা অক্ষম করা উচিত। ফায়ারস্টোর উদাহরণে পাস করা সেটিংসে cacheSizeBytes হিসাবে এই মানটি সেট করুন।

উপনাম টাইপ করুন

ওরফে টাইপ করুন বর্ণনা
অ্যাডপ্রেফিক্সটোকিস একটি নতুন মানচিত্র ফেরত দেয় যেখানে প্রতিটি কী একটি বিন্দুতে সংযুক্ত বাইরের কী দিয়ে উপসর্গ করা হয়।
সমষ্টিফিল্ড টাইপ ফায়ারস্টোর দ্বারা সমর্থিত সমস্ত AggregateField ধরণের ইউনিয়ন।
সমষ্টিস্পেকডাটা এমন একটি ধরণের যার কীগুলি একটি AggregateSpec থেকে নেওয়া হয় এবং যার মানগুলি ইনপুট AggregateSpec থেকে সংশ্লিষ্ট AggregateField দ্বারা সম্পাদিত সংহতকরণের ফলাফল।
AggregateType ইউনিয়ন প্রকারটি সম্পাদন করার জন্য সামগ্রিক প্রকারের প্রতিনিধিত্ব করে।
চাইল্ডআপডেটফিল্ডস প্রদত্ত টাইপ টি 1 এর জন্য নেস্টেড ক্ষেত্রগুলি গণনা করার জন্য সহায়ক। এটি ইউনিয়ন প্রকারগুলি যেমন undefined | {...} বিতরণ করার জন্য প্রয়োজন undefined | {...} (al চ্ছিক প্রপসের জন্য ঘটে) বা {a: A} | {b: B} । এই ব্যবহারের ক্ষেত্রে, V Record T[K] এর ইউনিয়ন প্রকারগুলি বিতরণ করতে ব্যবহৃত হয়, যেহেতু T[K] একটি অভিব্যক্তি হিসাবে মূল্যায়ন করা হয় এবং বিতরণ করা হয় না। Https://www.typescriptlang.org/docs/handbook/advanced-types.html#distribitive-conditional-types দেখুন
ডকুমেন্ট চেঞ্জ টাইপ DocumentChange ধরণটি 'যুক্ত', 'সরানো', বা 'পরিবর্তিত' হতে পারে।
ফায়ারস্টোরাররকোড ফায়ারস্টোর স্ট্যাটাস কোডগুলির সেট। কোডগুলি এখানে জিআরপিসি দ্বারা উন্মুক্তভাবে একই রকম: https://github.com/grpc/grpc/blob/master/doc/statuscodes.md সম্ভাব্য মানগুলি: - 'বাতিল': অপারেশনটি বাতিল করা হয়েছিল (সাধারণত কলার দ্বারা)। - 'অজানা': অজানা ত্রুটি বা অন্য কোনও ত্রুটি ডোমেন থেকে ত্রুটি। - 'অবৈধ-যুক্তি': ক্লায়েন্ট একটি অবৈধ যুক্তি নির্দিষ্ট করেছে। নোট করুন যে এটি 'ব্যর্থ-পূর্বনির্ধারণ' থেকে পৃথক। 'অবৈধ-যুক্তি' এমন যুক্তিগুলি নির্দেশ করে যা সিস্টেমের অবস্থা নির্বিশেষে সমস্যাযুক্ত (যেমন একটি অবৈধ ক্ষেত্রের নাম)। - 'ডেডলাইন-অতিক্রম করা': অপারেশন শেষ হওয়ার আগে ডেডলাইনটির মেয়াদ শেষ হয়ে গেছে। সিস্টেমের অবস্থা পরিবর্তন করে এমন ক্রিয়াকলাপগুলির জন্য, অপারেশন সফলভাবে শেষ হয়ে গেলেও এই ত্রুটিটি ফিরে আসতে পারে। উদাহরণস্বরূপ, একটি সার্ভারের একটি সফল প্রতিক্রিয়া সময়সীমাটির মেয়াদ শেষ হওয়ার জন্য যথেষ্ট পরিমাণে বিলম্বিত হতে পারে। - 'নন-ফাউন্ড': কিছু অনুরোধ করা নথি পাওয়া যায় নি। - 'ইতিমধ্যে বিদ্যমান': কিছু নথি যা আমরা ইতিমধ্যে তৈরি করার চেষ্টা করেছি তা বিদ্যমান। - 'অনুমতি-সংহত': কলারের নির্দিষ্ট অপারেশন কার্যকর করার অনুমতি নেই। -'রিসোর্স-এক্সহাউস্টেড': কিছু সংস্থান ক্লান্ত হয়ে পড়েছে, সম্ভবত একটি প্রতি ব্যবহারকারী কোটা, বা সম্ভবত পুরো ফাইল সিস্টেমটি স্থানের বাইরে রয়েছে। - 'ব্যর্থ-পূর্বনির্ধারণ': অপারেশন প্রত্যাখ্যান করা হয়েছিল কারণ সিস্টেমটি অপারেশনের কার্যকরকরণের জন্য প্রয়োজনীয় কোনও রাজ্যে নেই। - 'বাতিল': অপারেশনটি বাতিল করা হয়েছিল, সাধারণত লেনদেন বাতিল ইত্যাদির মতো সম্মতিযুক্ত সমস্যার কারণে- 'পরিসীমা-বহির্ভূত': বৈধ পরিসীমা পেরিয়ে যাওয়ার চেষ্টা করা হয়েছিল। - 'অপ্রচলিত': অপারেশন প্রয়োগ করা হয় না বা সমর্থিত/সক্ষম নয়। - 'অভ্যন্তরীণ': অভ্যন্তরীণ ত্রুটি। এর অর্থ অন্তর্নিহিত সিস্টেমের দ্বারা প্রত্যাশিত কিছু আক্রমণকারী ভেঙে গেছে। আপনি যদি এই ত্রুটিগুলির মধ্যে একটি দেখতে পান তবে কিছু খুব ভেঙে গেছে। - 'অনুপলব্ধ': পরিষেবাটি বর্তমানে অনুপলব্ধ। এটি সম্ভবত একটি ক্ষণস্থায়ী অবস্থা এবং এটি ব্যাকঅফ দিয়ে পুনরায় চেষ্টা করে সংশোধন করা যেতে পারে। - 'ডেটা-ক্ষতি': অপরিবর্তনীয় ডেটা ক্ষতি বা দুর্নীতি। - 'অবহেলিত': অনুরোধটির অপারেশনের জন্য বৈধ প্রমাণীকরণের শংসাপত্র নেই।
ফায়ারস্টোরলোকালক্যাচ সমস্ত সমর্থিত এসডিকে ক্যাশে স্তর থেকে ইউনিয়ন প্রকার।
শ্রবণশক্তি উত্সটি বর্ণনা করুন একটি ক্যোয়ারী শুনে। ক্যাশে এবং সার্ভার উভয় পরিবর্তন শুনতে default সেট করুন। কেবল ক্যাশে পরিবর্তনগুলি শুনতে cache সেট করুন।
মেমরিগারব্যাগকোলেক্টর মেমরি স্থানীয় ক্যাশে জন্য সমস্ত সমর্থন গ্যাবেজ সংগ্রহকারীদের থেকে ইউনিয়ন টাইপ।
নেস্টেডআপডেটফিল্ডস প্রতিটি ক্ষেত্রের জন্য (যেমন 'বার'), সমস্ত নেস্টেড কীগুলি সন্ধান করুন (যেমন { 'বার.বাজ': টি 1, 'বার.কেক্স': টি 2 } ) সমস্ত সম্ভাব্য কীগুলি সমন্বিত একটি একক মানচিত্র তৈরি করতে তাদের একসাথে ছেদ করুন যা সমস্ত al চ্ছিক হিসাবে চিহ্নিত
অর্ডারবাইডাইরেকশন একটি অর্ডারবাই () ধারাটির দিকটি 'ডেস্ক' বা 'এএসসি' (অবতরণ বা আরোহী) হিসাবে নির্দিষ্ট করা হয়।
পার্টিয়াল উইথফিল্ডভ্যালু টাইপস্ক্রিপ্টের Partial<T> এর অনুরূপ, তবে নেস্টেড ক্ষেত্রগুলি বাদ দেওয়া এবং ফিল্ডভ্যালুগুলি সম্পত্তি মান হিসাবে পাস করার অনুমতি দেয়।
অবিরাম ট্যাবম্যানেজার সমস্ত উপলব্ধ ট্যাব পরিচালকদের একটি ইউনিয়ন।
আদিম আদিম প্রকার।
ক্যোয়ার কনস্ট্রেইন্টটাইপ এই এসডিকে উপলব্ধ বিভিন্ন ক্যোয়ারী সীমাবদ্ধতা বর্ণনা করে।
ক্যোরিফিল্টারকনস্ট্রেন্ট QueryFilterConstraint হ'ল একটি সহায়ক ইউনিয়ন প্রকার যা ক্যোয়ারীফিল্ডফিল্টারকনস্ট্রেন্ট এবং ক্যোয়ার কমপোসাইটফিলিটফিল্টারকনস্ট্রেন্টকে উপস্থাপন করে .
QuirynonfilterContraint QueryNonFilterConstraint হ'ল একটি সহায়ক ইউনিয়ন প্রকার যা ক্যোয়ার কনস্ট্রেন্টগুলি উপস্থাপন করে যা নথিগুলির সেট সংকীর্ণ বা অর্ডার করতে ব্যবহৃত হয়, তবে এটি কোনও নথি ক্ষেত্রে স্পষ্টভাবে ফিল্টার করে না। QueryNonFilterConstraint এস অর্ডার করে অর্ডার করে তৈরি করা হয়েছে () , শুরু হবে() , স্টার্টফটার () , শেষের আগে () , এন্ড্যাট () , সীমাবদ্ধ () বা লিমিটোলাস্ট () এবং তারপরে একটি নতুন ক্যোয়ারী উদাহরণ তৈরি করতে ক্যোয়ারী () এ পাস করা যেতে পারে যাতে QueryConstraint কনস্ট্রেন্টও রয়েছে।
সেট অপশন একটি বিকল্প অবজেক্ট যা সেটডোকের আচরণ কনফিগার করে () , এবং কল। এই কলগুলি মার্জ সহ একটি SetOptions সরবরাহ করে সম্পূর্ণরূপে লক্ষ্য নথিগুলিকে ওভাররাইটিংয়ের পরিবর্তে দানাদার মার্জগুলি সম্পাদন করতে কনফিগার করা যেতে পারে merge: true ।
টাস্কস্টেট বান্ডিল লোডিং কার্যগুলির অবস্থা উপস্থাপন করে। 'ত্রুটি' এবং 'সাফল্য' উভয়ই ডুবে যাওয়া রাষ্ট্র: টাস্কটি বাতিল বা সম্পূর্ণ হবে এবং তাদের রিপোর্ট হওয়ার পরে আর কোনও আপডেট হবে না।
ইউনিয়নটোইন্টারসেকশন একটি ইউনিয়ন টাইপ U = T1 | T2 | ... , একটি ছেদযুক্ত প্রকার (T1 & T2 & ...) প্রদান করে। শর্তসাপেক্ষ প্রকার থেকে বিতরণকারী শর্তসাপেক্ষ প্রকার এবং অনুমান ব্যবহার করে। এটি কাজ করে কারণ কনট্রা-ভারিয়েন্ট পজিশনে একই ধরণের ভেরিয়েবলের জন্য একাধিক প্রার্থী একটি ছেদকরণের ধরণকে অনুমান করা যায়। https://www.typescriptlang.org/docs/handbook/advanced-types.html#type-inferency-conditional-types https://stackoverflow.com/questions/50374908/transform-aniion-type- থেকে-সূচনা -টাইপ
আপডেট ডেটা ডেটা আপডেট করুন ( আপডেটডোক () সহ ব্যবহারের জন্য ) এটি ক্ষেত্রের পাথগুলি নিয়ে গঠিত (যেমন 'ফু' বা 'ফু.বাজ') মানগুলিতে ম্যাপ করা। যে ক্ষেত্রগুলি ডক্টরগুলির মধ্যে বিন্দু রেফারেন্স নেস্টেড ক্ষেত্রগুলি ধারণ করে। ফিল্ডভ্যালুগুলি সম্পত্তির মান হিসাবে পাস করা যেতে পারে।
যেখানে ফিল্টারপ একটি যেখানে () ধারাটিতে ফিল্টার শর্তাদি স্ট্রিংগুলি '& lt;', '& lt; =', '==', '! =', '& Gt; =', '& gt;', 'অ্যারে-কনটেনস' ব্যবহার করে নির্দিষ্ট করা হয় , 'ইন', 'অ্যারে-কনটেইনস-যে কোনও', এবং 'নয়'।
ফিল্ডভ্যালু সহ ধরণের সুরক্ষা বজায় রেখে ফিল্ডভ্যালুগুলি সম্পত্তি মান হিসাবে পাস করার অনুমতি দেয়।

ফাংশন (অ্যাপ্লিকেশন, ...)

getfirestore (অ্যাপ্লিকেশন)

প্রদত্ত ফায়ারব্যাস অ্যাপের সাথে সম্পর্কিত বিদ্যমান ডিফল্ট ফায়ারস্টোর উদাহরণটি ফেরত দেয় . যদি কোনও উদাহরণ না থাকে তবে ডিফল্ট সেটিংস সহ একটি নতুন উদাহরণ আরম্ভ করে।

স্বাক্ষর:

export declare function getFirestore(app: FirebaseApp): Firestore;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
অ্যাপ ফায়ারবেস অ্যাপ ফায়ারব্যাস অ্যাপ উদাহরণটি যে ফেরত ফায়ারস্টোর উদাহরণটির সাথে সম্পর্কিত।

রিটার্ন:

ফায়ারস্টোর

প্রদত্ত অ্যাপ্লিকেশনটির ডিফল্ট ফায়ারস্টোর উদাহরণ।

getfirestore (অ্যাপ্লিকেশন, ডাটাবেসিড)

এই APIটি বিকাশকারীদের জন্য একটি পূর্বরূপ হিসাবে প্রদান করা হয়েছে এবং আমরা যে প্রতিক্রিয়া গ্রহন করি তার উপর ভিত্তি করে পরিবর্তিত হতে পারে। একটি উত্পাদন পরিবেশে এই API ব্যবহার করবেন না.

প্রদত্ত ফায়ারস্টোর উদাহরণটি প্রদত্ত ফায়ারব্যাস অ্যাপের সাথে সম্পর্কিত returns . যদি কোনও উদাহরণ না থাকে তবে ডিফল্ট সেটিংস সহ একটি নতুন উদাহরণ আরম্ভ করে।

স্বাক্ষর:

export declare function getFirestore(app: FirebaseApp, databaseId: string): Firestore;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
অ্যাপ ফায়ারবেস অ্যাপ ফায়ারব্যাস অ্যাপ উদাহরণটি যে ফেরত ফায়ারস্টোর উদাহরণটির সাথে সম্পর্কিত।
ডাটাবেসিড স্ট্রিং ডাটাবেসের নাম।

রিটার্ন:

ফায়ারস্টোর

প্রদত্ত অ্যাপ্লিকেশনটির নামযুক্ত ফায়ারস্টোর উদাহরণ।

ইনিশিয়ালফিরস্টোর (অ্যাপ্লিকেশন, সেটিংস, ডাটাবেসআইডি)

প্রদত্ত সেটিংস সহ ফায়ারস্টোরের একটি নতুন উদাহরণ সূচনা করে। Getfirestore () সহ অন্য কোনও ফাংশনের আগে কেবল কল করা যেতে পারে . যদি কাস্টম সেটিংস খালি থাকে তবে এই ফাংশনটি getfirestore কল করার সমতুল্য () .

স্বাক্ষর:

export declare function initializeFirestore(app: FirebaseApp, settings: FirestoreSettings, databaseId?: string): Firestore;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
অ্যাপ ফায়ারবেস অ্যাপ ফায়ারস্টোর উদাহরণটি যুক্ত হবে এমন ফায়ারবাস অ্যাপ ।
সেটিংস ফায়ারস্টোর সেটিংস ফায়ারস্টোর উদাহরণটি কনফিগার করতে একটি সেটিংস অবজেক্ট।
ডাটাবেসিড স্ট্রিং ডাটাবেসের নাম।

রিটার্ন:

ফায়ারস্টোর

একটি নতুন সূচনা ফায়ারস্টোর উদাহরণ।

ফাংশন (ফায়ারস্টোর, ...)

ক্লিয়ার ইন্ডেক্সেডডিব্পারসেন্স (ফায়ারস্টোর)

অবিরাম স্টোরেজ সাফ করে। এর মধ্যে মুলতুবি লেখা এবং ক্যাশেড নথি অন্তর্ভুক্ত রয়েছে।

ফায়ারস্টোর উদাহরণটি শুরু না করার সময় অবশ্যই কল করতে হবে (অ্যাপ্লিকেশনটি সমাপ্ত হওয়ার পরে বা অ্যাপ্লিকেশনটি প্রথম শুরু করার পরে)। প্রারম্ভকালে, এই ফাংশনটি অবশ্যই অন্যান্য ফাংশনগুলির আগে কল করা উচিত ( ইনিশিয়ালফিরস্টোর () বা getfirestore () ব্যতীত অন্য ))। যদি ফায়ারস্টোর উদাহরণটি এখনও চলছে, তবে প্রতিশ্রুতিটি failed-precondition ত্রুটি কোডের সাথে প্রত্যাখ্যান করা হবে .

স্বাক্ষর:

export declare function clearIndexedDbPersistence(firestore: Firestore): Promise<void>;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
ফায়ারস্টোর ফায়ারস্টোর ফায়ারস্টোর উদাহরণটি দৃ istence ়তা পরিষ্কার করার জন্য।

রিটার্ন:

প্রতিশ্রুতি <শূন্য>

অবিচ্ছিন্ন স্টোরেজ সাফ হয়ে গেলে এমন একটি Promise সমাধান করা হয়। অন্যথায়, প্রতিশ্রুতি একটি ত্রুটি সঙ্গে প্রত্যাখ্যান করা হয়।

সংগ্রহ (ফায়ারস্টোর, পাথ, পাথসিমেন্টস)

একটি CollectionReference ক্ষেত্রে উদাহরণ পাওয়া যায় যা নির্দিষ্ট পরম পথে সংগ্রহকে বোঝায়।

স্বাক্ষর:

export declare function collection(firestore: Firestore, path: string, ...pathSegments: string[]): CollectionReference<DocumentData, DocumentData>;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
ফায়ারস্টোর ফায়ারস্টোর রুট Firestore উদাহরণের একটি রেফারেন্স।
পথ স্ট্রিং একটি সংগ্রহের একটি স্ল্যাশ-বিচ্ছিন্ন পথ।
পাথসগমেন্টস স্ট্রিং[] প্রথম আর্গুমেন্টের সাথে তুলনামূলকভাবে প্রয়োগ করতে অতিরিক্ত পাথ বিভাগগুলি।

রিটার্ন:

সংগ্রহ রেফারেন্স < ডকুমেন্টডাটা , ডকুমেন্টডাটা >

CollectionReference উদাহরণ উদাহরণ।

ব্যতিক্রম

যদি চূড়ান্ত পাথটিতে এমনকি সংখ্যক বিভাগ থাকে এবং কোনও সংগ্রহের দিকে নির্দেশ করে না।

সংগ্রহগ্রুপ (ফায়ারস্টোর, সংগ্রহ আইডি)

একটি নতুন Query উদাহরণ তৈরি করে এবং ফেরত দেয় যা প্রদত্ত collectionId সহ একটি সংগ্রহ বা সাবকোলেকশন অন্তর্ভুক্ত ডাটাবেসের সমস্ত নথি অন্তর্ভুক্ত করে .

স্বাক্ষর:

export declare function collectionGroup(firestore: Firestore, collectionId: string): Query<DocumentData, DocumentData>;

পরামিতি

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

রিটার্ন:

প্রশ্ন < ডকুমেন্টডাটা , ডকুমেন্টডাটা >

তৈরি করা Query .

কানেক্টফিরস্টোরিমুলেটর (ফায়ারস্টোর, হোস্ট, পোর্ট, বিকল্প)

ক্লাউড ফায়ারস্টোর এমুলেটরের সাথে যোগাযোগের জন্য এই উদাহরণটি সংশোধন করুন।

স্বাক্ষর:

export declare function connectFirestoreEmulator(firestore: Firestore, host: string, port: number, options?: {
    mockUserToken?: EmulatorMockTokenOptions | string;
}): void;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
ফায়ারস্টোর ফায়ারস্টোর এমুলেটরের সাথে সংযোগ স্থাপনের জন্য কনফিগার করার জন্য Firestore উদাহরণ।
হোস্ট স্ট্রিং এমুলেটর হোস্ট (প্রাক্তন: লোকালহোস্ট)।
বন্দর সংখ্যা এমুলেটর পোর্ট (প্রাক্তন: 9000)।
বিকল্প {মোকুসারটোকেন?: এমুলেটোরমোকটোকেনপশনস | স্ট্রিং }

রিটার্ন:

অকার্যকর

অক্ষম কাজ (ফায়ারস্টোর)

এই উদাহরণের জন্য নেটওয়ার্ক ব্যবহার অক্ষম করে। এটি সক্ষম করার মাধ্যমে পুনরায় সক্ষম করা যেতে পারে () . নেটওয়ার্কটি অক্ষম থাকাকালীন, যে কোনও স্ন্যাপশট শ্রোতা, getDoc() বা getDocs() কলগুলি ক্যাশে থেকে ফলাফল ফিরিয়ে দেবে এবং নেটওয়ার্কটি পুনরুদ্ধার না হওয়া পর্যন্ত যে কোনও লেখার ক্রিয়াকলাপ সারি করা হবে।

স্বাক্ষর:

export declare function disableNetwork(firestore: Firestore): Promise<void>;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
ফায়ারস্টোর ফায়ারস্টোর

রিটার্ন:

প্রতিশ্রুতি <শূন্য>

নেটওয়ার্কটি অক্ষম হয়ে গেলে এমন একটি Promise যা সমাধান করা হয়।

ডক (ফায়ারস্টোর, পাথ, পাথসিমেন্টস)

একটি DocumentReference উদাহরণ পান যা নির্দিষ্ট পরম পথে নথিকে বোঝায়।

স্বাক্ষর:

export declare function doc(firestore: Firestore, path: string, ...pathSegments: string[]): DocumentReference<DocumentData, DocumentData>;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
ফায়ারস্টোর ফায়ারস্টোর রুট Firestore উদাহরণের একটি রেফারেন্স।
পথ স্ট্রিং একটি নথিতে একটি স্ল্যাশ-বিচ্ছিন্ন পথ।
পাথসগমেন্টস স্ট্রিং[] অতিরিক্ত পাথ বিভাগগুলি যা প্রথম যুক্তির সাথে সম্পর্কিত প্রয়োগ করা হবে।

রিটার্ন:

ডকুমেন্ট রেফারেন্স < ডকুমেন্টডাটা , ডকুমেন্টডাটা >

DocumentReference উদাহরণ।

ব্যতিক্রম

যদি চূড়ান্ত পাথটিতে একটি বিজোড় সংখ্যা থাকে এবং কোনও দস্তাবেজকে নির্দেশ করে না।

সক্ষম indexeddbperesstist (ফায়ারস্টোর, রেসিস্টেন্সেসটিংস)

এই ফাংশনটি ভবিষ্যতের বড় রিলিজে সরানো হবে। পরিবর্তে, ইনডেক্সডডিবি ক্যাশে চালু করার জন্য FirestoreSettings.localCache PersistentLocalCache লোকলক্যাচের একটি উদাহরণে সেট করুন। FirestoreSettings.localCache ইতিমধ্যে নির্দিষ্ট করা হলে এই ফাংশনটি কল করা একটি ব্যতিক্রম ছুঁড়ে ফেলবে।

সম্ভব হলে অবিরাম স্টোরেজ সক্ষম করার চেষ্টা।

ব্যর্থতার উপর, enableIndexedDbPersistence() প্রতিশ্রুতি প্রত্যাখ্যান করবে বা একটি ব্যতিক্রম নিক্ষেপ করবে। এটি ব্যর্থ হতে পারে এমন বেশ কয়েকটি কারণ রয়েছে, যা ত্রুটির code দ্বারা চিহ্নিত করা যেতে পারে।

* ব্যর্থ-পূর্বনির্ধারণ: অ্যাপ্লিকেশনটি ইতিমধ্যে অন্য ব্রাউজার ট্যাবে খোলা আছে। * অপ্রচলিত: ব্রাউজারটি অফলাইন অধ্যবসায় বাস্তবায়নের সাথে বেমানান।

মনে রাখবেন যে ব্যর্থতার পরেও, ফায়ারস্টোর উদাহরণটি ব্যবহারযোগ্য থাকবে, তবে অফলাইন অধ্যবসায় অক্ষম করা হবে।

নোড.জেএস পরিবেশে অধ্যবসায় ব্যবহার করা যায় না।

স্বাক্ষর:

export declare function enableIndexedDbPersistence(firestore: Firestore, persistenceSettings?: PersistenceSettings): Promise<void>;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
ফায়ারস্টোর ফায়ারস্টোর ফায়ারস্টোর উদাহরণটির জন্য দৃ istence ়তা সক্ষম করার জন্য।
স্থিরতা স্থিরতা অধ্যবসায় কনফিগার করতে al চ্ছিক সেটিংস অবজেক্ট।

রিটার্ন:

প্রতিশ্রুতি <শূন্য>

একটি Promise যা অবিরাম স্টোরেজ সফলভাবে সক্ষম করে উপস্থাপন করে।

সক্ষমতা

এই ফাংশনটি ভবিষ্যতের বড় রিলিজে সরানো হবে। পরিবর্তে, ইনডেক্সডডিবি ক্যাশে চালু করার জন্য FirestoreSettings.localCache PersistentLocalCache লোকলক্যাচের একটি উদাহরণে সেট করুন। FirestoreSettings.localCache ইতিমধ্যে নির্দিষ্ট করা হলে এই ফাংশনটি কল করা একটি ব্যতিক্রম ছুঁড়ে ফেলবে।

সম্ভব হলে মাল্টি-ট্যাব অবিচ্ছিন্ন স্টোরেজ সক্ষম করার চেষ্টা। যদি সমস্ত ট্যাব জুড়ে সক্ষম করা থাকে তবে সমস্ত অপারেশনগুলি সমস্ত সংযুক্ত দৃষ্টান্তগুলিতে ক্যোয়ারী এবং বিলম্বিত-ক্ষতিপূরণযুক্ত স্থানীয় ডকুমেন্ট আপডেটগুলির ভাগ করে নেওয়া সম্পাদন সহ স্থানীয় অধ্যবসায় অ্যাক্সেস ভাগ করে দেয়।

ব্যর্থতার উপর, enableMultiTabIndexedDbPersistence() প্রতিশ্রুতি প্রত্যাখ্যান করবে বা একটি ব্যতিক্রম ছুঁড়ে দেবে। এটি ব্যর্থ হতে পারে এমন বেশ কয়েকটি কারণ রয়েছে, যা ত্রুটির code দ্বারা চিহ্নিত করা যেতে পারে।

* ব্যর্থ-পূর্বনির্ধারণ: অ্যাপ্লিকেশনটি ইতিমধ্যে অন্য ব্রাউজার ট্যাবে খোলা আছে এবং মাল্টি-ট্যাব সক্ষম করা নেই। * অপ্রচলিত: ব্রাউজারটি অফলাইন অধ্যবসায় বাস্তবায়নের সাথে বেমানান।

মনে রাখবেন যে ব্যর্থতার পরেও, ফায়ারস্টোর উদাহরণটি ব্যবহারযোগ্য থাকবে, তবে অফলাইন অধ্যবসায় অক্ষম করা হবে।

স্বাক্ষর:

export declare function enableMultiTabIndexedDbPersistence(firestore: Firestore): Promise<void>;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
ফায়ারস্টোর ফায়ারস্টোর ফায়ারস্টোর উদাহরণটির জন্য দৃ istence ়তা সক্ষম করার জন্য।

রিটার্ন:

প্রতিশ্রুতি <শূন্য>

একটি Promise যা অবিরাম স্টোরেজ সফলভাবে সক্ষম করে উপস্থাপন করে।

সক্ষমতা (ফায়ারস্টোর)

এই ফায়ারস্টোর উদাহরণের জন্য নেটওয়ার্কের ব্যবহার পুনরায় সক্ষম করে অক্ষম কাজ () .

স্বাক্ষর:

export declare function enableNetwork(firestore: Firestore): Promise<void>;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
ফায়ারস্টোর ফায়ারস্টোর

রিটার্ন:

প্রতিশ্রুতি <শূন্য>

নেটওয়ার্ক সক্ষম হয়ে গেলে এমন একটি Promise যা সমাধান করা হয়।

getpersterntistccacheindexmanager (ফায়ারস্টোর)

প্রদত্ত Firestore অবজেক্ট দ্বারা ব্যবহৃত অবিরত ক্যাশে সূচক পরিচালককে ফেরত দেয়।

PersistentCacheIndexManager উদাহরণ, বা স্থানীয় অবিরাম স্টোরেজ ব্যবহার না করা থাকলে null ।

স্বাক্ষর:

export declare function getPersistentCacheIndexManager(firestore: Firestore): PersistentCacheIndexManager | null;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
ফায়ারস্টোর ফায়ারস্টোর

রিটার্ন:

অবিরাম ক্যাচিন্ডেক্সম্যানেজার | খালি

লোডবান্ডেল (ফায়ারস্টোর, বান্ডিল্ডাটা)

স্থানীয় ক্যাশে একটি ফায়ারস্টোর বান্ডিল লোড করে।

স্বাক্ষর:

export declare function loadBundle(firestore: Firestore, bundleData: ReadableStream<Uint8Array> | ArrayBuffer | string): LoadBundleTask;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
ফায়ারস্টোর ফায়ারস্টোর এর জন্য বান্ডিলগুলি লোড করার জন্য ফায়ারস্টোর উদাহরণ।
বান্ডিল্ডাটা Readablestream <uint8array> | ArrayBuffer | স্ট্রিং লোড করার জন্য বান্ডিলটি উপস্থাপন করে এমন একটি অবজেক্ট। বৈধ অবজেক্টগুলি হ'ল ArrayBuffer , ReadableStream<Uint8Array> বা string ।

রিটার্ন:

লোডবান্ডেল টাস্ক

একটি LoadBundleTask অবজেক্ট, যা কলারদের অগ্রগতি আপডেট এবং সমাপ্তি বা ত্রুটি ইভেন্টগুলির সাথে অবহিত করে। এটি একটি Promise<LoadBundleTaskProgress> .

নামকরণ (ফায়ারস্টোর, নাম)

প্রদত্ত নাম দ্বারা চিহ্নিত স্থানীয় ক্যাশে থেকে একটি ফায়ারস্টোর কোয়েরি পড়ে।

নামযুক্ত ক্যোয়ারীগুলি সার্ভারের পাশের বান্ডিলগুলিতে প্যাকেজ করা হয়েছে (ফলাফলের নথি সহ), এবং loadBundle ব্যবহার করে স্থানীয় ক্যাশে লোড করা হয়েছে . স্থানীয় ক্যাশে একবার, নাম অনুসারে একটি ক্যোয়ারী বের করতে এই পদ্ধতিটি ব্যবহার করুন।

স্বাক্ষর:

export declare function namedQuery(firestore: Firestore, name: string): Promise<Query | null>;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
ফায়ারস্টোর ফায়ারস্টোর ক্যোয়ারী থেকে পড়ার জন্য ফায়ারস্টোর উদাহরণ।
নাম স্ট্রিং প্রশ্নের নাম।

রিটার্ন:

প্রতিশ্রুতি < ক্যোয়ারী | নাল>

একটি Promise যা ক্যোয়ারী বা null দিয়ে সমাধান করা হয় .

onsnapshotsincync (ফায়ারস্টোর, পর্যবেক্ষক)

স্ন্যাপশট-ইন-সিঙ্ক ইভেন্টের জন্য শ্রোতাদের সংযুক্ত করে। স্ন্যাপশটস-ইন-সিঙ্ক ইভেন্টটি ইঙ্গিত দেয় যে প্রদত্ত পরিবর্তনের দ্বারা আক্রান্ত সমস্ত শ্রোতা বরখাস্ত হয়েছে, এমনকি যদি একটি একক সার্ভার-উত্পাদিত পরিবর্তন একাধিক শ্রোতাকে প্রভাবিত করে।

দ্রষ্টব্য: স্ন্যাপশট-ইন-সিঙ্ক ইভেন্টটি কেবল ইঙ্গিত দেয় যে শ্রোতারা একে অপরের সাথে সিঙ্কে রয়েছে, তবে সেই স্ন্যাপশটগুলি সার্ভারের সাথে সিঙ্কে রয়েছে কিনা তা সম্পর্কিত নয়। কোনও স্ন্যাপশট ক্যাশে বা সার্ভার থেকে রয়েছে কিনা তা নির্ধারণ করতে স্বতন্ত্র শ্রোতাদের স্ন্যাপশটমেটাটা ব্যবহার করুন।

স্বাক্ষর:

export declare function onSnapshotsInSync(firestore: Firestore, observer: {
    next?: (value: void) => void;
    error?: (error: FirestoreError) => void;
    complete?: () => void;
}): Unsubscribe;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
ফায়ারস্টোর ফায়ারস্টোর স্ন্যাপশটগুলি সিঙ্ক্রোনাইজ করার জন্য ফায়ারস্টোরের উদাহরণ।
পর্যবেক্ষক {পরবর্তী?: (মান: শূন্য) => অকার্যকর; ত্রুটি?: (ত্রুটি: ফায়ারস্টোরারার ) => অকার্যকর; সম্পূর্ণ?: () => অকার্যকর; } next এবং error কলব্যাক সমন্বিত একটি একক অবজেক্ট।

রিটার্ন:

সদস্যতা ত্যাগ করুন

স্ন্যাপশট শ্রোতা বাতিল করতে কল করা যেতে পারে এমন একটি সাবস্ক্রাইব ফাংশন।

onsnapshotsincync (ফায়ারস্টোর, অনসিঙ্ক)

স্ন্যাপশট-ইন-সিঙ্ক ইভেন্টের জন্য শ্রোতাদের সংযুক্ত করে। স্ন্যাপশটস-ইন-সিঙ্ক ইভেন্টটি ইঙ্গিত দেয় যে প্রদত্ত পরিবর্তনের দ্বারা আক্রান্ত সমস্ত শ্রোতা বরখাস্ত হয়েছে, এমনকি যদি একটি একক সার্ভার-উত্পাদিত পরিবর্তন একাধিক শ্রোতাকে প্রভাবিত করে।

দ্রষ্টব্য: স্ন্যাপশট-ইন-সিঙ্ক ইভেন্টটি কেবল ইঙ্গিত দেয় যে শ্রোতারা একে অপরের সাথে সিঙ্কে রয়েছে, তবে সেই স্ন্যাপশটগুলি সার্ভারের সাথে সিঙ্কে রয়েছে কিনা তা সম্পর্কিত নয়। কোনও স্ন্যাপশট ক্যাশে বা সার্ভার থেকে রয়েছে কিনা তা নির্ধারণ করতে স্বতন্ত্র শ্রোতাদের SnapshotMetadata ব্যবহার করুন।

স্বাক্ষর:

export declare function onSnapshotsInSync(firestore: Firestore, onSync: () => void): Unsubscribe;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
ফায়ারস্টোর ফায়ারস্টোর স্ন্যাপশটগুলি সিঙ্ক্রোনাইজ করার জন্য Firestore উদাহরণ।
অনসিঙ্ক () => অকার্যকর প্রতিবার সমস্ত স্ন্যাপশট শ্রোতা একে অপরের সাথে সিঙ্কে থাকাকালীন কলব্যাক কল করা হবে।

রিটার্ন:

সদস্যতা ত্যাগ করুন

স্ন্যাপশট শ্রোতা বাতিল করতে কল করা যেতে পারে এমন একটি সাবস্ক্রাইব ফাংশন।

রান ট্রান্সঅ্যাকশন (ফায়ারস্টোর, আপডেট ফাংশন, বিকল্পগুলি)

প্রদত্ত updateFunction সম্পাদন করে এবং তারপরে লেনদেনের মধ্যে প্রয়োগ করা পরিবর্তনগুলি প্রতিশ্রুতিবদ্ধ করার চেষ্টা করে। যদি লেনদেনের মধ্যে পড়া কোনও নথি পরিবর্তিত হয়, ক্লাউড ফায়ারস্টোর updateFunction পুনরায় চেষ্টা করে . যদি এটি 5 টি চেষ্টার পরে প্রতিশ্রুতিবদ্ধ হতে ব্যর্থ হয় তবে লেনদেন ব্যর্থ হয়।

একক লেনদেনে অনুমোদিত লেখার সর্বাধিক সংখ্যা 500।

স্বাক্ষর:

export declare function runTransaction<T>(firestore: Firestore, updateFunction: (transaction: Transaction) => Promise<T>, options?: TransactionOptions): Promise<T>;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
ফায়ারস্টোর ফায়ারস্টোর এই লেনদেনটি চালানোর জন্য ফায়ারস্টোর ডাটাবেসের একটি রেফারেন্স।
আপডেট ফাংশন (লেনদেন: লেনদেন ) => প্রতিশ্রুতি <t> লেনদেনের প্রসঙ্গে কার্যকর করার জন্য ফাংশন।
বিকল্প লেনদেনের বিকল্প প্রতিশ্রুতিবদ্ধ করার সর্বাধিক সংখ্যক প্রচেষ্টা কনফিগার করার জন্য একটি বিকল্প অবজেক্ট।

রিটার্ন:

প্রতিশ্রুতি <টি>

যদি লেনদেনটি সফলভাবে সম্পন্ন হয় বা স্পষ্টভাবে বাতিল করা হয় ( updateFunction একটি ব্যর্থ প্রতিশ্রুতি ফিরিয়ে দেয়), updateFunction দ্বারা ফিরে আসা প্রতিশ্রুতি এখানে ফিরে এসেছে। অন্যথায়, যদি লেনদেনটি ব্যর্থ হয় তবে সংশ্লিষ্ট ব্যর্থতার ত্রুটি সহ একটি প্রত্যাখ্যানিত প্রতিশ্রুতি ফিরে আসে।

Setindexconfigration (ফায়ারস্টোর, কনফিগারেশন)

এই APIটি বিকাশকারীদের জন্য একটি পূর্বরূপ হিসাবে প্রদান করা হয়েছে এবং আমরা যে প্রতিক্রিয়া গ্রহন করি তার উপর ভিত্তি করে পরিবর্তিত হতে পারে। একটি উত্পাদন পরিবেশে এই API ব্যবহার করবেন না.

ম্যানুয়ালি ক্যাশে সূচকগুলি তৈরি করার পরিবর্তে, এসডিকে স্থানীয়ভাবে চলমান ক্যোয়ারির enablePersistentCacheIndexAutoCreation() ক্যাশে সূচকগুলি তৈরি করবেন কিনা তা সিদ্ধান্ত নিতে সক্ষম করুন।

স্থানীয় ক্যোয়ারী এক্সিকিউশনের জন্য সূচকগুলি কনফিগার করে। পূর্ববর্তী কোনও সূচক কনফিগারেশন ওভাররাইড করা হয়। সূচক কনফিগারেশন অব্যাহত থাকলে Promise সমাধান হয়।

সূচক এন্ট্রিগুলি নিজেরাই অসাধারণভাবে তৈরি করা হয়। সূচকগুলি এখনও উপলভ্য না থাকলেও আপনি এমন প্রশ্নগুলি ব্যবহার চালিয়ে যেতে পারেন যা সূচকগুলির প্রয়োজন। সূচক এন্ট্রিগুলি লেখার পরে কোয়েরি এক্সিকিউশন স্বয়ংক্রিয়ভাবে সূচকটি ব্যবহার শুরু করবে।

সূচকগুলি কেবল ইনডেক্সডডিবি অধ্যবসায়ের সাথে সমর্থিত। যদি ইনডেক্সডডিবি সক্ষম না করা হয় তবে কোনও সূচক কনফিগারেশন উপেক্ষা করা হয়।

স্বাক্ষর:

export declare function setIndexConfiguration(firestore: Firestore, configuration: IndexConfiguration): Promise<void>;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
ফায়ারস্টোর ফায়ারস্টোর এর জন্য সূচকগুলি কনফিগার করার জন্য ফায়ারস্টোর উদাহরণ।
কনফিগারেশন সূচক কনফিগারেশন সূচক সংজ্ঞা।

রিটার্ন:

প্রতিশ্রুতি <শূন্য>

সমস্ত সূচকগুলি সফলভাবে কনফিগার করা হলে এমন একটি Promise যা সমাধান করে।

ব্যতিক্রম

JSON ফর্ম্যাটটি যদি অবৈধ থাকে তবে ফায়ারস্টোরারর।

Setindexconfigration (ফায়ারস্টোর, জেএসএন)

এই APIটি বিকাশকারীদের জন্য একটি পূর্বরূপ হিসাবে প্রদান করা হয়েছে এবং আমরা যে প্রতিক্রিয়া গ্রহন করি তার উপর ভিত্তি করে পরিবর্তিত হতে পারে। একটি উত্পাদন পরিবেশে এই API ব্যবহার করবেন না.

ম্যানুয়ালি ক্যাশে সূচকগুলি তৈরি করার পরিবর্তে, এসডিকে স্থানীয়ভাবে চলমান ক্যোয়ারির enablePersistentCacheIndexAutoCreation() ক্যাশে সূচকগুলি তৈরি করবেন কিনা তা সিদ্ধান্ত নিতে সক্ষম করুন।

স্থানীয় ক্যোয়ারী এক্সিকিউশনের জন্য সূচকগুলি কনফিগার করে। পূর্ববর্তী কোনও সূচক কনফিগারেশন ওভাররাইড করা হয়। সূচক কনফিগারেশন অব্যাহত থাকলে Promise সমাধান হয়।

সূচক এন্ট্রিগুলি নিজেরাই অসাধারণভাবে তৈরি করা হয়। সূচকগুলি এখনও উপলভ্য না থাকলেও আপনি এমন প্রশ্নগুলি ব্যবহার চালিয়ে যেতে পারেন যা সূচকগুলির প্রয়োজন। সূচক এন্ট্রিগুলি লেখার পরে কোয়েরি এক্সিকিউশন স্বয়ংক্রিয়ভাবে সূচকটি ব্যবহার শুরু করবে।

সূচকগুলি কেবল ইনডেক্সডডিবি অধ্যবসায়ের সাথে সমর্থিত। সূচক কনফিগারেশন সেট করার আগে enableIndexedDbPersistence() বা enableMultiTabIndexedDbPersistence() এওনোক করুন। যদি ইনডেক্সডডিবি সক্ষম না করা হয় তবে কোনও সূচক কনফিগারেশন উপেক্ষা করা হয়।

পদ্ধতিটি ফায়ারবেস সিএলআই ( firebase firestore:indexes দ্বারা রফতানি করা জেএসএন ফর্ম্যাটটি গ্রহণ করে ) যদি JSON ফর্ম্যাটটি অবৈধ হয় তবে এই পদ্ধতিটি একটি ত্রুটি ছুঁড়ে দেয়।

স্বাক্ষর:

export declare function setIndexConfiguration(firestore: Firestore, json: string): Promise<void>;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
ফায়ারস্টোর ফায়ারস্টোর এর জন্য সূচকগুলি কনফিগার করার জন্য ফায়ারস্টোর উদাহরণ।
json স্ট্রিং ফায়ারবেস সিএলআই দ্বারা রফতানি করা জেএসএন ফর্ম্যাট।

রিটার্ন:

প্রতিশ্রুতি <শূন্য>

সমস্ত সূচকগুলি সফলভাবে কনফিগার করা হলে এমন একটি Promise যা সমাধান করে।

ব্যতিক্রম

JSON ফর্ম্যাটটি যদি অবৈধ থাকে তবে ফায়ারস্টোরারর।

সমাপ্তি (ফায়ারস্টোর)

প্রদত্ত ফায়ারস্টোর উদাহরণটি সমাপ্ত করে।

terminate() কল করার পরে কেবল clearIndexedDbPersistence() ফাংশন ব্যবহার করা যেতে পারে। অন্য কোনও ফাংশন একটি FirestoreError নিক্ষেপ করবে .

সমাপ্তির পরে পুনরায় চালু করতে, getfirestore () এর সাথে ফায়ারবেসফিরস্টোরের একটি নতুন উদাহরণ তৈরি করুন .

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

স্বাক্ষর:

export declare function terminate(firestore: Firestore): Promise<void>;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
ফায়ারস্টোর ফায়ারস্টোর

রিটার্ন:

প্রতিশ্রুতি <শূন্য>

একটি Promise যা সমাধান করা হয় যখন উদাহরণটি সফলভাবে সমাপ্ত করা হয়।

ওয়েটফোরপেন্ডিং রাইটস (ফায়ারস্টোর)

সক্রিয় ব্যবহারকারীর জন্য বর্তমানে সমস্ত মুলতুবি থাকা লেখার আগ পর্যন্ত অপেক্ষা করা হবে।

কোনও অসামান্য লেখা না থাকলে প্রত্যাবর্তিত প্রতিশ্রুতি তাত্ক্ষণিকভাবে সমাধান করে। অন্যথায়, প্রতিশ্রুতি পূর্বে জারি করা সমস্ত লেখার জন্য অপেক্ষা করে (পূর্ববর্তী অ্যাপ্লিকেশন সেশনে লেখাগুলি সহ), তবে এটি ফাংশনটি ডাকা হওয়ার পরে যুক্ত হওয়া লেখার জন্য অপেক্ষা করে না। আপনি যদি অতিরিক্ত লেখার জন্য অপেক্ষা করতে চান তবে waitForPendingWrites() আবার কল করুন।

যে কোনও অসামান্য waitForPendingWrites() প্রতিশ্রুতি ব্যবহারকারীর পরিবর্তনের সময় প্রত্যাখ্যান করা হয়।

স্বাক্ষর:

export declare function waitForPendingWrites(firestore: Firestore): Promise<void>;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
ফায়ারস্টোর ফায়ারস্টোর

রিটার্ন:

প্রতিশ্রুতি <শূন্য>

একটি Promise যা বর্তমানে সমস্ত মুলতুবি লেখার সময় সমাধান হয় ব্যাকএন্ড দ্বারা স্বীকৃত হয়েছে।

রাইটিংব্যাচ (ফায়ারস্টোর)

একক পারমাণবিক অপারেশন হিসাবে একাধিক লেখার জন্য ব্যবহৃত একটি রাইট ব্যাচ তৈরি করে। একক রাইটিংব্যাচে অনুমোদিত সর্বাধিক সংখ্যক লেখার 500।

লেনদেনের বিপরীতে, লেখার ব্যাচগুলি অফলাইনে স্থির থাকে এবং তাই যখন আপনার পড়ার ডেটাতে আপনার লেখার শর্ত দেওয়ার প্রয়োজন হয় না তখন এটি পছন্দনীয়।

স্বাক্ষর:

export declare function writeBatch(firestore: Firestore): WriteBatch;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
ফায়ারস্টোর ফায়ারস্টোর

রিটার্ন:

WriteBatch

একটি রাইটিংব্যাচ যা পরমাণুভাবে একাধিক লেখার জন্য ব্যবহার করা যেতে পারে।

ফাংশন()

গণনা()

একটি সমষ্টিফিল্ড অবজেক্ট তৈরি করুন যা কোনও ক্যোয়ারির ফলাফল সেটে নথির গণনা গণনা করতে ব্যবহার করা যেতে পারে।

স্বাক্ষর:

export declare function count(): AggregateField<number>;

রিটার্ন:

Aggregatefield <সংখ্যা>

মুছে ফেলা ()

মুছে ফেলার জন্য একটি ক্ষেত্র চিহ্নিত করতে {merge: true} সহ আপডেটটোক () বা সেটডোক () এর সাথে ব্যবহারের জন্য একটি সেন্ডিনেল ফেরত দেয়।

স্বাক্ষর:

export declare function deleteField(): FieldValue;

রিটার্ন:

ফিল্ড ভ্যালু

ডকুমেন্টআইডি ()

কোনও নথির আইডি উল্লেখ করতে একটি বিশেষ সেন্ডিনেল FieldPath ফেরত দেয়। এটি ডকুমেন্ট আইডি দ্বারা বাছাই বা ফিল্টার করতে প্রশ্নের মধ্যে ব্যবহার করা যেতে পারে।

স্বাক্ষর:

export declare function documentId(): FieldPath;

রিটার্ন:

ফিল্ডপাথ

getfirestore ()

ডিফল্ট ফায়ারবাস অ্যাপের সাথে সম্পর্কিত বিদ্যমান ডিফল্ট ফায়ারস্টোর উদাহরণটি ফেরত দেয় . যদি কোনও উদাহরণ না থাকে তবে ডিফল্ট সেটিংস সহ একটি নতুন উদাহরণ আরম্ভ করে।

স্বাক্ষর:

export declare function getFirestore(): Firestore;

রিটার্ন:

ফায়ারস্টোর

ডিফল্ট অ্যাপ্লিকেশনটির ডিফল্ট ফায়ারস্টোর উদাহরণ।

মেমোরিএগারগারব্যাগকোলেক্টর ()

MemoryEagerGarbageCollector একটি উদাহরণ তৈরি করে . এটি অন্যথায় স্পষ্টভাবে নির্দিষ্ট না করা হলে এটি ডিফল্ট আবর্জনা সংগ্রাহকও।

স্বাক্ষর:

export declare function memoryEagerGarbageCollector(): MemoryEagerGarbageCollector;

রিটার্ন:

মেমোরিএগারগারব্যাগকোলেক্টর

অবিরাম মেমিউটিপলেটবম্যানেজার ()

PersistentMultipleTabManager একটি উদাহরণ তৈরি করে .

স্বাক্ষর:

export declare function persistentMultipleTabManager(): PersistentMultipleTabManager;

রিটার্ন:

অবিরামমিলিটিপলেটবম্যানেজার

সার্ভারটিমস্ট্যাম্প ()

লিখিত ডেটাতে সার্ভার-উত্পাদিত টাইমস্ট্যাম্প অন্তর্ভুক্ত করতে সেটডোক () বা আপডেটডোক () এর সাথে ব্যবহৃত একটি সেন্ডিনেল ফেরত দেয়।

স্বাক্ষর:

export declare function serverTimestamp(): FieldValue;

রিটার্ন:

ফিল্ড ভ্যালু

ফাংশন (ডাটাবেসিড, ...)

getfirestore (ডাটাবেসিড)

এই APIটি বিকাশকারীদের জন্য একটি পূর্বরূপ হিসাবে প্রদান করা হয়েছে এবং আমরা যে প্রতিক্রিয়া গ্রহন করি তার উপর ভিত্তি করে পরিবর্তিত হতে পারে। একটি উত্পাদন পরিবেশে এই API ব্যবহার করবেন না.

ডিফল্ট ফায়ারব্যাস অ্যাপের সাথে সম্পর্কিত বিদ্যমান নামযুক্ত ফায়ারস্টোর উদাহরণটি ফিরিয়ে দেয় . যদি কোনও উদাহরণ না থাকে তবে ডিফল্ট সেটিংস সহ একটি নতুন উদাহরণ আরম্ভ করে।

স্বাক্ষর:

export declare function getFirestore(databaseId: string): Firestore;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
ডাটাবেসিড স্ট্রিং ডাটাবেসের নাম।

রিটার্ন:

ফায়ারস্টোর

ডিফল্ট অ্যাপের নামযুক্ত ফায়ারস্টোর উদাহরণ।

ফাংশন (উপাদান, ...)

অ্যারায়ারমোভ (উপাদান)

একটি বিশেষ মান প্রদান করে যা সেটডোক () এর সাথে ব্যবহার করা যেতে পারে বা যা সার্ভারে ইতিমধ্যে বিদ্যমান যে কোনও অ্যারে মান থেকে প্রদত্ত উপাদানগুলি অপসারণ করতে সার্ভারকে বলে। নির্দিষ্ট প্রতিটি উপাদানের সমস্ত উদাহরণ অ্যারে থেকে সরানো হবে। যদি ক্ষেত্রটি সংশোধন করা হচ্ছে তা ইতিমধ্যে কোনও অ্যারে না হলে এটি খালি অ্যারে দিয়ে ওভাররাইট করা হবে।

স্বাক্ষর:

export declare function arrayRemove(...elements: unknown[]): FieldValue;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
উপাদান অজানা [] অ্যারে থেকে সরানোর জন্য উপাদানগুলি।

রিটার্ন:

ফিল্ড ভ্যালু

FieldValue সেন্টিনেল setDoc() বা updateDoc() এ কলটিতে ব্যবহারের জন্য

অ্যারেউনিয়ন (উপাদান)

সেটডোক () বা আপডেটডোক () এর সাথে ব্যবহার করা যেতে পারে এমন একটি বিশেষ মান প্রদান করে যা সার্ভারে ইতিমধ্যে বিদ্যমান যে কোনও অ্যারে মানের সাথে প্রদত্ত উপাদানগুলিকে ইউনিয়ন করতে সার্ভারকে বলে। অ্যারেতে ইতিমধ্যে বিদ্যমান নেই এমন প্রতিটি নির্দিষ্ট উপাদান শেষে যুক্ত করা হবে। যদি ক্ষেত্রটি সংশোধন করা হচ্ছে তা ইতিমধ্যে কোনও অ্যারে না হলে এটি নির্দিষ্ট উপাদানগুলির সাথে যুক্ত একটি অ্যারে দিয়ে ওভাররাইট করা হবে।

স্বাক্ষর:

export declare function arrayUnion(...elements: unknown[]): FieldValue;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
উপাদান অজানা [] অ্যারেতে মিলনের উপাদানগুলি।

রিটার্ন:

ফিল্ড ভ্যালু

FieldValue সেন্টিনেল setDoc() বা updateDoc() এ কলটিতে ব্যবহারের জন্য .

ফাংশন (ক্ষেত্র, ...)

গড় (ক্ষেত্র)

একটি সমষ্টিগতফিল্ড অবজেক্ট তৈরি করুন যা কোনও প্রশ্নের ফলাফলের সেটে বিভিন্ন নথির উপরে নির্দিষ্ট ক্ষেত্রের গড় গণনা করতে ব্যবহার করা যেতে পারে।

স্বাক্ষর:

export declare function average(field: string | FieldPath): AggregateField<number | null>;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
ক্ষেত্র স্ট্রিং | ফিল্ডপাথ ফলাফল সেট জুড়ে গড় হিসাবে ক্ষেত্রটি নির্দিষ্ট করে।

রিটার্ন:

Aggregatefield <সংখ্যা | নাল>

যোগফল (ক্ষেত্র)

একটি সমষ্টিগতফিল্ড অবজেক্ট তৈরি করুন যা একটি ক্যোয়ারির ফলাফল সেটে বিভিন্ন নথির উপর একটি নির্দিষ্ট ক্ষেত্রের যোগফল গণনা করতে ব্যবহার করা যেতে পারে।

স্বাক্ষর:

export declare function sum(field: string | FieldPath): AggregateField<number>;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
ক্ষেত্র স্ট্রিং | ফিল্ডপাথ ফলাফল সেট জুড়ে যোগদানের জন্য ক্ষেত্রটি নির্দিষ্ট করে।

রিটার্ন:

Aggregatefield <সংখ্যা>

ফাংশন (ফিল্ডপথ, ...)

অর্ডারবি (ফিল্ডপথ, ডাইরেকশনস্ট্র)

একটি ক্যোয়ারী অর্ডারবি কনস্ট্রেন্ট তৈরি করে যা নির্দিষ্ট ক্ষেত্রের দ্বারা ক্যোয়ারির ফলাফলটি বাছাই করে, athing চ্ছিকভাবে আরোহণের পরিবর্তে ক্রমবর্ধমান ক্রমে।

স্বাক্ষর:

export declare function orderBy(fieldPath: string | FieldPath, directionStr?: OrderByDirection): QueryOrderByConstraint;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
ফিল্ডপথ স্ট্রিং | ফিল্ডপাথ The field to sort by.
directionStr OrderByDirection Optional direction to sort by ('asc' or 'desc'). If not specified, order will be ascending.

রিটার্ন:

QueryOrderByConstraint

The created QueryOrderByConstraint .

where(fieldPath, opStr, value)

Creates a QueryFieldFilterConstraint that enforces that documents must contain the specified field and that the value should satisfy the relation constraint provided.

স্বাক্ষর:

export declare function where(fieldPath: string | FieldPath, opStr: WhereFilterOp, value: unknown): QueryFieldFilterConstraint;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
fieldPath স্ট্রিং | ফিল্ডপাথ The path to compare
opStr WhereFilterOp The operation string (eg "&lt;", "&lt;=", "==", "&lt;", "&lt;=", "!=").
মান অজানা The value for comparison

রিটার্ন:

QueryFieldFilterConstraint

The created QueryFieldFilterConstraint .

function(fieldValues, ...)

endAt(fieldValues)

Creates a QueryEndAtConstraint that modifies the result set to end at the provided fields relative to the order of the query. The order of the field values must match the order of the order by clauses of the query.

স্বাক্ষর:

export declare function endAt(...fieldValues: unknown[]): QueryEndAtConstraint;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
fieldValues unknown[] The field values to end this query at, in order of the query's order by.

রিটার্ন:

QueryEndAtConstraint

A QueryEndAtConstraint to pass to query()

endBefore(fieldValues)

Creates a QueryEndAtConstraint that modifies the result set to end before the provided fields relative to the order of the query. The order of the field values must match the order of the order by clauses of the query.

স্বাক্ষর:

export declare function endBefore(...fieldValues: unknown[]): QueryEndAtConstraint;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
fieldValues unknown[] The field values to end this query before, in order of the query's order by.

রিটার্ন:

QueryEndAtConstraint

A QueryEndAtConstraint to pass to query()

startAfter(fieldValues)

Creates a QueryStartAtConstraint that modifies the result set to start after the provided fields relative to the order of the query. The order of the field values must match the order of the order by clauses of the query.

স্বাক্ষর:

export declare function startAfter(...fieldValues: unknown[]): QueryStartAtConstraint;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
fieldValues unknown[] The field values to start this query after, in order of the query's order by.

রিটার্ন:

QueryStartAtConstraint

A QueryStartAtConstraint to pass to query()

startAt(fieldValues)

Creates a QueryStartAtConstraint that modifies the result set to start at the provided fields relative to the order of the query. The order of the field values must match the order of the order by clauses of the query.

স্বাক্ষর:

export declare function startAt(...fieldValues: unknown[]): QueryStartAtConstraint;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
fieldValues unknown[] The field values to start this query at, in order of the query's order by.

রিটার্ন:

QueryStartAtConstraint

A QueryStartAtConstraint to pass to query() .

function(indexManager, ...)

deleteAllPersistentCacheIndexes(indexManager)

Removes all persistent cache indexes.

Please note this function will also deletes indexes generated by setIndexConfiguration() , which is deprecated.

স্বাক্ষর:

export declare function deleteAllPersistentCacheIndexes(indexManager: PersistentCacheIndexManager): void;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
indexManager PersistentCacheIndexManager

রিটার্ন:

অকার্যকর

disablePersistentCacheIndexAutoCreation(indexManager)

Stops creating persistent cache indexes automatically for local query execution. The indexes which have been created by calling enablePersistentCacheIndexAutoCreation() still take effect.

স্বাক্ষর:

export declare function disablePersistentCacheIndexAutoCreation(indexManager: PersistentCacheIndexManager): void;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
indexManager PersistentCacheIndexManager

রিটার্ন:

অকার্যকর

enablePersistentCacheIndexAutoCreation(indexManager)

Enables the SDK to create persistent cache indexes automatically for local query execution when the SDK believes cache indexes can help improve performance.

এই বৈশিষ্ট্যটি ডিফল্টরূপে অক্ষম করা হয়৷

স্বাক্ষর:

export declare function enablePersistentCacheIndexAutoCreation(indexManager: PersistentCacheIndexManager): void;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
indexManager PersistentCacheIndexManager

রিটার্ন:

অকার্যকর

function(left, ...)

aggregateFieldEqual(left, right)

Compares two 'AggregateField ` instances for equality.

স্বাক্ষর:

export declare function aggregateFieldEqual(left: AggregateField<unknown>, right: AggregateField<unknown>): boolean;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
বাম Aggregatefield <অজানা> Compare this AggregateField to the right .
অধিকার Aggregatefield <অজানা> Compare this AggregateField to the left .

রিটার্ন:

বুলিয়ান

aggregateQuerySnapshotEqual(left, right)

Compares two AggregateQuerySnapshot instances for equality.

Two AggregateQuerySnapshot instances are considered "equal" if they have underlying queries that compare equal, and the same data.

স্বাক্ষর:

export declare function aggregateQuerySnapshotEqual<AggregateSpecType extends AggregateSpec, AppModelType, DbModelType extends DocumentData>(left: AggregateQuerySnapshot<AggregateSpecType, AppModelType, DbModelType>, right: AggregateQuerySnapshot<AggregateSpecType, AppModelType, DbModelType>): boolean;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
বাম AggregateQuerySnapshot <AggregateSpecType, AppModelType, DbModelType> The first AggregateQuerySnapshot to compare.
অধিকার AggregateQuerySnapshot <AggregateSpecType, AppModelType, DbModelType> The second AggregateQuerySnapshot to compare.

রিটার্ন:

বুলিয়ান

true if the objects are "equal", as defined above, or false otherwise.

queryEqual(left, right)

Returns true if the provided queries point to the same collection and apply the same constraints.

স্বাক্ষর:

export declare function queryEqual<AppModelType, DbModelType extends DocumentData>(left: Query<AppModelType, DbModelType>, right: Query<AppModelType, DbModelType>): boolean;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
বাম প্রশ্ন <AppModelType, DbModelType> A Query to compare.
অধিকার প্রশ্ন <AppModelType, DbModelType> A Query to compare.

রিটার্ন:

বুলিয়ান

true if the references point to the same location in the same Firestore database.

refEqual(left, right)

Returns true if the provided references are equal.

স্বাক্ষর:

export declare function refEqual<AppModelType, DbModelType extends DocumentData>(left: DocumentReference<AppModelType, DbModelType> | CollectionReference<AppModelType, DbModelType>, right: DocumentReference<AppModelType, DbModelType> | CollectionReference<AppModelType, DbModelType>): boolean;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
বাম ডকুমেন্ট রেফারেন্স <AppModelType, DbModelType> | সংগ্রহ রেফারেন্স <AppModelType, DbModelType> A reference to compare.
অধিকার ডকুমেন্ট রেফারেন্স <AppModelType, DbModelType> | সংগ্রহ রেফারেন্স <AppModelType, DbModelType> A reference to compare.

রিটার্ন:

বুলিয়ান

true if the references point to the same location in the same Firestore database.

snapshotEqual(left, right)

Returns true if the provided snapshots are equal.

স্বাক্ষর:

export declare function snapshotEqual<AppModelType, DbModelType extends DocumentData>(left: DocumentSnapshot<AppModelType, DbModelType> | QuerySnapshot<AppModelType, DbModelType>, right: DocumentSnapshot<AppModelType, DbModelType> | QuerySnapshot<AppModelType, DbModelType>): boolean;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
বাম ডকুমেন্টস্ন্যাপশট <AppModelType, DbModelType> | কোয়েরি স্ন্যাপশট <AppModelType, DbModelType> A snapshot to compare.
অধিকার ডকুমেন্টস্ন্যাপশট <AppModelType, DbModelType> | কোয়েরি স্ন্যাপশট <AppModelType, DbModelType> A snapshot to compare.

রিটার্ন:

বুলিয়ান

true if the snapshots are equal.

function(limit, ...)

limit(limit)

Creates a QueryLimitConstraint that only returns the first matching documents.

স্বাক্ষর:

export declare function limit(limit: number): QueryLimitConstraint;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
সীমা সংখ্যা The maximum number of items to return.

রিটার্ন:

QueryLimitConstraint

The created QueryLimitConstraint .

limitToLast(limit)

Creates a QueryLimitConstraint that only returns the last matching documents.

You must specify at least one orderBy clause for limitToLast queries, otherwise an exception will be thrown during execution.

স্বাক্ষর:

export declare function limitToLast(limit: number): QueryLimitConstraint;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
সীমা সংখ্যা The maximum number of items to return.

রিটার্ন:

QueryLimitConstraint

The created QueryLimitConstraint .

function(logLevel, ...)

setLogLevel(logLevel)

Sets the verbosity of Cloud Firestore logs (debug, error, or silent).

স্বাক্ষর:

export declare function setLogLevel(logLevel: LogLevel): void;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
logLevel লগ লেভেল The verbosity you set for activity and error logging. Can be any of the following values:
  • debug for the most verbose logging level, primarily for debugging.
  • error to log errors only.
  • silent to turn off logging.

রিটার্ন:

অকার্যকর

function(n, ...)

increment(n)

Returns a special value that can be used with setDoc() or updateDoc() that tells the server to increment the field's current value by the given value.

If either the operand or the current field value uses floating point precision, all arithmetic follows IEEE 754 semantics. If both values are integers, values outside of JavaScript's safe number range ( Number.MIN_SAFE_INTEGER to Number.MAX_SAFE_INTEGER ) are also subject to precision loss. Furthermore, once processed by the Firestore backend, all integer operations are capped between -2^63 and 2^63-1.

If the current field value is not of type number , or if the field does not yet exist, the transformation sets the field to the given value.

স্বাক্ষর:

export declare function increment(n: number): FieldValue;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
n সংখ্যা The value to increment by.

রিটার্ন:

ফিল্ড ভ্যালু

The FieldValue sentinel for use in a call to setDoc() or updateDoc()

function(query, ...)

getAggregateFromServer(query, aggregateSpec)

Calculates the specified aggregations over the documents in the result set of the given query without actually downloading the documents.

Using this function to perform aggregations is efficient because only the final aggregation values, not the documents' data, are downloaded. This function can perform aggregations of the documents in cases where the result set is prohibitively large to download entirely (thousands of documents).

The result received from the server is presented, unaltered, without considering any local state. That is, documents in the local cache are not taken into consideration, neither are local modifications not yet synchronized with the server. Previously-downloaded results, if any, are not used. Every invocation of this function necessarily involves a round trip to the server.

স্বাক্ষর:

export declare function getAggregateFromServer<AggregateSpecType extends AggregateSpec, AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, aggregateSpec: AggregateSpecType): Promise<AggregateQuerySnapshot<AggregateSpecType, AppModelType, DbModelType>>;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
প্রশ্ন প্রশ্ন <AppModelType, DbModelType> The query whose result set is aggregated over.
aggregateSpec AggregateSpecType An AggregateSpec object that specifies the aggregates to perform over the result set. The AggregateSpec specifies aliases for each aggregate, which can be used to retrieve the aggregate result.

রিটার্ন:

Promise< AggregateQuerySnapshot <AggregateSpecType, AppModelType, DbModelType>>

উদাহরণ

const aggregateSnapshot = await getAggregateFromServer(query, {
  countOfDocs: count(),
  totalHours: sum('hours'),
  averageScore: average('score')
});

const countOfDocs: number = aggregateSnapshot.data().countOfDocs;
const totalHours: number = aggregateSnapshot.data().totalHours;
const averageScore: number | null = aggregateSnapshot.data().averageScore;

getCountFromServer(query)

Calculates the number of documents in the result set of the given query without actually downloading the documents.

Using this function to count the documents is efficient because only the final count, not the documents' data, is downloaded. This function can count the documents in cases where the result set is prohibitively large to download entirely (thousands of documents).

The result received from the server is presented, unaltered, without considering any local state. That is, documents in the local cache are not taken into consideration, neither are local modifications not yet synchronized with the server. Previously-downloaded results, if any, are not used. Every invocation of this function necessarily involves a round trip to the server.

স্বাক্ষর:

export declare function getCountFromServer<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>): Promise<AggregateQuerySnapshot<{
    count: AggregateField<number>;
}, AppModelType, DbModelType>>;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
প্রশ্ন প্রশ্ন <AppModelType, DbModelType> The query whose result set size is calculated.

রিটার্ন:

Promise< AggregateQuerySnapshot <{ count: AggregateField <number>; }, AppModelType, DbModelType>>

A Promise that will be resolved with the count; the count can be retrieved from snapshot.data().count , where snapshot is the AggregateQuerySnapshot to which the returned Promise resolves.

getDocs(query)

Executes the query and returns the results as a QuerySnapshot .

স্বাক্ষর:

export declare function getDocs<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>): Promise<QuerySnapshot<AppModelType, DbModelType>>;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
প্রশ্ন প্রশ্ন <AppModelType, DbModelType>

রিটার্ন:

Promise< QuerySnapshot <AppModelType, DbModelType>>

A Promise that will be resolved with the results of the query.

getDocsFromCache(query)

Executes the query and returns the results as a QuerySnapshot from cache. Returns an empty result set if no documents matching the query are currently cached.

স্বাক্ষর:

export declare function getDocsFromCache<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>): Promise<QuerySnapshot<AppModelType, DbModelType>>;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
প্রশ্ন প্রশ্ন <AppModelType, DbModelType>

রিটার্ন:

Promise< QuerySnapshot <AppModelType, DbModelType>>

A Promise that will be resolved with the results of the query.

getDocsFromServer(query)

Executes the query and returns the results as a QuerySnapshot from the server. Returns an error if the network is not available.

স্বাক্ষর:

export declare function getDocsFromServer<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>): Promise<QuerySnapshot<AppModelType, DbModelType>>;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
প্রশ্ন প্রশ্ন <AppModelType, DbModelType>

রিটার্ন:

Promise< QuerySnapshot <AppModelType, DbModelType>>

A Promise that will be resolved with the results of the query.

onSnapshot(query, observer)

Attaches a listener for QuerySnapshot events. You may either pass individual onNext and onError callbacks or pass a single observer object with next and error callbacks. The listener can be cancelled by calling the function that is returned when onSnapshot is called.

NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.

স্বাক্ষর:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, observer: {
    next?: (snapshot: QuerySnapshot<AppModelType, DbModelType>) => void;
    error?: (error: FirestoreError) => void;
    complete?: () => void;
}): Unsubscribe;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
প্রশ্ন প্রশ্ন <AppModelType, DbModelType> The query to listen to.
পর্যবেক্ষক { next?: (snapshot: QuerySnapshot <AppModelType, DbModelType>) => void; error?: (error: FirestoreError ) => void; complete?: () => void; } A single object containing next and error callbacks.

রিটার্ন:

সদস্যতা ত্যাগ করুন

An unsubscribe function that can be called to cancel the snapshot listener.

onSnapshot(query, options, observer)

Attaches a listener for QuerySnapshot events. You may either pass individual onNext and onError callbacks or pass a single observer object with next and error callbacks. The listener can be cancelled by calling the function that is returned when onSnapshot is called.

NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.

স্বাক্ষর:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, options: SnapshotListenOptions, observer: {
    next?: (snapshot: QuerySnapshot<AppModelType, DbModelType>) => void;
    error?: (error: FirestoreError) => void;
    complete?: () => void;
}): Unsubscribe;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
প্রশ্ন প্রশ্ন <AppModelType, DbModelType> The query to listen to.
বিকল্প SnapshotListenOptions Options controlling the listen behavior.
পর্যবেক্ষক { next?: (snapshot: QuerySnapshot <AppModelType, DbModelType>) => void; error?: (error: FirestoreError ) => void; complete?: () => void; } A single object containing next and error callbacks.

রিটার্ন:

সদস্যতা ত্যাগ করুন

An unsubscribe function that can be called to cancel the snapshot listener.

onSnapshot(query, onNext, onError, onCompletion)

Attaches a listener for QuerySnapshot events. You may either pass individual onNext and onError callbacks or pass a single observer object with next and error callbacks. The listener can be cancelled by calling the function that is returned when onSnapshot is called.

NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.

স্বাক্ষর:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, onNext: (snapshot: QuerySnapshot<AppModelType, DbModelType>) => void, onError?: (error: FirestoreError) => void, onCompletion?: () => void): Unsubscribe;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
প্রশ্ন প্রশ্ন <AppModelType, DbModelType> The query to listen to.
পরবর্তীতে (snapshot: QuerySnapshot <AppModelType, DbModelType>) => void A callback to be called every time a new QuerySnapshot is available.
onError (error: FirestoreError ) => void A callback to be called if the listen fails or is cancelled. No further callbacks will occur.
সমাপ্ত () => অকার্যকর Can be provided, but will not be called since streams are never ending.

রিটার্ন:

সদস্যতা ত্যাগ করুন

An unsubscribe function that can be called to cancel the snapshot listener.

onSnapshot(query, options, onNext, onError, onCompletion)

Attaches a listener for QuerySnapshot events. You may either pass individual onNext and onError callbacks or pass a single observer object with next and error callbacks. The listener can be cancelled by calling the function that is returned when onSnapshot is called.

NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.

স্বাক্ষর:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, options: SnapshotListenOptions, onNext: (snapshot: QuerySnapshot<AppModelType, DbModelType>) => void, onError?: (error: FirestoreError) => void, onCompletion?: () => void): Unsubscribe;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
প্রশ্ন প্রশ্ন <AppModelType, DbModelType> The query to listen to.
বিকল্প SnapshotListenOptions Options controlling the listen behavior.
পরবর্তীতে (snapshot: QuerySnapshot <AppModelType, DbModelType>) => void A callback to be called every time a new QuerySnapshot is available.
onError (error: FirestoreError ) => void A callback to be called if the listen fails or is cancelled. No further callbacks will occur.
সমাপ্ত () => অকার্যকর Can be provided, but will not be called since streams are never ending.

রিটার্ন:

সদস্যতা ত্যাগ করুন

An unsubscribe function that can be called to cancel the snapshot listener.

query(query, compositeFilter, queryConstraints)

Creates a new immutable instance of Query that is extended to also include additional query constraints.

স্বাক্ষর:

export declare function query<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, compositeFilter: QueryCompositeFilterConstraint, ...queryConstraints: QueryNonFilterConstraint[]): Query<AppModelType, DbModelType>;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
প্রশ্ন প্রশ্ন <AppModelType, DbModelType> The Query instance to use as a base for the new constraints.
compositeFilter QueryCompositeFilterConstraint The QueryCompositeFilterConstraint to apply. Create QueryCompositeFilterConstraint using and() or or() .
queryConstraints QueryNonFilterConstraint [] Additional QueryNonFilterConstraint s to apply (eg orderBy() , limit() )

রিটার্ন:

প্রশ্ন <AppModelType, DbModelType>

ব্যতিক্রম

if any of the provided query constraints cannot be combined with the existing or new constraints.

query(query, queryConstraints)

Creates a new immutable instance of Query that is extended to also include additional query constraints.

স্বাক্ষর:

export declare function query<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, ...queryConstraints: QueryConstraint[]): Query<AppModelType, DbModelType>;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
প্রশ্ন প্রশ্ন <AppModelType, DbModelType> The Query instance to use as a base for the new constraints.
queryConstraints QueryConstraint [] The list of QueryConstraint s to apply.

রিটার্ন:

প্রশ্ন <AppModelType, DbModelType>

ব্যতিক্রম

if any of the provided query constraints cannot be combined with the existing or new constraints.

function(queryConstraints, ...)

and(queryConstraints)

Creates a new QueryCompositeFilterConstraint that is a conjunction of the given filter constraints. A conjunction filter includes a document if it satisfies all of the given filters.

স্বাক্ষর:

export declare function and(...queryConstraints: QueryFilterConstraint[]): QueryCompositeFilterConstraint;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
queryConstraints QueryFilterConstraint [] ঐচ্ছিক। The list of QueryFilterConstraint s to perform a conjunction for. These must be created with calls to where() , or() , অথবা এবং() .

রিটার্ন:

QueryCompositeFilterConstraint

The newly created QueryCompositeFilterConstraint .

or(queryConstraints)

Creates a new QueryCompositeFilterConstraint that is a disjunction of the given filter constraints. A disjunction filter includes a document if it satisfies any of the given filters.

স্বাক্ষর:

export declare function or(...queryConstraints: QueryFilterConstraint[]): QueryCompositeFilterConstraint;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
queryConstraints QueryFilterConstraint [] ঐচ্ছিক। The list of QueryFilterConstraint s to perform a disjunction for. These must be created with calls to where() , or() , অথবা এবং() .

রিটার্ন:

QueryCompositeFilterConstraint

The newly created QueryCompositeFilterConstraint .

function(reference, ...)

addDoc(reference, data)

Add a new document to specified CollectionReference with the given data, assigning it a document ID automatically.

স্বাক্ষর:

export declare function addDoc<AppModelType, DbModelType extends DocumentData>(reference: CollectionReference<AppModelType, DbModelType>, data: WithFieldValue<AppModelType>): Promise<DocumentReference<AppModelType, DbModelType>>;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
রেফারেন্স সংগ্রহ রেফারেন্স <AppModelType, DbModelType> A reference to the collection to add this document to.
তথ্য WithFieldValue <AppModelType> An Object containing the data for the new document.

রিটার্ন:

Promise< DocumentReference <AppModelType, DbModelType>>

A Promise resolved with a DocumentReference pointing to the newly created document after it has been written to the backend (Note that it won't resolve while you're offline).

collection(reference, path, pathSegments)

Gets a CollectionReference instance that refers to a subcollection of reference at the the specified relative path.

স্বাক্ষর:

export declare function collection<AppModelType, DbModelType extends DocumentData>(reference: CollectionReference<AppModelType, DbModelType>, path: string, ...pathSegments: string[]): CollectionReference<DocumentData, DocumentData>;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
রেফারেন্স সংগ্রহ রেফারেন্স <AppModelType, DbModelType> A reference to a collection.
পথ স্ট্রিং A slash-separated path to a collection.
pathSegments স্ট্রিং[] Additional path segments to apply relative to the first argument.

রিটার্ন:

সংগ্রহ রেফারেন্স < DocumentData , DocumentData >

The CollectionReference instance.

ব্যতিক্রম

If the final path has an even number of segments and does not point to a collection.

collection(reference, path, pathSegments)

Gets a CollectionReference instance that refers to a subcollection of reference at the the specified relative path.

স্বাক্ষর:

export declare function collection<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, path: string, ...pathSegments: string[]): CollectionReference<DocumentData, DocumentData>;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
রেফারেন্স ডকুমেন্ট রেফারেন্স <AppModelType, DbModelType> A reference to a Firestore document.
পথ স্ট্রিং A slash-separated path to a collection.
pathSegments স্ট্রিং[] Additional path segments that will be applied relative to the first argument.

রিটার্ন:

সংগ্রহ রেফারেন্স < DocumentData , DocumentData >

The CollectionReference instance.

ব্যতিক্রম

If the final path has an even number of segments and does not point to a collection.

deleteDoc(reference)

Deletes the document referred to by the specified DocumentReference .

স্বাক্ষর:

export declare function deleteDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>): Promise<void>;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
রেফারেন্স ডকুমেন্ট রেফারেন্স <AppModelType, DbModelType> A reference to the document to delete.

রিটার্ন:

Promise<void>

A Promise resolved once the document has been successfully deleted from the backend (note that it won't resolve while you're offline).

doc(reference, path, pathSegments)

Gets a DocumentReference instance that refers to a document within reference at the specified relative path. If no path is specified, an automatically-generated unique ID will be used for the returned DocumentReference .

স্বাক্ষর:

export declare function doc<AppModelType, DbModelType extends DocumentData>(reference: CollectionReference<AppModelType, DbModelType>, path?: string, ...pathSegments: string[]): DocumentReference<AppModelType, DbModelType>;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
রেফারেন্স সংগ্রহ রেফারেন্স <AppModelType, DbModelType> A reference to a collection.
পথ স্ট্রিং A slash-separated path to a document. Has to be omitted to use auto-genrated IDs.
pathSegments স্ট্রিং[] Additional path segments that will be applied relative to the first argument.

রিটার্ন:

ডকুমেন্ট রেফারেন্স <AppModelType, DbModelType>

The DocumentReference instance.

ব্যতিক্রম

If the final path has an odd number of segments and does not point to a document.

doc(reference, path, pathSegments)

Gets a DocumentReference instance that refers to a document within reference at the specified relative path.

স্বাক্ষর:

export declare function doc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, path: string, ...pathSegments: string[]): DocumentReference<DocumentData, DocumentData>;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
রেফারেন্স ডকুমেন্ট রেফারেন্স <AppModelType, DbModelType> A reference to a Firestore document.
পথ স্ট্রিং A slash-separated path to a document.
pathSegments স্ট্রিং[] Additional path segments that will be applied relative to the first argument.

রিটার্ন:

ডকুমেন্ট রেফারেন্স < DocumentData , DocumentData >

The DocumentReference instance.

ব্যতিক্রম

If the final path has an odd number of segments and does not point to a document.

getDoc(reference)

Reads the document referred to by this DocumentReference .

স্বাক্ষর:

export declare function getDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>): Promise<DocumentSnapshot<AppModelType, DbModelType>>;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
রেফারেন্স ডকুমেন্ট রেফারেন্স <AppModelType, DbModelType> The reference of the document to fetch.

রিটার্ন:

Promise< DocumentSnapshot <AppModelType, DbModelType>>

A Promise resolved with a DocumentSnapshot containing the current document contents.

getDocFromCache(reference)

Reads the document referred to by this DocumentReference from cache. Returns an error if the document is not currently cached.

স্বাক্ষর:

export declare function getDocFromCache<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>): Promise<DocumentSnapshot<AppModelType, DbModelType>>;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
রেফারেন্স ডকুমেন্ট রেফারেন্স <AppModelType, DbModelType>

রিটার্ন:

Promise< DocumentSnapshot <AppModelType, DbModelType>>

A Promise resolved with a DocumentSnapshot containing the current document contents.

getDocFromServer(reference)

Reads the document referred to by this DocumentReference from the server. Returns an error if the network is not available.

স্বাক্ষর:

export declare function getDocFromServer<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>): Promise<DocumentSnapshot<AppModelType, DbModelType>>;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
রেফারেন্স ডকুমেন্ট রেফারেন্স <AppModelType, DbModelType>

রিটার্ন:

Promise< DocumentSnapshot <AppModelType, DbModelType>>

A Promise resolved with a DocumentSnapshot containing the current document contents.

onSnapshot(reference, observer)

Attaches a listener for DocumentSnapshot events. You may either pass individual onNext and onError callbacks or pass a single observer object with next and error callbacks.

NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.

স্বাক্ষর:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, observer: {
    next?: (snapshot: DocumentSnapshot<AppModelType, DbModelType>) => void;
    error?: (error: FirestoreError) => void;
    complete?: () => void;
}): Unsubscribe;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
রেফারেন্স ডকুমেন্ট রেফারেন্স <AppModelType, DbModelType> A reference to the document to listen to.
পর্যবেক্ষক { next?: (snapshot: DocumentSnapshot <AppModelType, DbModelType>) => void; error?: (error: FirestoreError ) => void; complete?: () => void; } A single object containing next and error callbacks.

রিটার্ন:

সদস্যতা ত্যাগ করুন

An unsubscribe function that can be called to cancel the snapshot listener.

onSnapshot(reference, options, observer)

Attaches a listener for DocumentSnapshot events. You may either pass individual onNext and onError callbacks or pass a single observer object with next and error callbacks.

NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.

স্বাক্ষর:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, options: SnapshotListenOptions, observer: {
    next?: (snapshot: DocumentSnapshot<AppModelType, DbModelType>) => void;
    error?: (error: FirestoreError) => void;
    complete?: () => void;
}): Unsubscribe;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
রেফারেন্স ডকুমেন্ট রেফারেন্স <AppModelType, DbModelType> A reference to the document to listen to.
বিকল্প SnapshotListenOptions Options controlling the listen behavior.
পর্যবেক্ষক { next?: (snapshot: DocumentSnapshot <AppModelType, DbModelType>) => void; error?: (error: FirestoreError ) => void; complete?: () => void; } A single object containing next and error callbacks.

রিটার্ন:

সদস্যতা ত্যাগ করুন

An unsubscribe function that can be called to cancel the snapshot listener.

onSnapshot(reference, onNext, onError, onCompletion)

Attaches a listener for DocumentSnapshot events. You may either pass individual onNext and onError callbacks or pass a single observer object with next and error callbacks.

NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.

স্বাক্ষর:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, onNext: (snapshot: DocumentSnapshot<AppModelType, DbModelType>) => void, onError?: (error: FirestoreError) => void, onCompletion?: () => void): Unsubscribe;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
রেফারেন্স ডকুমেন্ট রেফারেন্স <AppModelType, DbModelType> A reference to the document to listen to.
পরবর্তীতে (snapshot: DocumentSnapshot <AppModelType, DbModelType>) => void A callback to be called every time a new DocumentSnapshot is available.
onError (error: FirestoreError ) => void A callback to be called if the listen fails or is cancelled. No further callbacks will occur.
সমাপ্ত () => অকার্যকর Can be provided, but will not be called since streams are never ending.

রিটার্ন:

সদস্যতা ত্যাগ করুন

An unsubscribe function that can be called to cancel the snapshot listener.

onSnapshot(reference, options, onNext, onError, onCompletion)

Attaches a listener for DocumentSnapshot events. You may either pass individual onNext and onError callbacks or pass a single observer object with next and error callbacks.

NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.

স্বাক্ষর:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, options: SnapshotListenOptions, onNext: (snapshot: DocumentSnapshot<AppModelType, DbModelType>) => void, onError?: (error: FirestoreError) => void, onCompletion?: () => void): Unsubscribe;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
রেফারেন্স ডকুমেন্ট রেফারেন্স <AppModelType, DbModelType> A reference to the document to listen to.
বিকল্প SnapshotListenOptions Options controlling the listen behavior.
পরবর্তীতে (snapshot: DocumentSnapshot <AppModelType, DbModelType>) => void A callback to be called every time a new DocumentSnapshot is available.
onError (error: FirestoreError ) => void A callback to be called if the listen fails or is cancelled. No further callbacks will occur.
সমাপ্ত () => অকার্যকর Can be provided, but will not be called since streams are never ending.

রিটার্ন:

সদস্যতা ত্যাগ করুন

An unsubscribe function that can be called to cancel the snapshot listener.

setDoc(reference, data)

Writes to the document referred to by this DocumentReference . If the document does not yet exist, it will be created.

স্বাক্ষর:

export declare function setDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, data: WithFieldValue<AppModelType>): Promise<void>;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
রেফারেন্স ডকুমেন্ট রেফারেন্স <AppModelType, DbModelType> A reference to the document to write.
তথ্য WithFieldValue <AppModelType> A map of the fields and values for the document.

রিটার্ন:

Promise<void>

A Promise resolved once the data has been successfully written to the backend (note that it won't resolve while you're offline).

setDoc(reference, data, options)

Writes to the document referred to by the specified DocumentReference . If the document does not yet exist, it will be created. If you provide merge or mergeFields , the provided data can be merged into an existing document.

স্বাক্ষর:

export declare function setDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, data: PartialWithFieldValue<AppModelType>, options: SetOptions): Promise<void>;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
রেফারেন্স ডকুমেন্ট রেফারেন্স <AppModelType, DbModelType> A reference to the document to write.
তথ্য PartialWithFieldValue <AppModelType> A map of the fields and values for the document.
বিকল্প সেট অপশন An object to configure the set behavior.

রিটার্ন:

Promise<void>

A Promise resolved once the data has been successfully written to the backend (note that it won't resolve while you're offline).

updateDoc(reference, data)

Updates fields in the document referred to by the specified DocumentReference . The update will fail if applied to a document that does not exist.

স্বাক্ষর:

export declare function updateDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, data: UpdateData<DbModelType>): Promise<void>;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
রেফারেন্স ডকুমেন্ট রেফারেন্স <AppModelType, DbModelType> A reference to the document to update.
তথ্য আপডেট ডেটা <DbModelType> An object containing the fields and values with which to update the document. Fields can contain dots to reference nested fields within the document.

রিটার্ন:

Promise<void>

A Promise resolved once the data has been successfully written to the backend (note that it won't resolve while you're offline).

updateDoc(reference, field, value, moreFieldsAndValues)

Updates fields in the document referred to by the specified DocumentReference The update will fail if applied to a document that does not exist.

Nested fields can be updated by providing dot-separated field path strings or by providing FieldPath objects.

স্বাক্ষর:

export declare function updateDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, field: string | FieldPath, value: unknown, ...moreFieldsAndValues: unknown[]): Promise<void>;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
রেফারেন্স ডকুমেন্ট রেফারেন্স <AppModelType, DbModelType> A reference to the document to update.
ক্ষেত্র স্ট্রিং | ফিল্ডপাথ The first field to update.
মান অজানা The first value.
moreFieldsAndValues unknown[] Additional key value pairs.

রিটার্ন:

Promise<void>

A Promise resolved once the data has been successfully written to the backend (note that it won't resolve while you're offline).

function(settings, ...)

memoryLocalCache(settings)

Creates an instance of MemoryLocalCache . The instance can be set to FirestoreSettings.cache to tell the SDK which cache layer to use.

স্বাক্ষর:

export declare function memoryLocalCache(settings?: MemoryCacheSettings): MemoryLocalCache;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
সেটিংস মেমরি ক্যাশে সেটিংস

রিটার্ন:

MemoryLocalCache

memoryLruGarbageCollector(settings)

Creates an instance of MemoryLruGarbageCollector .

A target size can be specified as part of the setting parameter. The collector will start deleting documents once the cache size exceeds the given size. The default cache size is 40MB (40 * 1024 * 1024 bytes).

স্বাক্ষর:

export declare function memoryLruGarbageCollector(settings?: {
    cacheSizeBytes?: number;
}): MemoryLruGarbageCollector;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
সেটিংস { cacheSizeBytes?: number; }

রিটার্ন:

MemoryLruGarbageCollector

persistentLocalCache(settings)

Creates an instance of PersistentLocalCache . The instance can be set to FirestoreSettings.cache to tell the SDK which cache layer to use.

Persistent cache cannot be used in a Node.js environment.

স্বাক্ষর:

export declare function persistentLocalCache(settings?: PersistentCacheSettings): PersistentLocalCache;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
সেটিংস স্থায়ী ক্যাশে সেটিংস

রিটার্ন:

PersistentLocalCache

persistentSingleTabManager(settings)

Creates an instance of PersistentSingleTabManager .

স্বাক্ষর:

export declare function persistentSingleTabManager(settings: PersistentSingleTabManagerSettings | undefined): PersistentSingleTabManager;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
সেটিংস PersistentSingleTabManagerSettings | অনির্ধারিত Configures the created tab manager.

রিটার্ন:

PersistentSingleTabManager

function(snapshot, ...)

endAt(snapshot)

Creates a QueryEndAtConstraint that modifies the result set to end at the provided document (inclusive). The end position is relative to the order of the query. The document must contain all of the fields provided in the orderBy of the query.

স্বাক্ষর:

export declare function endAt<AppModelType, DbModelType extends DocumentData>(snapshot: DocumentSnapshot<AppModelType, DbModelType>): QueryEndAtConstraint;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
স্ন্যাপশট ডকুমেন্টস্ন্যাপশট <AppModelType, DbModelType> The snapshot of the document to end at.

রিটার্ন:

QueryEndAtConstraint

A QueryEndAtConstraint to pass to query()

endBefore(snapshot)

Creates a QueryEndAtConstraint that modifies the result set to end before the provided document (exclusive). The end position is relative to the order of the query. The document must contain all of the fields provided in the orderBy of the query.

স্বাক্ষর:

export declare function endBefore<AppModelType, DbModelType extends DocumentData>(snapshot: DocumentSnapshot<AppModelType, DbModelType>): QueryEndAtConstraint;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
স্ন্যাপশট ডকুমেন্টস্ন্যাপশট <AppModelType, DbModelType> The snapshot of the document to end before.

রিটার্ন:

QueryEndAtConstraint

A QueryEndAtConstraint to pass to query()

startAfter(snapshot)

Creates a QueryStartAtConstraint that modifies the result set to start after the provided document (exclusive). The starting position is relative to the order of the query. The document must contain all of the fields provided in the orderBy of the query.

স্বাক্ষর:

export declare function startAfter<AppModelType, DbModelType extends DocumentData>(snapshot: DocumentSnapshot<AppModelType, DbModelType>): QueryStartAtConstraint;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
স্ন্যাপশট ডকুমেন্টস্ন্যাপশট <AppModelType, DbModelType> The snapshot of the document to start after.

রিটার্ন:

QueryStartAtConstraint

A QueryStartAtConstraint to pass to query()

startAt(snapshot)

Creates a QueryStartAtConstraint that modifies the result set to start at the provided document (inclusive). The starting position is relative to the order of the query. The document must contain all of the fields provided in the orderBy of this query.

স্বাক্ষর:

export declare function startAt<AppModelType, DbModelType extends DocumentData>(snapshot: DocumentSnapshot<AppModelType, DbModelType>): QueryStartAtConstraint;

পরামিতি

প্যারামিটার প্রকার বর্ণনা
স্ন্যাপশট ডকুমেন্টস্ন্যাপশট <AppModelType, DbModelType> The snapshot of the document to start at.

রিটার্ন:

QueryStartAtConstraint

A QueryStartAtConstraint to pass to query() .

CACHE_SIZE_UNLIMITED

Constant used to indicate the LRU garbage collection should be disabled. Set this value as the cacheSizeBytes on the settings passed to the Firestore instance.

স্বাক্ষর:

CACHE_SIZE_UNLIMITED = -1

AddPrefixToKeys

Returns a new map where every key is prefixed with the outer key appended to a dot.

স্বাক্ষর:

export declare type AddPrefixToKeys<Prefix extends string, T extends Record<string, unknown>> = {
    [K in keyof T & string as `${Prefix}.${K}`]+?: string extends K ? any : T[K];
};

AggregateFieldType

The union of all AggregateField types that are supported by Firestore.

স্বাক্ষর:

export declare type AggregateFieldType = ReturnType<typeof sum> | ReturnType<typeof average> | ReturnType<typeof count>;

AggregateSpecData

A type whose keys are taken from an AggregateSpec , and whose values are the result of the aggregation performed by the corresponding AggregateField from the input AggregateSpec .

স্বাক্ষর:

export declare type AggregateSpecData<T extends AggregateSpec> = {
    [P in keyof T]: T[P] extends AggregateField<infer U> ? U : never;
};

AggregateType

Union type representing the aggregate type to be performed.

স্বাক্ষর:

export declare type AggregateType = 'count' | 'avg' | 'sum';

ChildUpdateFields

Helper for calculating the nested fields for a given type T1. This is needed to distribute union types such as undefined | {...} (happens for optional props) or {a: A} | {b: B} .

In this use case, V is used to distribute the union types of T[K] on Record , since T[K] is evaluated as an expression and not distributed.

See https://www.typescriptlang.org/docs/handbook/advanced-types.html#distributive-conditional-types

স্বাক্ষর:

export declare type ChildUpdateFields<K extends string, V> = V extends Record<string, unknown> ? AddPrefixToKeys<K, UpdateData<V>> : never;

ডকুমেন্ট চেঞ্জ টাইপ

The type of a DocumentChange may be 'added', 'removed', or 'modified'.

স্বাক্ষর:

export declare type DocumentChangeType = 'added' | 'removed' | 'modified';

FirestoreErrorCode

The set of Firestore status codes. The codes are the same at the ones exposed by gRPC here: https://github.com/grpc/grpc/blob/master/doc/statuscodes.md

Possible values: - 'cancelled': The operation was cancelled (typically by the caller). - 'unknown': Unknown error or an error from a different error domain. - 'invalid-argument': Client specified an invalid argument. Note that this differs from 'failed-precondition'. 'invalid-argument' indicates arguments that are problematic regardless of the state of the system (eg an invalid field name). - 'deadline-exceeded': Deadline expired before operation could complete. For operations that change the state of the system, this error may be returned even if the operation has completed successfully. For example, a successful response from a server could have been delayed long enough for the deadline to expire. - 'not-found': Some requested document was not found. - 'already-exists': Some document that we attempted to create already exists. - 'permission-denied': The caller does not have permission to execute the specified operation. - 'resource-exhausted': Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space. - 'failed-precondition': Operation was rejected because the system is not in a state required for the operation's execution. - 'aborted': The operation was aborted, typically due to a concurrency issue like transaction aborts, etc. - 'out-of-range': Operation was attempted past the valid range. - 'unimplemented': Operation is not implemented or not supported/enabled. - 'internal': Internal errors. Means some invariants expected by underlying system has been broken. If you see one of these errors, something is very broken. - 'unavailable': The service is currently unavailable. This is most likely a transient condition and may be corrected by retrying with a backoff. - 'data-loss': Unrecoverable data loss or corruption. - 'unauthenticated': The request does not have valid authentication credentials for the operation.

স্বাক্ষর:

export declare type FirestoreErrorCode = 'cancelled' | 'unknown' | 'invalid-argument' | 'deadline-exceeded' | 'not-found' | 'already-exists' | 'permission-denied' | 'resource-exhausted' | 'failed-precondition' | 'aborted' | 'out-of-range' | 'unimplemented' | 'internal' | 'unavailable' | 'data-loss' | 'unauthenticated';

FirestoreLocalCache

Union type from all supported SDK cache layer.

স্বাক্ষর:

export declare type FirestoreLocalCache = MemoryLocalCache | PersistentLocalCache;

ListenSource

Describe the source a query listens to.

Set to default to listen to both cache and server changes. Set to cache to listen to changes in cache only.

স্বাক্ষর:

export declare type ListenSource = 'default' | 'cache';

MemoryGarbageCollector

Union type from all support gabage collectors for memory local cache.

স্বাক্ষর:

export declare type MemoryGarbageCollector = MemoryEagerGarbageCollector | MemoryLruGarbageCollector;

NestedUpdateFields

For each field (eg 'bar'), find all nested keys (eg { 'bar.baz': T1, 'bar.qux': T2 } ) Intersect them together to make a single map containing all possible keys that are all marked as optional

স্বাক্ষর:

export declare type NestedUpdateFields<T extends Record<string, unknown>> = UnionToIntersection<{
    [K in keyof T & string]: ChildUpdateFields<K, T[K]>;
}[keyof T & string]>;

OrderByDirection

The direction of a orderBy() clause is specified as 'desc' or 'asc' (descending or ascending).

স্বাক্ষর:

export declare type OrderByDirection = 'desc' | 'asc';

PartialWithFieldValue

Similar to Typescript's Partial<T> , but allows nested fields to be omitted and FieldValues to be passed in as property values.

স্বাক্ষর:

export declare type PartialWithFieldValue<T> = Partial<T> | (T extends Primitive ? T : T extends {} ? {
    [K in keyof T]?: PartialWithFieldValue<T[K]> | FieldValue;
} : never);

PersistentTabManager

A union of all available tab managers.

স্বাক্ষর:

export declare type PersistentTabManager = PersistentSingleTabManager | PersistentMultipleTabManager;

আদিম

Primitive types.

স্বাক্ষর:

export declare type Primitive = string | number | boolean | undefined | null;

QueryConstraintType

Describes the different query constraints available in this SDK.

স্বাক্ষর:

export declare type QueryConstraintType = 'where' | 'orderBy' | 'limit' | 'limitToLast' | 'startAt' | 'startAfter' | 'endAt' | 'endBefore';

QueryFilterConstraint

QueryFilterConstraint is a helper union type that represents QueryFieldFilterConstraint and QueryCompositeFilterConstraint .

স্বাক্ষর:

export declare type QueryFilterConstraint = QueryFieldFilterConstraint | QueryCompositeFilterConstraint;

QueryNonFilterConstraint

QueryNonFilterConstraint is a helper union type that represents QueryConstraints which are used to narrow or order the set of documents, but that do not explicitly filter on a document field. QueryNonFilterConstraint s are created by invoking orderBy() , শুরু হবে() , startAfter() , endBefore() , endAt() , limit() or limitToLast() and can then be passed to query() to create a new query instance that also contains the QueryConstraint .

স্বাক্ষর:

export declare type QueryNonFilterConstraint = QueryOrderByConstraint | QueryLimitConstraint | QueryStartAtConstraint | QueryEndAtConstraint;

সেট অপশন

An options object that configures the behavior of setDoc() , and calls. These calls can be configured to perform granular merges instead of overwriting the target documents in their entirety by providing a SetOptions with merge: true .

স্বাক্ষর:

export declare type SetOptions = {
    readonly merge?: boolean;
} | {
    readonly mergeFields?: Array<string | FieldPath>;
};

TaskState

Represents the state of bundle loading tasks.

Both 'Error' and 'Success' are sinking state: task will abort or complete and there will be no more updates after they are reported.

স্বাক্ষর:

export declare type TaskState = 'Error' | 'Running' | 'Success';

UnionToIntersection

Given a union type U = T1 | T2 | ... , returns an intersected type (T1 & T2 & ...) .

Uses distributive conditional types and inference from conditional types. This works because multiple candidates for the same type variable in contra-variant positions causes an intersection type to be inferred. https://www.typescriptlang.org/docs/handbook/advanced-types.html#type-inference-in-conditional-types https://stackoverflow.com/questions/50374908/transform-union-type-to-intersection -টাইপ

স্বাক্ষর:

export declare type UnionToIntersection<U> = (U extends unknown ? (k: U) => void : never) extends (k: infer I) => void ? I : never;

আপডেট ডেটা

Update data (for use with updateDoc() ) that consists of field paths (eg 'foo' or 'foo.baz') mapped to values. Fields that contain dots reference nested fields within the document. FieldValues can be passed in as property values.

স্বাক্ষর:

export declare type UpdateData<T> = T extends Primitive ? T : T extends {} ? {
    [K in keyof T]?: UpdateData<T[K]> | FieldValue;
} & NestedUpdateFields<T> : Partial<T>;

WhereFilterOp

Filter conditions in a where() clause are specified using the strings '&lt;', '&lt;=', '==', '!=', '&gt;=', '&gt;', 'array-contains', 'in', 'array-contains-any', and 'not-in'.

স্বাক্ষর:

export declare type WhereFilterOp = '<' | '<=' | '==' | '!=' | '>=' | '>' | 'array-contains' | 'in' | 'array-contains-any' | 'not-in';

WithFieldValue

Allows FieldValues to be passed in as a property value while maintaining type safety.

স্বাক্ষর:

export declare type WithFieldValue<T> = T | (T extends Primitive ? T : T extends {} ? {
    [K in keyof T]: WithFieldValue<T[K]> | FieldValue;
} : never);