@firebase/firestore

ฟังก์ชัน

ชั้นเรียน

อินเทอร์เฟซ

ตัวแปร

พิมพ์ชื่อแทน

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

getFirestore(แอป)

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

ลายเซ็น:

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

พารามิเตอร์

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

Firestore

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

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

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

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

ลายเซ็น:

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

พารามิเตอร์

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

Firestore

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

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

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

ลายเซ็น:

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

พารามิเตอร์

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

Firestore

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

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

clearIndexedDbPersistence(firestore)

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

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

ลายเซ็น:

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

พารามิเตอร์

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

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

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

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

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

ลายเซ็น:

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

พารามิเตอร์

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

CollectionReference<DocumentData, DocumentData>

อินสแตนซ์ CollectionReference

ข้อยกเว้น

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

CollectionGroup(firestore, collectionsId)

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

ลายเซ็น:

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

พารามิเตอร์

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

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

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

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

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

ลายเซ็น:

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

พารามิเตอร์

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

เป็นโมฆะ

disabledNetwork(firestore)

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

ลายเซ็น:

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

พารามิเตอร์

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

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

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

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

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

ลายเซ็น:

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

พารามิเตอร์

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

DocumentReference<DocumentData, DocumentData>

อินสแตนซ์ DocumentReference

ข้อยกเว้น

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

enabledIndexedDbPersistence(firestore, Persistence)

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

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

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

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

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

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

ลายเซ็น:

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

พารามิเตอร์

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

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

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

enabledMultiTabIndexedDbPersistence(firestore)

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

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

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

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

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

ลายเซ็น:

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

พารามิเตอร์

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

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

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

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

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

ลายเซ็น:

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

พารามิเตอร์

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

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

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

getPersistentCacheIndexManager(firestore)

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

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

ลายเซ็น:

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

พารามิเตอร์

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

PersistentCacheIndexManager | ค่าว่าง

loadBundle(Firestore, BundleData)

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

ลายเซ็น:

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

พารามิเตอร์

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

LoadBundleTask

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

nameQuery(firestore, name)

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

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

ลายเซ็น:

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

พารามิเตอร์

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

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

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;

พารามิเตอร์

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

ยกเลิกการสมัคร

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

onSnapshotsInSync(firestore, onSync)

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

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

ลายเซ็น:

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

พารามิเตอร์

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

ยกเลิกการสมัคร

ฟังก์ชันยกเลิกการสมัครที่เรียกใช้เพื่อยกเลิก 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>;

พารามิเตอร์

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

สัญญา<T>

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

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

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

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

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

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

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

ลายเซ็น:

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

พารามิเตอร์

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

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

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

ข้อยกเว้น

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

setIndexConfiguration(firestore, JSON)

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

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

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

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

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

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

ลายเซ็น:

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

พารามิเตอร์

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

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

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

ข้อยกเว้น

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

สิ้นสุด(firestore)

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

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

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

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

ลายเซ็น:

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

พารามิเตอร์

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

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

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

โปรดรอForPendingWrites(firestore)

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

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

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

ลายเซ็น:

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

พารามิเตอร์

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

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

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

WriteBatch(firestore)

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

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

ลายเซ็น:

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

พารามิเตอร์

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

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;

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

Firestore

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

MemoryEagerGarbageCollector()

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

ลายเซ็น:

export declare function memoryEagerGarbageCollector(): 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

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

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

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

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

ลายเซ็น:

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

พารามิเตอร์

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

ค่าฟิลด์

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

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

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

ลายเซ็น:

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

พารามิเตอร์

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

ค่าฟิลด์

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

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

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

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

ลายเซ็น:

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

พารามิเตอร์

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

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

sum(ฟิลด์)

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

ลายเซ็น:

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

พารามิเตอร์

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

AggregateField<number>

function(fieldPath, ...)

orderBy(fieldPath, pathStr)

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

ลายเซ็น:

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

พารามิเตอร์

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

QueryOrderByConstraint

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

where(fieldPath, opStr, value)

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

ลายเซ็น:

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

พารามิเตอร์

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

QueryFieldFilterConstraint

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;

พารามิเตอร์

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

เป็นโมฆะ

disabledPersistentCacheIndexAutoCreation(indexManager)

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

ลายเซ็น:

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

พารามิเตอร์

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

เป็นโมฆะ

enablePersistentCacheIndexAutoCreation(indexManager)

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

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

ลายเซ็น:

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

พารามิเตอร์

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

เป็นโมฆะ

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

totalFieldEqual(ซ้าย ขวา)

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

ลายเซ็น:

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

พารามิเตอร์

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

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;

พารามิเตอร์

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

boolean

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

queryEqual(ซ้าย ขวา)

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

ลายเซ็น:

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

พารามิเตอร์

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

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;

พารามิเตอร์

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

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;

พารามิเตอร์

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

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;

พารามิเตอร์

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

เป็นโมฆะ

ฟังก์ชัน(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;

พารามิเตอร์

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

ค่าฟิลด์

คำสัญญาณ 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>>;

พารามิเตอร์

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

สัญญา<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>>;

พารามิเตอร์

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

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>>;

พารามิเตอร์

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

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

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

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

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

ลายเซ็น:

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

พารามิเตอร์

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

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

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

getDocumentsFromServer(คำค้นหา)

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

ลายเซ็น:

export declare function getDocsFromServer<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>): Promise<QuerySnapshot<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;

พารามิเตอร์

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

ยกเลิกการสมัคร

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

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>, options: SnapshotListenOptions, observer: {
    next?: (snapshot: QuerySnapshot<AppModelType, DbModelType>) => void;
    error?: (error: FirestoreError) => void;
    complete?: () => void;
}): Unsubscribe;

พารามิเตอร์

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

ยกเลิกการสมัคร

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

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

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

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

ลายเซ็น:

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;

พารามิเตอร์

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

ยกเลิกการสมัคร

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

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

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

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

ลายเซ็น:

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;

พารามิเตอร์

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

ยกเลิกการสมัคร

ฟังก์ชันยกเลิกการสมัครที่เรียกใช้เพื่อยกเลิก 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>;

พารามิเตอร์

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

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

ข้อยกเว้น

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

query(query, queryConstraints)

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

ลายเซ็น:

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

พารามิเตอร์

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

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

ข้อยกเว้น

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

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

และ(queryConstraints)

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

ลายเซ็น:

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

พารามิเตอร์

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

QueryCompositeFilterConstraint

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

หรือ(queryConstraints)

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

ลายเซ็น:

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

พารามิเตอร์

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

QueryCompositeFilterConstraint

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

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

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

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

ลายเซ็น:

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

พารามิเตอร์

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

สัญญา<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<DocumentData, DocumentData>

อินสแตนซ์ CollectionReference

ข้อยกเว้น

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

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

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

ลายเซ็น:

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

พารามิเตอร์

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

CollectionReference<DocumentData, DocumentData>

อินสแตนซ์ CollectionReference

ข้อยกเว้น

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

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

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

ลายเซ็น:

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

พารามิเตอร์

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

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

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

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

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

ลายเซ็น:

export declare function doc<AppModelType, DbModelType extends DocumentData>(reference: CollectionReference<AppModelType, DbModelType>, path?: string, ...pathSegments: string[]): DocumentReference<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<DocumentData, DocumentData>

อินสแตนซ์ DocumentReference

ข้อยกเว้น

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

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

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

ลายเซ็น:

export declare function getDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>): Promise<DocumentSnapshot<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>>;

พารามิเตอร์

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

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

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

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

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

ลายเซ็น:

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

พารามิเตอร์

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

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

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

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

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

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

ลายเซ็น:

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;

พารามิเตอร์

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

ยกเลิกการสมัคร

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

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

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

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

ลายเซ็น:

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;

พารามิเตอร์

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

ยกเลิกการสมัคร

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

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

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

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

ลายเซ็น:

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;

พารามิเตอร์

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

ยกเลิกการสมัคร

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

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

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

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

ลายเซ็น:

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;

พารามิเตอร์

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

ยกเลิกการสมัคร

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

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

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

ลายเซ็น:

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

พารามิเตอร์

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

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

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

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

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

ลายเซ็น:

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

พารามิเตอร์

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

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

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

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

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

ลายเซ็น:

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

พารามิเตอร์

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

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

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

อัปเดต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>;

พารามิเตอร์

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

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

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

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

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;

พารามิเตอร์

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

MemoryLruGarbageCollector

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

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

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

ลายเซ็น:

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

พารามิเตอร์

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

PersistentLocalCache

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

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

ลายเซ็น:

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

พารามิเตอร์

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

PersistentSingleTabManager

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

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

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

ลายเซ็น:

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

พารามิเตอร์

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

ข้อความค้นหาสิ้นสุดที่ข้อจำกัด

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

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

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

ลายเซ็น:

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

พารามิเตอร์

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

ข้อความค้นหาสิ้นสุดที่ข้อจำกัด

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

StartAfter(สแนปชอต)

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

ลายเซ็น:

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

พารามิเตอร์

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

คำค้นหาเริ่มต้นที่ข้อจำกัด

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

StartAt(snapshot)

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

ลายเซ็น:

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

พารามิเตอร์

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

คำค้นหาเริ่มต้นที่ข้อจำกัด

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

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

เวกเตอร์(ค่า)

สร้าง VectorValue ใหม่ที่สร้างขึ้นด้วยสำเนาของอาร์เรย์ตัวเลขที่ระบุ

ลายเซ็น:

export declare function vector(values?: number[]): VectorValue;

พารามิเตอร์

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

ค่าเวกเตอร์

VectorValue ใหม่ที่สร้างขึ้นด้วยสำเนาของอาร์เรย์ตัวเลขที่ระบุ

CACHE_SIZE_UNLIMITED

ค่าคงที่ที่ใช้เพื่อระบุว่าควรปิดใช้การเก็บขยะ LRU ตั้งค่านี้เป็น cacheSizeBytes ในการตั้งค่าที่ส่งไปยังอินสแตนซ์ Firestore

ลายเซ็น:

CACHE_SIZE_UNLIMITED = -1

AddPrefixToKey

แสดงแผนที่ใหม่ที่ทุกคีย์นำหน้าด้วยคีย์ด้านนอกต่อท้ายจุด

ลายเซ็น:

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

การรวมของ AggregateField ทุกประเภทที่ Firestore รองรับ

ลายเซ็น:

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

ข้อมูลสเปครวม

ประเภทซึ่งมีคีย์ที่ได้มาจาก AggregateSpec และมีค่าเป็นผลมาจากการรวมซึ่งดำเนินการโดย AggregateField ที่เกี่ยวข้องจากอินพุต AggregateSpec

ลายเซ็น:

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

AggregateType

ประเภทการรวมที่แสดงประเภทการรวมที่จะดำเนินการ

ลายเซ็น:

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

ฟิลด์การอัปเดตย่อย

ตัวช่วยในการคำนวณช่องที่ซ้อนกันสำหรับประเภท T1 ที่กำหนด จำเป็นต่อการเผยแพร่ประเภทการรวม เช่น undefined | {...} (เกิดขึ้นสำหรับอุปกรณ์ประกอบฉากที่ไม่บังคับ) หรือ {a: A} | {b: B}

ในกรณีการใช้งานนี้ V จะใช้เพื่อกระจายประเภทการรวมของ T[K] ใน Record เนื่องจาก T[K] จะได้รับการประเมินเป็นนิพจน์ ไม่ใช่กระจาย

ดู 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;

ประเภทการเปลี่ยนเอกสาร

ประเภทของ DocumentChange อาจเป็น "เพิ่ม" "นำออก" หรือ "แก้ไข"

ลายเซ็น:

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

FirestoreErrorCode

ชุดรหัสสถานะ Firestore รหัสจะเหมือนกันกับรหัสที่ gRPC แสดงที่ https://github.com/grpc/grpc/blob/master/doc/statuscodes.md

ค่าที่เป็นไปได้ ได้แก่ - "cancelled": ระบบยกเลิกการดำเนินการนี้ (โดยปกติผู้โทร) - 'unknown': ข้อผิดพลาดที่ไม่รู้จัก หรือข้อผิดพลาดจากโดเมนข้อผิดพลาดอื่น - 'ภาษาที่ไม่ถูกต้อง-อาร์กิวเมนต์': ลูกค้าระบุอาร์กิวเมนต์ที่ไม่ถูกต้อง โปรดทราบว่าเงื่อนไขนี้แตกต่างจาก "เงื่อนไขที่กำหนดไว้ล่วงหน้าซึ่งระบบล้มเหลว" "การโต้แย้งที่ไม่ถูกต้อง" ระบุอาร์กิวเมนต์ที่ทำให้เกิดปัญหาโดยไม่คำนึงถึงสถานะของระบบ (เช่น ชื่อฟิลด์ที่ไม่ถูกต้อง) - 'เกินกำหนดเวลา': กำหนดเวลาหมดอายุก่อนที่การดำเนินการจะเสร็จสมบูรณ์ สำหรับการดำเนินการที่เปลี่ยนสถานะของระบบ ข้อผิดพลาดนี้อาจได้รับการส่งกลับแม้จะดำเนินการสำเร็จแล้วก็ตาม ตัวอย่างเช่น การตอบกลับที่สำเร็จจากเซิร์ฟเวอร์อาจล่าช้าไปนานพอสมควรหมดอายุ - 'not-found': ไม่พบเอกสารที่ขอ - "มีอยู่แล้ว": มีเอกสารที่เราพยายามสร้างอยู่แล้ว - 'permission-denied': ผู้โทรไม่ได้รับอนุญาตให้เรียกใช้การดำเนินการที่ระบุ - 'ทรัพยากรหมดแล้ว': ทรัพยากรบางส่วนหมดแล้ว อาจมีโควต้าของผู้ใช้แต่ละราย หรือบางระบบไฟล์อาจหมด - 'failed-precondition': การดำเนินการถูกปฏิเสธเนื่องจากระบบไม่อยู่ในสถานะที่จำเป็นสำหรับการดำเนินการ - 'ล้มเลิก': มีการล้มเลิกการดำเนินการ โดยทั่วไปจะเกิดจากปัญหาเกิดขึ้นพร้อมกัน เช่น ล้มเลิกธุรกรรม ฯลฯ - "นอกช่วง": มีการพยายามดำเนินการเกินช่วงที่ถูกต้อง - 'ไม่ได้ใช้งาน': การทำงานไม่ได้ดำเนินการหรือไม่มีการสนับสนุน/เปิดใช้งาน - 'ภายใน': ข้อผิดพลาดภายใน หมายความว่าค่าคงที่บางส่วนที่ระบบสำคัญคาดไว้เสียหาย หากคุณเห็นข้อผิดพลาดเหล่านี้ แสดงว่ามีข้อผิดพลาดมาก - 'unavailable': บริการไม่พร้อมใช้งานในขณะนี้ ปัญหานี้อาจเกิดขึ้นชั่วคราวและอาจแก้ไขได้โดยการลองอีกครั้งโดยใช้ Backoff - 'data-loss': ข้อมูลสูญหายหรือเสียหายโดยที่กู้คืนไม่ได้ - 'unauthenticated': คำขอไม่มีข้อมูลเข้าสู่ระบบการตรวจสอบสิทธิ์ที่ถูกต้องสำหรับการดำเนินการ

ลายเซ็น:

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

ประเภทการรวมจากเลเยอร์แคชของ SDK ทั้งหมดที่รองรับ

ลายเซ็น:

export declare type FirestoreLocalCache = MemoryLocalCache | PersistentLocalCache;

แหล่งที่มาของการฟัง

อธิบายแหล่งที่มาที่การค้นหารับ

ตั้งค่าเป็น default เพื่อฟังการเปลี่ยนแปลงของทั้งแคชและเซิร์ฟเวอร์ ตั้งค่าเป็น cache เพื่อฟังการเปลี่ยนแปลงในแคชเท่านั้น

ลายเซ็น:

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

อุปกรณ์รวบรวมหน่วยความจำของขยะ

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

ลายเซ็น:

export declare type MemoryGarbageCollector = MemoryEagerGarbageCollector | MemoryLruGarbageCollector;

ฟิลด์การอัปเดตที่ซ้อนกัน

ในแต่ละช่อง (เช่น "bar") ให้ค้นหาคีย์ที่ฝังทั้งหมด (เช่น {'bar.baz': T1, 'bar.qux': T2}) นำคีย์เหล่านั้นมาตัดกันเพื่อสร้างแผนที่เดียวที่มีคีย์ที่เป็นไปได้ทั้งหมด ซึ่งทั้งหมดนั้นทำเครื่องหมายว่าไม่บังคับ

ลายเซ็น:

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

คำสั่งByDirection

ทิศทางของคำสั่ง orderBy() จะระบุเป็น "desc" หรือ "asc" (มากไปน้อยหรือน้อยไปมาก)

ลายเซ็น:

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

บางส่วนของค่าฟิลด์

คล้ายกับ Partial<T> ของ TypeScript แต่อนุญาตให้ละเว้นฟิลด์ที่ซ้อนอยู่และส่ง FieldValues เป็นค่าพร็อพเพอร์ตี้ได้

ลายเซ็น:

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

PersistentTabManager

การรวมผู้จัดการแท็บที่มีอยู่ทั้งหมด

ลายเซ็น:

export declare type PersistentTabManager = PersistentSingleTabManager | PersistentMultipleTabManager;

แบบพื้นฐาน

ประเภทพื้นฐาน

ลายเซ็น:

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

QueryConstraintType

อธิบายข้อจำกัดการค้นหาแบบต่างๆ ที่มีใน SDK นี้

ลายเซ็น:

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

ข้อจำกัดตัวกรองข้อความค้นหา

QueryFilterConstraint เป็นการรวมประเภท Helper ที่แสดงถึง QueryFieldFilterConstraint และ QueryCompositeFilterConstraint

ลายเซ็น:

export declare type QueryFilterConstraint = QueryFieldFilterConstraint | QueryCompositeFilterConstraint;

ข้อความค้นหาNonFilterConstraint

QueryNonFilterConstraint เป็นการรวมประเภท Helper ที่แสดงถึง QueryConstraints ซึ่งใช้ในการจำกัดหรือจัดลำดับชุดเอกสาร แต่ไม่ได้กรองในช่องเอกสารอย่างชัดแจ้ง QueryNonFilterConstraint สร้างโดยการเรียกใช้ orderBy(), startAt(), startAfter(), endbefore(), endAt(), limit() หรือ limitToLast() จากนั้นจึงจะส่งผ่านไปยัง query() เพื่อสร้างการค้นหาใหม่ด้วยQueryConstraint

ลายเซ็น:

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

ตั้งค่าตัวเลือก

ออบเจ็กต์ตัวเลือกที่กำหนดลักษณะการทำงานของ setDoc() และการเรียก การกำหนดค่าการเรียกเหล่านี้ให้ทำการผสานแบบละเอียดแทนการเขียนทับเอกสารเป้าหมายทั้งหมดได้โดยการระบุ SetOptions ด้วย merge: true

ลายเซ็น:

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

สถานะงาน

แสดงสถานะของงานการโหลดแพ็กเกจ

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

ลายเซ็น:

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

ทางแยกไป

หากกำหนดประเภทการรวม U = T1 | T2 | ... จะแสดงผลประเภทที่ตัดกัน (T1 & T2 & ...)

ใช้ประเภทแบบมีเงื่อนไขแบบกระจายและการอนุมานจากประเภทแบบมีเงื่อนไข ซึ่งวิธีนี้ได้ผลเนื่องจากตัวเลือกหลายตัวสำหรับตัวแปรประเภทเดียวกันในตำแหน่งต่างๆ ของตัวแปรจะทำให้ระบบอนุมานประเภทจุดตัด https://www.typescriptlang.org/docs/handbook/advanced-types.html#type-inference-in-conditional-types https://stackoverflow.com/questions/50374908/transform-union-type-to-intersection-type

ลายเซ็น:

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