@firebase/firestore

อินสแตนซ์ Firestore เริ่มต้นของแอปที่ระบุ

getFirestore(แอป, รหัสฐานข้อมูล)

API นี้เป็นเพียงตัวอย่างสำหรับนักพัฒนาซอฟต์แวร์และอาจเปลี่ยนแปลงไปตามความคิดเห็นที่เราได้รับ อย่าใช้ API นี้ในสภาพแวดล้อมที่ใช้งานจริง

แสดงผลอินสแตนซ์ Firestore ที่มีอยู่ซึ่งเชื่อมโยงกับ FirebaseApp ที่ระบุ หากไม่มีอินสแตนซ์ ให้เริ่มต้นอินสแตนซ์ใหม่ด้วยการตั้งค่าเริ่มต้น

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
แอป	แอป Firebase	อินสแตนซ์ FirebaseApp ที่เชื่อมโยงกับอินสแตนซ์ Firestore ที่แสดงผลเชื่อมโยงอยู่
รหัสฐานข้อมูล	สตริง	ชื่อของฐานข้อมูล

การคืนสินค้า:

อินสแตนซ์ Firestore ของแอปที่ระบุ

เริ่มต้นFirestore(แอป, การตั้งค่า, รหัสฐานข้อมูล)

เริ่มต้นอินสแตนซ์ใหม่ของ Firestore ด้วยการตั้งค่าที่มีให้ สามารถเรียกใช้ก่อนฟังก์ชันอื่นๆ เท่านั้น ซึ่งรวมถึง getFirestore() หากการตั้งค่าที่กำหนดเองว่างเปล่า ฟังก์ชันนี้เทียบเท่ากับการเรียกใช้ getFirestore()

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
แอป	แอป Firebase	FirebaseApp ที่จะเชื่อมโยงอินสแตนซ์ Firestore
การตั้งค่า	FirestoreSettings	ออบเจ็กต์การตั้งค่าที่จะกำหนดค่าอินสแตนซ์ Firestore
รหัสฐานข้อมูล	สตริง	ชื่อของฐานข้อมูล

การคืนสินค้า:

CollectionReference<DocumentData, DocumentData>

อินสแตนซ์ Firestore เริ่มต้นใหม่

ฟังก์ชัน(firestore, ...)

clearIndexedDbPersistence(firestore)

ล้างพื้นที่เก็บข้อมูลถาวร ซึ่งรวมถึงการเขียนที่รอดำเนินการและเอกสารที่แคชไว้

ต้องเรียกใช้ในขณะที่อินสแตนซ์ Firestore ยังไม่เริ่มทำงาน (หลังจากแอปสิ้นสุดลงหรือเมื่อแอปเริ่มต้นเป็นครั้งแรก) เมื่อเริ่มต้นใช้งาน จะต้องเรียกใช้ฟังก์ชันนี้ก่อนฟังก์ชันอื่นๆ (นอกเหนือจาก initializeFirestore() หรือ getFirestore())) หากอินสแตนซ์ Firestore ยังคงทำงานอยู่ ระบบจะปฏิเสธสัญญาพร้อมรหัสข้อผิดพลาด failed-precondition

หมายเหตุ: clearIndexedDbPersistence() มีวัตถุประสงค์หลักเพื่อช่วยเขียนการทดสอบที่เชื่อถือได้โดยใช้ Cloud Firestore โดยใช้กลไกที่มีประสิทธิภาพในการลบข้อมูลที่มีอยู่ แต่จะไม่พยายามเขียนทับอย่างปลอดภัยหรือทำให้ข้อมูลที่แคชไว้ไม่สามารถกู้คืนได้ สำหรับแอปพลิเคชันที่มีความละเอียดอ่อนต่อการเปิดเผยข้อมูลที่แคชไว้ระหว่างเซสชันของผู้ใช้ เราขอแนะนำไม่ให้เปิดใช้การคงอยู่เลย

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
firestore	Firestore	อินสแตนซ์ Firestore ที่จะล้างความต่อเนื่อง

การคืนสินค้า:

คำสัญญา<โมฆะ>

Promise ที่ได้รับการแก้ไขเมื่อล้างพื้นที่เก็บข้อมูลถาวรแล้ว มิฉะนั้น ระบบจะปฏิเสธสัญญาโดยมีข้อผิดพลาด

คอลเล็กชัน(Firestore, เส้นทาง, กลุ่มเส้นทาง)

รับอินสแตนซ์ CollectionReference ที่อ้างถึงคอลเล็กชันในเส้นทางสัมบูรณ์ที่ระบุ

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
firestore	Firestore	การอ้างอิงไปยังอินสแตนซ์ `Firestore` รูท
เส้นทาง	สตริง	เส้นทางที่คั่นด้วยเครื่องหมายทับไปยังคอลเล็กชัน
กลุ่มเส้นทาง	สตริง[]	กลุ่มเส้นทางเพิ่มเติมที่จะนำไปใช้โดยสัมพันธ์กับอาร์กิวเมนต์แรก

การคืนสินค้า:

อินสแตนซ์ CollectionReference

ข้อยกเว้น

หากเส้นทางสุดท้ายมีจำนวนกลุ่มเท่ากันและไม่ได้ชี้ไปที่คอลเล็กชัน

CollectionGroup(firestore, collectionsId)

สร้างและแสดงผลอินสแตนซ์ Query ใหม่ที่มีเอกสารทั้งหมดในฐานข้อมูลที่มีในคอลเล็กชันหรือคอลเล็กชันย่อยที่มี collectionId ที่ระบุ

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
firestore	Firestore	การอ้างอิงไปยังอินสแตนซ์ `Firestore` รูท
รหัสคอลเล็กชัน	สตริง	ระบุคอลเล็กชันที่ต้องการค้นหา ระบบจะรวมคอลเล็กชันหรือคอลเล็กชันย่อยทั้งหมดที่มีรหัสนี้เป็นกลุ่มสุดท้ายของเส้นทาง ต้องไม่มีเครื่องหมายทับ

การคืนสินค้า:

การค้นหา<DocumentData, DocumentData>

Query ที่สร้างขึ้น

ConnectFirestoreEmulator(firestore, โฮสต์, พอร์ต, ตัวเลือก)

แก้ไขอินสแตนซ์นี้เพื่อสื่อสารกับโปรแกรมจำลอง Cloud Firestore

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
firestore	Firestore	อินสแตนซ์ `Firestore` ที่จะกำหนดค่าเพื่อเชื่อมต่อกับโปรแกรมจำลอง
ผู้จัด	สตริง	โฮสต์โปรแกรมจำลอง (เช่น localhost)
พอร์ต	ตัวเลข	พอร์ตโปรแกรมจำลอง (เช่น 9000)
ตัวเลือก	{ mockUserToken?: EmulatorMockTokenOptions \| string;สตริง; }

การคืนสินค้า:

เป็นโมฆะ

disabledNetwork(firestore)

ปิดใช้การใช้งานเครือข่ายสำหรับอินสแตนซ์นี้ คุณจะเปิดใช้ได้อีกครั้งผ่าน enableNetwork() ขณะที่เครือข่ายปิดใช้อยู่ Listener ของสแนปชอต, การเรียกใช้ getDoc() หรือ getDocs() จะแสดงผลลัพธ์จากแคช และการดำเนินการเขียนทั้งหมดจะอยู่ในคิวจนกว่าจะกู้คืนเครือข่าย

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
firestore	Firestore

การคืนสินค้า:

คำสัญญา<โมฆะ>

Promiseที่ได้รับการแก้ไขเมื่อเครือข่ายถูกปิดใช้

doc(firestore, เส้นทาง, กลุ่มเส้นทาง)

รับอินสแตนซ์ DocumentReference ที่อ้างถึงเอกสารในเส้นทางสัมบูรณ์ที่ระบุ

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
firestore	Firestore	การอ้างอิงไปยังอินสแตนซ์ `Firestore` รูท
เส้นทาง	สตริง	เส้นทางที่คั่นด้วยเครื่องหมายทับไปยังเอกสาร
กลุ่มเส้นทาง	สตริง[]	กลุ่มเส้นทางเพิ่มเติมที่จะนำไปใช้โดยสัมพันธ์กับอาร์กิวเมนต์แรก

การคืนสินค้า:

DocumentReference<DocumentData, DocumentData>

อินสแตนซ์ DocumentReference

ข้อยกเว้น

หากเส้นทางสุดท้ายมีจำนวนกลุ่มเป็นคี่และไม่ได้ชี้ไปที่เอกสาร

enabledIndexedDbPersistence(firestore, Persistence)

คำเตือน: API นี้ล้าสมัยแล้ว

เราจะนำฟังก์ชันนี้ออกในรุ่นหลักในอนาคต ให้ตั้งค่า FirestoreSettings.localCache เป็นอินสแตนซ์ PersistentLocalCache แทนเพื่อเปิดใช้แคช IndexedDb การเรียกใช้ฟังก์ชันนี้เมื่อระบุ FirestoreSettings.localCache แล้วจะส่งข้อยกเว้น

พยายามเปิดใช้พื้นที่เก็บข้อมูลถาวรหากเป็นไปได้

หากไม่สำเร็จ enableIndexedDbPersistence() จะปฏิเสธสัญญาหรือส่งข้อยกเว้น การทำขั้นตอนนี้ไม่สำเร็จอาจเกิดจากหลายสาเหตุ ซึ่งดูได้จาก code ในข้อผิดพลาด

* เงื่อนไขเบื้องต้นล้มเหลว: แอปเปิดอยู่แล้วในแท็บเบราว์เซอร์อื่น * ไม่ได้ใช้งาน: เบราว์เซอร์ไม่สามารถทำงานร่วมกับการใช้งานต่อเนื่องแบบออฟไลน์

โปรดทราบว่าแม้จะล้มเหลวแล้ว อินสแตนซ์ Firestore จะยังคงใช้งานได้ แต่ระบบจะปิดใช้ความต่อเนื่องแบบออฟไลน์

ไม่สามารถใช้ความต่อเนื่องในสภาพแวดล้อม Node.js ได้

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
firestore	Firestore	อินสแตนซ์ Firestore ที่จะเปิดใช้การคงอยู่
การตั้งค่าต่อเนื่อง	PersistenceSettings	ออบเจ็กต์การตั้งค่าที่ไม่บังคับเพื่อกำหนดค่าการคงอยู่

การคืนสินค้า:

คำสัญญา<โมฆะ>

Promise หมายถึงการเปิดใช้พื้นที่เก็บข้อมูลถาวรสำเร็จ

enabledMultiTabIndexedDbPersistence(firestore)

คำเตือน: API นี้ล้าสมัยแล้ว

เราจะนำฟังก์ชันนี้ออกในรุ่นหลักในอนาคต แต่ให้ตั้งค่า FirestoreSettings.localCache เป็นอินสแตนซ์ PersistentLocalCache แทน เพื่อเปิดแคชที่มีการจัดทำดัชนี การเรียกใช้ฟังก์ชันนี้เมื่อระบุ FirestoreSettings.localCache แล้วจะส่งข้อยกเว้น

พยายามเปิดใช้พื้นที่เก็บข้อมูลถาวรแบบหลายแท็บหากเป็นไปได้ หากเปิดใช้ในแท็บทั้งหมด การดำเนินการทั้งหมดจะแชร์สิทธิ์เข้าถึงความต่อเนื่องในเครื่อง รวมถึงการดำเนินการค้นหาที่แชร์และการอัปเดตเอกสารในเครื่องซึ่งชดเชยเวลาในการตอบสนองในอินสแตนซ์ทั้งหมดที่เชื่อมต่อ

หากไม่สำเร็จ enableMultiTabIndexedDbPersistence() จะปฏิเสธสัญญาหรือส่งข้อยกเว้น การทำขั้นตอนนี้ไม่สำเร็จอาจเกิดจากหลายสาเหตุ ซึ่งดูได้จาก code ในข้อผิดพลาด

* เงื่อนไขเบื้องต้นล้มเหลว: แอปเปิดอยู่แล้วในแท็บเบราว์เซอร์อื่นและไม่ได้เปิดใช้หลายแท็บ * ไม่ได้ใช้งาน: เบราว์เซอร์ไม่สามารถทำงานร่วมกับการใช้งานต่อเนื่องแบบออฟไลน์

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
firestore	Firestore	อินสแตนซ์ Firestore ที่จะเปิดใช้การคงอยู่

การคืนสินค้า:

คำสัญญา<โมฆะ>

Promise หมายถึงการเปิดใช้พื้นที่เก็บข้อมูลถาวรสำเร็จ

ให้เปิดใช้เครือข่าย(firestore)

เปิดใช้เครือข่ายสำหรับอินสแตนซ์ Firestore นี้อีกครั้งหลังจากเรียกใช้ disableNetwork() ก่อนหน้า

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
firestore	Firestore

การคืนสินค้า:

คำสัญญา<โมฆะ>

Promise ที่ได้รับการแก้ไขเมื่อเปิดใช้เครือข่ายแล้ว

getPersistentCacheIndexManager(firestore)

แสดงผลตัวจัดการดัชนี PersistentCache ซึ่งใช้โดยออบเจ็กต์ Firestore ที่ระบุ

อินสแตนซ์ PersistentCacheIndexManager หรือ null หากไม่ได้ใช้งานพื้นที่เก็บข้อมูลถาวรในเครื่อง

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
firestore	Firestore

การคืนสินค้า:

PersistentCacheIndexManager | ค่าว่าง

loadBundle(Firestore, BundleData)

โหลดแพ็กเกจ Firestore ลงในแคชในเครื่อง

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
firestore	Firestore	อินสแตนซ์ Firestore ที่จะใช้โหลดแพ็กเกจ
ข้อมูลชุด	สตรีมที่อ่านได้<Uint8Array> \| ArrayBuffer \| สตริง	ออบเจ็กต์ที่แสดงถึง Bundle ที่จะโหลด ออบเจ็กต์ที่ถูกต้องคือ `ArrayBuffer`, `ReadableStream<Uint8Array>` หรือ `string`

การคืนสินค้า:

LoadBundleTask

ออบเจ็กต์ LoadBundleTask ซึ่งแจ้งให้ผู้โทรทราบเกี่ยวกับการอัปเดตความคืบหน้า รวมถึงเหตุการณ์การเสร็จสมบูรณ์หรือข้อผิดพลาด ซึ่งใช้เป็น Promise<LoadBundleTaskProgress> ได้

nameQuery(firestore, name)

อ่านการค้นหาของ Firestore จากแคชในเครื่องซึ่งระบุโดยใช้ชื่อจริง

คำค้นหาที่มีชื่อจะอยู่ในแพ็กเกจที่ฝั่งเซิร์ฟเวอร์ (พร้อมเอกสารผลลัพธ์) และโหลดไปยังแคชในเครื่องโดยใช้ loadBundle เมื่ออยู่ในแคชในเครื่องแล้ว ให้ใช้วิธีการนี้เพื่อดึงข้อมูลคำค้นหาตามชื่อ

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
firestore	Firestore	อินสแตนซ์ Firestore ที่จะอ่านการค้นหา
name	สตริง	ชื่อของการค้นหา

การคืนสินค้า:

คำมั่นสัญญา<การค้นหา | ค่าว่าง>

Promise ที่ได้ข้อยุติด้วยคำค้นหาหรือ null

onSnapshotsInSync(firestore, ผู้สังเกตการณ์)

แนบ Listener สำหรับกิจกรรมสแนปชอตในการซิงค์ เหตุการณ์ Snap-in-ซิงค์ ระบุว่า Listener ทั้งหมดที่ได้รับผลกระทบจากการเปลี่ยนแปลงหนึ่งๆ ได้เริ่มทำงานแล้ว แม้ว่าการเปลี่ยนแปลงเดียวที่เซิร์ฟเวอร์สร้างขึ้นจะส่งผลกระทบต่อ Listener หลายรายการก็ตาม

หมายเหตุ: เหตุการณ์สแนปชอตในการซิงค์จะระบุว่า Listener ซิงค์กันเท่านั้น แต่ไม่ได้เชื่อมโยงกับว่าสแนปชอตเหล่านั้นซิงค์กับเซิร์ฟเวอร์หรือไม่ ใช้ SnapshotMetadata ใน Listener แต่ละรายการเพื่อระบุว่าสแนปชอตมาจากแคชหรือเซิร์ฟเวอร์

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
firestore	Firestore	อินสแตนซ์ของ Firestore สำหรับการซิงค์สแนปชอต
ผู้สังเกตการณ์	{ ถัดไป?: (ค่า: โมฆะ) => โมฆะ; ?: (ข้อผิดพลาด: FirestoreError) => โมฆะ; เสร็จสมบูรณ์: () => โมฆะ; }	ออบเจ็กต์เดียวที่มี Callback `next` และ `error`

การคืนสินค้า:

ฟังก์ชันยกเลิกการสมัครที่เรียกใช้เพื่อยกเลิก Listener ของสแนปชอตได้

onSnapshotsInSync(firestore, onSync)

หมายเหตุ: เหตุการณ์สแนปชอตในการซิงค์จะระบุว่า Listener ซิงค์กันเท่านั้น แต่ไม่ได้เชื่อมโยงกับว่าสแนปชอตเหล่านั้นซิงค์กับเซิร์ฟเวอร์หรือไม่ ใช้ SnapshotMetadata ใน Listener แต่ละรายการเพื่อระบุว่าสแนปชอตมาจากแคชหรือเซิร์ฟเวอร์

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
firestore	Firestore	อินสแตนซ์ `Firestore` สำหรับการซิงค์สแนปชอต
การซิงค์	() => เป็นโมฆะ	ระบบจะเรียก Callback ทุกครั้งที่ Listener ของสแนปชอตทั้งหมดซิงค์กัน

การคืนสินค้า:

ฟังก์ชันยกเลิกการสมัครที่เรียกใช้เพื่อยกเลิก Listener ของสแนปชอตได้

RunTransaction(firestore, updateFunction, ตัวเลือก)

เรียกใช้ updateFunction ที่ระบุแล้วพยายามยืนยันการเปลี่ยนแปลงที่มีผลภายในธุรกรรม หากเอกสารที่อ่านในธุรกรรมมีการเปลี่ยนแปลง Cloud Firestore จะลอง updateFunction อีกครั้ง หากดำเนินการไม่สำเร็จหลังจากพยายามครบ 5 ครั้งแล้ว ธุรกรรมจะไม่สำเร็จ

จำนวนการเขียนสูงสุดที่อนุญาตในธุรกรรมเดียวคือ 500

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
firestore	Firestore	การอ้างอิงฐานข้อมูล Firestore สำหรับใช้ทำธุรกรรมนี้
อัปเดตฟังก์ชัน	(transaction: ธุรกรรม) => สัญญา<T>	ฟังก์ชันที่จะดำเนินการภายในบริบทของธุรกรรม
ตัวเลือก	ตัวเลือกธุรกรรม	ออบเจ็กต์ตัวเลือกเพื่อกำหนดจำนวนครั้งสูงสุดในการคอมมิต

การคืนสินค้า:

สัญญา<T>

หากธุรกรรมเสร็จสมบูรณ์หรือมีการล้มเลิกอย่างชัดเจน (updateFunction แสดงการสัญญาที่ไม่สำเร็จ) ระบบจะแสดงผลสัญญาที่ updateFunction ส่งคืนที่นี่ มิเช่นนั้น หากธุรกรรมล้มเหลว ระบบจะส่งกลับสัญญาที่ถูกปฏิเสธพร้อมข้อผิดพลาดเกี่ยวกับความล้มเหลวที่สอดคล้องกัน

setIndexConfiguration(firestore, การกำหนดค่า)

API นี้เป็นเพียงตัวอย่างสำหรับนักพัฒนาซอฟต์แวร์และอาจเปลี่ยนแปลงไปตามความคิดเห็นที่เราได้รับ อย่าใช้ API นี้ในสภาพแวดล้อมที่ใช้งานจริง

คำเตือน: API นี้ล้าสมัยแล้ว

ลองใช้ enablePersistentCacheIndexAutoCreation() แทนการสร้างดัชนีแคชด้วยตนเองเพื่อให้ SDK ตัดสินใจว่าจะสร้างดัชนีแคชสำหรับการค้นหาที่ทำงานในเครื่องหรือไม่

กำหนดค่าการจัดทำดัชนีสำหรับการดำเนินการค้นหาในเครื่อง ระบบจะลบล้างการกำหนดค่าดัชนีก่อนหน้านี้ Promise จะได้รับการแก้ไขเมื่อมีการเก็บการกำหนดค่าดัชนีไว้

รายการดัชนีจะสร้างขึ้นแบบไม่พร้อมกัน คุณยังคงใช้คำค้นหาที่ต้องมีการจัดทําดัชนีต่อไปได้ แม้ว่าดัชนีจะยังไม่พร้อมให้บริการก็ตาม การดำเนินการค้นหาจะเริ่มใช้ดัชนีโดยอัตโนมัติเมื่อมีการเขียนรายการดัชนีแล้ว

ระบบจะรองรับดัชนีเฉพาะที่มีความต่อเนื่องของ IndexedDb เท่านั้น หากไม่ได้เปิดใช้ IndexedDb ระบบจะไม่ประมวลผลการกำหนดค่าดัชนีใดๆ

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
firestore	Firestore	อินสแตนซ์ Firestore ที่จะกำหนดค่าดัชนี
การกำหนดค่า	IndexConfiguration	คําจํากัดความของดัชนี

การคืนสินค้า:

คำสัญญา<โมฆะ>

Promise ที่ได้รับการแก้ไขเมื่อกำหนดค่าดัชนีทั้งหมดเรียบร้อยแล้ว

ข้อยกเว้น

FirestoreError หากรูปแบบ JSON ไม่ถูกต้อง

setIndexConfiguration(firestore, JSON)

API นี้เป็นเพียงตัวอย่างสำหรับนักพัฒนาซอฟต์แวร์และอาจเปลี่ยนแปลงไปตามความคิดเห็นที่เราได้รับ อย่าใช้ API นี้ในสภาพแวดล้อมที่ใช้งานจริง

คำเตือน: API นี้ล้าสมัยแล้ว

ลองใช้ enablePersistentCacheIndexAutoCreation() แทนการสร้างดัชนีแคชด้วยตนเองเพื่อให้ SDK ตัดสินใจว่าจะสร้างดัชนีแคชสำหรับการค้นหาที่ทำงานในเครื่องหรือไม่

ระบบจะรองรับดัชนีเฉพาะที่มีความต่อเนื่องของ IndexedDb เท่านั้น เรียกใช้ enableIndexedDbPersistence() หรือ enableMultiTabIndexedDbPersistence() ก่อนตั้งค่าการกำหนดค่าดัชนี หากไม่ได้เปิดใช้ IndexedDb ระบบจะไม่ประมวลผลการกำหนดค่าดัชนีใดๆ

เมธอดนี้ยอมรับรูปแบบ JSON ที่ Firebase CLI (firebase firestore:indexes) ส่งออก หากรูปแบบ JSON ไม่ถูกต้อง เมธอดนี้จะแสดงข้อผิดพลาด

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
firestore	Firestore	อินสแตนซ์ Firestore ที่จะกำหนดค่าดัชนี
JSON	สตริง	รูปแบบ JSON ที่ส่งออกโดย Firebase CLI

การคืนสินค้า:

คำสัญญา<โมฆะ>

Promise ที่ได้รับการแก้ไขเมื่อกำหนดค่าดัชนีทั้งหมดเรียบร้อยแล้ว

ข้อยกเว้น

FirestoreError หากรูปแบบ JSON ไม่ถูกต้อง

สิ้นสุด(firestore)

ยุติอินสแตนซ์ Firestore ที่ระบุ

หลังจากเรียก terminate() แล้ว ระบบจะสามารถใช้ฟังก์ชัน clearIndexedDbPersistence() ได้เท่านั้น ฟังก์ชันอื่นๆ จะแสดง FirestoreError

หากต้องการรีสตาร์ทหลังการสิ้นสุด ให้สร้างอินสแตนซ์ใหม่ของ FirebaseFirestore ด้วย getFirestore()

การสิ้นสุดจะไม่ยกเลิกการเขียนที่รอดำเนินการ และสัญญาใดๆ ที่กำลังรอการตอบสนองจากเซิร์ฟเวอร์จะไม่ได้รับการแก้ไข หากคุณเปิดใช้การถาวร ครั้งต่อไปที่คุณเริ่มต้นอินสแตนซ์นี้ อินสแตนซ์จะส่งการเขียนเหล่านี้ไปยังเซิร์ฟเวอร์ต่อ

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
firestore	Firestore

การคืนสินค้า:

คำสัญญา<โมฆะ>

Promise ที่แก้ไขแล้วเมื่อยุติอินสแตนซ์เรียบร้อยแล้ว

โปรดรอForPendingWrites(firestore)

รอจนกว่าแบ็กเอนด์จะรับทราบการเขียนที่รอดำเนินการทั้งหมดสำหรับผู้ใช้ที่ใช้งานอยู่

สัญญาที่ส่งคืนจะสำเร็จทันทีหากไม่มีการเขียนค้างอยู่ มิเช่นนั้น สัญญาจะรอการเขียนที่ออกก่อนหน้านี้ทั้งหมด (รวมถึงการเขียนในเซสชันแอปก่อนหน้า) แต่จะไม่รอการเขียนที่เพิ่มเข้ามาหลังจากเรียกใช้ฟังก์ชัน หากต้องการรอการเขียนเพิ่มเติม โปรดโทรหา waitForPendingWrites() อีกครั้ง

สัญญา waitForPendingWrites() ที่ค้างอยู่จะถูกปฏิเสธระหว่างการเปลี่ยนแปลงผู้ใช้

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
firestore	Firestore

การคืนสินค้า:

คำสัญญา<โมฆะ>

Promise ซึ่งแก้ไขเมื่อแบ็กเอนด์รับทราบการเขียนที่รอดำเนินการทั้งหมด

WriteBatch(firestore)

สร้างกลุ่มการเขียนที่ใช้สำหรับการเขียนหลายรายการเป็นการดำเนินการแบบอะตอมรายการเดียว จำนวนการเขียนสูงสุดที่อนุญาตใน WriteBatch เดียวคือ 500 ไฟล์

การเขียนแบบกลุ่มนั้นแตกต่างจากธุรกรรมตรงที่จะคงกลุ่มการเขียนไว้แบบออฟไลน์ ดังนั้นจึงเหมาะสมกว่าเมื่อคุณไม่จำเป็นต้องกำหนดเงื่อนไขการเขียนในข้อมูลอ่านแล้ว

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
firestore	Firestore

การคืนสินค้า:

WriteBatch

WriteBatch ที่ใช้เพื่อเรียกใช้การเขียนหลายรายการได้ในระดับอะตอม

ฟังก์ชัน()

จำนวน()

สร้างออบเจ็กต์ AggregateField ที่สามารถใช้ในการคำนวณจำนวนเอกสารในชุดผลลัพธ์ของการค้นหา

ลายเซ็น:

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

การคืนสินค้า:

AggregateField<number>

deleteField()

แสดงผลที่ส่งสำหรับใช้กับ updateDoc() หรือ setDoc() ด้วย {merge: true} เพื่อทำเครื่องหมายช่องสำหรับลบ

ลายเซ็น:

export declare function deleteField(): FieldValue;

การคืนสินค้า:

documentId()

แสดงผลการแจ้งเตือนพิเศษ FieldPath เพื่ออ้างถึงรหัสของเอกสาร โดยสามารถใช้ในคำค้นหาเพื่อจัดเรียงหรือกรองตามรหัสเอกสาร

ลายเซ็น:

export declare function documentId(): FieldPath;

การคืนสินค้า:

FieldPath

getFirestore()

แสดงผลอินสแตนซ์ Firestore เริ่มต้นที่มีอยู่ซึ่งเชื่อมโยงกับ FirebaseApp เริ่มต้น หากไม่มีอินสแตนซ์ ให้เริ่มต้นอินสแตนซ์ใหม่ด้วยการตั้งค่าเริ่มต้น

ลายเซ็น:

export declare function getFirestore(): Firestore;

การคืนสินค้า:

MemoryEagerGarbageCollector

อินสแตนซ์ Firestore เริ่มต้นของแอปเริ่มต้น

MemoryEagerGarbageCollector()

สร้างอินสแตนซ์ของ MemoryEagerGarbageCollector นอกจากนี้ยังเป็นค่าเริ่มต้นของเครื่องมือเก็บขยะ เว้นแต่จะระบุไว้เป็นอย่างอื่นอย่างชัดเจน

ลายเซ็น:

export declare function memoryEagerGarbageCollector(): MemoryEagerGarbageCollector;

การคืนสินค้า:

PerserialTabManager()

สร้างอินสแตนซ์ของ PersistentMultipleTabManager

ลายเซ็น:

export declare function persistentMultipleTabManager(): PersistentMultipleTabManager;

การคืนสินค้า:

PersistentMultiTabManager

ServerTimestamp()

แสดงผลเซนติเนลที่ใช้กับ setDoc() หรือ updateDoc() เพื่อรวมการประทับเวลาที่เซิร์ฟเวอร์สร้างขึ้นในข้อมูลที่เขียน

ลายเซ็น:

export declare function serverTimestamp(): FieldValue;

การคืนสินค้า:

ฟังก์ชัน(รหัสฐานข้อมูล, ...)

getFirestore(รหัสฐานข้อมูล)

API นี้เป็นเพียงตัวอย่างสำหรับนักพัฒนาซอฟต์แวร์และอาจเปลี่ยนแปลงไปตามความคิดเห็นที่เราได้รับ อย่าใช้ API นี้ในสภาพแวดล้อมที่ใช้งานจริง

แสดงผลอินสแตนซ์ Firestore ที่มีอยู่ซึ่งเชื่อมโยงกับ FirebaseApp เริ่มต้น หากไม่มีอินสแตนซ์ ให้เริ่มต้นอินสแตนซ์ใหม่ด้วยการตั้งค่าเริ่มต้น

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
รหัสฐานข้อมูล	สตริง	ชื่อของฐานข้อมูล

การคืนสินค้า:

อินสแตนซ์ Firestore ของแอปเริ่มต้น

ฟังก์ชัน(องค์ประกอบ, ...)

ArrayRemove(องค์ประกอบ)

แสดงผลค่าพิเศษที่สามารถใช้กับ setDoc() หรือที่บอกเซิร์ฟเวอร์ให้นำองค์ประกอบที่กำหนดออกจากค่าอาร์เรย์ใดๆ ที่มีอยู่ในเซิร์ฟเวอร์ ระบบจะนำอินสแตนซ์ทั้งหมดของแต่ละองค์ประกอบที่ระบุออกจากอาร์เรย์ หากช่องที่แก้ไขไม่ใช่อาร์เรย์อยู่แล้ว ช่องนี้จะถูกเขียนทับด้วยอาร์เรย์ที่ว่างเปล่า

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
องค์ประกอบ	ไม่ทราบ[]	องค์ประกอบที่จะนำออกจากอาร์เรย์

การคืนสินค้า:

คำสัญญาณ FieldValue สำหรับใช้ในการโทรถึง setDoc() หรือ updateDoc()

อาร์เรย์ยูเนียน(องค์ประกอบ)

แสดงผลค่าพิเศษที่สามารถใช้กับ setDoc() หรือ updateDoc() ซึ่งบอกเซิร์ฟเวอร์ให้รวมองค์ประกอบที่ระบุกับค่าอาร์เรย์ใดๆ ก็ตามที่มีอยู่ในเซิร์ฟเวอร์แล้ว แต่ละองค์ประกอบที่ระบุซึ่งไม่ได้มีอยู่ในอาร์เรย์จะเพิ่มต่อท้าย หากฟิลด์ที่แก้ไขไม่ใช่อาร์เรย์ ฟิลด์ดังกล่าวจะถูกเขียนทับด้วยอาร์เรย์ที่มีอีลิเมนต์ที่ระบุ

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
องค์ประกอบ	ไม่ทราบ[]	องค์ประกอบที่จะผนวกเข้ากับอาร์เรย์

การคืนสินค้า:

QueryFieldFilterConstraint

คำสัญญาณ FieldValue สำหรับใช้ในการโทรถึง setDoc() หรือ updateDoc()

ฟังก์ชัน(ฟิลด์, ...)

ค่าเฉลี่ย(ฟิลด์)

สร้างออบเจ็กต์ AggregateField ที่สามารถใช้ในการคำนวณค่าเฉลี่ยของช่องที่ระบุในช่วงของเอกสารในชุดผลลัพธ์ของการค้นหา

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
พื้นที่	สตริง \| FieldPath	ระบุฟิลด์ที่จะหาค่าเฉลี่ยในชุดผลลัพธ์

การคืนสินค้า:

AggregateField<number | ค่าว่าง>

sum(ฟิลด์)

สร้างออบเจ็กต์ AggregateField ที่สามารถใช้ในการคำนวณผลรวมของช่องที่ระบุในช่วงของเอกสารในชุดผลลัพธ์ของการค้นหา

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
พื้นที่	สตริง \| FieldPath	ระบุฟิลด์ที่จะรวมในชุดผลลัพธ์

การคืนสินค้า:

AggregateField<number>

function(fieldPath, ...)

orderBy(fieldPath, pathStr)

สร้าง QueryOrderByConstraint ที่จัดเรียงผลการค้นหาตามช่องที่ระบุ โดยสามารถเรียงจากมากไปน้อยแทนที่จะเรียงจากน้อยไปมาก

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
FieldPath	สตริง \| FieldPath	ช่องที่ใช้จัดเรียง
ทิศทางStr	OrderByDirection	ทิศทางการจัดเรียงตาม ("asc" หรือ "desc") (ไม่บังคับ) หากไม่ได้ระบุ ลำดับจะเรียงจากน้อยไปมาก

การคืนสินค้า:

QueryOrderByConstraint

QueryOrderByConstraint ที่สร้างขึ้น

where(fieldPath, opStr, value)

สร้าง QueryFieldFilterConstraint ที่บังคับให้เอกสารต้องมีช่องที่ระบุ และค่าควรเป็นไปตามข้อจำกัดความสัมพันธ์ที่ระบุ

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
FieldPath	สตริง \| FieldPath	เส้นทางที่จะเปรียบเทียบ
opStr	ตำแหน่งFilterOp	สตริงการดำเนินการ (เช่น "<", "<=", "==", "<", "<=", "!=")
value	ไม่ทราบ	ค่าสำหรับเปรียบเทียบ

การคืนสินค้า:

QueryFieldFilterConstraint ที่สร้างขึ้น

Functions(fieldValues, ...)

endAt(ค่าฟิลด์)

สร้าง QueryEndAtConstraint ที่ปรับเปลี่ยนชุดผลลัพธ์ให้สิ้นสุดในช่องที่ให้ไว้ซึ่งสัมพันธ์กับลำดับของการค้นหา ลำดับของค่าช่องต้องตรงกับลำดับของค่าตามอนุประโยคในข้อความค้นหา

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
ค่าฟิลด์	ไม่ทราบ[]	ค่าของช่องที่จะสิ้นสุดคำค้นหานี้ตามลำดับของคำค้นหา

การคืนสินค้า:

QueryEndAtConstraint เพื่อส่งไปยัง query()

endbefore(fieldValues)

สร้าง QueryEndAtConstraint ที่ปรับเปลี่ยนชุดผลลัพธ์ให้สิ้นสุดก่อนช่องที่ระบุซึ่งสัมพันธ์กับลำดับของการค้นหา ลำดับของค่าช่องต้องตรงกับลำดับของค่าตามอนุประโยคในข้อความค้นหา

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
ค่าฟิลด์	ไม่ทราบ[]	ค่าของช่องที่จะจบการค้นหานี้ก่อน ตามลำดับของคำค้นหา

การคืนสินค้า:

QueryEndAtConstraint เพื่อส่งไปยัง query()

StartAfter(fieldValues)

สร้าง QueryStartAtConstraint ที่แก้ไขชุดผลลัพธ์ให้เริ่มต้นหลังช่องที่ระบุไว้ซึ่งสัมพันธ์กับลำดับของการค้นหา ลำดับของค่าช่องต้องตรงกับลำดับของค่าตามอนุประโยคในข้อความค้นหา

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
ค่าฟิลด์	ไม่ทราบ[]	ค่าของช่องที่จะเริ่มคำค้นหานี้ในภายหลัง ตามลำดับคำค้นหา

การคืนสินค้า:

QueryStartAtConstraint เพื่อส่งไปยัง query()

เริ่มที่(ค่าฟิลด์)

สร้าง QueryStartAtConstraint ที่แก้ไขชุดผลลัพธ์ให้เริ่มต้นที่ช่องที่ระบุซึ่งสัมพันธ์กับลำดับของการค้นหา ลำดับของค่าช่องต้องตรงกับลำดับของค่าตามอนุประโยคในข้อความค้นหา

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
ค่าฟิลด์	ไม่ทราบ[]	ค่าของช่องที่จะเริ่มต้นการค้นหานี้ ตามลำดับของคำค้นหา

การคืนสินค้า:

QueryStartAtConstraint เพื่อส่งไปยัง query()

ฟังก์ชัน(indexManager, ...)

deleteAllPersistentCacheIndexes(indexManager)

นำดัชนีแคชถาวรทั้งหมดออก

โปรดทราบว่าฟังก์ชันนี้จะลบดัชนีที่สร้างโดย setIndexConfiguration() ซึ่งเลิกใช้งานแล้วด้วย

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
เครื่องมือจัดการดัชนี	PersistentCacheIndexManager

การคืนสินค้า:

เป็นโมฆะ

disabledPersistentCacheIndexAutoCreation(indexManager)

หยุดการสร้างดัชนีแคชถาวรโดยอัตโนมัติสำหรับการดำเนินการค้นหาในเครื่อง ดัชนีที่สร้างจากการเรียก enablePersistentCacheIndexAutoCreation() จะยังคงมีผลอยู่

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
เครื่องมือจัดการดัชนี	PersistentCacheIndexManager

การคืนสินค้า:

เป็นโมฆะ

enablePersistentCacheIndexAutoCreation(indexManager)

เปิดใช้ SDK เพื่อสร้างดัชนีแคชถาวรโดยอัตโนมัติสำหรับการดำเนินการค้นหาในเครื่องเมื่อ SDK เชื่อว่าดัชนีแคชช่วยปรับปรุงประสิทธิภาพได้

ฟีเจอร์นี้ปิดใช้อยู่โดยค่าเริ่มต้น

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
เครื่องมือจัดการดัชนี	PersistentCacheIndexManager

การคืนสินค้า:

เป็นโมฆะ

ฟังก์ชัน(ซ้าย, ...)

totalFieldEqual(ซ้าย ขวา)

เปรียบเทียบอินสแตนซ์ "AggregateField" 2 รายการสำหรับความเท่ากัน

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
ซ้าย	AggregateField<unknown>	เปรียบเทียบ AggregateField นี้กับ `right`
ขวา	AggregateField<unknown>	เปรียบเทียบ AggregateField นี้กับ `left`

การคืนสินค้า:

boolean

รวมข้อความค้นหาSnapshotEqual(ซ้าย ขวา)

เปรียบเทียบอินสแตนซ์ AggregateQuerySnapshot 2 อินสแตนซ์เพื่อความเท่ากัน

อินสแตนซ์ AggregateQuerySnapshot 2 รายการถือว่าเป็น "เท่ากัน" หากมีคำค้นหาพื้นฐานที่เปรียบเทียบเท่ากันและข้อมูลเดียวกัน

ลายเซ็น:

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>	`AggregateQuerySnapshot` แรกที่จะเปรียบเทียบ
ขวา	AggregateQuerySnapshot<AggregateSpecType, AppModelType, DbModelType>	`AggregateQuerySnapshot` รายการที่ 2 ที่จะเปรียบเทียบ

การคืนสินค้า:

boolean

true หากวัตถุนั้น "เท่ากัน" ตามที่กำหนดไว้ข้างต้น หรือ false ในกรณีอื่นๆ

queryEqual(ซ้าย ขวา)

แสดงผลเป็น "จริง" หากคำค้นหาที่ระบุชี้ไปยังคอลเล็กชันเดียวกันและใช้ข้อจำกัดเดียวกัน

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
ซ้าย	คำค้นหา<AppModelType, DbModelType>	`Query` ที่จะเปรียบเทียบ
ขวา	คำค้นหา<AppModelType, DbModelType>	`Query` ที่จะเปรียบเทียบ

การคืนสินค้า:

boolean

"จริง" หากการอ้างอิงชี้ไปยังตำแหน่งเดียวกันในฐานข้อมูล Firestore เดียวกัน

refEqual(ซ้าย ขวา)

แสดงค่า "จริง" หากการอ้างอิงที่ระบุเท่ากัน

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
ซ้าย	DocumentReference<AppModelType, DbModelType> \| CollectionReference<AppModelType, DbModelType>	ข้อมูลอ้างอิงสำหรับเปรียบเทียบ
ขวา	DocumentReference<AppModelType, DbModelType> \| CollectionReference<AppModelType, DbModelType>	ข้อมูลอ้างอิงสำหรับเปรียบเทียบ

การคืนสินค้า:

boolean

"จริง" หากการอ้างอิงชี้ไปยังตำแหน่งเดียวกันในฐานข้อมูล Firestore เดียวกัน

SnapshotEqual(ซ้าย, ขวา)

แสดงค่า "จริง" หากสแนปชอตที่ระบุเท่ากัน

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
ซ้าย	DocumentSnapshot<AppModelType, DbModelType> \| QuerySnapshot<AppModelType, DbModelType>	ภาพรวมที่จะเปรียบเทียบ
ขวา	DocumentSnapshot<AppModelType, DbModelType> \| QuerySnapshot<AppModelType, DbModelType>	ภาพรวมที่จะเปรียบเทียบ

การคืนสินค้า:

boolean

"จริง" หากสแนปชอตเท่ากัน

ฟังก์ชัน(ขีดจำกัด, ...)

ขีดจำกัด(จำนวนสูงสุด)

สร้าง QueryLimitConstraint ที่แสดงเอกสารที่ตรงกันรายการแรกเท่านั้น

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
ขีดจำกัด	ตัวเลข	จำนวนรายการสูงสุดที่จะแสดง

การคืนสินค้า:

QueryLimitConstraint

QueryLimitConstraint ที่สร้างขึ้น

ขีดจำกัดToLast(ขีดจำกัด)

สร้าง QueryLimitConstraint ที่แสดงเฉพาะเอกสารที่ตรงกันล่าสุดเท่านั้น

คุณต้องระบุอนุประโยค orderBy อย่างน้อย 1 อย่างสำหรับการค้นหา limitToLast ไม่เช่นนั้นจะมีข้อยกเว้นระหว่างการดำเนินการ

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
ขีดจำกัด	ตัวเลข	จำนวนรายการสูงสุดที่จะแสดง

การคืนสินค้า:

QueryLimitConstraint

QueryLimitConstraint ที่สร้างขึ้น

ฟังก์ชัน(logLevel, ...)

setLogLevel(logLevel)

ตั้งค่าการพูดรายละเอียดของบันทึก Cloud Firestore (แก้ไขข้อบกพร่อง ข้อผิดพลาด หรือปิดเสียง)

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
ระดับบันทึก	ระดับบันทึก	การพูดรายละเอียดที่คุณกำหนดสำหรับกิจกรรมและการบันทึกข้อผิดพลาด อาจเป็นค่าใดก็ได้ต่อไปนี้ `debug` สำหรับระดับการบันทึกที่มีข้อมูลขนาดใหญ่ที่สุด และสำหรับการแก้ไขข้อบกพร่องเป็นหลัก `error` เพื่อบันทึกเฉพาะข้อผิดพลาดเท่านั้น `silent to turn off logging.`

การคืนสินค้า:

เป็นโมฆะ

ฟังก์ชัน(n, ...)

เพิ่มขึ้น(n)

แสดงผลค่าพิเศษที่ใช้กับ setDoc() หรือ updateDoc() ได้ ซึ่งบอกเซิร์ฟเวอร์ให้เพิ่มค่าปัจจุบันของช่องตามค่าที่ระบุ

ถ้าตัวถูกดำเนินการหรือค่าฟิลด์ปัจจุบันใช้ความแม่นยำของจุดลอยตัว เลขคณิตทั้งหมดจะเป็นไปตามความหมาย IEEE 754 หากทั้ง 2 ค่าเป็นจำนวนเต็ม ค่าที่อยู่นอกช่วงตัวเลขที่ปลอดภัยของ JavaScript (Number.MIN_SAFE_INTEGER ถึง Number.MAX_SAFE_INTEGER) จะสูญเสียความแม่นยำด้วย นอกจากนี้ เมื่อประมวลผลโดยแบ็กเอนด์ของ Firestore การดำเนินการจำนวนเต็มทั้งหมดจะจำกัดระหว่าง -2^63 และ 2^63-1

หากค่าของช่องปัจจุบันไม่ใช่ประเภท number หรือยังไม่มีช่องนี้ การเปลี่ยนรูปแบบจะตั้งค่าช่องนี้เป็นค่าที่ระบุ

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
n	ตัวเลข	ค่าที่จะเพิ่มตาม

การคืนสินค้า:

คำสัญญาณ FieldValue สำหรับใช้ในการโทรถึง setDoc() หรือ updateDoc()

ฟังก์ชัน(ข้อความค้นหา, ...)

getAggregateFromServer(ข้อความค้นหา, AggregateSpec)

คำนวณการรวมที่ระบุของเอกสารในชุดผลลัพธ์ของข้อความค้นหานั้นๆ โดยไม่ต้องดาวน์โหลดเอกสารจริง

การใช้ฟังก์ชันนี้เพื่อดำเนินการรวมจะมีประสิทธิภาพ เนื่องจากมีเพียงค่าการรวมสุดท้ายเท่านั้น ไม่ใช่เอกสาร ที่มีการดาวน์โหลดข้อมูล ฟังก์ชันนี้ทำการรวมเอกสารได้ในกรณีที่ชุดผลลัพธ์มีขนาดใหญ่มากจนดาวน์โหลดไม่ได้ (เอกสารหลายพันรายการ)

ผลลัพธ์ที่ได้รับจากเซิร์ฟเวอร์จะปรากฏโดยไม่มีการเปลี่ยนแปลง โดยไม่คำนึงถึงสถานะในเครื่อง กล่าวคือ เอกสารในแคชในเครื่องจะไม่ถูกนำมาพิจารณา การแก้ไขในเครื่องที่ยังไม่ได้ซิงค์กับเซิร์ฟเวอร์ ผลลัพธ์ที่ดาวน์โหลดก่อนหน้านี้ (หากมี) จะไม่ใช้ การเรียกใช้ฟังก์ชันนี้ทุกครั้งจะต้องเดินทางไป-กลับไปยังเซิร์ฟเวอร์

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
query	คำค้นหา<AppModelType, DbModelType>	ข้อความค้นหาที่มีชุดผลลัพธ์เป็นผลรวม
ข้อมูลจำเพาะรวม	AggregateSpecType	ออบเจ็กต์ `AggregateSpec` ที่ระบุการรวบรวมข้อมูลที่จะดำเนินการเหนือชุดผลลัพธ์ AggregateSpec จะระบุชื่อแทนสำหรับข้อมูลรวมแต่ละรายการ ซึ่งสามารถใช้เพื่อดึงผลลัพธ์การรวมได้

การคืนสินค้า:

สัญญา<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(คำค้นหา)

คำนวณจำนวนเอกสารในชุดผลลัพธ์ของคำค้นหาที่ระบุโดยไม่ต้องดาวน์โหลดเอกสารจริง

การใช้ฟังก์ชันนี้เพื่อนับจำนวนเอกสารจะมีประสิทธิภาพ เนื่องจากมีเพียงจำนวนสุดท้ายเท่านั้น ไม่ใช่จำนวนเอกสาร มีการดาวน์โหลดข้อมูล ฟังก์ชันนี้สามารถนับเอกสารได้ในกรณีที่ชุดผลลัพธ์มีขนาดใหญ่มากจนไม่สามารถดาวน์โหลดได้ทั้งหมด (เอกสารหลายพันรายการ)

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
query	คำค้นหา<AppModelType, DbModelType>	คำค้นหาที่มีการคำนวณขนาดของชุดผลลัพธ์

การคืนสินค้า:

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

คำสัญญาที่จะได้รับการแก้ไขด้วยจำนวน สามารถดึงจำนวนได้จาก snapshot.data().count โดยที่ snapshot คือ AggregateQuerySnapshot ที่ Promise แสดงผลเป็นค่าคงที่

getDocuments(คำค้นหา)

ดำเนินการค้นหาและแสดงผลลัพธ์เป็น QuerySnapshot

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
query	คำค้นหา<AppModelType, DbModelType>

การคืนสินค้า:

สัญญา<QuerySnapshot<AppModelType, DbModelType>>

Promise ที่จะได้รับการแก้ไขด้วยผลการค้นหา

getDocumentsFromCache(ข้อความค้นหา)

ดำเนินการค้นหาและส่งคืนผลลัพธ์เป็น QuerySnapshot จากแคช แสดงผลชุดผลลัพธ์ที่ว่างเปล่า หากไม่มีเอกสารที่ตรงกับข้อความค้นหาในปัจจุบัน

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
query	คำค้นหา<AppModelType, DbModelType>

การคืนสินค้า:

สัญญา<QuerySnapshot<AppModelType, DbModelType>>

Promise ที่จะได้รับการแก้ไขด้วยผลการค้นหา

getDocumentsFromServer(คำค้นหา)

ดำเนินการค้นหาและส่งคืนผลลัพธ์เป็น QuerySnapshot จากเซิร์ฟเวอร์ แสดงผลข้อผิดพลาดหากเครือข่ายไม่พร้อมใช้งาน

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
query	คำค้นหา<AppModelType, DbModelType>

การคืนสินค้า:

สัญญา<QuerySnapshot<AppModelType, DbModelType>>

Promise ที่จะได้รับการแก้ไขด้วยผลการค้นหา

onSnapshot(คำค้นหา, ผู้สังเกตการณ์)

แนบ Listener สำหรับกิจกรรม QuerySnapshot รายการ คุณอาจส่ง Callback onNext และ onError ทีละรายการ หรือส่งออบเจ็กต์ผู้สังเกตการณ์ 1 รายการที่มี Callback next และ error ยกเลิก Listener ได้โดยเรียกใช้ฟังก์ชันที่แสดงผลเมื่อมีการเรียกใช้ onSnapshot

หมายเหตุ: แม้ว่าจะมีการเรียกกลับ onCompletion ได้ แต่จะไม่มีการเรียกรายการดังกล่าวเนื่องจากสตรีมสแนปชอตจะไม่มีที่สิ้นสุด

ลายเซ็น:

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;

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
query	คำค้นหา<AppModelType, DbModelType>	คำค้นหาที่จะฟัง
ผู้สังเกตการณ์	{ ถัดไป?: (สแนปชอต: QuerySnapshot<AppModelType, DbModelType>) => โมฆะ; ?: (ข้อผิดพลาด: FirestoreError) => เป็นโมฆะ; เสร็จสมบูรณ์: () => โมฆะ; }	ออบเจ็กต์เดียวที่มี Callback `next` และ `error`

การคืนสินค้า:

ฟังก์ชันยกเลิกการสมัครที่เรียกใช้เพื่อยกเลิก Listener ของสแนปชอตได้

onSnapshot(คำค้นหา ตัวเลือก ผู้สังเกตการณ์)

ลายเซ็น:

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;

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
query	คำค้นหา<AppModelType, DbModelType>	คำค้นหาที่จะฟัง
ตัวเลือก	ตัวเลือกฟังสแนปชอต	ตัวเลือกที่ควบคุมพฤติกรรมการฟัง
ผู้สังเกตการณ์	{ ถัดไป?: (สแนปชอต: QuerySnapshot<AppModelType, DbModelType>) => โมฆะ; ?: (ข้อผิดพลาด: FirestoreError) => โมฆะ; เสร็จสมบูรณ์: () => โมฆะ; }	ออบเจ็กต์เดียวที่มี Callback `next` และ `error`

การคืนสินค้า:

ฟังก์ชันยกเลิกการสมัครที่เรียกใช้เพื่อยกเลิก Listener ของสแนปชอตได้

onSnapshot(ข้อความค้นหา, onNext, onError, onUnderstanding)

ลายเซ็น:

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;

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
query	คำค้นหา<AppModelType, DbModelType>	คำค้นหาที่จะฟัง
ถัดไป	(สแนปชอต: QuerySnapshot<AppModelType, DbModelType>) => เป็นโมฆะ	ระบบจะโทรกลับทุกครั้งที่ `QuerySnapshot` ใหม่พร้อมใช้งาน
onError	(ข้อผิดพลาด: FirestoreError) => เป็นโมฆะ	การเรียกกลับที่จะถูกเรียกหากการฟังไม่สำเร็จหรือถูกยกเลิก จะไม่มีการติดต่อกลับอีกต่อไป
เสร็จสมบูรณ์	() => เป็นโมฆะ	มีได้ แต่จะไม่มีการเรียกใช้เนื่องจากสตรีมจะไม่สิ้นสุด

การคืนสินค้า:

ฟังก์ชันยกเลิกการสมัครที่เรียกใช้เพื่อยกเลิก Listener ของสแนปชอตได้

onSnapshot(ข้อความค้นหา, ตัวเลือก, onNext, onError, onComplete)

ลายเซ็น:

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;

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
query	คำค้นหา<AppModelType, DbModelType>	คำค้นหาที่จะฟัง
ตัวเลือก	ตัวเลือกฟังสแนปชอต	ตัวเลือกที่ควบคุมพฤติกรรมการฟัง
ถัดไป	(สแนปชอต: QuerySnapshot<AppModelType, DbModelType>) => เป็นโมฆะ	ระบบจะโทรกลับทุกครั้งที่ `QuerySnapshot` ใหม่พร้อมใช้งาน
onError	(ข้อผิดพลาด: FirestoreError) => เป็นโมฆะ	การเรียกกลับที่จะถูกเรียกหากการฟังไม่สำเร็จหรือถูกยกเลิก จะไม่มีการติดต่อกลับอีกต่อไป
เสร็จสมบูรณ์	() => เป็นโมฆะ	มีได้ แต่จะไม่มีการเรียกใช้เนื่องจากสตรีมจะไม่สิ้นสุด

การคืนสินค้า:

QueryCompositeFilterConstraint

ฟังก์ชันยกเลิกการสมัครที่เรียกใช้เพื่อยกเลิก Listener ของสแนปชอตได้

query(query, CompositFilter, queryConstraints)

สร้างอินสแตนซ์ใหม่ของ Query ที่เปลี่ยนแปลงไม่ได้ซึ่งจะขยายเพื่อรวมข้อจำกัดการค้นหาเพิ่มเติมด้วย

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
query	คำค้นหา<AppModelType, DbModelType>	อินสแตนซ์ข้อความค้นหาที่จะใช้เป็นฐานสำหรับข้อจำกัดใหม่
ตัวกรองแบบผสม	QueryCompositeFilterConstraint	QueryCompositeFilterConstraint ที่จะใช้ สร้าง QueryCompositeFilterConstraint โดยใช้ and() หรือ or()
ข้อจำกัดข้อความค้นหา	QueryNonFilterConstraint[]	QueryNonFilterConstraint เพิ่มเติมที่จะใช้ (เช่น orderBy(), limit())

การคืนสินค้า:

คำค้นหา<AppModelType, DbModelType>

ข้อยกเว้น

หากข้อจำกัดการค้นหาที่ระบุไม่สามารถรวมกับข้อจำกัดที่มีอยู่หรือข้อจำกัดใหม่

query(query, queryConstraints)

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
query	คำค้นหา<AppModelType, DbModelType>	อินสแตนซ์ข้อความค้นหาที่จะใช้เป็นฐานสำหรับข้อจำกัดใหม่
ข้อจำกัดข้อความค้นหา	QueryConstraint[]	รายการ QueryConstraint ที่จะใช้

การคืนสินค้า:

คำค้นหา<AppModelType, DbModelType>

ข้อยกเว้น

ฟังก์ชัน(queryConstraints, ...)

และ(queryConstraints)

สร้าง QueryCompositeFilterConstraint ใหม่ที่เป็นการผสมผสานของข้อจำกัดตัวกรองที่ระบุ ตัวกรองร่วมจะมีเอกสารหากตรงกับตัวกรองทั้งหมดที่ระบุ

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
ข้อจำกัดข้อความค้นหา	QueryFilterConstraint[]	ไม่บังคับ รายการ QueryFilterConstraint ที่จะทำการร่วม ซึ่งต้องสร้างโดยมีการเรียกไปที่ where(), or() หรือ and()

การคืนสินค้า:

QueryCompositeFilterConstraint ที่สร้างขึ้นใหม่

หรือ(queryConstraints)

สร้าง QueryCompositeFilterConstraint ใหม่ซึ่งเป็นการแยกส่วนข้อจำกัดตัวกรองที่ระบุ ตัวกรองการแยกประกอบด้วยเอกสารหากตรงกับตัวกรองที่ระบุ

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
ข้อจำกัดข้อความค้นหา	QueryFilterConstraint[]	ไม่บังคับ รายการ QueryFilterConstraint เพื่อทำการแยก ซึ่งต้องสร้างขึ้นโดยมีการเรียกไปที่ where(), or() หรือ and()

การคืนสินค้า:

QueryCompositeFilterConstraint

QueryCompositeFilterConstraint ที่สร้างขึ้นใหม่

ฟังก์ชัน(การอ้างอิง, ...)

addDoc(ข้อมูลอ้างอิง, ข้อมูล)

เพิ่มเอกสารใหม่ไปยัง CollectionReference ที่ระบุด้วยข้อมูลที่ระบุ ซึ่งจะเป็นการกำหนดรหัสเอกสารให้กับเอกสารโดยอัตโนมัติ

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
การอ้างอิง	CollectionReference<AppModelType, DbModelType>	การอ้างอิงคอลเล็กชันที่จะเพิ่มเอกสารนี้
ข้อมูล	WithFieldValue<AppModelType>	ออบเจ็กต์ที่มีข้อมูลสำหรับเอกสารใหม่

การคืนสินค้า:

สัญญา<DocumentReference<AppModelType, DbModelType>>

Promise ได้รับการแก้ไขแล้วโดยมี DocumentReference ซึ่งชี้ไปยังเอกสารที่สร้างขึ้นใหม่หลังจากเขียนไปยังแบ็กเอนด์แล้ว (โปรดทราบว่าปัญหานี้จะไม่แก้ไขขณะที่คุณออฟไลน์)

คอลเล็กชัน(ข้อมูลอ้างอิง เส้นทาง กลุ่มเส้นทาง)

รับอินสแตนซ์ CollectionReference ที่อ้างถึงคอลเล็กชันย่อยของ reference ที่เส้นทางแบบสัมพัทธ์ที่ระบุ

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
การอ้างอิง	CollectionReference<AppModelType, DbModelType>	การอ้างอิงคอลเล็กชัน
เส้นทาง	สตริง	เส้นทางที่คั่นด้วยเครื่องหมายทับไปยังคอลเล็กชัน
กลุ่มเส้นทาง	สตริง[]	กลุ่มเส้นทางเพิ่มเติมที่จะนำไปใช้โดยสัมพันธ์กับอาร์กิวเมนต์แรก

การคืนสินค้า:

CollectionReference<DocumentData, DocumentData>

อินสแตนซ์ CollectionReference

ข้อยกเว้น

หากเส้นทางสุดท้ายมีจำนวนกลุ่มเท่ากันและไม่ได้ชี้ไปที่คอลเล็กชัน

คอลเล็กชัน(ข้อมูลอ้างอิง เส้นทาง กลุ่มเส้นทาง)

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
การอ้างอิง	DocumentReference<AppModelType, DbModelType>	การอ้างอิงเอกสาร Firestore
เส้นทาง	สตริง	เส้นทางที่คั่นด้วยเครื่องหมายทับไปยังคอลเล็กชัน
กลุ่มเส้นทาง	สตริง[]	กลุ่มเส้นทางเพิ่มเติมที่จะนำไปใช้โดยสัมพันธ์กับอาร์กิวเมนต์แรก

การคืนสินค้า:

CollectionReference<DocumentData, DocumentData>

อินสแตนซ์ CollectionReference

ข้อยกเว้น

หากเส้นทางสุดท้ายมีจำนวนกลุ่มเท่ากันและไม่ได้ชี้ไปที่คอลเล็กชัน

ลบเอกสาร(การอ้างอิง)

ลบเอกสารที่ DocumentReference ที่ระบุอ้างถึง

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
การอ้างอิง	DocumentReference<AppModelType, DbModelType>	การอ้างอิงเอกสารที่จะลบ

การคืนสินค้า:

คำสัญญา<โมฆะ>

Promise ได้รับการแก้ไขเมื่อลบเอกสารออกจากแบ็กเอนด์สำเร็จแล้ว (โปรดทราบว่าเอกสารจะไม่หายไปขณะที่คุณออฟไลน์)

เอกสาร(การอ้างอิง เส้นทาง กลุ่มเส้นทาง)

รับอินสแตนซ์ DocumentReference ที่อ้างถึงเอกสารภายใน reference ที่เส้นทางแบบสัมพัทธ์ที่ระบุ หากไม่ได้ระบุเส้นทาง ระบบจะใช้รหัสที่ไม่ซ้ำกันที่สร้างขึ้นโดยอัตโนมัติสำหรับ DocumentReference ที่แสดงผล

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
การอ้างอิง	CollectionReference<AppModelType, DbModelType>	การอ้างอิงคอลเล็กชัน
เส้นทาง	สตริง	เส้นทางที่คั่นด้วยเครื่องหมายทับไปยังเอกสาร คุณต้องละเว้นเพื่อใช้รหัสที่สร้างขึ้นโดยอัตโนมัติ
กลุ่มเส้นทาง	สตริง[]	กลุ่มเส้นทางเพิ่มเติมที่จะนำไปใช้โดยสัมพันธ์กับอาร์กิวเมนต์แรก

การคืนสินค้า:

DocumentReference<AppModelType, DbModelType>

อินสแตนซ์ DocumentReference

ข้อยกเว้น

หากเส้นทางสุดท้ายมีจำนวนกลุ่มเป็นคี่และไม่ได้ชี้ไปที่เอกสาร

เอกสาร(การอ้างอิง เส้นทาง กลุ่มเส้นทาง)

รับอินสแตนซ์ DocumentReference ที่อ้างถึงเอกสารภายใน reference ที่เส้นทางแบบสัมพัทธ์ที่ระบุ

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
การอ้างอิง	DocumentReference<AppModelType, DbModelType>	การอ้างอิงเอกสาร Firestore
เส้นทาง	สตริง	เส้นทางที่คั่นด้วยเครื่องหมายทับไปยังเอกสาร
กลุ่มเส้นทาง	สตริง[]	กลุ่มเส้นทางเพิ่มเติมที่จะนำไปใช้โดยสัมพันธ์กับอาร์กิวเมนต์แรก

การคืนสินค้า:

DocumentReference<DocumentData, DocumentData>

อินสแตนซ์ DocumentReference

ข้อยกเว้น

หากเส้นทางสุดท้ายมีจำนวนกลุ่มเป็นคี่และไม่ได้ชี้ไปที่เอกสาร

getDoc(การอ้างอิง)

อ่านเอกสารที่ DocumentReference นี้อ้างอิงถึง

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
การอ้างอิง	DocumentReference<AppModelType, DbModelType>	ข้อมูลอ้างอิงของเอกสารที่จะดึงข้อมูล

การคืนสินค้า:

สัญญา<DocumentSnapshot<AppModelType, DbModelType>>

Promise แก้ปัญหาด้วย DocumentSnapshot ที่มีเนื้อหาเอกสารปัจจุบัน

getDocFromCache(การอ้างอิง)

อ่านเอกสารที่ DocumentReference นี้อ้างอิงจากแคช แสดงผลข้อผิดพลาดถ้าเอกสารไม่ได้มีการแคชไว้

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
การอ้างอิง	DocumentReference<AppModelType, DbModelType>

การคืนสินค้า:

สัญญา<DocumentSnapshot<AppModelType, DbModelType>>

Promise แก้ปัญหาโดยมี DocumentSnapshot ซึ่งมีเนื้อหาเอกสารปัจจุบัน

getDocFromServer(การอ้างอิง)

อ่านเอกสารที่ DocumentReference นี้อ้างอิงจากเซิร์ฟเวอร์ แสดงผลข้อผิดพลาดหากเครือข่ายไม่พร้อมใช้งาน

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
การอ้างอิง	DocumentReference<AppModelType, DbModelType>

การคืนสินค้า:

สัญญา<DocumentSnapshot<AppModelType, DbModelType>>

Promise แก้ปัญหาโดยมี DocumentSnapshot ซึ่งมีเนื้อหาเอกสารปัจจุบัน

onSnapshot(ข้อมูลอ้างอิง ผู้สังเกตการณ์)

แนบ Listener สำหรับกิจกรรม DocumentSnapshot รายการ คุณอาจส่ง Callback onNext และ onError ทีละรายการ หรือส่งออบเจ็กต์ผู้สังเกตการณ์ 1 รายการที่มี Callback next และ error

ลายเซ็น:

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;

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
การอ้างอิง	DocumentReference<AppModelType, DbModelType>	การอ้างอิงเอกสารที่จะฟัง
ผู้สังเกตการณ์	{ ถัดไป?: (สแนปชอต: DocumentSnapshot<AppModelType, DbModelType>) => โมฆะ; ?: (ข้อผิดพลาด: FirestoreError) => โมฆะ; เสร็จสมบูรณ์: () => โมฆะ; }	ออบเจ็กต์เดียวที่มี Callback `next` และ `error`

การคืนสินค้า:

ฟังก์ชันยกเลิกการสมัครที่เรียกใช้เพื่อยกเลิก Listener ของสแนปชอตได้

onSnapshot(ข้อมูลอ้างอิง ตัวเลือก ผู้สังเกตการณ์)

ลายเซ็น:

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;

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
การอ้างอิง	DocumentReference<AppModelType, DbModelType>	การอ้างอิงเอกสารที่จะฟัง
ตัวเลือก	ตัวเลือกฟังสแนปชอต	ตัวเลือกที่ควบคุมพฤติกรรมการฟัง
ผู้สังเกตการณ์	{ ถัดไป?: (สแนปชอต: DocumentSnapshot<AppModelType, DbModelType>) => โมฆะ; ?: (ข้อผิดพลาด: FirestoreError) => โมฆะ; เสร็จสมบูรณ์: () => โมฆะ; }	ออบเจ็กต์เดียวที่มี Callback `next` และ `error`

การคืนสินค้า:

ฟังก์ชันยกเลิกการสมัครที่เรียกใช้เพื่อยกเลิก Listener ของสแนปชอตได้

onSnapshot(การอ้างอิง, onNext, onError, onCOMPLETE)

ลายเซ็น:

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;

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
การอ้างอิง	DocumentReference<AppModelType, DbModelType>	การอ้างอิงเอกสารที่จะฟัง
ถัดไป	(สแนปชอต: DocumentSnapshot<AppModelType, DbModelType>) => เป็นโมฆะ	ระบบจะโทรกลับทุกครั้งที่ `DocumentSnapshot` ใหม่พร้อมใช้งาน
onError	(ข้อผิดพลาด: FirestoreError) => เป็นโมฆะ	การเรียกกลับที่จะถูกเรียกหากการฟังไม่สำเร็จหรือถูกยกเลิก จะไม่มีการติดต่อกลับอีกต่อไป
เสร็จสมบูรณ์	() => เป็นโมฆะ	มีได้ แต่จะไม่มีการเรียกใช้เนื่องจากสตรีมจะไม่สิ้นสุด

การคืนสินค้า:

ฟังก์ชันยกเลิกการสมัครที่เรียกใช้เพื่อยกเลิก Listener ของสแนปชอตได้

onSnapshot(การอ้างอิง, ตัวเลือก, onNext, onError, onComplete)

ลายเซ็น:

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;

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
การอ้างอิง	DocumentReference<AppModelType, DbModelType>	การอ้างอิงเอกสารที่จะฟัง
ตัวเลือก	ตัวเลือกฟังสแนปชอต	ตัวเลือกที่ควบคุมพฤติกรรมการฟัง
ถัดไป	(สแนปชอต: DocumentSnapshot<AppModelType, DbModelType>) => เป็นโมฆะ	ระบบจะโทรกลับทุกครั้งที่ `DocumentSnapshot` ใหม่พร้อมใช้งาน
onError	(ข้อผิดพลาด: FirestoreError) => เป็นโมฆะ	การเรียกกลับที่จะถูกเรียกหากการฟังไม่สำเร็จหรือถูกยกเลิก จะไม่มีการติดต่อกลับอีกต่อไป
เสร็จสมบูรณ์	() => เป็นโมฆะ	มีได้ แต่จะไม่มีการเรียกใช้เนื่องจากสตรีมจะไม่สิ้นสุด

การคืนสินค้า:

MemoryLruGarbageCollector

ฟังก์ชันยกเลิกการสมัครที่เรียกใช้เพื่อยกเลิก Listener ของสแนปชอตได้

setDoc(การอ้างอิง, ข้อมูล)

เขียนในเอกสารที่ DocumentReference นี้อ้างถึง ระบบจะสร้างเอกสารหากยังไม่มี

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
การอ้างอิง	DocumentReference<AppModelType, DbModelType>	การอ้างอิงเอกสารที่จะเขียน
ข้อมูล	WithFieldValue<AppModelType>	แมปของช่องและค่าสำหรับเอกสาร

การคืนสินค้า:

คำสัญญา<โมฆะ>

Promise จะได้รับการแก้ไขเมื่อมีการเขียนข้อมูลลงในแบ็กเอนด์เรียบร้อยแล้ว (โปรดทราบว่าจะไม่มีการแก้ไขขณะที่คุณออฟไลน์)

setDoc(การอ้างอิง ข้อมูล ตัวเลือก)

เขียนในเอกสารอ้างอิงโดย DocumentReference ที่ระบุ ระบบจะสร้างเอกสารหากยังไม่มี หากคุณระบุ merge หรือ mergeFields คุณจะรวมข้อมูลที่ระบุเข้ากับเอกสารที่มีอยู่ได้

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
การอ้างอิง	DocumentReference<AppModelType, DbModelType>	การอ้างอิงเอกสารที่จะเขียน
ข้อมูล	บางส่วนของWithFieldValue<AppModelType>	แมปของช่องและค่าสำหรับเอกสาร
ตัวเลือก	SetOptions	ออบเจ็กต์สำหรับกำหนดค่าพฤติกรรมของเซ็ต

การคืนสินค้า:

คำสัญญา<โมฆะ>

Promise ได้รับการแก้ปัญหาเมื่อเขียนข้อมูลลงในแบ็กเอนด์สำเร็จแล้ว (โปรดทราบว่าจะไม่แก้ปัญหาขณะที่คุณออฟไลน์)

เอกสารอัปเดต(ข้อมูลอ้างอิง ข้อมูล)

อัปเดตช่องในเอกสารที่อ้างอิงโดย DocumentReference ที่ระบุ การอัปเดตจะล้มเหลวหากใช้กับเอกสารที่ไม่มีอยู่

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
การอ้างอิง	DocumentReference<AppModelType, DbModelType>	การอ้างอิงเอกสารที่จะอัปเดต
ข้อมูล	UpdateData<DbModelType>	ออบเจ็กต์ที่มีช่องและค่าที่จะอัปเดตเอกสาร ช่องอาจมีจุดเพื่ออ้างอิงช่องที่ซ้อนกันภายในเอกสารได้

การคืนสินค้า:

คำสัญญา<โมฆะ>

อัปเดตDoc(การอ้างอิง, ฟิลด์, ค่า, moreFieldsAndValues)

อัปเดตช่องในเอกสารที่ DocumentReference ที่ระบุอ้างถึง การอัปเดตจะล้มเหลวหากนำไปใช้กับเอกสารที่ไม่มีอยู่

คุณอัปเดตช่องที่ซ้อนกันได้โดยใช้สตริงเส้นทางช่องที่มีจุดคั่นด้วยจุด หรือระบุออบเจ็กต์ FieldPath

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
การอ้างอิง	DocumentReference<AppModelType, DbModelType>	การอ้างอิงเอกสารที่จะอัปเดต
พื้นที่	สตริง \| FieldPath	ช่องแรกที่จะอัปเดต
value	ไม่ทราบ	ค่าแรก
moreFieldsAndValues	ไม่ทราบ[]	คู่คีย์-ค่าเพิ่มเติม

การคืนสินค้า:

คำสัญญา<โมฆะ>

ฟังก์ชัน(การตั้งค่า, ...)

MemoryLocalCache(การตั้งค่า)

สร้างอินสแตนซ์ของ MemoryLocalCache สามารถตั้งค่าอินสแตนซ์เป็น FirestoreSettings.cache เพื่อบอก SDK ว่าควรใช้เลเยอร์แคชใด

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
การตั้งค่า	การตั้งค่าแคชหน่วยความจำ

การคืนสินค้า:

MemoryLocalCache

MemoryLruGarbageCollector(การตั้งค่า)

สร้างอินสแตนซ์ของ MemoryLruGarbageCollector

ขนาดเป้าหมายสามารถระบุเป็นส่วนหนึ่งของพารามิเตอร์การตั้งค่าได้ ตัวรวบรวมจะเริ่มลบเอกสารเมื่อแคชมีขนาดเกินขนาดที่ระบุ ขนาดแคชเริ่มต้นคือ 40 MB (40 * 1024 * 1024 ไบต์)

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
การตั้งค่า	{ cacheSizeBytes?: ตัวเลข; }

การคืนสินค้า:

ถาวรLocalCache(การตั้งค่า)

สร้างอินสแตนซ์ของ PersistentLocalCache สามารถตั้งค่าอินสแตนซ์เป็น FirestoreSettings.cache เพื่อบอก SDK ว่าควรใช้เลเยอร์แคชใด

แคชถาวรไม่สามารถใช้ในสภาพแวดล้อม Node.js ได้

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
การตั้งค่า	PersistentCacheSettings

การคืนสินค้า:

PersistentLocalCache

PersusSingleTabManager(การตั้งค่า)

สร้างอินสแตนซ์ของ PersistentSingleTabManager

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
การตั้งค่า	PersistentSingleTabManagerSettings \| ไม่ได้กำหนด	กำหนดค่าตัวจัดการแท็บที่สร้างขึ้น

การคืนสินค้า:

PersistentSingleTabManager

ฟังก์ชัน(สแนปชอต, ...)

สิ้นสุดที่(สแนปชอต)

สร้าง QueryEndAtConstraint ที่แก้ไขชุดผลลัพธ์ให้สิ้นสุดที่เอกสารที่ระบุ (รวม) ตำแหน่งสิ้นสุดจะสัมพันธ์กับลำดับของการค้นหา เอกสารต้องมีช่องทั้งหมดที่ให้ไว้ใน orderBy ของการค้นหา

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
สแนปชอต	DocumentSnapshot<AppModelType, DbModelType>	สแนปชอตของเอกสารที่จะสิ้นสุด

การคืนสินค้า:

QueryEndAtConstraint เพื่อส่งไปยัง query()

สิ้นสุดก่อน(สแนปชอต)

สร้าง QueryEndAtConstraint ที่แก้ไขผลลัพธ์ที่กำหนดให้สิ้นสุดก่อนเอกสารที่ระบุ (ไม่รวม) ตำแหน่งสิ้นสุดจะสัมพันธ์กับลำดับของการค้นหา เอกสารต้องมีช่องทั้งหมดที่ให้ไว้ใน orderBy ของการค้นหา

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
สแนปชอต	DocumentSnapshot<AppModelType, DbModelType>	สแนปชอตของเอกสารที่จะสิ้นสุดก่อน

การคืนสินค้า:

QueryEndAtConstraint เพื่อส่งไปยัง query()

StartAfter(สแนปชอต)

สร้าง QueryStartAtConstraint ที่แก้ไขชุดผลลัพธ์ให้เริ่มต้นหลังจากเอกสารที่ระบุ (ไม่รวม) ตำแหน่งเริ่มต้นจะสัมพันธ์กับลำดับของคำค้นหา เอกสารต้องมีช่องทั้งหมดที่ให้ไว้ใน orderBy ของการค้นหา

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
สแนปชอต	DocumentSnapshot<AppModelType, DbModelType>	ภาพรวมของเอกสารที่จะเริ่มต้นภายหลัง

การคืนสินค้า:

QueryStartAtConstraint เพื่อส่งไปยัง query()

StartAt(snapshot)

สร้าง QueryStartAtConstraint ที่แก้ไขชุดผลลัพธ์ให้เริ่มต้นที่เอกสารที่ระบุ (รวม) ตำแหน่งเริ่มต้นจะสัมพันธ์กับลำดับของคำค้นหา เอกสารต้องมีช่องทั้งหมดที่ระบุไว้ใน orderBy ของการค้นหานี้

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
สแนปชอต	DocumentSnapshot<AppModelType, DbModelType>	ภาพรวมของเอกสารที่จะเริ่มต้น

การคืนสินค้า: