database package

ฐานข้อมูลเรียลไทม์ของ Firebase

ฟังก์ชัน

ฟังก์ชัน คำอธิบาย
ฟังก์ชัน(แอป, ...)
getDatabase(แอป, URL) แสดงผลอินสแตนซ์ของ Realtime Database SDK ที่เชื่อมโยงกับ FirebaseApp ที่ระบุ เริ่มต้นอินสแตนซ์ใหม่ด้วยการตั้งค่าเริ่มต้น หากไม่มีอินสแตนซ์หรืออินสแตนซ์ที่มีอยู่ใช้ URL ของฐานข้อมูลที่กำหนดเอง
function(db, ...)
connectDatabaseEmulator(db, โฮสต์, พอร์ต, ตัวเลือก) แก้ไขอินสแตนซ์ที่ระบุเพื่อสื่อสารกับโปรแกรมจำลอง Realtime Database

หมายเหตุ: ต้องเรียกใช้เมธอดนี้ก่อนที่จะดำเนินการอื่นๆ
goOffline(db) ยกเลิกการเชื่อมต่อกับเซิร์ฟเวอร์ (การดำเนินการเกี่ยวกับฐานข้อมูลทั้งหมดจะเสร็จสิ้นแบบออฟไลน์)ไคลเอ็นต์จะรักษาการเชื่อมต่ออย่างต่อเนื่องกับเซิร์ฟเวอร์ฐานข้อมูลโดยอัตโนมัติ ซึ่งจะใช้งานไปเรื่อยๆ และเชื่อมต่ออีกครั้งเมื่อยกเลิกการเชื่อมต่อ อย่างไรก็ตาม ระบบอาจใช้เมธอด goOffline() และ goOnline() เพื่อควบคุมการเชื่อมต่อไคลเอ็นต์ในกรณีที่การเชื่อมต่ออย่างต่อเนื่องไม่เป็นที่ต้องการขณะที่ออฟไลน์ ไคลเอ็นต์จะไม่ได้รับการอัปเดตข้อมูลจากฐานข้อมูลอีกต่อไป อย่างไรก็ตาม การดำเนินการเกี่ยวกับฐานข้อมูลทั้งหมดที่ดำเนินการในเครื่องจะทำให้เหตุการณ์เริ่มทำงานทันที ซึ่งทำให้แอปพลิเคชันของคุณทำงานได้ตามปกติต่อไป นอกจากนี้ การดำเนินการแต่ละรายการที่ทำในเครื่องจะได้รับการจัดคิวโดยอัตโนมัติ แล้วลองทำใหม่เมื่อมีการเชื่อมต่อกับเซิร์ฟเวอร์ฐานข้อมูลอีกครั้งหากต้องการเชื่อมต่อกับฐานข้อมูลอีกครั้งและเริ่มรับเหตุการณ์ระยะไกล โปรดดูที่ goOnline()
goOnline(db) เชื่อมต่อเซิร์ฟเวอร์อีกครั้งและซิงค์สถานะฐานข้อมูลออฟไลน์กับสถานะเซิร์ฟเวอร์ควรใช้เมธอดนี้หลังจากปิดการเชื่อมต่อที่ใช้งานอยู่กับ goOffline() แล้ว เมื่อเชื่อมต่อแล้ว ไคลเอ็นต์จะส่งข้อมูลที่ถูกต้องและเริ่มเหตุการณ์ที่เหมาะสมเพื่อ "ตามทัน" ไคลเอ็นต์ โดยอัตโนมัติ
ref(db, เส้นทาง) แสดงผล Reference ที่แสดงถึงตำแหน่งในฐานข้อมูลที่ตรงกับเส้นทางที่ระบุ หากไม่ได้ระบุเส้นทาง Reference จะชี้ไปที่รูทของฐานข้อมูล
refFromURL(db, url) แสดงผล Reference ที่แสดงถึงตำแหน่งในฐานข้อมูลที่ตรงกับ URL ของ Firebase ที่ระบุมีข้อยกเว้นหาก URL ไม่ใช่ URL ของฐานข้อมูล Firebase ที่ถูกต้อง หรือมีโดเมนต่างจากอินสแตนซ์ Database ปัจจุบันโปรดทราบว่าระบบจะไม่สนใจพารามิเตอร์การค้นหาทั้งหมด (orderBy, limitToLast ฯลฯ) และไม่ได้ใช้กับ Reference ที่แสดงผล
function()
forceLongPolling() บังคับให้ใช้ LongPolling แทน WebSockets ระบบจะไม่สนใจค่านี้หากมีการใช้โปรโตคอล WebSocket ใน DatabaseURL
forceWebSockets() บังคับใช้ WebSockets แทน LongPolling
orderByKey() สร้าง QueryConstraint ใหม่ที่เรียงลำดับตามคีย์จัดเรียงผลการค้นหาตามคีย์ค่า (จากน้อยไปมาก)อ่านเพิ่มเติมเกี่ยวกับ orderByKey() ได้ในจัดเรียงข้อมูล
orderByPriority() สร้าง QueryConstraint ใหม่ที่เรียงลำดับตามลำดับความสำคัญแอปพลิเคชันไม่จำเป็นต้องใช้ลำดับความสำคัญแต่สามารถเรียงลำดับคอลเล็กชันตามพร็อพเพอร์ตี้ทั่วไปได้ (ดูจัดเรียงข้อมูลสำหรับทางเลือกอื่นที่มีลำดับความสำคัญ
orderByValue() สร้าง QueryConstraint ใหม่ที่เรียงลำดับตามค่าหากรายการย่อยของการค้นหาเป็นค่าสเกลาร์ทั้งหมด (สตริง ตัวเลข หรือบูลีน) คุณจะเรียงลำดับผลลัพธ์ตามค่า (จากน้อยไปมาก) ได้อ่านเพิ่มเติมเกี่ยวกับ orderByValue() ได้ในจัดเรียงข้อมูล
serverTimestamp() แสดงผลค่าตัวยึดตำแหน่งสำหรับการป้อนข้อมูลการประทับเวลาปัจจุบันโดยอัตโนมัติ (เวลาตั้งแต่ Unix Epoch ในหน่วยมิลลิวินาที) ตามที่เซิร์ฟเวอร์ Firebase กำหนด
function(เดลต้า, ...)
เพิ่มขึ้น(เดลต้า) แสดงผลค่าตัวยึดตำแหน่งที่สามารถใช้เพื่อเพิ่มค่าฐานข้อมูลปัจจุบันในระดับอะตอมตามเดลต้าที่ระบุ
ฟังก์ชัน(เปิดใช้อยู่, ...)
enableL Logging(เปิดใช้, ถาวร) บันทึกข้อมูลการแก้ไขข้อบกพร่องไปยังคอนโซล
function(ขีดจำกัด, ...)
limitToFirst(จำกัด) สร้าง QueryConstraint ใหม่ที่หากจำกัดเฉพาะจำนวนรายการย่อยที่เจาะจงแรกเมธอด limitToFirst() ใช้เพื่อกำหนดจำนวนสูงสุดของผู้เผยแพร่โฆษณาย่อยที่จะซิงค์สำหรับ Callback ที่ระบุ หากตั้งขีดจำกัดไว้ที่ 100 รายการ ในตอนแรกเราจะรับเหตุการณ์สูงสุด 100 child_added รายการเท่านั้น ถ้าเรามีข้อความน้อยกว่า 100 ข้อความที่จัดเก็บไว้ในฐานข้อมูลของเรา เหตุการณ์ child_added จะเริ่มทำงานสำหรับแต่ละข้อความ อย่างไรก็ตาม หากเรามีข้อความเกิน 100 ข้อความ เราจะได้รับเฉพาะเหตุการณ์ child_added สำหรับข้อความที่เรียงลำดับ 100 รายการแรกเท่านั้น เมื่อรายการมีการเปลี่ยนแปลง เราจะได้รับเหตุการณ์ child_removed รายการสำหรับแต่ละรายการที่ไม่ได้อยู่ในรายการที่ใช้งานอยู่เพื่อให้จำนวนทั้งหมดยังคงอยู่ที่ 100คุณสามารถอ่านเพิ่มเติมเกี่ยวกับ limitToFirst() ได้ในการกรองข้อมูล
limitToLast(ขีดจำกัด) สร้าง QueryConstraint ใหม่ที่จำกัดให้แสดงผลเฉพาะจำนวนรายการย่อยที่ระบุล่าสุดเมธอด limitToLast() ใช้เพื่อกำหนดจำนวนสูงสุดของการซิงค์รายการย่อยสำหรับ Callback ที่กำหนด หากตั้งขีดจำกัดไว้ที่ 100 รายการ ในตอนแรกเราจะรับเหตุการณ์สูงสุด 100 child_added รายการเท่านั้น หากเราเก็บข้อความน้อยกว่า 100 ข้อความไว้ในฐานข้อมูล เหตุการณ์ child_added จะเริ่มทำงานสำหรับแต่ละข้อความ อย่างไรก็ตาม หากเรามีข้อความเกิน 100 ข้อความ เราจะรับเฉพาะเหตุการณ์ child_added สำหรับข้อความที่เรียงลำดับ 100 รายการล่าสุดเท่านั้น เมื่อรายการมีการเปลี่ยนแปลง เราจะได้รับเหตุการณ์ child_removed รายการสำหรับแต่ละรายการที่ไม่ได้อยู่ในรายการที่ใช้งานอยู่เพื่อให้จำนวนทั้งหมดยังคงอยู่ที่ 100คุณสามารถอ่านเพิ่มเติมเกี่ยวกับ limitToLast() ได้ในการกรองข้อมูล
ฟังก์ชัน(logger, ...)
enableLaking(logger) บันทึกข้อมูลการแก้ไขข้อบกพร่องไปยังคอนโซล
ฟังก์ชัน(หลัก, ...)
ย่อย(หลัก, เส้นทาง) รับ Reference สำหรับตำแหน่งที่เส้นทางสัมพัทธ์ที่ระบุเส้นทางแบบสัมพัทธ์อาจเป็นชื่อย่อยแบบง่าย (เช่น "ada") หรือเส้นทางที่คั่นด้วยเครื่องหมายทับในระดับที่ลึกขึ้น (เช่น "ada/name/first")
พุช(หลัก, ค่า) สร้างตำแหน่งย่อยใหม่โดยใช้คีย์ที่ไม่ซ้ำกันและแสดงผล Referenceนี่คือรูปแบบที่พบบ่อยที่สุดในการเพิ่มข้อมูลในคอลเล็กชันหากคุณระบุค่าให้กับ push() ระบบจะเขียนค่าลงในตำแหน่งที่สร้างขึ้น หากคุณไม่ส่งค่าใดๆ ระบบจะไม่เขียนข้อมูลลงในฐานข้อมูลและองค์ประกอบย่อยจะยังว่างเปล่า (แต่คุณใช้ Reference ที่อื่นได้)คีย์ที่ไม่ซ้ำกันที่สร้างโดย push() จะเรียงลำดับตามเวลาปัจจุบัน ดังนั้นรายการผลลัพธ์จึงจัดเรียงตามลำดับเวลา คีย์เหล่านี้ยังออกแบบมาให้คาดเดาไม่ได้ด้วย (มีเอนโทรปีแบบสุ่ม 72 บิต)โปรดดูหัวข้อเพิ่มในรายการข้อมูล ดูวิธี 2^120 วิธีในการตรวจสอบว่าตัวระบุไม่ซ้ำกัน
function(เส้นทาง, ...)
orderByChild(เส้นทาง) สร้าง QueryConstraint ใหม่ที่เรียงลำดับตามคีย์ย่อยที่ระบุคำค้นหาจะเรียงลำดับได้ครั้งละ 1 คีย์เท่านั้น การเรียกใช้ orderByChild() หลายครั้งด้วยคำค้นหาเดียวกันเป็นข้อผิดพลาดการค้นหาด้วย Firebase ช่วยให้คุณเรียงลำดับข้อมูลตามคีย์ย่อยใดก็ได้อย่างรวดเร็ว แต่หากทราบล่วงหน้าว่าดัชนีจะเป็นอะไร คุณก็กำหนดดัชนีผ่านกฎ .indexOn ในกฎความปลอดภัยได้เพื่อประสิทธิภาพที่ดีขึ้น ดูข้อมูลเพิ่มเติมได้ที่กฎ https://firebase.google.com/docs/database/security/indexing-dataอ่านข้อมูลเพิ่มเติมเกี่ยวกับ orderByChild() ได้ในจัดเรียงข้อมูล
ฟังก์ชั่น(ข้อความค้นหา, ...)
รับ(คำค้นหา) รับผลการค้นหาล่าสุดสําหรับการค้นหานี้
off(คำค้นหา, eventType, callback) ปลด Callback ที่แนบมาก่อนหน้านี้กับ Listener on() (onValue, onChildAdded) ที่เกี่ยวข้อง หมายเหตุ: นี่ไม่ใช่วิธีที่แนะนำในการนำ Listener ออก โปรดใช้ฟังก์ชัน Callback ที่ส่งกลับจาก Callback on ที่เกี่ยวข้องแทนปลด Callback ที่แนบมาก่อนหน้านี้ด้วย on*() ออก การเรียกใช้ off() ใน Listener หลักจะไม่นำ Listener ที่ลงทะเบียนในโหนดย่อยออกโดยอัตโนมัติ และต้องเรียกใช้ off() ใน Listener ย่อยด้วยเพื่อนำ Callback ออกหากไม่ได้ระบุ Callback ระบบจะนำ Callback ทั้งหมดสำหรับ eventType ที่ระบุออก ในทำนองเดียวกัน หากไม่มีการระบุ eventType การเรียกกลับทั้งหมดสำหรับ Reference จะถูกนำออกนอกจากนี้ Listener แต่ละรายการยังนำออกได้โดยเรียกใช้ Callback ที่เป็นการยกเลิกการสมัคร
onChildAdded(query, callback, cancelCallback) รอฟังการเปลี่ยนแปลงของข้อมูลในตำแหน่งที่เจาะจงวิธีนี้เป็นวิธีหลักในการอ่านข้อมูลจากฐานข้อมูล ระบบจะเรียกใช้ Callback สำหรับข้อมูลเบื้องต้นและอีกครั้งเมื่อข้อมูลเปลี่ยนแปลง เรียกใช้ Callback ของการยกเลิกการสมัครที่แสดงผลเพื่อหยุดรับการอัปเดต ดูรายละเอียดเพิ่มเติมได้ที่ดึงข้อมูลบนเว็บเหตุการณ์ onChildAdded จะทริกเกอร์ 1 เหตุการณ์สำหรับบุตรหลานเริ่มแรกแต่ละคน ณ ตำแหน่งนี้ และเหตุการณ์นี้จะทริกเกอร์อีกครั้งเมื่อมีการเพิ่มเหตุการณ์ย่อยใหม่ DataSnapshot ที่ส่งผ่านไปยัง Callback จะแสดงข้อมูลของผู้เผยแพร่โฆษณาย่อยที่เกี่ยวข้อง เพื่อวัตถุประสงค์ด้านการจัดเรียง ระบบจะส่งผ่านอาร์กิวเมนต์ที่ 2 ซึ่งเป็นสตริงที่มีคีย์รายการย่อยก่อนหน้าตามลำดับการจัดเรียง หรือ null หากเป็นอาร์กิวเมนต์ย่อยรายการแรก
onChildAdd(คำค้นหา, Callback, ตัวเลือก) รอฟังการเปลี่ยนแปลงของข้อมูลในตำแหน่งที่เจาะจงวิธีนี้เป็นวิธีหลักในการอ่านข้อมูลจากฐานข้อมูล ระบบจะเรียกใช้ Callback สำหรับข้อมูลเบื้องต้นและอีกครั้งเมื่อข้อมูลเปลี่ยนแปลง เรียกใช้ Callback ของการยกเลิกการสมัครที่แสดงผลเพื่อหยุดรับการอัปเดต ดูรายละเอียดเพิ่มเติมได้ที่ดึงข้อมูลบนเว็บเหตุการณ์ onChildAdded จะทริกเกอร์ 1 เหตุการณ์สำหรับบุตรหลานเริ่มแรกแต่ละคน ณ ตำแหน่งนี้ และเหตุการณ์นี้จะทริกเกอร์อีกครั้งทุกครั้งที่มีการเพิ่มรายการย่อยใหม่ DataSnapshot ที่ส่งผ่านไปยัง Callback จะแสดงข้อมูลของผู้เผยแพร่โฆษณาย่อยที่เกี่ยวข้อง เพื่อวัตถุประสงค์ด้านการจัดเรียง ระบบจะส่งผ่านอาร์กิวเมนต์ที่ 2 ซึ่งเป็นสตริงที่มีคีย์รายการย่อยก่อนหน้าตามลำดับการจัดเรียง หรือ null หากเป็นอาร์กิวเมนต์ย่อยรายการแรก
onChildAdd(การค้นหา, callback, cancelCallback, ตัวเลือก) รอฟังการเปลี่ยนแปลงของข้อมูลในตำแหน่งที่เจาะจงวิธีนี้เป็นวิธีหลักในการอ่านข้อมูลจากฐานข้อมูล ระบบจะเรียกใช้ Callback สำหรับข้อมูลเบื้องต้นและอีกครั้งเมื่อข้อมูลเปลี่ยนแปลง เรียกใช้ Callback ของการยกเลิกการสมัครที่แสดงผลเพื่อหยุดรับการอัปเดต ดูรายละเอียดเพิ่มเติมได้ที่ดึงข้อมูลบนเว็บเหตุการณ์ onChildAdded จะทริกเกอร์ 1 เหตุการณ์สำหรับบุตรหลานเริ่มแรกแต่ละคน ณ ตำแหน่งนี้ และเหตุการณ์นี้จะทริกเกอร์อีกครั้งทุกครั้งที่มีการเพิ่มรายการย่อยใหม่ DataSnapshot ที่ส่งผ่านไปยัง Callback จะแสดงข้อมูลของผู้เผยแพร่โฆษณาย่อยที่เกี่ยวข้อง เพื่อวัตถุประสงค์ด้านการจัดเรียง ระบบจะส่งผ่านอาร์กิวเมนต์ที่ 2 ซึ่งเป็นสตริงที่มีคีย์รายการย่อยก่อนหน้าตามลำดับการจัดเรียง หรือ null หากเป็นอาร์กิวเมนต์ย่อยรายการแรก
onChildChanged(query, callback, cancelCallback) รอฟังการเปลี่ยนแปลงของข้อมูลในตำแหน่งที่เจาะจงวิธีนี้เป็นวิธีหลักในการอ่านข้อมูลจากฐานข้อมูล ระบบจะเรียกใช้ Callback สำหรับข้อมูลเบื้องต้นและอีกครั้งเมื่อข้อมูลเปลี่ยนแปลง เรียกใช้ Callback ของการยกเลิกการสมัครที่แสดงผลเพื่อหยุดรับการอัปเดต ดูรายละเอียดเพิ่มเติมได้ที่ดึงข้อมูลบนเว็บเหตุการณ์ onChildChanged จะทริกเกอร์เมื่อข้อมูลที่จัดเก็บไว้ในรายการย่อย (หรือองค์ประกอบสืบทอดใดๆ ของเหตุการณ์) มีการเปลี่ยนแปลง โปรดทราบว่าเหตุการณ์ child_changed รายการเดียวอาจแสดงการเปลี่ยนแปลงหลายรายการที่เกิดขึ้นกับรายการย่อย DataSnapshot ที่ส่งไปยัง Callback จะมีเนื้อหาย่อยใหม่ เพื่อวัตถุประสงค์ด้านการจัดเรียง การเรียกกลับจะส่งผ่านอาร์กิวเมนต์ที่ 2 ซึ่งเป็นสตริงที่มีคีย์รายการย่อยก่อนหน้าตามลำดับการจัดเรียง หรือ null หากเป็นอาร์กิวเมนต์รายการย่อยรายการแรก
onChildChanged(คำค้นหา การเรียกกลับ ตัวเลือก) รอฟังการเปลี่ยนแปลงของข้อมูลในตำแหน่งที่เจาะจงวิธีนี้เป็นวิธีหลักในการอ่านข้อมูลจากฐานข้อมูล ระบบจะเรียกใช้ Callback สำหรับข้อมูลเบื้องต้นและอีกครั้งเมื่อข้อมูลเปลี่ยนแปลง เรียกใช้ Callback ของการยกเลิกการสมัครที่แสดงผลเพื่อหยุดรับการอัปเดต ดูรายละเอียดเพิ่มเติมได้ที่ดึงข้อมูลบนเว็บเหตุการณ์ onChildChanged จะทริกเกอร์เมื่อข้อมูลที่จัดเก็บไว้ในรายการย่อย (หรือองค์ประกอบสืบทอดใดๆ ของเหตุการณ์) มีการเปลี่ยนแปลง โปรดทราบว่าเหตุการณ์ child_changed รายการเดียวอาจแสดงการเปลี่ยนแปลงหลายรายการที่เกิดขึ้นกับรายการย่อย DataSnapshot ที่ส่งไปยัง Callback จะมีเนื้อหาย่อยใหม่ เพื่อวัตถุประสงค์ด้านการจัดเรียง การเรียกกลับจะส่งผ่านอาร์กิวเมนต์ที่ 2 ซึ่งเป็นสตริงที่มีคีย์รายการย่อยก่อนหน้าตามลำดับการจัดเรียง หรือ null หากเป็นอาร์กิวเมนต์รายการย่อยรายการแรก
onChildChanged(คำค้นหา, callback, cancelCallback, ตัวเลือก) รอฟังการเปลี่ยนแปลงของข้อมูลในตำแหน่งที่เจาะจงวิธีนี้เป็นวิธีหลักในการอ่านข้อมูลจากฐานข้อมูล ระบบจะเรียกใช้ Callback สำหรับข้อมูลเบื้องต้นและอีกครั้งเมื่อข้อมูลเปลี่ยนแปลง เรียกใช้ Callback ของการยกเลิกการสมัครที่แสดงผลเพื่อหยุดรับการอัปเดต ดูรายละเอียดเพิ่มเติมได้ที่ดึงข้อมูลบนเว็บเหตุการณ์ onChildChanged จะทริกเกอร์เมื่อข้อมูลที่จัดเก็บไว้ในรายการย่อย (หรือองค์ประกอบสืบทอดใดๆ ของเหตุการณ์) มีการเปลี่ยนแปลง โปรดทราบว่าเหตุการณ์ child_changed รายการเดียวอาจแสดงการเปลี่ยนแปลงหลายรายการที่เกิดขึ้นกับรายการย่อย DataSnapshot ที่ส่งไปยัง Callback จะมีเนื้อหาย่อยใหม่ เพื่อวัตถุประสงค์ด้านการจัดเรียง การเรียกกลับจะส่งผ่านอาร์กิวเมนต์ที่ 2 ซึ่งเป็นสตริงที่มีคีย์รายการย่อยก่อนหน้าตามลำดับการจัดเรียง หรือ null หากเป็นอาร์กิวเมนต์รายการย่อยรายการแรก
onChildMoved(การค้นหา, callback, cancelCallback) รอฟังการเปลี่ยนแปลงของข้อมูลในตำแหน่งที่เจาะจงวิธีนี้เป็นวิธีหลักในการอ่านข้อมูลจากฐานข้อมูล ระบบจะเรียกใช้ Callback สำหรับข้อมูลเบื้องต้นและอีกครั้งเมื่อข้อมูลเปลี่ยนแปลง เรียกใช้ Callback ของการยกเลิกการสมัครที่แสดงผลเพื่อหยุดรับการอัปเดต ดูรายละเอียดเพิ่มเติมได้ที่ดึงข้อมูลบนเว็บเหตุการณ์ onChildMoved จะทริกเกอร์เมื่อลำดับการจัดเรียงของบุตรหลานเปลี่ยนแปลงจนตำแหน่งที่เกี่ยวข้องกับรายการข้างเคียงเปลี่ยนไป DataSnapshot ที่ส่งไปยัง Callback จะเป็นข้อมูลของบุตรหลานที่ย้ายไปแล้ว และจะส่งอาร์กิวเมนต์ที่ 2 ซึ่งเป็นสตริงที่มีคีย์รายการย่อยก่อนหน้าตามลำดับการจัดเรียง หรือ null หากเป็นอาร์กิวเมนต์ย่อยรายการแรก
onChildMoved(คำค้นหา การติดต่อกลับ ตัวเลือก) รอฟังการเปลี่ยนแปลงของข้อมูลในตำแหน่งที่เจาะจงวิธีนี้เป็นวิธีหลักในการอ่านข้อมูลจากฐานข้อมูล ระบบจะเรียกใช้ Callback สำหรับข้อมูลเบื้องต้นและอีกครั้งเมื่อข้อมูลเปลี่ยนแปลง เรียกใช้ Callback ของการยกเลิกการสมัครที่แสดงผลเพื่อหยุดรับการอัปเดต ดูรายละเอียดเพิ่มเติมได้ที่ดึงข้อมูลบนเว็บเหตุการณ์ onChildMoved จะทริกเกอร์เมื่อลำดับการจัดเรียงของบุตรหลานเปลี่ยนแปลงจนตำแหน่งที่เกี่ยวข้องกับรายการข้างเคียงเปลี่ยนไป DataSnapshot ที่ส่งผ่านไปยัง Callback จะเป็นข้อมูลของบุตรหลานที่ย้ายไปแล้ว และจะส่งอาร์กิวเมนต์ที่ 2 ซึ่งเป็นสตริงที่มีคีย์รายการย่อยก่อนหน้าตามลำดับการจัดเรียง หรือ null หากเป็นอาร์กิวเมนต์ย่อยรายการแรก
onChildMoved(การค้นหา, callback, cancelCallback, ตัวเลือก) รอฟังการเปลี่ยนแปลงของข้อมูลในตำแหน่งที่เจาะจงวิธีนี้เป็นวิธีหลักในการอ่านข้อมูลจากฐานข้อมูล ระบบจะเรียกใช้ Callback สำหรับข้อมูลเบื้องต้นและอีกครั้งเมื่อข้อมูลเปลี่ยนแปลง เรียกใช้ Callback ของการยกเลิกการสมัครที่แสดงผลเพื่อหยุดรับการอัปเดต ดูรายละเอียดเพิ่มเติมได้ที่ดึงข้อมูลบนเว็บเหตุการณ์ onChildMoved จะทริกเกอร์เมื่อลำดับการจัดเรียงของบุตรหลานเปลี่ยนแปลงจนตำแหน่งที่เกี่ยวข้องกับรายการข้างเคียงเปลี่ยนไป DataSnapshot ที่ส่งไปยัง Callback จะเป็นข้อมูลของบุตรหลานที่ย้ายไปแล้ว และจะส่งอาร์กิวเมนต์ที่ 2 ซึ่งเป็นสตริงที่มีคีย์รายการย่อยก่อนหน้าตามลำดับการจัดเรียง หรือ null หากเป็นอาร์กิวเมนต์ย่อยรายการแรก
onChildRemoved(คำค้นหา, callback, cancelCallback) รอฟังการเปลี่ยนแปลงของข้อมูลในตำแหน่งที่เจาะจงวิธีนี้เป็นวิธีหลักในการอ่านข้อมูลจากฐานข้อมูล ระบบจะเรียกใช้ Callback สำหรับข้อมูลเบื้องต้นและอีกครั้งเมื่อข้อมูลเปลี่ยนแปลง เรียกใช้ Callback ของการยกเลิกการสมัครที่แสดงผลเพื่อหยุดรับการอัปเดต ดูรายละเอียดเพิ่มเติมได้ที่ดึงข้อมูลบนเว็บเหตุการณ์ onChildRemoved จะทริกเกอร์ทุกครั้งที่นำเด็กออก DataSnapshot ที่ส่งผ่านไปยัง Callback จะเป็นข้อมูลเก่าสำหรับบุตรหลานที่ถูกนำออก ระบบจะนำรายการย่อยออกเมื่อ - ไคลเอ็นต์เรียก remove() บนรายการย่อยหรือระดับบนของรายการย่อยดังกล่าวอย่างชัดแจ้ง ไคลเอ็นต์เรียก set(null) ในเครือข่ายย่อยนั้นหรือระดับบนสุดของรายการย่อย ที่รายการย่อยได้ลบรายการย่อยทั้งหมดออกแล้ว มีคำค้นหาที่ปัจจุบันกรองรายการย่อยออก (เนื่องจากมีการเปลี่ยนแปลงลำดับการจัดเรียงหรือถึงขีดจำกัดสูงสุด)
onChildRemoved(คำค้นหา Callback, ตัวเลือก) รอฟังการเปลี่ยนแปลงของข้อมูลในตำแหน่งที่เจาะจงวิธีนี้เป็นวิธีหลักในการอ่านข้อมูลจากฐานข้อมูล ระบบจะเรียกใช้ Callback สำหรับข้อมูลเบื้องต้นและอีกครั้งเมื่อข้อมูลเปลี่ยนแปลง เรียกใช้ Callback ของการยกเลิกการสมัครที่แสดงผลเพื่อหยุดรับการอัปเดต ดูรายละเอียดเพิ่มเติมได้ที่ดึงข้อมูลบนเว็บเหตุการณ์ onChildRemoved จะทริกเกอร์ทุกครั้งที่นำเด็กออก DataSnapshot ที่ส่งผ่านไปยัง Callback จะเป็นข้อมูลเก่าสำหรับบุตรหลานที่ถูกนำออก ระบบจะนำรายการย่อยออกเมื่อ - ไคลเอ็นต์เรียก remove() บนรายการย่อยหรือระดับบนของรายการย่อยดังกล่าวอย่างชัดแจ้ง ไคลเอ็นต์เรียก set(null) ในเครือข่ายย่อยนั้นหรือระดับบนสุดของรายการย่อย ที่รายการย่อยได้ลบรายการย่อยทั้งหมดออกแล้ว มีคำค้นหาที่ปัจจุบันกรองรายการย่อยออก (เนื่องจากมีการเปลี่ยนแปลงลำดับการจัดเรียงหรือถึงขีดจำกัดสูงสุด)
onChildRemoved(คำค้นหา, callback, cancelCallback, ตัวเลือก) รอฟังการเปลี่ยนแปลงของข้อมูลในตำแหน่งที่เจาะจงวิธีนี้เป็นวิธีหลักในการอ่านข้อมูลจากฐานข้อมูล ระบบจะเรียกใช้ Callback สำหรับข้อมูลเบื้องต้นและอีกครั้งเมื่อข้อมูลเปลี่ยนแปลง เรียกใช้ Callback ของการยกเลิกการสมัครที่แสดงผลเพื่อหยุดรับการอัปเดต ดูรายละเอียดเพิ่มเติมได้ที่ดึงข้อมูลบนเว็บเหตุการณ์ onChildRemoved จะทริกเกอร์ทุกครั้งที่นำเด็กออก DataSnapshot ที่ส่งผ่านไปยัง Callback จะเป็นข้อมูลเก่าสำหรับบุตรหลานที่ถูกนำออก ระบบจะนำรายการย่อยออกเมื่อ - ไคลเอ็นต์เรียก remove() บนรายการย่อยหรือระดับบนของรายการย่อยดังกล่าวอย่างชัดแจ้ง ไคลเอ็นต์เรียก set(null) ในเครือข่ายย่อยนั้นหรือระดับบนสุดของรายการย่อย ที่รายการย่อยได้ลบรายการย่อยทั้งหมดออกแล้ว มีคำค้นหาที่ปัจจุบันกรองรายการย่อยออก (เนื่องจากมีการเปลี่ยนแปลงลำดับการจัดเรียงหรือถึงขีดจำกัดสูงสุด)
onValue(query, callback, cancelCallback) รอฟังการเปลี่ยนแปลงของข้อมูลในตำแหน่งที่เจาะจงวิธีนี้เป็นวิธีหลักในการอ่านข้อมูลจากฐานข้อมูล ระบบจะเรียกใช้ Callback สำหรับข้อมูลเบื้องต้นและอีกครั้งเมื่อข้อมูลเปลี่ยนแปลง เรียกใช้ Callback ของการยกเลิกการสมัครที่แสดงผลเพื่อหยุดรับการอัปเดต ดูรายละเอียดเพิ่มเติมได้ที่ดึงข้อมูลบนเว็บเหตุการณ์ onValue จะทริกเกอร์ 1 ครั้งโดยมีข้อมูลเบื้องต้นที่จัดเก็บไว้ในตำแหน่งนี้ แล้วทริกเกอร์อีกครั้งทุกครั้งที่ข้อมูลมีการเปลี่ยนแปลง DataSnapshot ที่ส่งไปยัง Callback จะเป็นตำแหน่งที่มีการเรียกใช้ on() เนื้อหาจะไม่ทริกเกอร์จนกว่าจะมีการซิงค์เนื้อหาทั้งหมด หากสถานที่ไม่มีข้อมูล ระบบจะเรียกให้แสดงด้วย DataSnapshot ที่ว่างเปล่า (val() จะแสดงผลเป็น null)
onValue(ข้อความค้นหา การติดต่อกลับ ตัวเลือก) รอฟังการเปลี่ยนแปลงของข้อมูลในตำแหน่งที่เจาะจงวิธีนี้เป็นวิธีหลักในการอ่านข้อมูลจากฐานข้อมูล ระบบจะเรียกใช้ Callback สำหรับข้อมูลเบื้องต้นและอีกครั้งเมื่อข้อมูลเปลี่ยนแปลง เรียกใช้ Callback ของการยกเลิกการสมัครที่แสดงผลเพื่อหยุดรับการอัปเดต ดูรายละเอียดเพิ่มเติมได้ที่ดึงข้อมูลบนเว็บเหตุการณ์ onValue จะทริกเกอร์ 1 ครั้งโดยมีข้อมูลเบื้องต้นที่จัดเก็บไว้ในตำแหน่งนี้ แล้วทริกเกอร์อีกครั้งทุกครั้งที่ข้อมูลมีการเปลี่ยนแปลง DataSnapshot ที่ส่งไปยัง Callback จะเป็นตำแหน่งที่มีการเรียกใช้ on() เนื้อหาจะไม่ทริกเกอร์จนกว่าจะมีการซิงค์เนื้อหาทั้งหมด หากสถานที่ไม่มีข้อมูล ระบบจะเรียกให้แสดงด้วย DataSnapshot ที่ว่างเปล่า (val() จะแสดงผลเป็น null)
onValue(query, callback, cancelCallback, options) รอฟังการเปลี่ยนแปลงของข้อมูลในตำแหน่งที่เจาะจงวิธีนี้เป็นวิธีหลักในการอ่านข้อมูลจากฐานข้อมูล ระบบจะเรียกใช้ Callback สำหรับข้อมูลเบื้องต้นและอีกครั้งเมื่อข้อมูลเปลี่ยนแปลง เรียกใช้ Callback ของการยกเลิกการสมัครที่แสดงผลเพื่อหยุดรับการอัปเดต ดูรายละเอียดเพิ่มเติมได้ที่ดึงข้อมูลบนเว็บเหตุการณ์ onValue จะทริกเกอร์ 1 ครั้งโดยมีข้อมูลเบื้องต้นที่จัดเก็บไว้ในตำแหน่งนี้ แล้วทริกเกอร์อีกครั้งทุกครั้งที่ข้อมูลมีการเปลี่ยนแปลง DataSnapshot ที่ส่งไปยัง Callback จะเป็นตำแหน่งที่มีการเรียกใช้ on() เนื้อหาจะไม่ทริกเกอร์จนกว่าจะมีการซิงค์เนื้อหาทั้งหมด หากสถานที่ไม่มีข้อมูล ระบบจะเรียกให้แสดงด้วย DataSnapshot ที่ว่างเปล่า (val() จะแสดงผลเป็น null)
query(query, queryConstraints) สร้างอินสแตนซ์ที่เปลี่ยนแปลงไม่ได้ใหม่ของ Query ซึ่งขยายไปเพื่อรวมข้อจำกัดการค้นหาเพิ่มเติมด้วย
ฟังก์ชัน(อ้างอิง, ...)
เมื่อยกเลิกการเชื่อมต่อ(อ้างอิง) แสดงผลออบเจ็กต์ OnDisconnect - ดูรายละเอียดวิธีใช้ได้ที่การเปิดใช้งานความสามารถแบบออฟไลน์ใน JavaScript
ลบ(อ้างอิง) นำข้อมูลที่ตำแหน่งฐานข้อมูลนี้ออกระบบจะลบข้อมูลทั้งหมดในตำแหน่งย่อยด้วยผลของการนำออกจะแสดงทันทีและ "value" ของเหตุการณ์ที่เกี่ยวข้อง จะถูกเรียกใช้ ระบบจะเริ่มซิงค์ข้อมูลรายการที่ลบไปยังเซิร์ฟเวอร์ Firebase ด้วย และ "สัญญา" ที่ส่งกลับมาจะแก้ไขเมื่อเสร็จสมบูรณ์ หากมี ระบบจะเรียก Callback onComplete แบบไม่พร้อมกันหลังจากการซิงค์เสร็จสิ้น
runTransaction(อ้างอิง, transactionUpdate, ตัวเลือก) แก้ไขข้อมูลในตำแหน่งนี้โดยอัตโนมัติแก้ไขข้อมูลในตำแหน่งนี้ทีละน้อย set() ต่างจาก set() ปกติที่เพียงเขียนทับข้อมูลโดยไม่คำนึงถึงค่าเดิม กล่าวคือ runTransaction() จะใช้เพื่อแก้ไขค่าที่มีอยู่ให้เป็นค่าใหม่ เพื่อให้แน่ใจว่าจะไม่มีข้อขัดแย้งกับไคลเอ็นต์อื่นๆ ที่เขียนไปยังตำแหน่งเดียวกันพร้อมกัน หากต้องการดำเนินการนี้ คุณจะต้องส่งฟังก์ชันอัปเดต runTransaction() ที่ใช้ในการแปลงค่าปัจจุบันเป็นค่าใหม่ หากไคลเอ็นต์อื่นเขียนไปยังตำแหน่งก่อนที่จะเขียนค่าใหม่ได้สำเร็จ ระบบจะเรียกใช้ฟังก์ชันอัปเดตอีกครั้งด้วยค่าปัจจุบันใหม่ และจะดำเนินการเขียนใหม่ สิ่งนี้จะเกิดขึ้นซ้ำๆ จนกว่าการเขียนของคุณจะสำเร็จโดยไม่มีความขัดแย้ง หรือคุณล้มเลิกธุรกรรมโดยไม่ส่งคืนมูลค่าจากฟังก์ชันการอัปเดตหมายเหตุ: การแก้ไขข้อมูลด้วย set() จะยกเลิกธุรกรรมทั้งหมดที่รอดำเนินการ ณ สถานที่ตั้งนั้น ดังนั้นคุณควรดำเนินการอย่างรอบคอบหากใช้ set() และ runTransaction() ร่วมกันอัปเดตข้อมูลเดียวกันหมายเหตุ: เมื่อใช้ธุรกรรมที่มีกฎการรักษาความปลอดภัยและ Firebase โปรดทราบว่าลูกค้าต้องมีสิทธิ์เข้าถึง .read นอกเหนือไปจากการเข้าถึง .write จึงจะทำธุรกรรมได้ เนื่องจากลักษณะของธุรกรรมฝั่งไคลเอ็นต์กำหนดให้ลูกค้าอ่านข้อมูลเพื่ออัปเดตข้อมูล
set(ref, ค่า) เขียนข้อมูลไปยังตำแหน่งฐานข้อมูลนี้การดำเนินการนี้จะเขียนทับข้อมูลทั้งหมดในตำแหน่งนี้และตำแหน่งย่อยทั้งหมดผลของการเขียนจะปรากฏทันที และเหตุการณ์ที่เกี่ยวข้อง ("value", "child_added" ฯลฯ) จะถูกทริกเกอร์ ระบบจะเริ่มซิงค์ข้อมูลไปยังเซิร์ฟเวอร์ Firebase ด้วย และ Promise ที่แสดงผลจะยุติลงเมื่อเสร็จสมบูรณ์ หากมี ระบบจะเรียก Callback onComplete ว่าไม่พร้อมกันหลังจากการซิงค์เสร็จสิ้นแล้วการส่ง null สำหรับค่าใหม่เทียบเท่ากับการเรียกใช้ remove() กล่าวคือ ข้อมูลทั้งหมดที่ตำแหน่งนี้และตำแหน่งย่อยทั้งหมดจะถูกลบset() จะนำลำดับความสำคัญทั้งหมดที่จัดเก็บอยู่ที่ตำแหน่งนี้ออก ดังนั้นหากต้องเก็บลำดับความสำคัญไว้ คุณจะต้องใช้ setWithPriority() แทนโปรดทราบว่าการแก้ไขข้อมูลด้วย set() จะยกเลิกธุรกรรมทั้งหมดที่รอดำเนินการ ณ ตำแหน่งนั้น ดังนั้นคุณควรดำเนินการอย่างรอบคอบหากผสม set() และ transaction() เพื่อแก้ไขข้อมูลเดียวกันset() รายการเดียวจะสร้าง "ค่า" รายการเดียว ณ สถานที่ที่มีการดำเนินการ set()
setPriority(การอ้างอิง, ลำดับความสำคัญ) กำหนดลำดับความสำคัญให้กับข้อมูลที่ตำแหน่งฐานข้อมูลนี้แอปพลิเคชันไม่จำเป็นต้องใช้ลำดับความสำคัญแต่สามารถเรียงลำดับคอลเล็กชันตามพร็อพเพอร์ตี้ทั่วไปได้ (ดูการจัดเรียงและกรองข้อมูล )
setWithPriority(การอ้างอิง ค่า ลําดับความสําคัญ) เขียนข้อมูลตำแหน่งฐานข้อมูล เช่นเดียวกับ set() แต่จะระบุลำดับความสำคัญสำหรับข้อมูลนั้นด้วยแอปพลิเคชันไม่จำเป็นต้องใช้ลำดับความสำคัญแต่สามารถเรียงลำดับคอลเล็กชันตามพร็อพเพอร์ตี้ทั่วไปได้ (ดูการจัดเรียงและกรองข้อมูล )
update(การอ้างอิง, ค่า) เขียนค่าหลายค่าไปยังฐานข้อมูลพร้อมกันอาร์กิวเมนต์ values มีคู่คุณสมบัติ-ค่าหลายรายการที่จะเขียนลงในฐานข้อมูลพร้อมกัน พร็อพเพอร์ตี้ย่อยแต่ละรายการอาจเป็นพร็อพเพอร์ตี้แบบง่าย (เช่น "ชื่อ") หรือเส้นทางที่เกี่ยวข้อง (เช่น "ชื่อ/รายการแรก") จากตำแหน่งปัจจุบันไปยังข้อมูลที่จะอัปเดตตรงข้ามกับเมธอด set() คือ update() สามารถใช้เพื่อเลือกอัปเดตเฉพาะพร็อพเพอร์ตี้ที่อ้างอิงในตำแหน่งปัจจุบันที่ต้องการได้ (แทนที่จะแทนที่พร็อพเพอร์ตี้ย่อยทั้งหมดที่ตำแหน่งปัจจุบัน)ผลของการเขียนจะปรากฏทันที และเหตุการณ์ "ย่อย _value" ที่เกี่ยวข้องจะปรากฏ ("ย่อย" ที่เกี่ยวข้อง) ระบบจะเริ่มซิงค์ข้อมูลไปยังเซิร์ฟเวอร์ Firebase ด้วย และ Promise ที่แสดงผลจะยุติลงเมื่อเสร็จสมบูรณ์ หากมี ระบบจะเรียก Callback onComplete แบบอะซิงโครนัสหลังจากการซิงค์เสร็จสิ้นแล้วupdate() รายการเดียวจะสร้าง "ค่า" เดียว เหตุการณ์ในตำแหน่งที่มีการดำเนินการ update() โดยไม่คำนึงถึงจำนวนเด็กที่ถูกแก้ไขโปรดทราบว่าการแก้ไขข้อมูลด้วย update() จะยกเลิกธุรกรรมทั้งหมดที่รอดำเนินการ ณ ตำแหน่งนั้น ดังนั้นคุณควรระมัดระวังอย่างยิ่งหากผสม update() และ transaction() เพื่อแก้ไขข้อมูลเดียวกันการส่ง null ไปยัง update() จะนำข้อมูลที่ตำแหน่งนี้ออกดูแนะนำการอัปเดตสถานที่หลายแห่งและอื่นๆ
function(ค่า, ...)
endAt(ค่า, คีย์) สร้าง QueryConstraint ที่มีจุดสิ้นสุดที่ระบุการใช้ startAt(), startAfter(), endBefore(), endAt() และ equalTo() จะช่วยให้คุณเลือกจุดเริ่มต้นและจุดสิ้นสุดที่กำหนดเองสำหรับการค้นหาของคุณได้รวมจุดสิ้นสุดแล้ว บุตรหลานที่มีค่าตามที่ระบุทุกประการจึงรวมอยู่ในการค้นหา คุณใช้อาร์กิวเมนต์คีย์ที่ไม่บังคับเพื่อจำกัดช่วงของการค้นหาเพิ่มเติมได้ หากระบุไว้ ย่อยที่มีค่าที่ระบุจริงๆ จะต้องมีชื่อคีย์น้อยกว่าหรือเท่ากับคีย์ที่ระบุคุณสามารถอ่านเพิ่มเติมเกี่ยวกับ endAt() ได้ในการกรองข้อมูล
endก่อน(ค่า, คีย์) สร้าง QueryConstraint ที่มีจุดสิ้นสุดตามที่ระบุ (ไม่รวม)การใช้ startAt(), startAfter(), endBefore(), endAt() และ equalTo() จะช่วยให้คุณเลือกจุดเริ่มต้นและจุดสิ้นสุดที่กำหนดเองสำหรับการค้นหาของคุณได้จุดสิ้นสุดนี้ไม่จำกัดเพียงเท่านั้น หากระบุเฉพาะค่า ระบบจะรวมรายการย่อยที่มีค่าน้อยกว่าค่าที่ระบุไว้ในการค้นหา หากระบุคีย์แล้ว คีย์ย่อยต้องมีค่าน้อยกว่าหรือเท่ากับค่าที่ระบุและชื่อคีย์น้อยกว่าคีย์ที่ระบุ
equalTo(ค่า, คีย์) สร้าง QueryConstraint ที่รวมรายการย่อยที่ตรงกับค่าที่ระบุการใช้ startAt(), startAfter(), endBefore(), endAt() และ equalTo() จะช่วยให้คุณเลือกจุดเริ่มต้นและจุดสิ้นสุดที่กำหนดเองสำหรับการค้นหาของคุณได้อาร์กิวเมนต์คีย์ที่ไม่บังคับใช้เพื่อจำกัดช่วงของการค้นหาเพิ่มเติมได้ หากระบุไว้ ย่อยที่มีค่าที่ระบุไว้จะต้องมีคีย์ที่ระบุเป็นชื่อคีย์ด้วย ซึ่งใช้กรองชุดผลลัพธ์ที่มีรายการที่ตรงกันจำนวนมากสำหรับค่าเดียวกันได้อ่านเพิ่มเติมเกี่ยวกับ equalTo() ได้ในการกรองข้อมูล
startAfter(ค่า, คีย์) สร้าง QueryConstraint พร้อมจุดเริ่มต้นที่ระบุ (ไม่รวม)การใช้ startAt(), startAfter(), endBefore(), endAt() และ equalTo() จะช่วยให้คุณเลือกจุดเริ่มต้นและจุดสิ้นสุดที่กำหนดเองสำหรับการค้นหาของคุณได้จุดเริ่มต้นนี้สุดพิเศษ หากระบุเฉพาะค่า ระบบจะรวมรายการย่อยที่มีค่ามากกว่าค่าที่ระบุไว้ในการค้นหา หากระบุคีย์แล้ว คีย์ย่อยต้องมีค่ามากกว่าหรือเท่ากับค่าที่ระบุและมีชื่อคีย์มากกว่าคีย์ที่ระบุ
startAt(ค่า, คีย์) สร้าง QueryConstraint ที่มีจุดเริ่มต้นที่ระบุการใช้ startAt(), startAfter(), endBefore(), endAt() และ equalTo() จะช่วยให้คุณเลือกจุดเริ่มต้นและจุดสิ้นสุดที่กำหนดเองสำหรับการค้นหาของคุณได้รวมจุดเริ่มต้นแล้ว เด็กที่มีค่าตามที่ระบุทุกประการจึงรวมอยู่ในการค้นหา คุณใช้อาร์กิวเมนต์คีย์ที่ไม่บังคับเพื่อจำกัดช่วงของการค้นหาเพิ่มเติมได้ หากระบุไว้ ย่อยที่มีค่าที่ระบุจริงๆ จะต้องมีชื่อคีย์มากกว่าหรือเท่ากับคีย์ที่ระบุคุณสามารถอ่านเพิ่มเติมเกี่ยวกับ startAt() ได้ในการกรองข้อมูล

ชั้นเรียน

ชั้น คำอธิบาย
ฐานข้อมูล ชั้นเรียนที่แสดงฐานข้อมูลเรียลไทม์ของ Firebase
DataSnapshot DataSnapshot มีข้อมูลจากตำแหน่งฐานข้อมูลเมื่อใดก็ตามที่คุณอ่านข้อมูลจากฐานข้อมูล คุณจะได้รับข้อมูลเป็น DataSnapshot ระบบจะส่ง DataSnapshot ไปยัง Callback ของเหตุการณ์ที่คุณแนบด้วย on() หรือ once() คุณดึงเนื้อหาของสแนปชอตเป็นออบเจ็กต์ JavaScript ได้โดยเรียกใช้เมธอด val() อีกวิธีหนึ่งคือข้ามผ่านไปยังสแนปชอตได้โดยเรียกใช้ child() เพื่อแสดงผลสแนปชอตย่อย (ซึ่งหลังจากนั้นคุณอาจเรียก val() ก็ได้)DataSnapshot เป็นสำเนาข้อมูลที่มีการเปลี่ยนแปลงและสร้างขึ้นอย่างมีประสิทธิภาพในตำแหน่งฐานข้อมูล ซึ่งจะแก้ไขไม่ได้และจะไม่เปลี่ยนแปลง (หากต้องการแก้ไขข้อมูล ให้เรียกใช้เมธอด set() ใน Reference โดยตรงเสมอ)
เมื่อยกเลิกการเชื่อมต่อ คลาส onDisconnect จะช่วยให้คุณเขียนหรือล้างข้อมูลเมื่อไคลเอ็นต์ยกเลิกการเชื่อมต่อจากเซิร์ฟเวอร์ฐานข้อมูลได้ การอัปเดตเหล่านี้จะเกิดขึ้นไม่ว่าไคลเอ็นต์จะตัดการเชื่อมต่ออย่างชัดเจนหรือไม่ คุณจึงไว้วางใจให้ไคลเอ็นต์นั้นล้างข้อมูลได้แม้ว่าการเชื่อมต่อจะหลุดหรือไคลเอ็นต์ขัดข้องคลาส onDisconnect มักใช้เพื่อจัดการตัวตนในแอปพลิเคชันที่มีประโยชน์ในการตรวจหาจำนวนไคลเอ็นต์ที่เชื่อมต่อและเมื่อไคลเอ็นต์อื่นๆ ยกเลิกการเชื่อมต่อ ดูข้อมูลเพิ่มเติมที่การเปิดใช้ความสามารถแบบออฟไลน์ใน JavaScriptเพื่อหลีกเลี่ยงปัญหาเมื่อการเชื่อมต่อถูกตัดก่อนที่จะสามารถโอนคำขอไปยังเซิร์ฟเวอร์ฐานข้อมูล ควรเรียกใช้ฟังก์ชันเหล่านี้ก่อนที่จะเขียนข้อมูลโปรดทราบว่าการดำเนินการ onDisconnect จะทำงานเพียงครั้งเดียว หากต้องการให้มีการดำเนินการทุกครั้งที่ยกเลิกการเชื่อมต่อ คุณจะต้องเริ่มดำเนินการ onDisconnect ใหม่ทุกครั้งที่เชื่อมต่ออีกครั้ง
ข้อความค้นหาข้อจำกัด QueryConstraint จะใช้เพื่อจำกัดชุดของเอกสารที่แสดงโดยการค้นหาฐานข้อมูล ซึ่งQueryConstraintสร้างขึ้นโดยการเรียกใช้ endAt(), endก่อนที่จะ (endAt(), endก่อนที่จะ(), startstartAt(), startQueryConstraint
ผลการทำธุรกรรม ประเภทสำหรับค่าแปลค่าของ runTransaction()

อินเทอร์เฟซ

อินเทอร์เฟซ คำอธิบาย
ข้อมูลอ้างอิงฐานข้อมูล DatabaseReference แสดงถึงตำแหน่งที่เจาะจงในฐานข้อมูลของคุณ และสามารถใช้สำหรับการอ่านหรือเขียนข้อมูลไปยังตำแหน่งฐานข้อมูลนั้นคุณสามารถอ้างอิงตำแหน่งรากหรือตำแหน่งย่อยในฐานข้อมูลของคุณได้โดยเรียก ref() หรือ ref("child/path")การเขียนดำเนินการโดยใช้เมธอด set() และอ่านได้โดยใช้เมธอด on*() โปรดดู https://firebase.google.com/docs/database/web/read-and-write
IteratedDataSnapshot แสดงภาพรวมย่อยของ Reference ที่ปรับปรุง คีย์จะไม่มีวันระบุได้
ตัวเลือกในการฟัง ออบเจ็กต์ตัวเลือกที่ใช้ปรับแต่ง Listener ได้
คำถาม Query จะจัดเรียงและกรองข้อมูลในตำแหน่งฐานข้อมูลเพื่อให้รวมเฉพาะข้อมูลย่อยบางส่วน ซึ่งสามารถใช้เรียงลำดับการรวบรวมข้อมูลตามแอตทริบิวต์บางอย่าง (เช่น ความสูงของไดโนเสาร์) และเพื่อจำกัดรายการจำนวนมาก (เช่น ข้อความแชท) ให้มีจำนวนที่เหมาะสำหรับการซิงค์กับไคลเอ็นต์ การค้นหาสร้างขึ้นด้วยการเชื่อมโยงเมธอดตัวกรองอย่างน้อย 1 รายการเข้าด้วยกันซึ่งกำหนดไว้ที่นี่คุณสามารถรับข้อมูลจาก Query ได้โดยใช้เมธอด on*() เช่นเดียวกับ DatabaseReference คุณจะได้รับเฉพาะเหตุการณ์และ DataSnapshot สําหรับข้อมูลชุดย่อยที่ตรงกับคำค้นหาของคุณดูข้อมูลเพิ่มเติมได้ที่ https://firebase.google.com/docs/database/web/lists-of-data#sorting_and_filtering_data
แล้วเชื่อมโยงได้ Promise ที่สามารถทำหน้าที่เป็น DatabaseReference ได้ด้วยเมื่อแสดงผลโดย push() ข้อมูลอ้างอิงจะพร้อมใช้งานทันที และ Promise จะได้รับการแก้ไขเมื่อการเขียนไปยังแบ็กเอนด์เสร็จสมบูรณ์
ตัวเลือกธุรกรรม ออบเจ็กต์ตัวเลือกเพื่อกำหนดค่าธุรกรรม

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

พิมพ์ชื่อแทน คำอธิบาย
EventType สตริงใดสตริงหนึ่งต่อไปนี้ ได้แก่ "value", "child_added", "child_changed", "child_นำออกแล้ว" หรือ "child_moved"
QueryConstraintType อธิบายข้อจำกัดการค้นหาที่แตกต่างกันที่มีใน SDK นี้
ยกเลิกการสมัคร Callback ที่สามารถเรียกใช้เพื่อนำ Listener ออก

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

getDatabase(แอป, URL)

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

ลายเซ็น:

export declare function getDatabase(app?: FirebaseApp, url?: string): Database;

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
แอป แอป Firebase อินสแตนซ์ FirebaseApp ที่เชื่อมโยงกับอินสแตนซ์ Realtime Database ที่แสดงผลอยู่
url สตริง URL ของอินสแตนซ์ Realtime Database ที่จะเชื่อมต่อ หากไม่ระบุ SDK จะเชื่อมต่อกับอินสแตนซ์เริ่มต้นของแอป Firebase

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

ฐานข้อมูล

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

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

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

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

หมายเหตุ: ต้องเรียกใช้เมธอดนี้ก่อนที่จะดำเนินการอื่นๆ

ลายเซ็น:

export declare function connectDatabaseEmulator(db: Database, host: string, port: number, options?: {
    mockUserToken?: EmulatorMockTokenOptions | string;
}): void;

พารามิเตอร์

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

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

เป็นโมฆะ

goOffline(db)

การยกเลิกการเชื่อมต่อจากเซิร์ฟเวอร์ (การดำเนินการเกี่ยวกับฐานข้อมูลทั้งหมดจะดำเนินการแบบออฟไลน์)

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

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

หากต้องการเชื่อมต่อกับฐานข้อมูลอีกครั้งและเริ่มรับเหตุการณ์ระยะไกล โปรดดูgoOnline()

ลายเซ็น:

export declare function goOffline(db: Database): void;

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
db ฐานข้อมูล อินสแตนซ์ที่จะยกเลิกการเชื่อมต่อ

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

เป็นโมฆะ

goOnline(db)

เชื่อมต่อเซิร์ฟเวอร์อีกครั้งและซิงค์สถานะฐานข้อมูลออฟไลน์กับสถานะเซิร์ฟเวอร์

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

ลายเซ็น:

export declare function goOnline(db: Database): void;

พารามิเตอร์

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

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

เป็นโมฆะ

ref(db, เส้นทาง)

แสดงผล Reference ที่แสดงถึงตำแหน่งในฐานข้อมูลที่ตรงกับเส้นทางที่ระบุ หากไม่ได้ระบุเส้นทาง Reference จะชี้ไปที่รูทของฐานข้อมูล

ลายเซ็น:

export declare function ref(db: Database, path?: string): DatabaseReference;

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
db ฐานข้อมูล อินสแตนซ์ฐานข้อมูลที่จะรับการอ้างอิง
เส้นทาง สตริง เส้นทางที่ไม่บังคับซึ่งแสดงตำแหน่งที่ Reference ที่แสดงผลจะชี้ หากไม่ระบุ Reference ที่แสดงผลจะชี้ไปยังรูทของฐานข้อมูล

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

ข้อมูลอ้างอิงฐานข้อมูล

หากมีเส้นทาง Reference จะชี้ไปยังเส้นทางที่ระบุ ในกรณีอื่นๆ จะเป็น Reference ที่ชี้ไปยังรูทของฐานข้อมูล

refFromURL(db, url)

แสดงผล Reference ซึ่งแสดงตำแหน่งในฐานข้อมูลที่เกี่ยวข้องกับ URL ของ Firebase ที่ระบุ

จะมีข้อยกเว้นหาก URL ไม่ใช่ URL ของฐานข้อมูล Firebase ที่ถูกต้อง หรือมีโดเมนต่างจากอินสแตนซ์ Database ปัจจุบัน

โปรดทราบว่าพารามิเตอร์การค้นหาทั้งหมด (orderBy, limitToLast ฯลฯ) จะถูกละเว้นและไม่มีผลกับ Reference ที่แสดงผล

ลายเซ็น:

export declare function refFromURL(db: Database, url: string): DatabaseReference;

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
db ฐานข้อมูล อินสแตนซ์ฐานข้อมูลที่จะรับการอ้างอิง
url สตริง URL ของ Firebase ซึ่ง Reference ที่แสดงผลจะชี้

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

ข้อมูลอ้างอิงฐานข้อมูล

Reference ที่ชี้ไปยัง URL ของ Firebase ที่ระบุ

ฟังก์ชัน()

forceLongPolling()

บังคับให้ใช้ LongPolling แทน WebSockets ระบบจะไม่สนใจค่านี้หากมีการใช้โปรโตคอล WebSocket ใน DatabaseURL

ลายเซ็น:

export declare function forceLongPolling(): void;

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

เป็นโมฆะ

forceWebSockets

บังคับใช้ WebSockets แทน LongPolling

ลายเซ็น:

export declare function forceWebSockets(): void;

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

เป็นโมฆะ

orderByKey()

สร้าง QueryConstraint ใหม่ที่เรียงลำดับตามคีย์

จัดเรียงผลลัพธ์ของคำค้นหาตามค่าคีย์ (จากน้อยไปมาก)

อ่านเพิ่มเติมเกี่ยวกับ orderByKey() ได้ในจัดเรียงข้อมูล

ลายเซ็น:

export declare function orderByKey(): QueryConstraint;

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

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

orderByPriority()

สร้าง QueryConstraint ใหม่ที่จัดเรียงตามลำดับความสำคัญ

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

ลายเซ็น:

export declare function orderByPriority(): QueryConstraint;

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

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

orderByValue()

สร้าง QueryConstraint ใหม่ที่จัดเรียงตามมูลค่า

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

อ่านเพิ่มเติมเกี่ยวกับ orderByValue() ได้ในจัดเรียงข้อมูล

ลายเซ็น:

export declare function orderByValue(): QueryConstraint;

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

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

ServerTimestamp()

แสดงผลค่าตัวยึดตำแหน่งสำหรับการป้อนข้อมูลการประทับเวลาปัจจุบันโดยอัตโนมัติ (เวลาตั้งแต่ Unix Epoch ในหน่วยมิลลิวินาที) ตามที่เซิร์ฟเวอร์ Firebase กำหนด

ลายเซ็น:

export declare function serverTimestamp(): object;

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

ออบเจ็กต์

ฟังก์ชัน(เดลต้า, ...)

เพิ่ม(เดลต้า)

แสดงผลค่าตัวยึดตำแหน่งที่สามารถใช้เพื่อเพิ่มค่าฐานข้อมูลปัจจุบันในระดับอะตอมตามเดลต้าที่ระบุ

ลายเซ็น:

export declare function increment(delta: number): object;

พารามิเตอร์

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

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

ออบเจ็กต์

ค่าตัวยึดตำแหน่งสำหรับการแก้ไขข้อมูลในฝั่งเซิร์ฟเวอร์แบบอะตอม

ฟังก์ชัน(เปิดใช้งานแล้ว, ...)

ให้เปิดใช้การบันทึก(เปิดใช้ ถาวร)

บันทึกข้อมูลการแก้ไขข้อบกพร่องไปยังคอนโซล

ลายเซ็น:

export declare function enableLogging(enabled: boolean, persistent?: boolean): any;

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
เปิดใช้อยู่ boolean เปิดใช้การบันทึกหาก true ปิดใช้การบันทึกหาก false
ต่อเนื่อง boolean จำสถานะการบันทึกระหว่างการรีเฟรชหน้าหาก true

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

ทั้งหมด

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

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

สร้าง QueryConstraint ใหม่ที่หากจำกัดจำนวนเด็กแรกที่เจาะจง

เมธอด limitToFirst() ใช้เพื่อกำหนดจำนวนองค์ประกอบย่อยสูงสุดที่จะซิงค์สำหรับ Callback ที่ระบุ หากตั้งขีดจำกัดไว้ที่ 100 รายการ ในตอนแรกเราจะรับเหตุการณ์สูงสุด 100 child_added รายการเท่านั้น หากเราเก็บข้อความน้อยกว่า 100 ข้อความไว้ในฐานข้อมูล เหตุการณ์ child_added จะเริ่มทำงานสำหรับแต่ละข้อความ อย่างไรก็ตาม หากเรามีข้อความเกิน 100 ข้อความ เราจะได้รับเฉพาะเหตุการณ์ child_added สำหรับข้อความที่เรียงลำดับ 100 รายการแรกเท่านั้น เมื่อสินค้ามีการเปลี่ยนแปลง เราจะได้รับเหตุการณ์ child_removed รายการสำหรับแต่ละรายการที่ไม่ได้อยู่ในรายการที่ใช้งานอยู่เพื่อให้จำนวนทั้งหมดยังคงอยู่ที่ 100 รายการ

อ่านเพิ่มเติมเกี่ยวกับ limitToFirst() ได้ในการกรองข้อมูล

ลายเซ็น:

export declare function limitToFirst(limit: number): QueryConstraint;

พารามิเตอร์

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

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

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

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

สร้าง QueryConstraint ใหม่ที่จำกัดให้แสดงผลเฉพาะจำนวนรายการย่อยที่ระบุล่าสุด

เมธอด limitToLast() ใช้เพื่อกำหนดจำนวนองค์ประกอบย่อยสูงสุดที่จะซิงค์สำหรับ Callback ที่ระบุ หากตั้งขีดจำกัดไว้ที่ 100 รายการ ในตอนแรกเราจะรับเหตุการณ์สูงสุด 100 child_added รายการเท่านั้น หากเราเก็บข้อความน้อยกว่า 100 ข้อความไว้ในฐานข้อมูล เหตุการณ์ child_added จะเริ่มทำงานสำหรับแต่ละข้อความ อย่างไรก็ตาม หากเรามีข้อความเกิน 100 ข้อความ เราจะรับเฉพาะเหตุการณ์ child_added สำหรับข้อความที่เรียงลำดับ 100 รายการล่าสุดเท่านั้น เมื่อสินค้ามีการเปลี่ยนแปลง เราจะได้รับเหตุการณ์ child_removed รายการสำหรับแต่ละรายการที่ไม่ได้อยู่ในรายการที่ใช้งานอยู่เพื่อให้จำนวนทั้งหมดยังคงอยู่ที่ 100 รายการ

อ่านเพิ่มเติมเกี่ยวกับ limitToLast() ได้ในการกรองข้อมูล

ลายเซ็น:

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

พารามิเตอร์

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

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

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

ฟังก์ชัน(ตัวบันทึก, ...)

ระบบจะเปิดใช้การบันทึก(ตัวบันทึก)

บันทึกข้อมูลการแก้ไขข้อบกพร่องไปยังคอนโซล

ลายเซ็น:

export declare function enableLogging(logger: (message: string) => unknown): any;

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
ตัวบันทึก (ข้อความ: สตริง) => ไม่รู้จัก ฟังก์ชันตัวบันทึกที่กำหนดเองสำหรับควบคุมวิธีการบันทึกสิ่งต่างๆ

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

ทั้งหมด

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

ลูก(หลัก, เส้นทาง)

รับ Reference สำหรับสถานที่ตั้งในเส้นทางที่เกี่ยวข้องที่ระบุ

เส้นทางแบบสัมพัทธ์อาจเป็นชื่อย่อยแบบง่าย (เช่น "ada") หรือเส้นทางที่คั่นด้วยเครื่องหมายทับในระดับที่ลึกขึ้น (เช่น "ada/name/first")

ลายเซ็น:

export declare function child(parent: DatabaseReference, path: string): DatabaseReference;

พารามิเตอร์

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

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

ข้อมูลอ้างอิงฐานข้อมูล

ตำแหน่งย่อยที่ระบุ

พุช(หลัก, ค่า)

สร้างตำแหน่งย่อยใหม่โดยใช้คีย์ที่ไม่ซ้ำกันและแสดงผล Reference ของตำแหน่งดังกล่าว

นี่คือรูปแบบที่ใช้กันมากที่สุดสำหรับการเพิ่มข้อมูลไปยังคอลเล็กชันรายการ

หากคุณระบุค่าเป็น push() ระบบจะเขียนค่าลงในตำแหน่งที่สร้างขึ้น หากไม่ส่งผ่านค่า จะไม่มีการเขียนสิ่งใดไปยังฐานข้อมูลและรายการย่อยจะยังคงว่างเปล่า (แต่คุณใช้ Reference ในที่อื่นได้)

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

โปรดดูหัวข้อเพิ่มในรายการข้อมูล ดูวิธี 2^120 วิธีในการตรวจสอบว่าตัวระบุไม่ซ้ำกัน

ลายเซ็น:

export declare function push(parent: DatabaseReference, value?: unknown): ThenableReference;

พารามิเตอร์

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

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

แล้วเชื่อมโยงได้

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

ฟังก์ชัน(เส้นทาง, ...)

orderByChild(เส้นทาง)

สร้าง QueryConstraint ใหม่ที่สั่งซื้อตามคีย์ย่อยที่ระบุ

คำค้นหาสามารถเรียงลำดับได้ครั้งละ 1 คีย์เท่านั้น การเรียกใช้ orderByChild() หลายครั้งโดยใช้คำค้นหาเดียวกันเป็นข้อผิดพลาด

การค้นหา Firebase ช่วยให้คุณเรียงลำดับข้อมูลตามคีย์ย่อยได้ทันที แต่หากทราบล่วงหน้าว่าดัชนีจะเป็นอะไร คุณก็กำหนดดัชนีผ่านกฎ .indexOn ในกฎความปลอดภัยได้เพื่อประสิทธิภาพที่ดีขึ้น ดูข้อมูลเพิ่มเติมได้ที่กฎ https://firebase.google.com/docs/database/security/indexing-data

อ่านเพิ่มเติมเกี่ยวกับ orderByChild() ได้ในจัดเรียงข้อมูล

ลายเซ็น:

export declare function orderByChild(path: string): QueryConstraint;

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
เส้นทาง สตริง เส้นทางการเรียงลำดับตาม

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

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

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

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

รับผลการค้นหาล่าสุดสําหรับการค้นหานี้

ลายเซ็น:

export declare function get(query: Query): Promise<DataSnapshot>;

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
query คำถาม คำค้นหาที่จะเรียกใช้

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

สัญญา<DataSnapshot>

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

ปิด(ข้อความค้นหา, eventType, callback)

ปลด Callback ที่แนบมาก่อนหน้านี้กับ Listener on*() (onValue, onChildAdded) ที่เกี่ยวข้อง หมายเหตุ: นี่ไม่ใช่วิธีที่แนะนำในการนำ Listener ออก โปรดใช้ฟังก์ชัน Callback ที่ส่งกลับจาก Callback on* ที่เกี่ยวข้องแทน

ปลด Callback ที่แนบมาก่อนหน้านี้ด้วย on*() ออก การเรียกใช้ off() ใน Listener หลักจะไม่นำ Listener ที่ลงทะเบียนในโหนดย่อยออกโดยอัตโนมัติ และต้องเรียกใช้ off() ใน Listener ย่อยทั้งหมดเพื่อนำ Callback ออก

หากไม่ได้ระบุ Callback ระบบจะนำ Callback ทั้งหมดสำหรับ eventType ที่ระบุออก ในทำนองเดียวกัน หากไม่ได้ระบุ eventType การเรียกกลับทั้งหมดสำหรับ Reference จะถูกนำออก

นอกจากนี้ ผู้ฟังแต่ละรายยังนำผู้ฟังออกได้โดยเรียกใช้ Callback ของการยกเลิกการสมัคร

ลายเซ็น:

export declare function off(query: Query, eventType?: EventType, callback?: (snapshot: DataSnapshot, previousChildName?: string | null) => unknown): void;

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
query คำถาม การค้นหาที่ผู้ฟังลงทะเบียนไว้
eventType EventType สตริงใดสตริงหนึ่งต่อไปนี้ ได้แก่ "value", "child_added", "child_changed", "child_นำออกแล้ว" หรือ "child_moved" หากไม่ระบุ ระบบจะนำ Callback ทั้งหมดสำหรับ Reference ออก
Callback (สแนปชอต: DataSnapshot, oldChildName?: string | null) => ไม่รู้จัก ฟังก์ชัน Callback ที่ส่งไปยัง on() หรือ undefined เพื่อนำ Callback ทั้งหมดออก

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

เป็นโมฆะ

onChildAdd(ข้อความค้นหา, callback, cancelCallback)

คอยฟังการเปลี่ยนแปลงของข้อมูลในตำแหน่งที่เจาะจง

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

ระบบจะทริกเกอร์เหตุการณ์ onChildAdded 1 ครั้งสำหรับเด็กเริ่มแรกแต่ละคนที่ตำแหน่งนี้ และจะทำงานอีกครั้งทุกครั้งที่มีการเพิ่มเด็กใหม่ DataSnapshot ที่ส่งผ่านไปยัง Callback จะแสดงข้อมูลของผู้เผยแพร่โฆษณาย่อยที่เกี่ยวข้อง เพื่อวัตถุประสงค์ด้านการจัดเรียง ระบบจะส่งผ่านอาร์กิวเมนต์ที่ 2 ซึ่งเป็นสตริงที่มีคีย์รายการย่อยก่อนหน้าตามลำดับการจัดเรียง หรือ null หากเป็นอาร์กิวเมนต์ย่อยรายการแรก

ลายเซ็น:

export declare function onChildAdded(query: Query, callback: (snapshot: DataSnapshot, previousChildName?: string | null) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
query คำถาม คำค้นหาที่จะเรียกใช้
Callback (สแนปชอต: DataSnapshot, oldChildName?: string | null) => ไม่รู้จัก Callback ที่เริ่มทำงานเมื่อเหตุการณ์ที่ระบุเกิดขึ้น Callback ระบบจะส่ง DataSnapshot และสตริงที่มีคีย์ของรายการย่อยก่อนหน้าตามลำดับการจัดเรียง หรือ null หากเป็นคีย์ย่อยรายการแรก
ยกเลิก Callback (ข้อผิดพลาด: ข้อผิดพลาด) => ไม่รู้จัก การติดต่อกลับ (ไม่บังคับ) ซึ่งจะได้รับการแจ้งเตือนหากการติดตามกิจกรรมของคุณถูกยกเลิกเนื่องจากลูกค้าของคุณไม่มีสิทธิ์อ่านข้อมูลนี้ (หรือมีข้อมูลแต่ตอนนี้สูญเสียสิทธิ์แล้ว) Callback นี้จะส่งผ่านออบเจ็กต์ Error ที่ระบุสาเหตุที่เกิดความล้มเหลวขึ้น

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

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

ฟังก์ชันที่สามารถเรียกใช้เพื่อนำ Listener ออก

onChildAdd(คำค้นหา, Callback, ตัวเลือก)

คอยฟังการเปลี่ยนแปลงของข้อมูลในตำแหน่งที่เจาะจง

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

ระบบจะทริกเกอร์เหตุการณ์ onChildAdded 1 ครั้งสำหรับเด็กเริ่มแรกแต่ละคนที่ตำแหน่งนี้ และจะทำงานอีกครั้งทุกครั้งที่มีการเพิ่มเด็กใหม่ DataSnapshot ที่ส่งผ่านไปยังฟังก์ชัน Callback จะแสดงข้อมูลสำหรับผู้เผยแพร่โฆษณาย่อยที่เกี่ยวข้อง เพื่อวัตถุประสงค์ด้านการจัดเรียง ระบบจะส่งผ่านอาร์กิวเมนต์ที่ 2 ซึ่งเป็นสตริงที่มีคีย์รายการย่อยก่อนหน้าตามลำดับการจัดเรียง หรือ null หากเป็นอาร์กิวเมนต์ย่อยรายการแรก

ลายเซ็น:

export declare function onChildAdded(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, options: ListenOptions): Unsubscribe;

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
query คำถาม คำค้นหาที่จะเรียกใช้
Callback (สแนปชอต: DataSnapshot, beforeChildName: string | null) => ไม่รู้จัก Callback ที่เริ่มทำงานเมื่อเหตุการณ์ที่ระบุเกิดขึ้น Callback ระบบจะส่ง DataSnapshot และสตริงที่มีคีย์ของรายการย่อยก่อนหน้าตามลำดับการจัดเรียง หรือ null หากเป็นคีย์ย่อยรายการแรก
ตัวเลือก ตัวเลือกในการฟัง ออบเจ็กต์ที่สามารถใช้กำหนดค่า onlyOnce ซึ่งจะนำ Listener ออกหลังจากการเรียกใช้ครั้งแรก

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

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

ฟังก์ชันที่สามารถเรียกใช้เพื่อนำ Listener ออก

onChildAdd(การค้นหา, callback, cancelCallback, options)

คอยฟังการเปลี่ยนแปลงของข้อมูลในตำแหน่งที่เจาะจง

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

ระบบจะทริกเกอร์เหตุการณ์ onChildAdded 1 ครั้งสำหรับเด็กเริ่มแรกแต่ละคนที่ตำแหน่งนี้ และจะทำงานอีกครั้งทุกครั้งที่มีการเพิ่มเด็กใหม่ DataSnapshot ที่ส่งผ่านไปยัง Callback จะแสดงข้อมูลของผู้เผยแพร่โฆษณาย่อยที่เกี่ยวข้อง เพื่อวัตถุประสงค์ด้านการจัดเรียง ระบบจะส่งผ่านอาร์กิวเมนต์ที่ 2 ซึ่งเป็นสตริงที่มีคีย์รายการย่อยก่อนหน้าตามลำดับการจัดเรียง หรือ null หากเป็นอาร์กิวเมนต์ย่อยรายการแรก

ลายเซ็น:

export declare function onChildAdded(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
query คำถาม คำค้นหาที่จะเรียกใช้
Callback (สแนปชอต: DataSnapshot, beforeChildName: string | null) => ไม่รู้จัก Callback ที่เริ่มทำงานเมื่อเหตุการณ์ที่ระบุเกิดขึ้น Callback ระบบจะส่ง DataSnapshot และสตริงที่มีคีย์ของรายการย่อยก่อนหน้าตามลำดับการจัดเรียง หรือ null หากเป็นรายการแรก
ยกเลิก Callback (ข้อผิดพลาด: ข้อผิดพลาด) => ไม่รู้จัก การติดต่อกลับ (ไม่บังคับ) ซึ่งจะได้รับการแจ้งเตือนหากมีการยกเลิกการสมัครใช้บริการกิจกรรมของคุณเนื่องจากลูกค้าไม่มีสิทธิ์อ่านข้อมูลนี้ (หรือลูกค้ามีสิทธิ์แต่ตอนนี้ข้อมูลหายไปแล้ว) Callback นี้จะส่งผ่านออบเจ็กต์ Error ที่ระบุสาเหตุของความล้มเหลวขึ้น
ตัวเลือก ตัวเลือกในการฟัง ออบเจ็กต์ที่สามารถใช้กำหนดค่า onlyOnce ซึ่งจะนำ Listener ออกหลังจากการเรียกใช้ครั้งแรก

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

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

ฟังก์ชันที่สามารถเรียกใช้เพื่อนำ Listener ออก

onChildChanged(query, callback, cancelCallback)

คอยฟังการเปลี่ยนแปลงของข้อมูลในตำแหน่งที่เจาะจง

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

เหตุการณ์ onChildChanged จะทริกเกอร์เมื่อข้อมูลที่จัดเก็บไว้ในรายการย่อย (หรือองค์ประกอบย่อยของรายการย่อย) มีการเปลี่ยนแปลง โปรดทราบว่าเหตุการณ์ child_changed รายการเดียวอาจแสดงการเปลี่ยนแปลงหลายรายการที่เกิดขึ้นกับรายการย่อย DataSnapshot ที่ส่งไปยัง Callback จะมีเนื้อหาย่อยใหม่ เพื่อวัตถุประสงค์ด้านการจัดเรียง การเรียกกลับจะส่งผ่านอาร์กิวเมนต์ที่ 2 ซึ่งเป็นสตริงที่มีคีย์รายการย่อยก่อนหน้าตามลำดับการจัดเรียง หรือ null หากเป็นอาร์กิวเมนต์รายการย่อยรายการแรก

ลายเซ็น:

export declare function onChildChanged(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
query คำถาม คำค้นหาที่จะเรียกใช้
Callback (สแนปชอต: DataSnapshot, beforeChildName: string | null) => ไม่รู้จัก Callback ที่เริ่มทำงานเมื่อเหตุการณ์ที่ระบุเกิดขึ้น Callback ระบบจะส่ง DataSnapshot และสตริงที่มีคีย์ของรายการย่อยก่อนหน้าตามลำดับการจัดเรียง หรือ null หากเป็นคีย์ย่อยรายการแรก
ยกเลิก Callback (ข้อผิดพลาด: ข้อผิดพลาด) => ไม่รู้จัก การติดต่อกลับ (ไม่บังคับ) ซึ่งจะได้รับการแจ้งเตือนหากการติดตามกิจกรรมของคุณถูกยกเลิกเนื่องจากลูกค้าของคุณไม่มีสิทธิ์อ่านข้อมูลนี้ (หรือมีข้อมูลแต่ตอนนี้สูญเสียสิทธิ์แล้ว) Callback นี้จะส่งผ่านออบเจ็กต์ Error ที่ระบุสาเหตุที่เกิดความล้มเหลวขึ้น

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

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

ฟังก์ชันที่สามารถเรียกใช้เพื่อนำ Listener ออก

onChildChanged(คำค้นหา การติดต่อกลับ ตัวเลือก)

คอยฟังการเปลี่ยนแปลงของข้อมูลในตำแหน่งที่เจาะจง

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

เหตุการณ์ onChildChanged จะทริกเกอร์เมื่อข้อมูลที่จัดเก็บไว้ในรายการย่อย (หรือองค์ประกอบย่อยของรายการย่อย) มีการเปลี่ยนแปลง โปรดทราบว่าเหตุการณ์ child_changed รายการเดียวอาจแสดงการเปลี่ยนแปลงหลายรายการที่เกิดขึ้นกับรายการย่อย DataSnapshot ที่ส่งไปยัง Callback จะมีเนื้อหาย่อยใหม่ เพื่อวัตถุประสงค์ด้านการจัดเรียง การเรียกกลับจะส่งผ่านอาร์กิวเมนต์ที่ 2 ซึ่งเป็นสตริงที่มีคีย์รายการย่อยก่อนหน้าตามลำดับการจัดเรียง หรือ null หากเป็นอาร์กิวเมนต์รายการย่อยรายการแรก

ลายเซ็น:

export declare function onChildChanged(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, options: ListenOptions): Unsubscribe;

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
query คำถาม คำค้นหาที่จะเรียกใช้
Callback (สแนปชอต: DataSnapshot, beforeChildName: string | null) => ไม่รู้จัก Callback ที่เริ่มทำงานเมื่อเหตุการณ์ที่ระบุเกิดขึ้น Callback ระบบจะส่ง DataSnapshot และสตริงที่มีคีย์ของรายการย่อยก่อนหน้าตามลำดับการจัดเรียง หรือ null หากเป็นคีย์ย่อยรายการแรก
ตัวเลือก ตัวเลือกในการฟัง ออบเจ็กต์ที่สามารถใช้กำหนดค่า onlyOnce ซึ่งจะนำ Listener ออกหลังจากการเรียกใช้ครั้งแรก

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

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

ฟังก์ชันที่สามารถเรียกใช้เพื่อนำ Listener ออก

onChildChanged(query, callback, cancelCallback, ตัวเลือก)

คอยฟังการเปลี่ยนแปลงของข้อมูลในตำแหน่งที่เจาะจง

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

เหตุการณ์ onChildChanged จะทริกเกอร์เมื่อข้อมูลที่จัดเก็บไว้ในรายการย่อย (หรือองค์ประกอบย่อยของรายการย่อย) มีการเปลี่ยนแปลง โปรดทราบว่าเหตุการณ์ child_changed รายการเดียวอาจแสดงการเปลี่ยนแปลงหลายรายการที่เกิดขึ้นกับรายการย่อย DataSnapshot ที่ส่งไปยัง Callback จะมีเนื้อหาย่อยใหม่ เพื่อวัตถุประสงค์ด้านการจัดเรียง การเรียกกลับจะส่งผ่านอาร์กิวเมนต์ที่ 2 ซึ่งเป็นสตริงที่มีคีย์รายการย่อยก่อนหน้าตามลำดับการจัดเรียง หรือ null หากเป็นอาร์กิวเมนต์รายการย่อยรายการแรก

ลายเซ็น:

export declare function onChildChanged(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
query คำถาม คำค้นหาที่จะเรียกใช้
Callback (สแนปชอต: DataSnapshot, beforeChildName: string | null) => ไม่รู้จัก Callback ที่เริ่มทำงานเมื่อเหตุการณ์ที่ระบุเกิดขึ้น Callback ระบบจะส่ง DataSnapshot และสตริงที่มีคีย์ของรายการย่อยก่อนหน้าตามลำดับการจัดเรียง หรือ null หากเป็นรายการแรก
ยกเลิก Callback (ข้อผิดพลาด: ข้อผิดพลาด) => ไม่รู้จัก การติดต่อกลับ (ไม่บังคับ) ซึ่งจะได้รับการแจ้งเตือนหากมีการยกเลิกการสมัครใช้บริการกิจกรรมของคุณเนื่องจากลูกค้าไม่มีสิทธิ์อ่านข้อมูลนี้ (หรือลูกค้ามีสิทธิ์แต่ตอนนี้ข้อมูลหายไปแล้ว) Callback นี้จะส่งผ่านออบเจ็กต์ Error ที่ระบุสาเหตุของความล้มเหลวขึ้น
ตัวเลือก ตัวเลือกในการฟัง ออบเจ็กต์ที่สามารถใช้กำหนดค่า onlyOnce ซึ่งจะนำ Listener ออกหลังจากการเรียกใช้ครั้งแรก

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

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

ฟังก์ชันที่สามารถเรียกใช้เพื่อนำ Listener ออก

onChildMoved(การค้นหา, การติดต่อกลับ, ยกเลิก Callback)

คอยฟังการเปลี่ยนแปลงของข้อมูลในตำแหน่งที่เจาะจง

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

ระบบจะทริกเกอร์เหตุการณ์ onChildMoved เมื่อลำดับการจัดเรียงของบุตรหลานเปลี่ยนแปลงจนตำแหน่งที่เกี่ยวข้องกับรายการข้างเคียงเปลี่ยนไป DataSnapshot ที่ส่งไปยัง Callback จะเป็นข้อมูลของบุตรหลานที่ย้ายไปแล้ว และจะส่งอาร์กิวเมนต์ที่ 2 ซึ่งเป็นสตริงที่มีคีย์รายการย่อยก่อนหน้าตามลำดับการจัดเรียง หรือ null หากเป็นอาร์กิวเมนต์ย่อยรายการแรก

ลายเซ็น:

export declare function onChildMoved(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
query คำถาม คำค้นหาที่จะเรียกใช้
Callback (สแนปชอต: DataSnapshot, beforeChildName: string | null) => ไม่รู้จัก Callback ที่เริ่มทำงานเมื่อเหตุการณ์ที่ระบุเกิดขึ้น Callback ระบบจะส่ง DataSnapshot และสตริงที่มีคีย์ของรายการย่อยก่อนหน้าตามลำดับการจัดเรียง หรือ null หากเป็นคีย์ย่อยรายการแรก
ยกเลิก Callback (ข้อผิดพลาด: ข้อผิดพลาด) => ไม่รู้จัก การติดต่อกลับ (ไม่บังคับ) ซึ่งจะได้รับการแจ้งเตือนหากการติดตามกิจกรรมของคุณถูกยกเลิกเนื่องจากลูกค้าของคุณไม่มีสิทธิ์อ่านข้อมูลนี้ (หรือมีข้อมูลแต่ตอนนี้สูญเสียสิทธิ์แล้ว) Callback นี้จะส่งผ่านออบเจ็กต์ Error ที่ระบุสาเหตุที่เกิดความล้มเหลวขึ้น

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

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

ฟังก์ชันที่สามารถเรียกใช้เพื่อนำ Listener ออก

onChildMoved(คำค้นหา, Callback, ตัวเลือก)

คอยฟังการเปลี่ยนแปลงของข้อมูลในตำแหน่งที่เจาะจง

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

ระบบจะทริกเกอร์เหตุการณ์ onChildMoved เมื่อลำดับการจัดเรียงของบุตรหลานเปลี่ยนแปลงจนตำแหน่งที่เกี่ยวข้องกับรายการข้างเคียงเปลี่ยนไป DataSnapshot ที่ส่งผ่านไปยัง Callback จะเป็นข้อมูลของบุตรหลานที่ย้ายไปแล้ว และจะส่งอาร์กิวเมนต์ที่ 2 ซึ่งเป็นสตริงที่มีคีย์รายการย่อยก่อนหน้าตามลำดับการจัดเรียง หรือ null หากเป็นอาร์กิวเมนต์ย่อยรายการแรก

ลายเซ็น:

export declare function onChildMoved(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, options: ListenOptions): Unsubscribe;

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
query คำถาม คำค้นหาที่จะเรียกใช้
Callback (สแนปชอต: DataSnapshot, beforeChildName: string | null) => ไม่รู้จัก Callback ที่เริ่มทำงานเมื่อเหตุการณ์ที่ระบุเกิดขึ้น Callback ระบบจะส่ง DataSnapshot และสตริงที่มีคีย์ของรายการย่อยก่อนหน้าตามลำดับการจัดเรียง หรือ null หากเป็นคีย์ย่อยรายการแรก
ตัวเลือก ตัวเลือกในการฟัง ออบเจ็กต์ที่สามารถใช้กำหนดค่า onlyOnce ซึ่งจะนำ Listener ออกหลังจากการเรียกใช้ครั้งแรก

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

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

ฟังก์ชันที่สามารถเรียกใช้เพื่อนำ Listener ออก

onChildMoved(การค้นหา, การติดต่อกลับ, ยกเลิก Callback, ตัวเลือก)

คอยฟังการเปลี่ยนแปลงของข้อมูลในตำแหน่งที่เจาะจง

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

ระบบจะทริกเกอร์เหตุการณ์ onChildMoved เมื่อลำดับการจัดเรียงของบุตรหลานเปลี่ยนแปลงจนตำแหน่งที่เกี่ยวข้องกับรายการข้างเคียงเปลี่ยนไป DataSnapshot ที่ส่งไปยัง Callback จะเป็นข้อมูลของบุตรหลานที่ย้ายไปแล้ว และจะส่งอาร์กิวเมนต์ที่ 2 ซึ่งเป็นสตริงที่มีคีย์รายการย่อยก่อนหน้าตามลำดับการจัดเรียง หรือ null หากเป็นอาร์กิวเมนต์ย่อยรายการแรก

ลายเซ็น:

export declare function onChildMoved(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
query คำถาม คำค้นหาที่จะเรียกใช้
Callback (สแนปชอต: DataSnapshot, beforeChildName: string | null) => ไม่รู้จัก Callback ที่เริ่มทำงานเมื่อเหตุการณ์ที่ระบุเกิดขึ้น Callback ระบบจะส่ง DataSnapshot และสตริงที่มีคีย์ของรายการย่อยก่อนหน้าตามลำดับการจัดเรียง หรือ null หากเป็นรายการแรก
ยกเลิก Callback (ข้อผิดพลาด: ข้อผิดพลาด) => ไม่รู้จัก การติดต่อกลับ (ไม่บังคับ) ซึ่งจะได้รับการแจ้งเตือนหากมีการยกเลิกการสมัครใช้บริการกิจกรรมของคุณเนื่องจากลูกค้าไม่มีสิทธิ์อ่านข้อมูลนี้ (หรือลูกค้ามีสิทธิ์แต่ตอนนี้ข้อมูลหายไปแล้ว) Callback นี้จะส่งผ่านออบเจ็กต์ Error ที่ระบุสาเหตุของความล้มเหลวขึ้น
ตัวเลือก ตัวเลือกในการฟัง ออบเจ็กต์ที่สามารถใช้กำหนดค่า onlyOnce ซึ่งจะนำ Listener ออกหลังจากการเรียกใช้ครั้งแรก

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

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

ฟังก์ชันที่สามารถเรียกใช้เพื่อนำ Listener ออก

onChildRemoved(คำค้นหา, callback, cancelCallback)

คอยฟังการเปลี่ยนแปลงของข้อมูลในตำแหน่งที่เจาะจง

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

ระบบจะทริกเกอร์เหตุการณ์ onChildRemoved ทุกครั้งที่นำเด็กออก DataSnapshot ที่ส่งผ่านไปยัง Callback จะเป็นข้อมูลเก่าสำหรับบุตรหลานที่ถูกนำออก ระบบจะนำรายการย่อยออกในกรณีต่อไปนี้

  • ลูกค้าเรียก remove() อย่างชัดเจนในบัญชีย่อยหรือระดับบนของผลิตภัณฑ์ย่อยดังกล่าว โดยไคลเอ็นต์เรียก set(null) บนรายการย่อยหรือระดับบนของบัญชีย่อยนั้น บัญชีย่อยดังกล่าวมีการนำรายการย่อยทั้งหมดออก มีคำค้นหาที่ตอนนี้กรองรายการย่อยออก (เนื่องจากมีการเปลี่ยนแปลงลำดับการจัดเรียงหรือถึงขีดจำกัดสูงสุด)

ลายเซ็น:

export declare function onChildRemoved(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
query คำถาม คำค้นหาที่จะเรียกใช้
Callback (สแนปชอต: DataSnapshot) => ไม่รู้จัก Callback ที่เริ่มทำงานเมื่อเหตุการณ์ที่ระบุเกิดขึ้น Callback ระบบจะส่ง DataSnapshot และสตริงที่มีคีย์ของรายการย่อยก่อนหน้าตามลำดับการจัดเรียง หรือ null หากเป็นรายการแรก
ยกเลิก Callback (ข้อผิดพลาด: ข้อผิดพลาด) => ไม่รู้จัก การติดต่อกลับ (ไม่บังคับ) ซึ่งจะได้รับการแจ้งเตือนหากการติดตามกิจกรรมของคุณถูกยกเลิกเนื่องจากลูกค้าของคุณไม่มีสิทธิ์อ่านข้อมูลนี้ (หรือมีข้อมูลแต่ตอนนี้สูญเสียสิทธิ์แล้ว) Callback นี้จะส่งผ่านออบเจ็กต์ Error ที่ระบุสาเหตุที่เกิดความล้มเหลวขึ้น

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

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

ฟังก์ชันที่สามารถเรียกใช้เพื่อนำ Listener ออก

onChildRemoved(คำค้นหา การติดต่อกลับ ตัวเลือก)

คอยฟังการเปลี่ยนแปลงของข้อมูลในตำแหน่งที่เจาะจง

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

ระบบจะทริกเกอร์เหตุการณ์ onChildRemoved ทุกครั้งที่นำเด็กออก DataSnapshot ที่ส่งผ่านไปยัง Callback จะเป็นข้อมูลเก่าสำหรับบุตรหลานที่ถูกนำออก ระบบจะนำรายการย่อยออกในกรณีต่อไปนี้

  • ลูกค้าเรียก remove() อย่างชัดเจนในบัญชีย่อยหรือระดับบนของผลิตภัณฑ์ย่อยดังกล่าว โดยไคลเอ็นต์เรียก set(null) บนรายการย่อยหรือระดับบนของบัญชีย่อยนั้น บัญชีย่อยดังกล่าวมีการนำรายการย่อยทั้งหมดออก มีคำค้นหาที่ตอนนี้กรองรายการย่อยออก (เนื่องจากมีการเปลี่ยนแปลงลำดับการจัดเรียงหรือถึงขีดจำกัดสูงสุด)

ลายเซ็น:

export declare function onChildRemoved(query: Query, callback: (snapshot: DataSnapshot) => unknown, options: ListenOptions): Unsubscribe;

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
query คำถาม คำค้นหาที่จะเรียกใช้
Callback (สแนปชอต: DataSnapshot) => ไม่รู้จัก Callback ที่เริ่มทำงานเมื่อเหตุการณ์ที่ระบุเกิดขึ้น Callback ระบบจะส่ง DataSnapshot และสตริงที่มีคีย์ของรายการย่อยก่อนหน้าตามลำดับการจัดเรียง หรือ null หากเป็นรายการแรก
ตัวเลือก ตัวเลือกในการฟัง ออบเจ็กต์ที่สามารถใช้กำหนดค่า onlyOnce ซึ่งจะนำ Listener ออกหลังจากการเรียกใช้ครั้งแรก

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

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

ฟังก์ชันที่สามารถเรียกใช้เพื่อนำ Listener ออก

onChildRemoved(คำค้นหา, callback, cancelCallback, ตัวเลือก)

คอยฟังการเปลี่ยนแปลงของข้อมูลในตำแหน่งที่เจาะจง

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

ระบบจะทริกเกอร์เหตุการณ์ onChildRemoved ทุกครั้งที่นำเด็กออก DataSnapshot ที่ส่งผ่านไปยัง Callback จะเป็นข้อมูลเก่าสำหรับบุตรหลานที่ถูกนำออก ระบบจะนำรายการย่อยออกในกรณีต่อไปนี้

  • ลูกค้าเรียก remove() อย่างชัดเจนในบัญชีย่อยหรือระดับบนของผลิตภัณฑ์ย่อยดังกล่าว โดยไคลเอ็นต์เรียก set(null) บนรายการย่อยหรือระดับบนของบัญชีย่อยนั้น บัญชีย่อยดังกล่าวมีการนำรายการย่อยทั้งหมดออก มีคำค้นหาที่ตอนนี้กรองรายการย่อยออก (เนื่องจากมีการเปลี่ยนแปลงลำดับการจัดเรียงหรือถึงขีดจำกัดสูงสุด)

ลายเซ็น:

export declare function onChildRemoved(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
query คำถาม คำค้นหาที่จะเรียกใช้
Callback (สแนปชอต: DataSnapshot) => ไม่รู้จัก Callback ที่เริ่มทำงานเมื่อเหตุการณ์ที่ระบุเกิดขึ้น Callback ระบบจะส่ง DataSnapshot และสตริงที่มีคีย์ของรายการย่อยก่อนหน้าตามลำดับการจัดเรียง หรือ null หากเป็นคีย์ย่อยรายการแรก
ยกเลิก Callback (ข้อผิดพลาด: ข้อผิดพลาด) => ไม่รู้จัก การติดต่อกลับ (ไม่บังคับ) ซึ่งจะได้รับการแจ้งเตือนหากมีการยกเลิกการสมัครใช้บริการกิจกรรมของคุณเนื่องจากลูกค้าไม่มีสิทธิ์อ่านข้อมูลนี้ (หรือลูกค้ามีสิทธิ์แต่ตอนนี้ข้อมูลหายไปแล้ว) Callback นี้จะส่งผ่านออบเจ็กต์ Error ที่ระบุสาเหตุของความล้มเหลวขึ้น
ตัวเลือก ตัวเลือกในการฟัง ออบเจ็กต์ที่สามารถใช้กำหนดค่า onlyOnce ซึ่งจะนำ Listener ออกหลังจากการเรียกใช้ครั้งแรก

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

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

ฟังก์ชันที่สามารถเรียกใช้เพื่อนำ Listener ออก

onValue(query, callback, cancelCallback)

คอยฟังการเปลี่ยนแปลงของข้อมูลในตำแหน่งที่เจาะจง

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

เหตุการณ์ onValue จะทริกเกอร์ 1 ครั้งโดยมีข้อมูลเบื้องต้นที่จัดเก็บไว้ในตำแหน่งนี้ แล้วทริกเกอร์อีกครั้งทุกครั้งที่ข้อมูลมีการเปลี่ยนแปลง DataSnapshot ที่ส่งไปยัง Callback จะเป็นตำแหน่งที่มีการเรียกใช้ on() ทริกเกอร์ดังกล่าวจะไม่ทริกเกอร์จนกว่าจะมีการซิงค์เนื้อหาทั้งหมด หากสถานที่ไม่มีข้อมูล ระบบจะเรียกให้แสดงด้วย DataSnapshot ที่ว่างเปล่า (val() จะแสดงผล null)

ลายเซ็น:

export declare function onValue(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
query คำถาม คำค้นหาที่จะเรียกใช้
Callback (สแนปชอต: DataSnapshot) => ไม่รู้จัก Callback ที่เริ่มทำงานเมื่อเหตุการณ์ที่ระบุเกิดขึ้น ระบบจะส่ง Callback ผ่าน DataSnapshot
ยกเลิกการโทรกลับ (ข้อผิดพลาด: ข้อผิดพลาด) => ไม่รู้จัก การติดต่อกลับ (ไม่บังคับ) ซึ่งจะได้รับการแจ้งเตือนหากการติดตามกิจกรรมของคุณถูกยกเลิกเนื่องจากลูกค้าของคุณไม่มีสิทธิ์อ่านข้อมูลนี้ (หรือมีข้อมูลแต่ตอนนี้สูญเสียสิทธิ์แล้ว) Callback นี้จะส่งผ่านออบเจ็กต์ Error ที่ระบุสาเหตุที่เกิดความล้มเหลวขึ้น

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

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

ฟังก์ชันที่สามารถเรียกใช้เพื่อนำ Listener ออก

onValue(ข้อความค้นหา, callback, ตัวเลือก)

คอยฟังการเปลี่ยนแปลงของข้อมูลในตำแหน่งที่เจาะจง

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

เหตุการณ์ onValue จะทริกเกอร์ 1 ครั้งโดยมีข้อมูลเบื้องต้นที่จัดเก็บไว้ในตำแหน่งนี้ แล้วทริกเกอร์อีกครั้งทุกครั้งที่ข้อมูลมีการเปลี่ยนแปลง DataSnapshot ที่ส่งไปยัง Callback จะเป็นตำแหน่งที่มีการเรียกใช้ on() เนื้อหาจะไม่ทริกเกอร์จนกว่าจะมีการซิงค์เนื้อหาทั้งหมด หากสถานที่ไม่มีข้อมูล ระบบจะเรียกให้แสดงด้วย DataSnapshot ที่ว่างเปล่า (val() จะแสดงผล null)

ลายเซ็น:

export declare function onValue(query: Query, callback: (snapshot: DataSnapshot) => unknown, options: ListenOptions): Unsubscribe;

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
query คำถาม คำค้นหาที่จะเรียกใช้
Callback (สแนปชอต: DataSnapshot) => ไม่รู้จัก Callback ที่เริ่มทำงานเมื่อเหตุการณ์ที่ระบุเกิดขึ้น ระบบจะส่ง Callback ผ่าน DataSnapshot
ตัวเลือก ตัวเลือกในการฟัง ออบเจ็กต์ที่สามารถใช้กำหนดค่า onlyOnce ซึ่งจะนำ Listener ออกหลังจากการเรียกใช้ครั้งแรก

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

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

ฟังก์ชันที่สามารถเรียกใช้เพื่อนำ Listener ออก

onValue(query, callback, cancelCallback, options)

คอยฟังการเปลี่ยนแปลงของข้อมูลในตำแหน่งที่เจาะจง

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

เหตุการณ์ onValue จะทริกเกอร์ 1 ครั้งโดยมีข้อมูลเบื้องต้นที่จัดเก็บไว้ในตำแหน่งนี้ แล้วทริกเกอร์อีกครั้งทุกครั้งที่ข้อมูลมีการเปลี่ยนแปลง DataSnapshot ที่ส่งไปยัง Callback จะเป็นตำแหน่งที่มีการเรียกใช้ on() เนื้อหาจะไม่ทริกเกอร์จนกว่าจะมีการซิงค์เนื้อหาทั้งหมด หากสถานที่ไม่มีข้อมูล ระบบจะเรียกให้แสดงด้วย DataSnapshot ที่ว่างเปล่า (val() จะแสดงผล null)

ลายเซ็น:

export declare function onValue(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
query คำถาม คำค้นหาที่จะเรียกใช้
Callback (สแนปชอต: DataSnapshot) => ไม่รู้จัก Callback ที่เริ่มทำงานเมื่อเหตุการณ์ที่ระบุเกิดขึ้น ระบบจะส่ง Callback ผ่าน DataSnapshot
ยกเลิกการโทรกลับ (ข้อผิดพลาด: ข้อผิดพลาด) => ไม่รู้จัก การติดต่อกลับ (ไม่บังคับ) ซึ่งจะได้รับการแจ้งเตือนหากมีการยกเลิกการสมัครใช้บริการกิจกรรมของคุณเนื่องจากลูกค้าไม่มีสิทธิ์อ่านข้อมูลนี้ (หรือลูกค้ามีสิทธิ์แต่ตอนนี้ข้อมูลหายไปแล้ว) Callback นี้จะส่งผ่านออบเจ็กต์ Error ที่ระบุสาเหตุของความล้มเหลวขึ้น
ตัวเลือก ตัวเลือกในการฟัง ออบเจ็กต์ที่สามารถใช้กำหนดค่า onlyOnce ซึ่งจะนำ Listener ออกหลังจากการเรียกใช้ครั้งแรก

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

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

ฟังก์ชันที่สามารถเรียกใช้เพื่อนำ Listener ออก

query(query, queryConstraints)

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

ลายเซ็น:

export declare function query(query: Query, ...queryConstraints: QueryConstraint[]): Query;

พารามิเตอร์

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

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

คำถาม

ข้อยกเว้น

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

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

เมื่อยกเลิกการเชื่อมต่อ(อ้างอิง)

แสดงผลออบเจ็กต์ OnDisconnect - ดูรายละเอียดวิธีใช้ได้ที่การเปิดใช้งานความสามารถแบบออฟไลน์ใน JavaScript

ลายเซ็น:

export declare function onDisconnect(ref: DatabaseReference): OnDisconnect;

พารามิเตอร์

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

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

เมื่อยกเลิกการเชื่อมต่อ

นำออก(อ้างอิง)

นำข้อมูลในตำแหน่งฐานข้อมูลนี้ออก

ข้อมูลทั้งหมดในสถานที่ตั้งย่อยจะถูกลบด้วย

ผลของการนำออกจะแสดงทันที และ "value" ของเหตุการณ์ที่เกี่ยวข้อง จะถูกเรียกใช้ ระบบจะเริ่มซิงค์ข้อมูลรายการที่ลบไปยังเซิร์ฟเวอร์ Firebase ด้วย และ "สัญญา" ที่ส่งกลับมาจะแก้ไขเมื่อเสร็จสมบูรณ์ หากมี ระบบจะเรียกใช้ Callback onComplete แบบไม่พร้อมกันหลังจากการซิงค์เสร็จสิ้น

ลายเซ็น:

export declare function remove(ref: DatabaseReference): Promise<void>;

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
อ้างอิง ข้อมูลอ้างอิงฐานข้อมูล ตำแหน่งที่จะนำออก

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

Promise&lt;void&gt;

แก้ไขเมื่อนำออกบนเซิร์ฟเวอร์เสร็จสิ้น

RunTransaction(อ้างอิง, transactionUpdate, ตัวเลือก)

แก้ไขข้อมูลในตำแหน่งนี้โดยอัตโนมัติ

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

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

ลายเซ็น:

export declare function runTransaction(ref: DatabaseReference, transactionUpdate: (currentData: any) => unknown, options?: TransactionOptions): Promise<TransactionResult>;

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
อ้างอิง ข้อมูลอ้างอิงฐานข้อมูล ตำแหน่งที่จะแก้ไขด้วยอะตอม
การอัปเดตธุรกรรม (currentData: any) => ไม่รู้จัก ฟังก์ชันที่นักพัฒนาซอฟต์แวร์มีให้ ซึ่งจะส่งข้อมูลปัจจุบันที่จัดเก็บไว้ในตำแหน่งนี้ (เป็นออบเจ็กต์ JavaScript) ฟังก์ชันควรแสดงผลค่าใหม่ที่ต้องการให้เขียน (เป็นออบเจ็กต์ JavaScript) หากแสดงผล undefined (กล่าวคือ คุณส่งคืนโดยไม่มีอาร์กิวเมนต์) ธุรกรรมจะถูกล้มเลิกและข้อมูลในตำแหน่งนี้จะไม่ถูกแก้ไข
ตัวเลือก ตัวเลือกธุรกรรม ออบเจ็กต์ตัวเลือกเพื่อกำหนดค่าธุรกรรม

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

สัญญา<Transactionผลลัพธ์>

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

ตั้งค่า(อ้างอิง, ค่า)

เขียนข้อมูลไปยังตำแหน่งฐานข้อมูลนี้

การดำเนินการนี้จะเขียนทับข้อมูลในสถานที่นี้และตำแหน่งย่อยทั้งหมด

ผลของการเขียนจะปรากฏทันทีและระบบจะแสดงเหตุการณ์ที่เกี่ยวข้อง ("value", "child_added" ฯลฯ) ระบบจะเริ่มซิงค์ข้อมูลไปยังเซิร์ฟเวอร์ Firebase ด้วย และ Promise ที่แสดงผลจะยุติลงเมื่อเสร็จสมบูรณ์ หากมี ระบบจะเรียก Callback onComplete ว่าไม่พร้อมกันหลังจากการซิงค์เสร็จสิ้นแล้ว

การส่ง null สำหรับค่าใหม่จะเทียบเท่ากับการเรียกใช้ remove() นั่นคือข้อมูลทั้งหมดในตำแหน่งนี้และตำแหน่งย่อยทั้งหมดจะถูกลบ

set() จะนำลำดับความสำคัญที่จัดเก็บไว้ในตำแหน่งนี้ออก ดังนั้นหากต้องเก็บลำดับความสำคัญไว้ คุณจะต้องใช้ setWithPriority() แทน

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

set() เดียวจะสร้าง "ค่า" เดียว ณ สถานที่ที่มีการดำเนินการ set()

ลายเซ็น:

export declare function set(ref: DatabaseReference, value: unknown): Promise<void>;

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
อ้างอิง ข้อมูลอ้างอิงฐานข้อมูล สถานที่ที่จะเขียนอีเมล
value ไม่ทราบ ค่าที่จะเขียน (สตริง ตัวเลข บูลีน ออบเจ็กต์ อาร์เรย์ หรือค่าว่าง)

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

Promise&lt;void&gt;

แก้ไขเมื่อการเขียนไปยังเซิร์ฟเวอร์เสร็จสมบูรณ์

setPriority(อ้างอิง, ลำดับความสำคัญ)

กำหนดลำดับความสำคัญให้กับข้อมูลที่ตำแหน่งฐานข้อมูลนี้

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

ลายเซ็น:

export declare function setPriority(ref: DatabaseReference, priority: string | number | null): Promise<void>;

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
อ้างอิง ข้อมูลอ้างอิงฐานข้อมูล สถานที่ที่จะเขียนถึง
Priority สตริง | ตัวเลข | ค่าว่าง ลำดับความสำคัญที่จะเขียน (สตริง ตัวเลข หรือค่าว่าง)

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

Promise&lt;void&gt;

แก้ไขเมื่อการเขียนไปยังเซิร์ฟเวอร์เสร็จสมบูรณ์

setWithPriority(การอ้างอิง ค่า ลำดับความสำคัญ)

เขียนข้อมูลตำแหน่งฐานข้อมูล เช่นเดียวกับ set() แต่จะระบุลำดับความสำคัญสำหรับข้อมูลนั้นด้วย

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

ลายเซ็น:

export declare function setWithPriority(ref: DatabaseReference, value: unknown, priority: string | number | null): Promise<void>;

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
อ้างอิง ข้อมูลอ้างอิงฐานข้อมูล สถานที่ที่จะเขียนถึง
value ไม่ทราบ ค่าที่จะเขียน (สตริง ตัวเลข บูลีน ออบเจ็กต์ อาร์เรย์ หรือค่าว่าง)
Priority สตริง | ตัวเลข | ค่าว่าง ลำดับความสำคัญที่จะเขียน (สตริง ตัวเลข หรือค่าว่าง)

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

Promise&lt;void&gt;

แก้ไขเมื่อการเขียนไปยังเซิร์ฟเวอร์เสร็จสมบูรณ์

อัปเดต(การอ้างอิง, ค่า)

เขียนค่าหลายค่าไปยังฐานข้อมูลพร้อมกัน

อาร์กิวเมนต์ values มีคู่คุณสมบัติ-ค่าหลายรายการที่จะเขียนลงในฐานข้อมูลร่วมกัน พร็อพเพอร์ตี้ย่อยแต่ละรายการอาจเป็นพร็อพเพอร์ตี้แบบง่าย (เช่น "name") หรือเส้นทางที่เกี่ยวข้อง (เช่น "ชื่อ/ชื่อ") จากตําแหน่งปัจจุบันไปยังข้อมูลที่จะอัปเดต

นอกจากเมธอด set() แล้ว update() สามารถใช้เพื่อเลือกเฉพาะพร็อพเพอร์ตี้ที่อ้างอิงในตำแหน่งปัจจุบันได้ (แทนการแทนที่พร็อพเพอร์ตี้ย่อยทั้งหมดในตำแหน่งปัจจุบัน)

ผลของการเขียนจะปรากฏทันที และเหตุการณ์ที่เกี่ยวข้อง ("value", "child_added" ฯลฯ) จะถูกเรียกใช้ ระบบจะเริ่มซิงค์ข้อมูลไปยังเซิร์ฟเวอร์ Firebase ด้วย และ Promise ที่แสดงผลจะยุติลงเมื่อเสร็จสมบูรณ์ หากมี ระบบจะเรียก Callback onComplete ว่าไม่พร้อมกันหลังจากการซิงค์เสร็จสิ้นแล้ว

update() เดียวจะสร้าง "ค่า" เดียว เหตุการณ์ในสถานที่ที่มีการดำเนินการ update() โดยไม่คำนึงถึงจำนวนเด็กที่ถูกแก้ไข

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

การส่งผ่าน null ไปยัง update() จะนำข้อมูลที่ตำแหน่งนี้ออก

ดูขอแนะนำการอัปเดตสถานที่หลายแห่งและอีกมากมาย

ลายเซ็น:

export declare function update(ref: DatabaseReference, values: object): Promise<void>;

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
อ้างอิง ข้อมูลอ้างอิงฐานข้อมูล สถานที่ที่จะเขียนอีเมล
ค่า ออบเจ็กต์ ออบเจ็กต์ที่มีหลายค่า

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

Promise&lt;void&gt;

แก้ไขเมื่อการอัปเดตในเซิร์ฟเวอร์เสร็จสมบูรณ์

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

endAt(ค่า, คีย์)

สร้าง QueryConstraint ที่มีจุดสิ้นสุดที่ระบุ

การใช้ startAt(), startAfter(), endBefore(), endAt() และ equalTo() จะช่วยให้คุณสามารถเลือกจุดเริ่มต้นและจุดสิ้นสุดที่ปรับแต่งได้สำหรับการค้นหาของคุณ

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

อ่านเพิ่มเติมเกี่ยวกับ endAt() ได้ในการกรองข้อมูล

ลายเซ็น:

export declare function endAt(value: number | string | boolean | null, key?: string): QueryConstraint;

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
value ตัวเลข | สตริง | บูลีน | ค่าว่าง ค่าที่จะสิ้นสุด ประเภทอาร์กิวเมนต์ขึ้นอยู่กับว่ามีการใช้ฟังก์ชัน orderBy() ใดในการค้นหานี้ ระบุค่าที่ตรงกับประเภท orderBy() เมื่อใช้ร่วมกับ orderByKey() ค่าจะต้องเป็นสตริง
แป้น สตริง คีย์ย่อยที่จะสิ้นสุดในกลุ่มรายการย่อยที่มีลำดับความสำคัญที่ระบุไว้ก่อนหน้านี้ อาร์กิวเมนต์นี้จะใช้ได้ก็ต่อเมื่อเรียงลำดับตามรายการย่อย ค่า หรือลำดับความสำคัญ

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

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

endbefore(ค่า, คีย์)

สร้าง QueryConstraint ที่มีจุดสิ้นสุดที่ระบุ (ไม่รวม)

การใช้ startAt(), startAfter(), endBefore(), endAt() และ equalTo() จะช่วยให้คุณสามารถเลือกจุดเริ่มต้นและจุดสิ้นสุดที่ปรับแต่งได้สำหรับการค้นหาของคุณ

ไม่รวมจุดสิ้นสุด หากระบุเฉพาะค่า ระบบจะรวมรายการย่อยที่มีค่าน้อยกว่าค่าที่ระบุไว้ในการค้นหา หากระบุคีย์แล้ว คีย์ย่อยต้องมีค่าน้อยกว่าหรือเท่ากับค่าที่ระบุและชื่อคีย์น้อยกว่าคีย์ที่ระบุ

ลายเซ็น:

export declare function endBefore(value: number | string | boolean | null, key?: string): QueryConstraint;

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
value ตัวเลข | สตริง | บูลีน | ค่าว่าง ค่าที่จะสิ้นสุดก่อน ประเภทอาร์กิวเมนต์ขึ้นอยู่กับว่ามีการใช้ฟังก์ชัน orderBy() ใดในการค้นหานี้ ระบุค่าที่ตรงกับประเภท orderBy() เมื่อใช้ร่วมกับ orderByKey() ค่าจะต้องเป็นสตริง
แป้น สตริง คีย์ย่อยที่จะสิ้นสุดก่อนในกลุ่มรายการย่อยที่มีลำดับความสำคัญที่ระบุไว้ก่อนหน้านี้ อาร์กิวเมนต์นี้จะใช้ได้ก็ต่อเมื่อเรียงลำดับตามรายการย่อย ค่า หรือลำดับความสำคัญ

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

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

เท่ากับ(ค่า, คีย์)

สร้าง QueryConstraint ที่รวมรายการย่อยที่ตรงกับค่าที่ระบุ

การใช้ startAt(), startAfter(), endBefore(), endAt() และ equalTo() จะช่วยให้คุณสามารถเลือกจุดเริ่มต้นและจุดสิ้นสุดที่ปรับแต่งได้สำหรับการค้นหาของคุณ

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

อ่านเพิ่มเติมเกี่ยวกับ equalTo() ได้ในการกรองข้อมูล

ลายเซ็น:

export declare function equalTo(value: number | string | boolean | null, key?: string): QueryConstraint;

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
value ตัวเลข | สตริง | บูลีน | ค่าว่าง ค่าที่จะจับคู่กับ ประเภทอาร์กิวเมนต์ขึ้นอยู่กับว่ามีการใช้ฟังก์ชัน orderBy() ใดในการค้นหานี้ ระบุค่าที่ตรงกับประเภท orderBy() เมื่อใช้ร่วมกับ orderByKey() ค่าจะต้องเป็นสตริง
แป้น สตริง คีย์ย่อยที่จะเริ่มต้นในกลุ่มรายการย่อยที่มีลำดับความสำคัญที่ระบุไว้ก่อนหน้านี้ อาร์กิวเมนต์นี้จะใช้ได้ก็ต่อเมื่อเรียงลำดับตามรายการย่อย ค่า หรือลำดับความสำคัญ

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

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

StartAfter(ค่า, คีย์)

สร้าง QueryConstraint ที่มีจุดเริ่มต้นที่ระบุ (ไม่รวม)

การใช้ startAt(), startAfter(), endBefore(), endAt() และ equalTo() จะช่วยให้คุณสามารถเลือกจุดเริ่มต้นและจุดสิ้นสุดที่ปรับแต่งได้สำหรับการค้นหาของคุณ

จุดเริ่มต้นนี้ไม่เกี่ยวข้องกับ หากระบุเฉพาะค่า ระบบจะรวมรายการย่อยที่มีค่ามากกว่าค่าที่ระบุไว้ในการค้นหา หากระบุคีย์แล้ว คีย์ย่อยต้องมีค่ามากกว่าหรือเท่ากับค่าที่ระบุและมีชื่อคีย์มากกว่าคีย์ที่ระบุ

ลายเซ็น:

export declare function startAfter(value: number | string | boolean | null, key?: string): QueryConstraint;

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
value ตัวเลข | สตริง | บูลีน | ค่าว่าง ค่าที่จะเริ่มต้นหลังจาก ประเภทอาร์กิวเมนต์ขึ้นอยู่กับว่ามีการใช้ฟังก์ชัน orderBy() ใดในการค้นหานี้ ระบุค่าที่ตรงกับประเภท orderBy() เมื่อใช้ร่วมกับ orderByKey() ค่าจะต้องเป็นสตริง
แป้น สตริง คีย์ย่อยที่จะเริ่มต้นหลังจากนั้น อาร์กิวเมนต์นี้จะใช้ได้ก็ต่อเมื่อเรียงลำดับตามรายการย่อย ค่า หรือลำดับความสำคัญ

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

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

StartAt(ค่า, คีย์)

สร้าง QueryConstraint ที่มีจุดเริ่มต้นที่ระบุ

การใช้ startAt(), startAfter(), endBefore(), endAt() และ equalTo() จะช่วยให้คุณสามารถเลือกจุดเริ่มต้นและจุดสิ้นสุดที่ปรับแต่งได้สำหรับการค้นหาของคุณ

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

อ่านเพิ่มเติมเกี่ยวกับ startAt() ได้ในการกรองข้อมูล

ลายเซ็น:

export declare function startAt(value?: number | string | boolean | null, key?: string): QueryConstraint;

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
value ตัวเลข | สตริง | บูลีน | ค่าว่าง ค่าที่จะเริ่มต้น ประเภทอาร์กิวเมนต์ขึ้นอยู่กับว่ามีการใช้ฟังก์ชัน orderBy() ใดในการค้นหานี้ ระบุค่าที่ตรงกับประเภท orderBy() เมื่อใช้ร่วมกับ orderByKey() ค่าจะต้องเป็นสตริง
แป้น สตริง คีย์ย่อยที่จะเริ่มต้น อาร์กิวเมนต์นี้จะใช้ได้ก็ต่อเมื่อเรียงลำดับตามรายการย่อย ค่า หรือลำดับความสำคัญ

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

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

ประเภทเหตุการณ์

สตริงใดสตริงหนึ่งต่อไปนี้ ได้แก่ "value", "child_added", "child_changed", "child_นำออกแล้ว" หรือ "child_moved"

ลายเซ็น:

export declare type EventType = 'value' | 'child_added' | 'child_changed' | 'child_moved' | 'child_removed';

QueryConstraintType

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

ลายเซ็น:

export declare type QueryConstraintType = 'endAt' | 'endBefore' | 'startAt' | 'startAfter' | 'limitToFirst' | 'limitToLast' | 'orderByChild' | 'orderByKey' | 'orderByPriority' | 'orderByValue' | 'equalTo';

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

Callback ที่สามารถเรียกใช้เพื่อนำ Listener ออก

ลายเซ็น:

export declare type Unsubscribe = () => void;