การส่งออก API ภายนอกอีกครั้ง
มีการส่งออก API ที่กำหนดภายนอกต่อไปนี้อีกครั้งจากจุดแรกเข้าของโมดูลนี้เพื่อความสะดวก
| สัญลักษณ์ | คำอธิบาย |
|---|---|
| ผู้เขียนแบบกลุ่ม | BulkWriter ประเภทจากแพ็กเกจ @google-cloud/firestore |
| AggregateField (ช่องข้อมูลรวม) | AggregateField ประเภทจากแพ็กเกจ @google-cloud/firestore |
| ตัวเลือกการเขียนแบบกลุ่ม | BulkWriterOptions ประเภทจากแพ็กเกจ @google-cloud/firestore |
| BundleBuilder | BundleBuilder ประเภทจากแพ็กเกจ @google-cloud/firestore |
| CollectionGroup [คอลเล็กชัน] | CollectionGroup ประเภทจากแพ็กเกจ @google-cloud/firestore |
| ข้อมูลอ้างอิงคอลเล็กชัน | CollectionReference ประเภทจากแพ็กเกจ @google-cloud/firestore |
| เปลี่ยนเอกสาร | DocumentChange ประเภทจากแพ็กเกจ @google-cloud/firestore |
| ข้อมูลเอกสาร | DocumentData ประเภทจากแพ็กเกจ @google-cloud/firestore |
| Documentหมายเลขอ้างอิง | DocumentReference ประเภทจากแพ็กเกจ @google-cloud/firestore |
| สแนปชอตเอกสาร | DocumentSnapshot ประเภทจากแพ็กเกจ @google-cloud/firestore |
| FieldPath | FieldPath ประเภทจากแพ็กเกจ @google-cloud/firestore |
| ค่าฟิลด์ | FieldValue ประเภทจากแพ็กเกจ @google-cloud/firestore |
| กรอง | Filter ประเภทจากแพ็กเกจ @google-cloud/firestore |
| Firestore | Firestore ประเภทจากแพ็กเกจ @google-cloud/firestore |
| FirestoreDataConverter | FirestoreDataConverter ประเภทจากแพ็กเกจ @google-cloud/firestore |
| GeoPoint | GeoPoint ประเภทจากแพ็กเกจ @google-cloud/firestore |
| GrpcStatus | GrpcStatus ประเภทจากแพ็กเกจ @google-cloud/firestore |
| เงื่อนไขที่กำหนดไว้ล่วงหน้า | Precondition ประเภทจากแพ็กเกจ @google-cloud/firestore |
| คำถาม | Query ประเภทจากแพ็กเกจ @google-cloud/firestore |
| สแนปชอตของการค้นหาเอกสาร | QueryDocumentSnapshot ประเภทจากแพ็กเกจ @google-cloud/firestore |
| พาร์ติชันการค้นหา | QueryPartition ประเภทจากแพ็กเกจ @google-cloud/firestore |
| สแนปชอตข้อความค้นหา | QuerySnapshot ประเภทจากแพ็กเกจ @google-cloud/firestore |
| ตัวเลือกการอ่าน | ReadOptions ประเภทจากแพ็กเกจ @google-cloud/firestore |
| SetOptions | SetOptions ประเภทจากแพ็กเกจ @google-cloud/firestore |
| การประทับเวลา | Timestamp ประเภทจากแพ็กเกจ @google-cloud/firestore |
| ธุรกรรม | Transaction ประเภทจากแพ็กเกจ @google-cloud/firestore |
| WriteBatch | WriteBatch ประเภทจากแพ็กเกจ @google-cloud/firestore |
| Writeผลลัพธ์ | WriteResult ประเภทจากแพ็กเกจ @google-cloud/firestore |
| setLogFunction | ฟังก์ชัน setLogFunction จากแพ็กเกจ @google-cloud/firestore |
Cloud Firestore
ฟังก์ชัน
| ฟังก์ชัน | คำอธิบาย |
|---|---|
| getFirestore() | ใช้บริการ Firestore เริ่มต้นสำหรับแอปเริ่มต้น |
| getFirestore(แอป) | รับบริการ Firestore เริ่มต้นสำหรับแอปที่ระบุ |
| getFirestore(databaseId) | (เบต้า) รับบริการ Firestore ที่ตั้งชื่อแล้วสำหรับแอปเริ่มต้น |
| getFirestore(แอป, รหัสฐานข้อมูล) | (เบต้า) รับบริการ Firestore ที่ตั้งชื่อแล้วสำหรับแอปที่ระบุ |
| initializeFirestore(แอป การตั้งค่า) | รับบริการ Firestore เริ่มต้นสำหรับแอปที่ระบุ โดยส่งผ่านพารามิเตอร์เพิ่มเติมไปยังเครื่องมือสร้างของแอป |
| initializeFirestore(แอป การตั้งค่า รหัสฐานข้อมูล) | (เบต้า) รับบริการ Firestore ที่ตั้งชื่อแล้วสำหรับแอปที่ระบุ โดยส่งพารามิเตอร์เพิ่มเติมไปยังเครื่องมือสร้าง |
ชั้นเรียน
| ชั้น | คำอธิบาย |
|---|---|
| ข้อผิดพลาด FirebaseFirestore | โครงสร้างรหัสข้อผิดพลาดของ Firebase Firestore ซึ่งจะขยาย FirebaseError |
อินเทอร์เฟซ
| อินเทอร์เฟซ | คำอธิบาย |
|---|---|
| FirestoreSettings | การตั้งค่าที่จะส่งไปยังตัวสร้าง Firestore |
getFirestore()
ใช้บริการ Firestore เริ่มต้นสำหรับแอปเริ่มต้น
ลายเซ็น:
export declare function getFirestore(): Firestore;
การคืนสินค้า:
Firestore
บริการ Firestore เริ่มต้นสำหรับแอปเริ่มต้น
ตัวอย่าง
// Get the default Firestore service for the default app
const defaultFirestore = getFirestore();
getFirestore(แอป)
รับบริการ Firestore เริ่มต้นสำหรับแอปที่ระบุ
ลายเซ็น:
export declare function getFirestore(app: App): Firestore;
พารามิเตอร์
| พารามิเตอร์ | ประเภท | คำอธิบาย |
|---|---|---|
| แอป | แอป | บริการ Firestore ที่จะส่งคืน |
การคืนสินค้า:
Firestore
บริการ Firestore เริ่มต้นที่เชื่อมโยงกับแอปที่ระบุ
ตัวอย่าง
// Get the default Firestore service for a specific app
const otherFirestore = getFirestore(app);
getFirestore(รหัสฐานข้อมูล)
API นี้เป็นเพียงตัวอย่างสำหรับนักพัฒนาซอฟต์แวร์และอาจเปลี่ยนแปลงไปตามความคิดเห็นที่เราได้รับ อย่าใช้ API นี้ในสภาพแวดล้อมที่ใช้งานจริง
รับบริการ Firestore ที่ตั้งชื่อสำหรับแอปเริ่มต้น
ลายเซ็น:
export declare function getFirestore(databaseId: string): Firestore;
พารามิเตอร์
| พารามิเตอร์ | ประเภท | คำอธิบาย |
|---|---|---|
| รหัสฐานข้อมูล | สตริง | ของฐานข้อมูลที่จะแสดงผล |
การคืนสินค้า:
Firestore
บริการ Firestore ที่ตั้งชื่อสำหรับแอปเริ่มต้น
ตัวอย่าง
// Get the Firestore service for a named database and default app
const otherFirestore = getFirestore('otherDb');
getFirestore(แอป, รหัสฐานข้อมูล)
API นี้เป็นเพียงตัวอย่างสำหรับนักพัฒนาซอฟต์แวร์และอาจเปลี่ยนแปลงไปตามความคิดเห็นที่เราได้รับ อย่าใช้ API นี้ในสภาพแวดล้อมที่ใช้งานจริง
รับบริการ Firestore ที่ตั้งชื่อสำหรับแอปที่ระบุ
ลายเซ็น:
export declare function getFirestore(app: App, databaseId: string): Firestore;
พารามิเตอร์
| พารามิเตอร์ | ประเภท | คำอธิบาย |
|---|---|---|
| แอป | แอป | บริการ Firestore ที่จะส่งคืน |
| รหัสฐานข้อมูล | สตริง | ของฐานข้อมูลที่จะแสดงผล |
การคืนสินค้า:
Firestore
บริการ Firestore ที่ชื่อซึ่งเชื่อมโยงกับแอปที่ระบุ
ตัวอย่าง
// Get the Firestore service for a named database and specific app.
const otherFirestore = getFirestore('otherDb');
defaultizeFirestore(แอป การตั้งค่า)
รับบริการ Firestore เริ่มต้นสำหรับแอปที่ระบุ โดยส่งผ่านพารามิเตอร์เพิ่มเติมไปยังเครื่องมือสร้างของแอป
ลายเซ็น:
export declare function initializeFirestore(app: App, settings?: FirestoreSettings): Firestore;
พารามิเตอร์
| พารามิเตอร์ | ประเภท | คำอธิบาย |
|---|---|---|
| แอป | แอป | บริการ Firestore ที่จะส่งคืน |
| การตั้งค่า | FirestoreSettings | ออบเจ็กต์การตั้งค่าที่จะส่งไปยังเครื่องมือสร้าง |
การคืนสินค้า:
Firestore
บริการ Firestore เริ่มต้นที่เชื่อมโยงกับแอปและการตั้งค่าที่ระบุ
ตัวอย่าง
// Get the Firestore service for a specific app, require HTTP/1.1 REST transport
const otherFirestore = initializeFirestore(app, {preferRest: true});
เริ่มต้นFirestore(แอป, การตั้งค่า, รหัสฐานข้อมูล)
API นี้เป็นเพียงตัวอย่างสำหรับนักพัฒนาซอฟต์แวร์และอาจเปลี่ยนแปลงไปตามความคิดเห็นที่เราได้รับ อย่าใช้ API นี้ในสภาพแวดล้อมที่ใช้งานจริง
รับบริการ Firestore ที่ตั้งชื่อสำหรับแอปที่ระบุ โดยส่งผ่านพารามิเตอร์เพิ่มเติมไปยังตัวสร้าง
ลายเซ็น:
export declare function initializeFirestore(app: App, settings: FirestoreSettings, databaseId: string): Firestore;
พารามิเตอร์
| พารามิเตอร์ | ประเภท | คำอธิบาย |
|---|---|---|
| แอป | แอป | บริการ Firestore ที่จะส่งคืน |
| การตั้งค่า | FirestoreSettings | ออบเจ็กต์การตั้งค่าที่จะส่งไปยังเครื่องมือสร้าง |
| รหัสฐานข้อมูล | สตริง | ของฐานข้อมูลที่จะแสดงผล |
การคืนสินค้า:
Firestore
บริการ Firestore ที่มีชื่อซึ่งเชื่อมโยงกับแอปและการตั้งค่าที่ระบุ
ตัวอย่าง
// Get the Firestore service for a specific app, require HTTP/1.1 REST transport
const otherFirestore = initializeFirestore(app, {preferRest: true}, 'otherDb');