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