Watch demos on how to build & run AI-powered apps with Firebase at Demo Day '24. Watch now.

דף זה תורגם על ידי Cloud Translation API.

database package

מסד נתונים בזמן אמת של Firebase

פונקציות

פוּנקצִיָה	תיאור
פונקציה (אפליקציה,...)
getDatabase(אפליקציה, url)	מחזירה את המופע של Realtime Database SDK המשויך ל- FirebaseApp שסופק . מאתחל מופע חדש עם הגדרות ברירת מחדל אם לא קיים מופע או אם המופע הקיים משתמש בכתובת אתר מותאמת אישית של מסד נתונים.
function(db,...)
connectDatabaseEmulator(db, host, port, options)	שנה את המופע שסופק כדי לתקשר עם אמולטור מסד הנתונים בזמן אמת. הערה: יש לקרוא לשיטה זו לפני ביצוע כל פעולה אחרת.
goOffline(db)	מתנתק מהשרת (כל פעולות מסד הנתונים יושלמו במצב לא מקוון). הלקוח שומר אוטומטית על חיבור מתמשך לשרת מסד הנתונים, שיישאר פעיל ללא הגבלת זמן ויתחבר מחדש לאחר ניתוק. עם זאת, ניתן להשתמש בשיטות `goOffline()` ו- `goOnline()` כדי לשלוט בחיבור הלקוח במקרים בהם חיבור מתמשך אינו רצוי. במצב לא מקוון, הלקוח לא יקבל עוד עדכוני נתונים ממסד הנתונים. עם זאת, כל פעולות מסד הנתונים המבוצעות באופן מקומי ימשיכו להפעיל אירועים מיידיים, מה שיאפשר לאפליקציה שלך להמשיך להתנהג כרגיל. בנוסף, כל פעולה המבוצעת באופן מקומי תוצב אוטומטית בתור ותנסה מחדש עם חיבור מחדש לשרת מסד הנתונים. כדי להתחבר מחדש למסד הנתונים ולהתחיל לקבל אירועים מרוחקים, ראה `goOnline()` .
goOnline(db)	מתחבר מחדש לשרת ומסנכרן את מצב מסד הנתונים הלא מקוון עם מצב השרת. יש להשתמש בשיטה זו לאחר השבתת החיבור הפעיל עם `goOffline()` . לאחר חיבור מחדש, הלקוח ישדר את הנתונים המתאימים ויפעיל את האירועים המתאימים כך שהלקוח שלך "יתפוס" אוטומטית.
ref(db, path)	מחזירה `Reference` המייצגת את המיקום במסד הנתונים המתאים לנתיב שסופק. אם לא מסופק נתיב, `Reference` תצביע על השורש של מסד הנתונים.
refFromURL(db, url)	מחזירה `Reference` המייצגת את המיקום במסד הנתונים התואם לכתובת ה-URL של Firebase. יוצאת חריגה אם כתובת האתר אינה כתובת אתר חוקית של מסד נתונים של Firebase או שיש לה דומיין שונה מהמופע הנוכחי `Database` . שים לב שכל פרמטרי השאילתה ( `orderBy` , `limitToLast` וכו') מתעלמים ואינם מוחלים על ה- `Reference` המוחזר.
פוּנקצִיָה()
forceLongPolling()	כפה את השימוש ב-longPolling במקום ב-websockets. תתעלם מכך אם נעשה שימוש בפרוטוקול websocket ב-URL של מסד הנתונים.
forceWebSockets()	כפה את השימוש ב-websockets במקום longPolling.
orderByKey()	יוצר `QueryConstraint` חדש שמסדר לפי המפתח. ממיין את התוצאות של שאילתה לפי ערכי המפתח (העולים) שלהן. תוכל לקרוא עוד על `orderByKey()` במיון נתונים .
orderByPriority()	יוצר `QueryConstraint` חדש שמסדר לפי עדיפות. יישומים אינם צריכים להשתמש בעדיפות, אך הם יכולים להזמין אוספים לפי מאפיינים רגילים (ראה מיון נתונים לחלופות לעדיפות.
orderByValue()	יוצר `QueryConstraint` חדש שמסדר לפי ערך. אם הילדים של שאילתה הם כולם ערכים סקלאריים (מחרוזת, מספר או בוליאני), תוכל לסדר את התוצאות לפי הערכים (העולים). אתה יכול לקרוא עוד על `orderByValue()` במיון נתונים .
serverTimestamp()	מחזירה ערך מציין מיקום לאכלוס אוטומטי של חותמת הזמן הנוכחית (זמן מאז עידן Unix, באלפיות שניות) כפי שנקבע על ידי שרתי Firebase.
פונקציה (דלתא, ...)
increment(delta)	מחזירה ערך מציין מיקום שניתן להשתמש בו כדי להגדיל באופן אטומי את ערך מסד הנתונים הנוכחי בדלתא שסופקה.
פונקציה (מופעלת, ...)
enableLogging (מופעל, מתמשך)	רושם מידע על ניפוי באגים לקונסולה.
פונקציה (מגבלה,...)
limitToFirst(limit)	יוצר `QueryConstraint` חדש שאם מוגבל למספר הספציפי הראשון של ילדים. השיטה `limitToFirst()` משמשת כדי להגדיר מספר מקסימלי של ילדים שיסונכרנו עבור התקשרות חוזרת נתונה. אם נגדיר מגבלה של 100, נקבל בהתחלה רק עד 100 אירועים `child_added` . אם יש לנו פחות מ-100 הודעות המאוחסנות במסד הנתונים שלנו, אירוע `child_added` יופעל עבור כל הודעה. עם זאת, אם יש לנו יותר מ-100 הודעות, נקבל אירוע `child_added` רק עבור 100 ההודעות הראשונות שהוזמנו. ככל שהפריטים משתנים, נקבל אירועי `child_removed` עבור כל פריט שיוצא מהרשימה הפעילה כך שהמספר הכולל יישאר על 100. אתה יכול לקרוא עוד על `limitToFirst()` בסינון נתונים .
limitToLast(limit)	יוצר `QueryConstraint` חדש שמוגבל להחזיר רק את המספר האחרון שצוין של ילדים. השיטה `limitToLast()` משמשת כדי להגדיר מספר מקסימלי של ילדים שיסונכרנו עבור התקשרות חוזרת נתונה. אם נגדיר מגבלה של 100, נקבל בהתחלה רק עד 100 אירועים `child_added` . אם יש לנו פחות מ-100 הודעות המאוחסנות במסד הנתונים שלנו, אירוע `child_added` יופעל עבור כל הודעה. עם זאת, אם יש לנו יותר מ-100 הודעות, נקבל אירוע `child_added` רק עבור 100 ההודעות האחרונות שהוזמנו. ככל שהפריטים משתנים, נקבל אירועי `child_removed` עבור כל פריט שיוצא מהרשימה הפעילה כך שהמספר הכולל יישאר על 100. אתה יכול לקרוא עוד על `limitToLast()` בסינון נתונים .
פונקציה (לוגר, ...)
enableLogging(logger)	רושם מידע על ניפוי באגים לקונסולה.
פונקציה (הורה, ...)
ילד (הורה, נתיב)	מקבל `Reference` עבור המיקום בנתיב היחסי שצוין. הנתיב היחסי יכול להיות שם צאצא פשוט (לדוגמה, "ada") או נתיב עמוק יותר מופרד באלכסון (לדוגמה, "ada/name/first").
push (הורה, ערך)	יוצר מיקום צאצא חדש באמצעות מפתח ייחודי ומחזיר את `Reference` שלו. זהו הדפוס הנפוץ ביותר להוספת נתונים לאוסף של פריטים. אם אתה מספק ערך ל- `push()` , הערך נכתב למיקום שנוצר. אם לא תעביר ערך, שום דבר לא נכתב למסד הנתונים והילד נשאר ריק (אבל אתה יכול להשתמש ב- `Reference` במקום אחר). המפתחות הייחודיים שנוצרו על ידי `push()` מסודרים לפי השעה הנוכחית, כך שרשימת הפריטים המתקבלת ממוינת באופן כרונולוגי. המפתחות מתוכננים גם כך שלא ניתן לנחש (הם מכילים 72 סיביות אקראיות של אנטרופיה). ראה הוסף לרשימת נתונים . ראה את 2^120 הדרכים להבטיח מזהים ייחודיים .
פונקציה (נתיב,...)
orderByChild(נתיב)	יוצר `QueryConstraint` חדש שמסדר לפי מפתח הצאצא שצוין. שאילתות יכולות להזמין רק לפי מפתח אחד בכל פעם. קריאה ל- `orderByChild()` מספר פעמים באותה שאילתה היא שגיאה. שאילתות Firebase מאפשרות לך לסדר את הנתונים שלך לפי כל מפתח צאצא תוך כדי תנועה. עם זאת, אם אתה יודע מראש מה יהיו האינדקסים שלך, אתה יכול להגדיר אותם באמצעות כלל .indexOn בכללי האבטחה שלך לביצועים טובים יותר. ראה https://firebase.google.com/docs/database/security/indexing-data כלל למידע נוסף. תוכל לקרוא עוד על `orderByChild()` במיון נתונים .
פונקציה (שאילתה,...)
קבל (שאילתה)	מקבל את התוצאה המעודכנת ביותר עבור שאילתה זו.
off(שאילתה, eventType, callback)	מנתקת התקשרות חוזרת שצורפה בעבר עם המאזין `on ()` ( `onValue` , `onChildAdded` ) המקביל. הערה: זו לא הדרך המומלצת להסיר מאזין. במקום זאת, אנא השתמש בפונקציית ההתקשרות החוזרת מהפונקציה `on` להתקשרות חוזרת. נתק התקשרות חוזרת שצורפה בעבר עם `on*()` . קריאה `off()` במאזין אב לא תסיר אוטומטית מאזינים הרשומים בצמתי צאצא, יש לקרוא `off()` גם בכל מאזין צאצא כדי להסיר את ההתקשרות חזרה. אם לא צוין התקשרות חוזרת, כל ההתקשרות לאחור עבור EventType שצוין יוסרו. באופן דומה, אם לא צוין eventType, כל ההתקשרות לאחור עבור ה- `Reference` יוסרו. ניתן להסיר מאזינים בודדים גם על ידי הפעלת התקשרות חוזרת לביטול הרישום שלהם.
onChildAdded(שאילתה, התקשרות חוזרת, ביטול התקשרות חוזרת)	מקשיב לשינויים בנתונים במיקום מסוים. זוהי הדרך העיקרית לקרוא נתונים ממסד נתונים. ההתקשרות חזרה שלך תופעל עבור הנתונים הראשוניים ושוב בכל פעם שהנתונים משתנים. הפעל את ההתקשרות חזרה לביטול הרישום כדי להפסיק לקבל עדכונים. ראה אחזור נתונים באינטרנט לפרטים נוספים. אירוע `onChildAdded` יופעל פעם אחת עבור כל ילד ראשוני במיקום זה, והוא יופעל שוב בכל פעם שמתווסף ילד חדש. תמונת ה- `DataSnapshot` שהועברה להתקשרות חזרה תשקף את הנתונים עבור הילד הרלוונטי. למטרות הזמנה, הוא מועבר ארגומנט שני שהוא מחרוזת המכילה את המפתח של הילד האח הקודם לפי סדר מיון, או `null` אם זה הילד הראשון.
onChildAdded(שאילתה, התקשרות חוזרת, אפשרויות)	מקשיב לשינויים בנתונים במיקום מסוים. זוהי הדרך העיקרית לקרוא נתונים ממסד נתונים. ההתקשרות חזרה שלך תופעל עבור הנתונים הראשוניים ושוב בכל פעם שהנתונים משתנים. הפעל את ההתקשרות חזרה לביטול הרישום כדי להפסיק לקבל עדכונים. ראה אחזור נתונים באינטרנט לפרטים נוספים. אירוע `onChildAdded` יופעל פעם אחת עבור כל ילד ראשוני במיקום זה, והוא יופעל שוב בכל פעם שמתווסף ילד חדש. תמונת ה- `DataSnapshot` שהועברה להתקשרות חזרה תשקף את הנתונים עבור הילד הרלוונטי. למטרות הזמנה, הוא מועבר ארגומנט שני שהוא מחרוזת המכילה את המפתח של הילד האח הקודם לפי סדר מיון, או `null` אם זה הילד הראשון.
onChildAdded(שאילתה, התקשרות חוזרת, ביטול התקשרות חוזרת, אפשרויות)	מקשיב לשינויים בנתונים במיקום מסוים. זוהי הדרך העיקרית לקרוא נתונים ממסד נתונים. ההתקשרות חזרה שלך תופעל עבור הנתונים הראשוניים ושוב בכל פעם שהנתונים משתנים. הפעל את ההתקשרות חזרה לביטול הרישום כדי להפסיק לקבל עדכונים. ראה אחזור נתונים באינטרנט לפרטים נוספים. אירוע `onChildAdded` יופעל פעם אחת עבור כל ילד ראשוני במיקום זה, והוא יופעל שוב בכל פעם שמתווסף ילד חדש. תמונת ה- `DataSnapshot` שהועברה להתקשרות חזרה תשקף את הנתונים עבור הילד הרלוונטי. למטרות הזמנה, הוא מועבר ארגומנט שני שהוא מחרוזת המכילה את המפתח של הילד האח הקודם לפי סדר מיון, או `null` אם זה הילד הראשון.
onChildChanged(שאילתה, התקשרות חוזרת, ביטול התקשרות חוזרת)	מקשיב לשינויים בנתונים במיקום מסוים. זוהי הדרך העיקרית לקרוא נתונים ממסד נתונים. ההתקשרות חזרה שלך תופעל עבור הנתונים הראשוניים ושוב בכל פעם שהנתונים משתנים. הפעל את ההתקשרות חזרה לביטול הרישום כדי להפסיק לקבל עדכונים. ראה אחזור נתונים באינטרנט לפרטים נוספים. אירוע `onChildChanged` יופעל כאשר הנתונים המאוחסנים בילד (או בכל אחד מצאצאיו) משתנים. שים לב שאירוע `child_changed` יחיד עשוי לייצג שינויים מרובים לילד. `DataSnapshot` המועברת להתקשרות חוזרת תכיל את תוכן הילד החדש. למטרות הזמנה, ההתקשרות חוזרת מועברת גם ארגומנט שני שהוא מחרוזת המכילה את המפתח של הילד האח הקודם לפי סדר מיון, או `null` אם זה הילד הראשון.
onChildChanged(שאילתה, התקשרות חוזרת, אפשרויות)	מקשיב לשינויים בנתונים במיקום מסוים. זוהי הדרך העיקרית לקרוא נתונים ממסד נתונים. ההתקשרות חזרה שלך תופעל עבור הנתונים הראשוניים ושוב בכל פעם שהנתונים משתנים. הפעל את ההתקשרות חזרה לביטול הרישום כדי להפסיק לקבל עדכונים. ראה אחזור נתונים באינטרנט לפרטים נוספים. אירוע `onChildChanged` יופעל כאשר הנתונים המאוחסנים בילד (או בכל אחד מצאצאיו) משתנים. שים לב שאירוע `child_changed` יחיד עשוי לייצג שינויים מרובים לילד. `DataSnapshot` המועברת להתקשרות חוזרת תכיל את תוכן הילד החדש. למטרות הזמנה, ההתקשרות חוזרת מועברת גם ארגומנט שני שהוא מחרוזת המכילה את המפתח של הילד האח הקודם לפי סדר מיון, או `null` אם זה הילד הראשון.
onChildChanged(שאילתה, התקשרות חוזרת, ביטול התקשרות חוזרת, אפשרויות)	מקשיב לשינויים בנתונים במיקום מסוים. זוהי הדרך העיקרית לקרוא נתונים ממסד נתונים. ההתקשרות חזרה שלך תופעל עבור הנתונים הראשוניים ושוב בכל פעם שהנתונים משתנים. הפעל את ההתקשרות חזרה לביטול הרישום כדי להפסיק לקבל עדכונים. ראה אחזור נתונים באינטרנט לפרטים נוספים. אירוע `onChildChanged` יופעל כאשר הנתונים המאוחסנים בילד (או בכל אחד מצאצאיו) משתנים. שים לב שאירוע `child_changed` יחיד עשוי לייצג שינויים מרובים לילד. `DataSnapshot` המועברת להתקשרות חוזרת תכיל את תוכן הילד החדש. למטרות הזמנה, ההתקשרות חוזרת מועברת גם ארגומנט שני שהוא מחרוזת המכילה את המפתח של הילד האח הקודם לפי סדר מיון, או `null` אם זה הילד הראשון.
onChildMoved(שאילתה, התקשרות חוזרת, ביטול התקשרות חוזרת)	מקשיב לשינויים בנתונים במיקום מסוים. זוהי הדרך העיקרית לקרוא נתונים ממסד נתונים. ההתקשרות חזרה שלך תופעל עבור הנתונים הראשוניים ושוב בכל פעם שהנתונים משתנים. הפעל את ההתקשרות חזרה לביטול הרישום כדי להפסיק לקבל עדכונים. ראה אחזור נתונים באינטרנט לפרטים נוספים. אירוע `onChildMoved` יופעל כאשר סדר המיון של ילד משתנה כך שהמיקום שלו ביחס לאחיו משתנה. ה- `DataSnapshot` שיועבר ל-callback יהיה עבור הנתונים של הילד שעבר. הוא מועבר גם ארגומנט שני שהוא מחרוזת המכילה את המפתח של הילד האח הקודם לפי סדר מיון, או `null` אם זה הילד הראשון.
onChildMoved(שאילתה, התקשרות חוזרת, אפשרויות)	מקשיב לשינויים בנתונים במיקום מסוים. זוהי הדרך העיקרית לקרוא נתונים ממסד נתונים. ההתקשרות חזרה שלך תופעל עבור הנתונים הראשוניים ושוב בכל פעם שהנתונים משתנים. הפעל את ההתקשרות חזרה לביטול הרישום כדי להפסיק לקבל עדכונים. ראה אחזור נתונים באינטרנט לפרטים נוספים. אירוע `onChildMoved` יופעל כאשר סדר המיון של ילד משתנה כך שהמיקום שלו ביחס לאחיו משתנה. ה- `DataSnapshot` שיועבר ל-callback יהיה עבור הנתונים של הילד שעבר. הוא מועבר גם ארגומנט שני שהוא מחרוזת המכילה את המפתח של הילד האח הקודם לפי סדר מיון, או `null` אם זה הילד הראשון.
onChildMoved(שאילתה, התקשרות חוזרת, ביטול התקשרות חוזרת, אפשרויות)	מקשיב לשינויים בנתונים במיקום מסוים. זוהי הדרך העיקרית לקרוא נתונים ממסד נתונים. ההתקשרות חזרה שלך תופעל עבור הנתונים הראשוניים ושוב בכל פעם שהנתונים משתנים. הפעל את ההתקשרות חזרה לביטול הרישום כדי להפסיק לקבל עדכונים. ראה אחזור נתונים באינטרנט לפרטים נוספים. אירוע `onChildMoved` יופעל כאשר סדר המיון של ילד משתנה כך שהמיקום שלו ביחס לאחיו משתנה. ה- `DataSnapshot` שיועבר ל-callback יהיה עבור הנתונים של הילד שעבר. הוא מועבר גם ארגומנט שני שהוא מחרוזת המכילה את המפתח של הילד האח הקודם לפי סדר מיון, או `null` אם זה הילד הראשון.
onChildRemoved(שאילתה, callback, cancelCallback)	מקשיב לשינויים בנתונים במיקום מסוים. זוהי הדרך העיקרית לקרוא נתונים ממסד נתונים. ההתקשרות חזרה שלך תופעל עבור הנתונים הראשוניים ושוב בכל פעם שהנתונים משתנים. הפעל את ההתקשרות חזרה לביטול הרישום כדי להפסיק לקבל עדכונים. ראה אחזור נתונים באינטרנט לפרטים נוספים. אירוע `onChildRemoved` יופעל פעם אחת בכל פעם שילד יוסר. תמונת ה- `DataSnapshot` שתועבר להתקשרות חזרה תהיה הנתונים הישנים של הילד שהוסר. ילד יוסר כאשר אחד מהם: - לקוח קורא במפורש `remove()` על אותו ילד או אחד מאבותיו - לקוח קורא ל- `set(null)` על אותו ילד או אחד מאבותיו - אותו ילד הסיר את כל ילדיו - יש שאילתה בתוקף שכעת מסנן את הילד (מכיוון שסדר המיון שונה או שהמגבלה המקסימלית נפגעה)
onChildRemoved(שאילתה, התקשרות חוזרת, אפשרויות)	מקשיב לשינויים בנתונים במיקום מסוים. זוהי הדרך העיקרית לקרוא נתונים ממסד נתונים. ההתקשרות חזרה שלך תופעל עבור הנתונים הראשוניים ושוב בכל פעם שהנתונים משתנים. הפעל את ההתקשרות חזרה לביטול הרישום כדי להפסיק לקבל עדכונים. ראה אחזור נתונים באינטרנט לפרטים נוספים. אירוע `onChildRemoved` יופעל פעם אחת בכל פעם שילד יוסר. תמונת ה- `DataSnapshot` שתועבר להתקשרות חזרה תהיה הנתונים הישנים של הילד שהוסר. ילד יוסר כאשר אחד מהם: - לקוח קורא במפורש `remove()` על אותו ילד או אחד מאבותיו - לקוח קורא ל- `set(null)` על אותו ילד או אחד מאבותיו - אותו ילד הסיר את כל ילדיו - יש שאילתה בתוקף שכעת מסנן את הילד (מכיוון שסדר המיון שונה או שהמגבלה המקסימלית נפגעה)
onChildRemoved(שאילתה, callback, cancelCallback, options)	מקשיב לשינויים בנתונים במיקום מסוים. זוהי הדרך העיקרית לקרוא נתונים ממסד נתונים. ההתקשרות חזרה שלך תופעל עבור הנתונים הראשוניים ושוב בכל פעם שהנתונים משתנים. הפעל את ההתקשרות חזרה לביטול הרישום כדי להפסיק לקבל עדכונים. ראה אחזור נתונים באינטרנט לפרטים נוספים. אירוע `onChildRemoved` יופעל פעם אחת בכל פעם שילד יוסר. תמונת ה- `DataSnapshot` שתועבר להתקשרות חזרה תהיה הנתונים הישנים של הילד שהוסר. ילד יוסר כאשר אחד מהם: - לקוח קורא במפורש `remove()` על אותו ילד או אחד מאבותיו - לקוח קורא ל- `set(null)` על אותו ילד או אחד מאבותיו - אותו ילד הסיר את כל ילדיו - יש שאילתה בתוקף שכעת מסנן את הילד (מכיוון שסדר המיון שונה או שהמגבלה המקסימלית נפגעה)
onValue(שאילתה, callback, cancelCallback)	מקשיב לשינויים בנתונים במיקום מסוים. זוהי הדרך העיקרית לקרוא נתונים ממסד נתונים. ההתקשרות חזרה שלך תופעל עבור הנתונים הראשוניים ושוב בכל פעם שהנתונים משתנים. הפעל את ההתקשרות חזרה לביטול הרישום כדי להפסיק לקבל עדכונים. ראה אחזור נתונים באינטרנט לפרטים נוספים. אירוע `onValue` יופעל פעם אחת עם הנתונים הראשוניים המאוחסנים במיקום זה, ולאחר מכן יופעל שוב בכל פעם שהנתונים משתנים. ה- `DataSnapshot` שיועבר ל-callback יהיה עבור המיקום שבו נקרא `on()` . זה לא יופעל עד שכל התוכן יסונכרן. אם למיקום אין נתונים, הוא יופעל עם `DataSnapshot` ריק ( `val()` יחזיר `null` ).
onValue(שאילתה, התקשרות חוזרת, אפשרויות)	מקשיב לשינויים בנתונים במיקום מסוים. זוהי הדרך העיקרית לקרוא נתונים ממסד נתונים. ההתקשרות חזרה שלך תופעל עבור הנתונים הראשוניים ושוב בכל פעם שהנתונים משתנים. הפעל את ההתקשרות חזרה לביטול הרישום כדי להפסיק לקבל עדכונים. ראה אחזור נתונים באינטרנט לפרטים נוספים. אירוע `onValue` יופעל פעם אחת עם הנתונים הראשוניים המאוחסנים במיקום זה, ולאחר מכן יופעל שוב בכל פעם שהנתונים משתנים. ה- `DataSnapshot` שיועבר ל-callback יהיה עבור המיקום שבו נקרא `on()` . זה לא יופעל עד שכל התוכן יסונכרן. אם למיקום אין נתונים, הוא יופעל עם `DataSnapshot` ריק ( `val()` יחזיר `null` ).
onValue(שאילתה, התקשרות חוזרת, ביטול התקשרות חוזרת, אפשרויות)	מקשיב לשינויים בנתונים במיקום מסוים. זוהי הדרך העיקרית לקרוא נתונים ממסד נתונים. ההתקשרות חזרה שלך תופעל עבור הנתונים הראשוניים ושוב בכל פעם שהנתונים משתנים. הפעל את ההתקשרות חזרה לביטול הרישום כדי להפסיק לקבל עדכונים. ראה אחזור נתונים באינטרנט לפרטים נוספים. אירוע `onValue` יופעל פעם אחת עם הנתונים הראשוניים המאוחסנים במיקום זה, ולאחר מכן יופעל שוב בכל פעם שהנתונים משתנים. ה- `DataSnapshot` שיועבר ל-callback יהיה עבור המיקום שבו נקרא `on()` . זה לא יופעל עד שכל התוכן יסונכרן. אם למיקום אין נתונים, הוא יופעל עם `DataSnapshot` ריק ( `val()` יחזיר `null` ).
query(query, queryConstraints)	יוצר מופע חדש בלתי ניתן לשינוי של `Query` שמורחב כך שיכלול גם אילוצי שאילתה נוספים.
function (ref, ...)
onDisconnect(ref)	מחזירה אובייקט `OnDisconnect` - ראה הפעלת יכולות לא מקוונות ב-JavaScript למידע נוסף על אופן השימוש בו.
להסיר (ref)	מסיר את הנתונים במיקום מסד נתונים זה. כל נתונים במיקומי ילדים יימחקו גם הם. השפעת ההסרה תהיה גלויה מיידית ו'ערך' האירוע המתאים יופעל. הסנכרון של ההסרה לשרתי Firebase יתחיל גם הוא, וההבטחה המוחזרת תיפתר כאשר תושלם. אם מסופק, ההתקשרות חוזרת onComplete תיקרא באופן אסינכרוני לאחר סיום הסנכרון.
runTransaction(ref, transactionUpdate, options)	משנה באופן אטומי את הנתונים במיקום זה. שנה את הנתונים במיקום זה באופן אטומי. בניגוד ל- `set()` רגיל, שפשוט מחליף את הנתונים ללא קשר לערך הקודם שלו, `runTransaction()` משמש כדי לשנות את הערך הקיים לערך חדש, מה שמבטיח שלא יהיו התנגשויות עם לקוחות אחרים שכותבים לאותו מיקום באותו זמן . כדי להשיג זאת, אתה מעביר את `runTransaction()` פונקציית עדכון המשמשת להפיכת הערך הנוכחי לערך חדש. אם לקוח אחר כותב למיקום לפני שהערך החדש שלך נכתב בהצלחה, פונקציית העדכון שלך תיקרא שוב עם הערך הנוכחי החדש, והכתיבה תבוצע מחדש. זה יקרה שוב ושוב עד שהכתיבה שלך תצליח ללא התנגשות או שתבטל את העסקה על ידי אי החזרת ערך מפונקציית העדכון שלך. הערה: שינוי נתונים עם `set()` יבטל את כל העסקאות הממתינות במיקום זה, לכן יש לנקוט זהירות רבה אם מערבבים `set()` ו- `runTransaction()` כדי לעדכן את אותם נתונים. הערה: בעת שימוש בעסקאות עם כללי אבטחה ו-Firebase, שים לב שלקוח צריך גישת `.read` בנוסף לגשת `.write` כדי לבצע עסקה. הסיבה לכך היא שהאופי של צד הלקוח של העסקאות מחייב את הלקוח לקרוא את הנתונים כדי לעדכן אותם באופן עסקה.
set(ref, value)	כותב נתונים למיקום מסד הנתונים הזה. פעולה זו תחליף את כל הנתונים במיקום זה ובכל מיקומי הצאצא. השפעת הכתיבה תהיה גלויה מיד, והאירועים המתאימים ("ערך", "ילד_נוסף" וכו') יופעלו. הסנכרון של הנתונים לשרתי Firebase יתחיל גם הוא, וההבטחה המוחזרת תיפתר כאשר תושלם. אם מסופק, ההתקשרות חוזרת `onComplete` תיקרא באופן אסינכרוני לאחר סיום הסנכרון. העברת `null` עבור הערך החדש שווה ערך לקריאת `remove()` ; כלומר, כל הנתונים במיקום זה וכל מיקומי הצאצא יימחקו. `set()` יסיר כל עדיפות המאוחסנת במיקום זה, כך שאם העדיפות נועדה להישמר, עליך להשתמש `setWithPriority()` במקום זאת. שים לב ששינוי נתונים עם `set()` יבטל את כל העסקאות הממתינות במיקום זה, לכן יש לנקוט זהירות רבה אם מערבבים `set()` ו- `transaction()` כדי לשנות את אותם נתונים. `set()` יחיד יפיק אירוע "value" בודד במיקום שבו בוצע ה- `set()` .
setPriority(ref, priority)	מגדיר עדיפות לנתונים במיקום מסד נתונים זה. יישומים אינם צריכים להשתמש בעדיפות, אך הם יכולים להזמין אוספים לפי מאפיינים רגילים (ראה מיון וסינון נתונים ).
setWithPriority(ref, value, priority)	כותב נתונים את מיקום מסד הנתונים. כמו `set()` אבל גם מציין את העדיפות של הנתונים האלה. יישומים אינם צריכים להשתמש בעדיפות, אך הם יכולים להזמין אוספים לפי מאפיינים רגילים (ראה מיון וסינון נתונים ).
עדכון (ר', ערכים)	כותב ערכים מרובים למסד הנתונים בבת אחת. הארגומנט `values` מכיל צמדי ערך נכסים מרובים שייכתבו למסד הנתונים ביחד. כל מאפיין צאצא יכול להיות מאפיין פשוט (לדוגמה, "שם") או נתיב יחסי (לדוגמה, "שם/ראשון") מהמיקום הנוכחי לנתונים שיש לעדכן. בניגוד לשיטת `set()` , ניתן להשתמש `update()` כדי לעדכן באופן סלקטיבי רק את המאפיינים המוזכרים במיקום הנוכחי (במקום להחליף את כל מאפייני הצאצא במיקום הנוכחי). השפעת הכתיבה תהיה גלויה מיד, והאירועים המתאימים ('ערך', 'ילד_נוסף' וכו') יופעלו. הסנכרון של הנתונים לשרתי Firebase יתחיל גם הוא, וההבטחה המוחזרת תיפתר כאשר תושלם. אם מסופק, ההתקשרות חוזרת `onComplete` תיקרא באופן אסינכרוני לאחר סיום הסנכרון. `update()` בודד יפיק אירוע "ערך" בודד במיקום שבו בוצע `update()` , ללא קשר למספר הילדים ששונו. שים לב ששינוי נתונים עם `update()` יבטל את כל העסקאות הממתינות במיקום זה, ולכן יש לנקוט זהירות רבה אם מערבבים `update()` ו- `transaction()` כדי לשנות את אותם נתונים. העברת `null` ל- `update()` תסיר את הנתונים במיקום זה. ראה הצגת עדכוני ריבוי מיקומים ועוד .
פונקציה (ערך, ...)
endAt(value, key)	יוצר `QueryConstraint` עם נקודת הסיום שצוינה. שימוש `startAt()` , `startAfter()` , `endBefore()` , `endAt()` ו- `equalTo()` מאפשר לך לבחור נקודות התחלה וסיום שרירותיות עבור השאילתות שלך. נקודת הסיום כוללת, כך שילדים עם הערך שצוין בדיוק ייכללו בשאילתה. ניתן להשתמש בארגומנט המפתח האופציונלי כדי להגביל עוד יותר את טווח השאילתה. אם הוא צוין, אז לילדים שיש להם בדיוק את הערך שצוין חייב להיות גם שם מפתח קטן או שווה למפתח שצוין. תוכל לקרוא עוד על `endAt()` בסינון נתונים .
endBefore(value, key)	יוצר `QueryConstraint` עם נקודת הסיום שצוינה (בלעדי). שימוש `startAt()` , `startAfter()` , `endBefore()` , `endAt()` ו- `equalTo()` מאפשר לך לבחור נקודות התחלה וסיום שרירותיות עבור השאילתות שלך. נקודת הסיום היא בלעדית. אם מסופק רק ערך, ילדים בעלי ערך נמוך מהערך שצוין ייכללו בשאילתה. אם צוין מפתח, אז לילדים חייב להיות ערך קטן או שווה לערך שצוין ושם מפתח קטן מהמפתח שצוין.
equalTo(ערך, מפתח)	יוצר `QueryConstraint` הכולל ילדים התואמים לערך שצוין. שימוש `startAt()` , `startAfter()` , `endBefore()` , `endAt()` ו- `equalTo()` מאפשר לך לבחור נקודות התחלה וסיום שרירותיות עבור השאילתות שלך. ניתן להשתמש בארגומנט המפתח האופציונלי כדי להגביל עוד יותר את טווח השאילתה. אם הוא צוין, אז ילדים שיש להם בדיוק את הערך שצוין חייבים לקבל בדיוק את המפתח שצוין כשם המפתח שלהם. זה יכול לשמש כדי לסנן ערכות תוצאות עם התאמות רבות עבור אותו ערך. תוכל לקרוא עוד על `equalTo()` בסינון נתונים .
startAfter(ערך, מפתח)	יוצר `QueryConstraint` עם נקודת ההתחלה שצוינה (בלעדי). שימוש `startAt()` , `startAfter()` , `endBefore()` , `endAt()` ו- `equalTo()` מאפשר לך לבחור נקודות התחלה וסיום שרירותיות עבור השאילתות שלך. נקודת המוצא היא בלעדית. אם מסופק רק ערך, ילדים בעלי ערך גדול מהערך שצוין ייכללו בשאילתה. אם צוין מפתח, אז לילדים חייב להיות ערך גדול או שווה לערך שצוין ושם מפתח גדול מהמפתח שצוין.
startAt(value, key)	יוצר `QueryConstraint` עם נקודת ההתחלה שצוינה. שימוש `startAt()` , `startAfter()` , `endBefore()` , `endAt()` ו- `equalTo()` מאפשר לך לבחור נקודות התחלה וסיום שרירותיות עבור השאילתות שלך. נקודת ההתחלה היא כוללנית, כך שילדים עם הערך שצוין בדיוק ייכללו בשאילתה. ניתן להשתמש בארגומנט המפתח האופציונלי כדי להגביל עוד יותר את טווח השאילתה. אם הוא צוין, אז לילדים שיש להם בדיוק את הערך שצוין חייב להיות גם שם מפתח גדול או שווה למפתח שצוין. תוכל לקרוא עוד על `startAt()` בסינון נתונים .

שיעורים

מעמד	תיאור
מאגר מידע	מחלקה המייצגת מסד נתונים בזמן אמת של Firebase.
תמונת נתונים	`DataSnapshot` מכילה נתונים ממיקום מסד נתונים. בכל פעם שאתה קורא נתונים ממסד הנתונים, אתה מקבל את הנתונים כ- `DataSnapshot` . תמונת `DataSnapshot` מועברת להתקשרות חוזרת של אירוע שאתה מצרף עם `on()` או `once()` . אתה יכול לחלץ את התוכן של תמונת המצב כאובייקט JavaScript על ידי קריאה לשיטת `val()` . לחלופין, אתה יכול לעבור לתוך תמונת המצב על ידי קריאה ל- `child()` כדי להחזיר צילומי מצב של ילד (אשר לאחר מכן תוכל לקרוא להם `val()` ). `DataSnapshot` היא עותק שנוצר ביעילות ובלתי ניתן לשינוי של הנתונים במיקום מסד נתונים. לא ניתן לשנות אותו ולעולם לא ישתנה (כדי לשנות נתונים, אתה תמיד קורא לשיטת `set()` ב- `Reference` ישירות).
OnDisconnect	המחלקה `onDisconnect` מאפשרת לך לכתוב או לנקות נתונים כאשר הלקוח שלך מתנתק משרת מסד הנתונים. עדכונים אלה מתרחשים בין אם הלקוח שלך מתנתק בצורה נקייה או לא, כך שאתה יכול לסמוך עליהם כדי לנקות נתונים גם אם חיבור נותק או לקוח קורס. המחלקה `onDisconnect` משמשת לרוב לניהול נוכחות ביישומים שבהם שימושי לזהות כמה לקוחות מחוברים ומתי לקוחות אחרים מתנתקים. ראה הפעלת יכולות לא מקוונות ב-JavaScript למידע נוסף. כדי למנוע בעיות כאשר חיבור נותק לפני שניתן להעביר את הבקשות לשרת מסד הנתונים, יש לקרוא לפונקציות אלו לפני כתיבת נתונים. שים לב שפעולות `onDisconnect` מופעלות פעם אחת בלבד. אם אתה רוצה שפעולה תתרחש בכל פעם שמתרחש ניתוק, תצטרך להקים מחדש את פעולות `onDisconnect` בכל פעם שאתה מתחבר מחדש.
QueryConstraint	`QueryConstraint` משמש לצמצום קבוצת המסמכים המוחזרת על ידי שאילתת מסד נתונים. `QueryConstraint` s נוצרים על ידי הפעלת endAt() , endBefore() , מתחיל ב() , startAfter() , limitToFirst() , limitToLast() , orderByChild() , orderByChild() , orderByKey() , orderByPriority() , orderByValue() או equalTo() ולאחר מכן ניתן להעביר אותם ל- query() כדי ליצור מופע שאילתה חדש המכיל גם את `QueryConstraint` זה.
תוצאה של עסקה	סוג עבור ערך הרזולוציה של runTransaction() .

ממשקים

מִמְשָׁק	תיאור
מסד נתונים	`DatabaseReference` מייצג מיקום ספציפי במסד הנתונים שלך וניתן להשתמש בו לקריאה או כתיבת נתונים לאותו מיקום מסד נתונים. אתה יכול להפנות למיקום השורש או הילד במסד הנתונים שלך על ידי קריאה `ref()` או `ref("child/path")` . הכתיבה מתבצעת בשיטת `set()` וניתן לבצע קריאה בשיטת `on*()` . ראה https://firebase.google.com/docs/database/web/read-and-write
IteratedDataSnapshot	מייצג תמונת מצב צאצא של `Reference` שעוברת עליה איטרציה. המפתח לעולם לא יהיה בלתי מוגדר.
אפשרויות האזנה	אובייקטי אפשרויות שניתן להשתמש בהם כדי להתאים אישית את המאזין.
שאילתא	`Query` ממיינת ומסננת את הנתונים במיקום מסד נתונים כך שרק תת-קבוצה של נתוני הצאצא נכללת. זה יכול לשמש כדי להזמין אוסף נתונים לפי תכונה כלשהי (לדוגמה, גובה דינוזאורים) וכן כדי להגביל רשימה גדולה של פריטים (לדוגמה, הודעות צ'אט) למספר המתאים לסנכרון עם הלקוח. שאילתות נוצרות על ידי שרשרת אחת או יותר משיטות הסינון המוגדרות כאן. בדיוק כמו עם `DatabaseReference` , אתה יכול לקבל נתונים `Query` על ידי שימוש בשיטות `on*()` . תקבל רק אירועים ו- `DataSnapshot` עבור תת-קבוצת הנתונים התואמים את השאילתה שלך. ראה https://firebase.google.com/docs/database/web/lists-of-data#sorting_and_filtering_data למידע נוסף.
ThenableReference	`Promise` שיכולה לשמש גם בתור `DatabaseReference` כשהיא מוחזרת על ידי push() . ההפניה זמינה מיד `Promise` נפתרת עם סיום הכתיבה ל-backend.
אפשרויות עסקאות	אובייקט אפשרויות להגדרת עסקאות.

הקלד כינויים

הקלד כינוי	תיאור
סוג אירוע	אחת מהמחרוזות הבאות: "value", "child_added", "child_changed", "child_removed" או "child_moved".
QueryConstraintType	מתאר את אילוצי השאילתה השונים הזמינים ב-SDK זה.
בטל את המנוי	התקשרות חוזרת שניתן להפעיל כדי להסיר מאזין.

פונקציה (אפליקציה,...)

getDatabase(אפליקציה, url)

מחזירה את המופע של Realtime Database SDK המשויך ל- FirebaseApp שסופק . מאתחל מופע חדש עם הגדרות ברירת מחדל אם לא קיים מופע או אם המופע הקיים משתמש בכתובת אתר מותאמת אישית של מסד נתונים.

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר	סוּג	תיאור
אפליקציה	FirebaseApp	מופע FirebaseApp שאליו משויך המופע של Realtime Database שהוחזר.
כתובת אתר	חוּט	כתובת האתר של מופע Realtime Database שאליו יש להתחבר. אם לא נמסר, ה- SDK מתחבר למופע ברירת המחדל של אפליקציית Firebase.

החזרות:

מאגר מידע

מופע Database של האפליקציה המסופקת.

פונקציה (db, ...)

connectDatabaseEmulator(db, host, port, options)

שנה את המופע שסופק כדי לתקשר עם אמולטור מסד הנתונים בזמן אמת.

הערה: יש לקרוא לשיטה זו לפני ביצוע פעולה אחרת.

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר	סוּג	תיאור
db	מאגר מידע	המופע לשינוי.
מנחה	חוּט	מארח האמולטור (לשעבר: localhost)
נמל	מספר	יציאת האמולטור (EX: 8080)
אפשרויות	{mockusertoken ?: emulatormocktokenoptions \| חוּט; }

החזרות:

בָּטֵל

Gooffline (DB)

ניתוק מהשרת (כל פעולות מסד הנתונים יושלמו במצב לא מקוון).

הלקוח שומר אוטומטית חיבור מתמשך לשרת מסד הנתונים, שיישאר פעיל ללא הגבלת זמן ויתחבר מחדש כאשר הוא מנותק. עם זאת, ניתן להשתמש בשיטות goOffline() ו- goOnline() כדי לשלוט בחיבור הלקוח במקרים בהם חיבור מתמשך אינו רצוי.

בעודו במצב לא מקוון, הלקוח כבר לא יקבל עדכוני נתונים ממסד הנתונים. עם זאת, כל פעולות מסד הנתונים המבוצעות באופן מקומי ימשיכו לירות מייד אירועים, ומאפשרות לאפליקציה שלך להמשיך להתנהג כרגיל. בנוסף, כל פעולה המבוצעת באופן מקומי תועבר באופן אוטומטי ותנחה מחדש על חיבור מחדש לשרת מסד הנתונים.

כדי להתחבר מחדש למסד הנתונים ולהתחיל לקבל אירועים מרוחקים, ראה goOnline() .

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר	סוּג	תיאור
db	מאגר מידע	המופע להתנתק.

החזרות:

בָּטֵל

gooonline (db)

מתחבר מחדש לשרת ומסנכרן את מצב מסד הנתונים הלא מקוון עם מצב השרת.

יש להשתמש בשיטה זו לאחר השבתת החיבור הפעיל עם goOffline() . לאחר חיבור מחדש, הלקוח ישדר את הנתונים המתאימים ויפטר את האירועים המתאימים כך שהלקוח שלך "יתפוס" אוטומטית.

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר	סוּג	תיאור
db	מאגר מידע	המופע לחיבור מחדש.

החזרות:

בָּטֵל

ref (db, path)

מחזירה Reference המייצגת את המיקום במסד הנתונים המתאימה לנתיב המסופק. אם לא מסופק נתיב, Reference תצביע על שורש בסיס הנתונים.

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר	סוּג	תיאור
db	מאגר מידע	מופע בסיס הנתונים לקבלת הפניה.
נָתִיב	חוּט	נתיב אופציונלי המייצג את המיקום `Reference` החוזרת תצביע. אם לא נמסר, `Reference` המוחזרת תצביע על שורש בסיס הנתונים.

החזרות:

DatabasereFerence

אם מסופק נתיב, Reference המפנה על הנתיב המסופק. אחרת, Reference שמצביעה על שורש מסד הנתונים.

reffromurl (db, url)

מחזירה Reference המייצגת את המיקום במסד הנתונים המתאימה לכתובת האתר המסופקת.

חריג נזרק אם כתובת האתר אינה כתובת אתר של מסד נתונים תקף של FireBase או שיש לה תחום שונה ממופע Database הנוכחי.

שימו לב שכל פרמטרי השאילתה ( orderBy , limitToLast וכו ') מתעלמים ואינם מיושמים על Reference המוחזרת .

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר	סוּג	תיאור
db	מאגר מידע	מופע בסיס הנתונים לקבלת הפניה.
כתובת אתר	חוּט	כתובת האש של FireBase בה תצביע `Reference` המוחזרת.

החזרות:

DatabasereFerence

Reference שמצביעה על כתובת האתר המסופקת.

פוּנקצִיָה()

forcelontpolling ()

כפה את השימוש ב- Longpolling במקום ב- WebSockets. יתעלמו מכך אם משתמשים בפרוטוקול WebSocket ב- DatabaseUrl.

חֲתִימָה:

export declare function forceLongPolling(): void;

החזרות:

בָּטֵל

ForceWebsockets ()

להכריח את השימוש ב- WebSockets במקום לנקוט זמן רב.

חֲתִימָה:

export declare function forceWebSockets(): void;

החזרות:

בָּטֵל

orderbykey ()

יוצר QueryConstraint חדש שמזמין על ידי המפתח.

ממיין את תוצאות השאילתה לפי ערכי המפתח שלהם (עולים).

אתה יכול לקרוא עוד על orderByKey() בנתוני מיון .

חֲתִימָה:

export declare function orderByKey(): QueryConstraint;

החזרות:

QueryConstraint

orderbypriority ()

יוצר QueryConstraint חדש שמוזמין בעדיפות.

יישומים אינם צריכים להשתמש בעדיפות אלא יכולים להזמין אוספים לפי מאפיינים רגילים (ראה נתוני מיון עבור אלטרנטיבות לעדיפות.

חֲתִימָה:

export declare function orderByPriority(): QueryConstraint;

החזרות:

QueryConstraint

orderbyValue ()

יוצר QueryConstraint חדש שמזמין לפי ערך.

אם ילדי השאילתה הם כל ערכי הסקלר (מחרוזת, מספר או בוליאני), אתה יכול להזמין את התוצאות לפי ערכי (העולה) שלהם.

אתה יכול לקרוא עוד על orderByValue() בנתוני מיון .

חֲתִימָה:

export declare function orderByValue(): QueryConstraint;

החזרות:

QueryConstraint

ServerTimestamp ()

מחזירה ערך מציין מיקום לאוכלוסייה אוטומטית של חותמת הזמן הנוכחית (זמן מאז תקופת ה- UNIX, באלפיות השנייה) כפי שנקבע על ידי שרתי Firebase.

חֲתִימָה:

export declare function serverTimestamp(): object;

החזרות:

לְהִתְנַגֵד

פונקציה (דלתא, ...)

increment(delta)

מחזירה ערך מציין מיקום שניתן להשתמש בהן כדי להגדיל את ערך מסד הנתונים הנוכחי על ידי הדלתא המסופקת.

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר	סוּג	תיאור
דֶלתָא	מספר	הסכום לשינוי הערך הנוכחי מבחינה אטומית.

החזרות:

לְהִתְנַגֵד

ערך מציין מקום לשינוי נתונים בצד השרת האטומי.

פונקציה (מופעלת, ...)

enableLogging (מופעל, מתמשך)

בוגרים מידע על ניפוי באגים לקונסולה.

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר	סוּג	תיאור
מופעל	בוליאני	מאפשר רישום אם `true` , מבטל רישום רישום אם `false` .
מַתְמִיד	בוליאני	זוכר את מצב הרישום בין רענון העמוד אם `true` .

החזרות:

כל

פונקציה (מגבלה, ...)

limittofirst (Limit)

יוצר QueryConstraint חדשני חדש שאם מוגבל למספר הספציפי הראשון של ילדים.

שיטת limitToFirst() משמשת להגדרת מספר מקסימלי של ילדים שיסנכרן לקבלת התקשרות נתונה. אם נקבע מגבלה של 100, אנו נקבל רק עד 100 אירועים child_added . אם יש לנו פחות ממאה הודעות המאוחסנות במסד הנתונים שלנו, אירוע child_added יורה לכל הודעה. עם זאת, אם יש לנו למעלה ממאה הודעות, נקבל רק אירוע child_added עבור 100 ההודעות הראשונות שהוזמנו. ככל שהפריטים משתנים, נקבל אירועים child_removed עבור כל פריט שנושר מהרשימה הפעילה כך שהמספר הכולל יישאר ב 100.

תוכל לקרוא עוד על limitToFirst() בסינון נתונים .

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר	סוּג	תיאור
לְהַגבִּיל	מספר	המספר המרבי של הצמתים שיכלול בשאילתה זו.

החזרות:

QueryConstraint

Limittolast (Limit)

יוצר QueryConstraint חדשה המוגבלת להחזיר רק את המספר האחרון שצוין של ילדים.

שיטת limitToLast() משמשת להגדרת מספר מקסימלי של ילדים שיסנכרנו לקבלת התקשרות נתונה. אם נקבע מגבלה של 100, אנו נקבל רק עד 100 אירועים child_added . אם יש לנו פחות ממאה הודעות המאוחסנות במסד הנתונים שלנו, אירוע child_added יורה לכל הודעה. עם זאת, אם יש לנו למעלה ממאה הודעות, נקבל רק אירוע child_added עבור 100 ההודעות האחרונות שהוזמנו. ככל שהפריטים משתנים, נקבל אירועים child_removed עבור כל פריט שנושר מהרשימה הפעילה כך שהמספר הכולל יישאר ב 100.

תוכל לקרוא עוד על limitToLast() בסינון נתוני .

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר	סוּג	תיאור
לְהַגבִּיל	מספר	המספר המרבי של הצמתים שיכלול בשאילתה זו.

החזרות:

QueryConstraint

פונקציה (לוגר, ...)

EnableLogging (Logger)

בוגרים מידע על ניפוי באגים לקונסולה.

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר	סוּג	תיאור
כּוֹרֵת עֵצִים	(הודעה: מחרוזת) => לא ידוע	פונקציית לוגר מותאם אישית כדי לשלוט כיצד הדברים נרשמים.

החזרות:

כל

פונקציה (הורה, ...)

ילד (הורה, נתיב)

מקבל Reference למיקום בנתיב היחסי שצוין.

הנתיב היחסי יכול להיות שם ילד פשוט (לדוגמה, "ADA") או נתיב עמוק יותר מופרד סלאש (לדוגמה, "ADA/שם/ראשון").

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר	סוּג	תיאור
הוֹרֶה	DatabasereFerence	מיקום ההורה.
נָתִיב	חוּט	מסלול יחסי ממיקום זה למיקום הילד הרצוי.

החזרות:

DatabasereFerence

מיקום הילד שצוין.

דחף (הורה, ערך)

מייצר מיקום ילד חדש באמצעות מפתח ייחודי ומחזיר את Reference שלו .

זהו הדפוס הנפוץ ביותר להוסיף נתונים לאוסף פריטים.

אם אתה מספק ערך push() , הערך נכתב למיקום שנוצר. אם אינך עובר ערך, שום דבר לא נכתב למסד הנתונים והילד נשאר ריק (אך אתה יכול להשתמש Reference במקום אחר).

המפתחות הייחודיים שנוצרו על ידי push() מוזמנים לפי השעה הנוכחית, ולכן רשימת הפריטים המתקבלת ממוינת כרונולוגית. המפתחות נועדו גם להיות בלתי ניתנים לנחש (הם מכילים 72 חתיכות אנטרופיה אקראיות).

ראה הוסף לרשימת נתונים . ראה את 2^120 הדרכים להבטיח מזהים ייחודיים .

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר	סוּג	תיאור
הוֹרֶה	DatabasereFerence	מיקום ההורה.
ערך	לא ידוע	ערך אופציונלי שייכתב במיקום שנוצר.

החזרות:

STABEBEREFERENCE

Promise Reference משולבים ; מחליט כאשר הכתיבה הושלמה, אך ניתן להשתמש בה מייד Reference למיקום הילד.

פונקציה (נתיב, ...)

OrderByChild (נתיב)

יוצר QueryConstraint חדשני חדש שמזמין על ידי מפתח הילד שצוין.

שאילתות יכולות להזמין רק על ידי מפתח אחד בכל פעם. קריאה ל- orderByChild() פעמים רבות באותה שאילתה היא שגיאה.

שאילתות Firebase מאפשרות לך להזמין את הנתונים שלך על ידי כל מפתח ילד תוך כדי תנועה. עם זאת, אם אתה יודע מראש מה יהיו האינדקסים שלך, אתה יכול להגדיר אותם באמצעות כלל. אינדקסון בכללי האבטחה שלך לצורך ביצועים טובים יותר. עיין בכתובת https://firebase.google.com/docs/database/security/indexing-data למידע נוסף.

אתה יכול לקרוא עוד על orderByChild() בנתוני מיון .

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר	סוּג	תיאור
נָתִיב	חוּט	הדרך לסדר על ידי.

החזרות:

QueryConstraint

פונקציה (שאילתה, ...)

קבל (שאילתה)

מקבל את התוצאה המעודכנת ביותר עבור שאילתה זו.

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר	סוּג	תיאור
שאילתא	שאילתא	השאילתה לרוץ.

החזרות:

הבטחה < datasnapshot >

Promise שפתרה ל- DataSnapShot המתקבל אם ערך זמין, או דוחה אם הלקוח אינו מסוגל להחזיר ערך (למשל, אם השרת אינו ניתן להשגה ואין שום דבר במטמון).

off(שאילתה, eventType, callback)

מתנתק התקשרות חוזרת בעבר עם התואם on*() ( onValue , onChildAdded ) מאזין. הערה: זו לא הדרך המומלצת להסיר מאזין. במקום זאת, אנא השתמש בפונקציית ההתקשרות החוזרת שהוחזרו מההתקשרות on* .

נתק התקשרות חוזרת בעבר עם on*() . השיחה off() על מאזין הורה לא תסיר אוטומטית את המאזינים הרשומים בצמתים לילדים, off() יש לקרוא גם לכל מאזיני הילד שיסירו את ההתקשרות.

אם לא צוין התקשרות חוזרת, כל ההתקשרות של ה- EventType שצוינו יוסרו. באופן דומה, אם לא צוין EventType, כל ההתקשרות Reference יוסרו.

ניתן להסיר גם מאזינים בודדים על ידי קריאת התקשרות חוזרת המנוי שלהם.

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר	סוּג	תיאור
שאילתא	שאילתא	השאילתה שאיתה נרשמה המאזין.
סוג אירוע	סוג אירוע	אחד המיתרים הבאים: "ערך", "Child_added", "Child_Changed", "Child_Moled", או "Child_bored." אם הושמט, כל ההתקשרות `Reference` יוסרו.
התקשר חזרה	(תמונת מצב: datasnapshot , ornifychildname?: מחרוזת \| null) => לא ידוע	פונקציית ההתקשרות שהועברה ל- `on()` או `undefined` כדי להסיר את כל ההתקשרות.

החזרות:

בָּטֵל

Onchildadded (שאילתה, התקשרות חוזרת, CallingCallback)

מקשיב לשינויי נתונים במיקום מסוים.

זו הדרך העיקרית לקרוא נתונים ממסד נתונים. ההתקשרות שלך יופעלה עבור הנתונים הראשוניים ושוב בכל פעם שהנתונים משתנים. הפעל את השיחה החוזרת של ביטול המנוי שהוחזר כדי להפסיק לקבל עדכונים. ראה פרטים נוספים על אחזור נתונים באינטרנט .

אירוע onChildAdded יופעל פעם אחת לכל ילד ראשוני במיקום זה, והוא יופעל שוב בכל פעם שמתווסף ילד חדש. ה- DataSnapshot שהועבר לשיחה חוזרת ישקף את הנתונים עבור הילד הרלוונטי. למטרות הזמנה, הוא מועבר טיעון שני שהוא מחרוזת המכילה את המפתח של ילד האחים הקודם לפי סדר מיון, או null אם הוא הילד הראשון.

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר	סוּג	תיאור
שאילתא	שאילתא	השאילתה לרוץ.
התקשר חזרה	(תמונת מצב: datasnapshot , ornifychildname?: מחרוזת \| null) => לא ידוע	התקשרות חוזרת שיורה כאשר האירוע שצוין מתרחש. ההתקשרות חוזרת תעבור DataSnapShot ומחרוזת המכילה את המפתח של הילד הקודם, לפי סדר מיון, או `null` אם זה הילד הראשון.
CallingCallback	(שגיאה: שגיאה) => לא ידוע	התקשרות חוזרת אופציונלית שתקבל הודעה אם מנוי האירוע שלך מבוטל אי פעם מכיוון שללקוח שלך אין אישור לקרוא נתונים אלה (או שהיה לו אישור אך כעת איבד אותם). התקשרות חוזרת זו תועבר אובייקט `Error` המציין מדוע התרחש הכישלון.

החזרות:

בטל את המנוי

פונקציה שניתן להפעיל אותה להסרת המאזין.

Onchildadded (שאילתה, התקשרות חוזרת, אפשרויות)

מקשיב לשינויי נתונים במיקום מסוים.

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר	סוּג	תיאור
שאילתא	שאילתא	השאילתה לרוץ.
התקשר חזרה	(תמונת מצב: datasnapshot , ornifychildname: מחרוזת \| null) => לא ידוע	התקשרות חוזרת שיורה כאשר האירוע שצוין מתרחש. ההתקשרות חוזרת תעבור DataSnapShot ומחרוזת המכילה את המפתח של הילד הקודם, לפי סדר מיון, או `null` אם זה הילד הראשון.
אפשרויות	האזנה	אובייקט שניתן להשתמש בו כדי להגדיר את התצורה `onlyOnce` , אשר מסיר את המאזין לאחר הפתיחה הראשונה שלו.

החזרות:

בטל את המנוי

פונקציה שניתן להפעיל אותה להסרת המאזין.

onChildAdded(שאילתה, התקשרות חוזרת, ביטול התקשרות חוזרת, אפשרויות)

מקשיב לשינויי נתונים במיקום מסוים.

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר	סוּג	תיאור
שאילתא	שאילתא	השאילתה לרוץ.
התקשר חזרה	(תמונת מצב: datasnapshot , ornifychildname: מחרוזת \| null) => לא ידוע	התקשרות חוזרת שיורה כאשר האירוע שצוין מתרחש. ההתקשרות חוזרת תעבור DataSnapShot ומחרוזת המכילה את המפתח של הילד הקודם, לפי סדר מיון, או `null` אם זה הילד הראשון.
CallingCallback	(שגיאה: שגיאה) => לא ידוע	התקשרות חוזרת אופציונלית שתקבל הודעה אם מנוי האירוע שלך מבוטל אי פעם מכיוון שללקוח שלך אין אישור לקרוא נתונים אלה (או שהיה לו אישור אך כעת איבד אותם). התקשרות חוזרת זו תועבר אובייקט `Error` המציין מדוע התרחש הכישלון.
אפשרויות	האזנה	אובייקט שניתן להשתמש בו כדי להגדיר את התצורה `onlyOnce` , אשר מסיר את המאזין לאחר הפתיחה הראשונה שלו.

החזרות:

בטל את המנוי

פונקציה שניתן להפעיל אותה להסרת המאזין.

OnChildChanged (שאילתה, התקשרות חוזרת, CallingCallback)

מקשיב לשינויי נתונים במיקום מסוים.

אירוע onChildChanged יופעל כאשר הנתונים המאוחסנים בילד (או כל צאצאיו) משתנים. שים לב שאירוע יחיד child_changed עשוי לייצג שינויים מרובים בילד. ה- DataSnapshot שהועבר לקריאה חוזרת יכיל את תוכן הילד החדש. למטרות הזמנה, ההתקשרות חוזרת מועברת גם טיעון שני שהוא מחרוזת המכילה את המפתח של ילד האח הקודם לפי סדר מיון, או null אם הוא הילד הראשון.

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר	סוּג	תיאור
שאילתא	שאילתא	השאילתה לרוץ.
התקשר חזרה	(תמונת מצב: datasnapshot , ornifychildname: מחרוזת \| null) => לא ידוע	התקשרות חוזרת שיורה כאשר האירוע שצוין מתרחש. ההתקשרות חוזרת תעבור DataSnapShot ומחרוזת המכילה את המפתח של הילד הקודם, לפי סדר מיון, או `null` אם זה הילד הראשון.
CallingCallback	(שגיאה: שגיאה) => לא ידוע	התקשרות חוזרת אופציונלית שתקבל הודעה אם מנוי האירוע שלך מבוטל אי פעם מכיוון שללקוח שלך אין אישור לקרוא נתונים אלה (או שהיה לו אישור אך כעת איבד אותם). התקשרות חוזרת זו תועבר אובייקט `Error` המציין מדוע התרחש הכישלון.

החזרות:

בטל את המנוי

פונקציה שניתן להפעיל אותה להסרת המאזין.

onchildchanged (שאילתה, התקשרות חוזרת, אפשרויות)

מקשיב לשינויי נתונים במיקום מסוים.

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר	סוּג	תיאור
שאילתא	שאילתא	השאילתה לרוץ.
התקשר חזרה	(תמונת מצב: datasnapshot , ornifychildname: מחרוזת \| null) => לא ידוע	התקשרות חוזרת שיורה כאשר האירוע שצוין מתרחש. ההתקשרות חוזרת תעבור DataSnapShot ומחרוזת המכילה את המפתח של הילד הקודם, לפי סדר מיון, או `null` אם זה הילד הראשון.
אפשרויות	האזנה	אובייקט שניתן להשתמש בו כדי להגדיר את התצורה `onlyOnce` , אשר מסיר את המאזין לאחר הפתיחה הראשונה שלו.

החזרות:

בטל את המנוי

פונקציה שניתן להפעיל אותה להסרת המאזין.

onChildChanged(שאילתה, התקשרות חוזרת, ביטול התקשרות חוזרת, אפשרויות)

מקשיב לשינויי נתונים במיקום מסוים.

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר	סוּג	תיאור
שאילתא	שאילתא	השאילתה לרוץ.
התקשר חזרה	(תמונת מצב: datasnapshot , ornifychildname: מחרוזת \| null) => לא ידוע	התקשרות חוזרת שיורה כאשר האירוע שצוין מתרחש. ההתקשרות חוזרת תעבור DataSnapShot ומחרוזת המכילה את המפתח של הילד הקודם, לפי סדר מיון, או `null` אם זה הילד הראשון.
CallingCallback	(שגיאה: שגיאה) => לא ידוע	התקשרות חוזרת אופציונלית שתקבל הודעה אם מנוי האירוע שלך מבוטל אי פעם מכיוון שללקוח שלך אין אישור לקרוא נתונים אלה (או שהיה לו אישור אך כעת איבד אותם). התקשרות חוזרת זו תועבר אובייקט `Error` המציין מדוע התרחש הכישלון.
אפשרויות	האזנה	אובייקט שניתן להשתמש בו כדי להגדיר את התצורה `onlyOnce` , אשר מסיר את המאזין לאחר הפתיחה הראשונה שלו.

החזרות:

בטל את המנוי

פונקציה שניתן להפעיל אותה להסרת המאזין.

OnChildModed (שאילתה, התקשרות חוזרת, CallingCallback)

מקשיב לשינויי נתונים במיקום מסוים.

אירוע onChildMoved יופעל כאשר סדר המיון של הילד ישתנה כך שמיקומו יחסית לאחיו משתנה. ה- DataSnapshot שהועבר לקריאה חוזרת תהיה לנתוני הילד שעברו. זה מועבר גם טיעון שני שהוא מחרוזת המכילה את המפתח של ילד האחים הקודם לפי סדר מיון, או null אם הוא הילד הראשון.

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר	סוּג	תיאור
שאילתא	שאילתא	השאילתה לרוץ.
התקשר חזרה	(תמונת מצב: datasnapshot , ornifychildname: מחרוזת \| null) => לא ידוע	התקשרות חוזרת שיורה כאשר האירוע שצוין מתרחש. ההתקשרות חוזרת תעבור DataSnapShot ומחרוזת המכילה את המפתח של הילד הקודם, לפי סדר מיון, או `null` אם זה הילד הראשון.
CallingCallback	(שגיאה: שגיאה) => לא ידוע	התקשרות חוזרת אופציונלית שתקבל הודעה אם מנוי האירוע שלך מבוטל אי פעם מכיוון שללקוח שלך אין אישור לקרוא נתונים אלה (או שהיה לו אישור אך כעת איבד אותם). התקשרות חוזרת זו תועבר אובייקט `Error` המציין מדוע התרחש הכישלון.

החזרות:

בטל את המנוי

פונקציה שניתן להפעיל אותה להסרת המאזין.

OnChildModed (שאילתה, התקשרות חוזרת, אפשרויות)

מקשיב לשינויי נתונים במיקום מסוים.

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר	סוּג	תיאור
שאילתא	שאילתא	השאילתה לרוץ.
התקשר חזרה	(תמונת מצב: datasnapshot , ornifychildname: מחרוזת \| null) => לא ידוע	התקשרות חוזרת שיורה כאשר האירוע שצוין מתרחש. ההתקשרות חוזרת תעבור DataSnapShot ומחרוזת המכילה את המפתח של הילד הקודם, לפי סדר מיון, או `null` אם זה הילד הראשון.
אפשרויות	האזנה	אובייקט שניתן להשתמש בו כדי להגדיר את התצורה `onlyOnce` , אשר מסיר את המאזין לאחר הפתיחה הראשונה שלו.

החזרות:

בטל את המנוי

פונקציה שניתן להפעיל אותה להסרת המאזין.

onChildMoved(שאילתה, התקשרות חוזרת, ביטול התקשרות חוזרת, אפשרויות)

מקשיב לשינויי נתונים במיקום מסוים.

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר	סוּג	תיאור
שאילתא	שאילתא	השאילתה לרוץ.
התקשר חזרה	(תמונת מצב: datasnapshot , ornifychildname: מחרוזת \| null) => לא ידוע	התקשרות חוזרת שיורה כאשר האירוע שצוין מתרחש. ההתקשרות חוזרת תעבור DataSnapShot ומחרוזת המכילה את המפתח של הילד הקודם, לפי סדר מיון, או `null` אם זה הילד הראשון.
CallingCallback	(שגיאה: שגיאה) => לא ידוע	התקשרות חוזרת אופציונלית שתקבל הודעה אם מנוי האירוע שלך מבוטל אי פעם מכיוון שללקוח שלך אין אישור לקרוא נתונים אלה (או שהיה לו אישור אך כעת איבד אותם). התקשרות חוזרת זו תועבר אובייקט `Error` המציין מדוע התרחש הכישלון.
אפשרויות	האזנה	אובייקט שניתן להשתמש בו כדי להגדיר את התצורה `onlyOnce` , אשר מסיר את המאזין לאחר הפתיחה הראשונה שלו.

החזרות:

בטל את המנוי

פונקציה שניתן להפעיל אותה להסרת המאזין.

OnChildRemod (שאילתה, התקשרות חוזרת, CallingCallback)

מקשיב לשינויי נתונים במיקום מסוים.

אירוע onChildRemoved יופעל פעם אחת בכל פעם שהילד יוסר. ה- DataSnapshot שהועבר לקריאה חוזרת יהיו הנתונים הישנים עבור הילד שהוסרו. ילד יוסר כאשר אחד מהם:

לקוח קורא במפורש remove() על אותו ילד או על אחד מאבות אבותיו - לקוח מתקשר set(null) על אותו ילד או על אחד מאבות אבותיו - שהילד הזה הוסר את כל ילדיו - יש שאילתה למעשה המסננת כעת החוצה את הילד (מכיוון שזה סדר המיון השתנה או שהגבול המקסימלי נפגע)

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר	סוּג	תיאור
שאילתא	שאילתא	השאילתה לרוץ.
התקשר חזרה	(תמונת מצב: datasnapshot ) => לא ידוע	התקשרות חוזרת שיורה כאשר האירוע שצוין מתרחש. ההתקשרות חוזרת תעבור DataSnapShot ומחרוזת המכילה את המפתח של הילד הקודם, לפי סדר מיון, או `null` אם זה הילד הראשון.
CallingCallback	(שגיאה: שגיאה) => לא ידוע	התקשרות חוזרת אופציונלית שתקבל הודעה אם מנוי האירוע שלך מבוטל אי פעם מכיוון שללקוח שלך אין אישור לקרוא נתונים אלה (או שהיה לו אישור אך כעת איבד אותם). התקשרות חוזרת זו תועבר אובייקט `Error` המציין מדוע התרחש הכישלון.

החזרות:

בטל את המנוי

פונקציה שניתן להפעיל אותה להסרת המאזין.

OnChildRemoded (שאילתה, התקשרות חוזרת, אפשרויות)

מקשיב לשינויי נתונים במיקום מסוים.

לקוח קורא במפורש remove() על אותו ילד או על אחד מאבות אבותיו - לקוח מתקשר set(null) על אותו ילד או על אחד מאבות אבותיו - שהילד הזה הוסר את כל ילדיו - יש שאילתה למעשה המסננת כעת החוצה את הילד (מכיוון שזה סדר המיון השתנה או שהגבול המקסימלי נפגע)

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר	סוּג	תיאור
שאילתא	שאילתא	השאילתה לרוץ.
התקשר חזרה	(תמונת מצב: datasnapshot ) => לא ידוע	התקשרות חוזרת שיורה כאשר האירוע שצוין מתרחש. ההתקשרות חוזרת תעבור DataSnapShot ומחרוזת המכילה את המפתח של הילד הקודם, לפי סדר מיון, או `null` אם זה הילד הראשון.
אפשרויות	האזנה	אובייקט שניתן להשתמש בו כדי להגדיר את התצורה `onlyOnce` , אשר מסיר את המאזין לאחר הפתיחה הראשונה שלו.

החזרות:

בטל את המנוי

פונקציה שניתן להפעיל אותה להסרת המאזין.

OnChildRemoded (שאילתה, התקשרות חוזרת, ביטול Callback, אפשרויות)

מקשיב לשינויי נתונים במיקום מסוים.

לקוח קורא במפורש remove() על אותו ילד או על אחד מאבות אבותיו - לקוח מתקשר set(null) על אותו ילד או על אחד מאבות אבותיו - שהילד הזה הוסר את כל ילדיו - יש שאילתה למעשה המסננת כעת החוצה את הילד (מכיוון שזה סדר המיון השתנה או שהגבול המקסימלי נפגע)

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר	סוּג	תיאור
שאילתא	שאילתא	השאילתה לרוץ.
התקשר חזרה	(תמונת מצב: datasnapshot ) => לא ידוע	התקשרות חוזרת שיורה כאשר האירוע שצוין מתרחש. ההתקשרות חוזרת תעבור DataSnapShot ומחרוזת המכילה את המפתח של הילד הקודם, לפי סדר מיון, או `null` אם זה הילד הראשון.
CallingCallback	(שגיאה: שגיאה) => לא ידוע	התקשרות חוזרת אופציונלית שתקבל הודעה אם מנוי האירוע שלך מבוטל אי פעם מכיוון שללקוח שלך אין אישור לקרוא נתונים אלה (או שהיה לו אישור אך כעת איבד אותם). התקשרות חוזרת זו תועבר אובייקט `Error` המציין מדוע התרחש הכישלון.
אפשרויות	האזנה	אובייקט שניתן להשתמש בו כדי להגדיר את התצורה `onlyOnce` , אשר מסיר את המאזין לאחר הפתיחה הראשונה שלו.

החזרות:

בטל את המנוי

פונקציה שניתן להפעיל אותה להסרת המאזין.

onvalue (שאילתה, התקשרות חוזרת, CallingCallback)

מקשיב לשינויי נתונים במיקום מסוים.

אירוע onValue יפעיל פעם אחת עם הנתונים הראשוניים המאוחסנים במיקום זה, ואז יפעיל שוב בכל פעם שהנתונים משתנים. ה- DataSnapshot שהועבר לקריאה חוזרת יהיה למיקום בו on() . זה לא יפעיל עד שהתוכן כולו יסונכרן. אם למיקום אין נתונים, הוא יופעל עם DataSnapshot ריק ( val() יחזור null ).

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר	סוּג	תיאור
שאילתא	שאילתא	השאילתה לרוץ.
התקשר חזרה	(תמונת מצב: datasnapshot ) => לא ידוע	התקשרות חוזרת שיורה כאשר האירוע שצוין מתרחש. ההתקשרות חוזרת תעבור DatasNapShot.
CallingCallback	(שגיאה: שגיאה) => לא ידוע	התקשרות חוזרת אופציונלית שתקבל הודעה אם מנוי האירוע שלך מבוטל אי פעם מכיוון שללקוח שלך אין אישור לקרוא נתונים אלה (או שהיה לו אישור אך כעת איבד אותם). התקשרות חוזרת זו תועבר אובייקט `Error` המציין מדוע התרחש הכישלון.

החזרות:

בטל את המנוי

פונקציה שניתן להפעיל אותה להסרת המאזין.

onvalue (שאילתה, התקשרות חוזרת, אפשרויות)

מקשיב לשינויי נתונים במיקום מסוים.

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר	סוּג	תיאור
שאילתא	שאילתא	השאילתה לרוץ.
התקשר חזרה	(תמונת מצב: datasnapshot ) => לא ידוע	התקשרות חוזרת שיורה כאשר האירוע שצוין מתרחש. ההתקשרות חוזרת תעבור DatasNapShot.
אפשרויות	האזנה	אובייקט שניתן להשתמש בו כדי להגדיר את התצורה `onlyOnce` , אשר מסיר את המאזין לאחר הפתיחה הראשונה שלו.

החזרות:

בטל את המנוי

פונקציה שניתן להפעיל אותה להסרת המאזין.

onvalue (שאילתה, התקשרות חוזרת, ביטול Callback, אפשרויות)

מקשיב לשינויי נתונים במיקום מסוים.

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר	סוּג	תיאור
שאילתא	שאילתא	השאילתה לרוץ.
התקשר חזרה	(תמונת מצב: datasnapshot ) => לא ידוע	התקשרות חוזרת שיורה כאשר האירוע שצוין מתרחש. ההתקשרות חוזרת תעבור DatasNapShot.
CallingCallback	(שגיאה: שגיאה) => לא ידוע	התקשרות חוזרת אופציונלית שתקבל הודעה אם מנוי האירוע שלך מבוטל אי פעם מכיוון שללקוח שלך אין אישור לקרוא נתונים אלה (או שהיה לו אישור אך כעת איבד אותם). התקשרות חוזרת זו תועבר אובייקט `Error` המציין מדוע התרחש הכישלון.
אפשרויות	האזנה	אובייקט שניתן להשתמש בו כדי להגדיר את התצורה `onlyOnce` , אשר מסיר את המאזין לאחר הפתיחה הראשונה שלו.

החזרות:

בטל את המנוי

פונקציה שניתן להפעיל אותה להסרת המאזין.

query(query, queryConstraints)

יוצר מופע חדש של Query בלתי ניתן לשינוי המורחב כך שיכלול גם אילוצי שאילתה נוספים.

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר	סוּג	תיאור
שאילתא	שאילתא	מופע השאילתה שישמש כבסיס לאילוצים החדשים.
QueryConstraints	QueryConstraint []	רשימת ה- `QueryConstraint` S כדי להגיש מועמדות.

החזרות:

שאילתא

חריגים

אם לא ניתן לשלב מישהו מאילוצי השאילתה המסופקים עם האילוצים הקיימים או החדשים.

פונקציה (ref, ...)

OnDisconnect (ref)

מחזיר אובייקט OnDisconnect - ראה הפעלת יכולות לא מקוונות ב- JavaScript למידע נוסף על השימוש בו.

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר	סוּג	תיאור
ref	DatabasereFerence	ההתייחסות להוסיף מפעילי OnDisconnect עבור.

החזרות:

Ondisconnect

הסר (ref)

מסיר את הנתונים במיקום מסד נתונים זה.

כל נתונים במיקומי ילדים יימחקו גם הם.

השפעת ההסרה תהיה גלויה באופן מיידי והאירוע המתאים 'ערך' יופעל. סנכרון ההסרה לשרתי FireBase יתחיל גם הוא, וההבטחה המוחזרת תיפתר בסיום. אם יסופק, ההתקשרות החוזרת Oncomplete תיקרא באופן סינכרוני לאחר סיום הסנכרון.

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר	סוּג	תיאור
ref	DatabasereFerence	המיקום להסרה.

החזרות:

Promise<void>

Resolves when remove on server is complete.

runTransaction(ref, transactionUpdate, options)

Atomically modifies the data at this location.

Atomically modify the data at this location. Unlike a normal set() , which just overwrites the data regardless of its previous value, runTransaction() is used to modify the existing value to a new value, ensuring there are no conflicts with other clients writing to the same location at the same time.

To accomplish this, you pass runTransaction() an update function which is used to transform the current value into a new value. If another client writes to the location before your new value is successfully written, your update function will be called again with the new current value, and the write will be retried. This will happen repeatedly until your write succeeds without conflict or you abort the transaction by not returning a value from your update function.

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר	סוּג	תיאור
ref	DatabaseReference	The location to atomically modify.
transactionUpdate	(currentData: any) => unknown	A developer-supplied function which will be passed the current data stored at this location (as a JavaScript object). The function should return the new value it would like written (as a JavaScript object). If `undefined` is returned (ie you return with no arguments) the transaction will be aborted and the data at this location will not be modified.
אפשרויות	TransactionOptions	An options object to configure transactions.

החזרות:

Promise< TransactionResult >

A Promise that can optionally be used instead of the onComplete callback to handle success and failure.

set(ref, value)

Writes data to this Database location.

This will overwrite any data at this location and all child locations.

The effect of the write will be visible immediately, and the corresponding events ("value", "child_added", etc.) will be triggered. Synchronization of the data to the Firebase servers will also be started, and the returned Promise will resolve when complete. If provided, the onComplete callback will be called asynchronously after synchronization has finished.

Passing null for the new value is equivalent to calling remove() ; namely, all data at this location and all child locations will be deleted.

set() will remove any priority stored at this location, so if priority is meant to be preserved, you need to use setWithPriority() instead.

Note that modifying data with set() will cancel any pending transactions at that location, so extreme care should be taken if mixing set() and transaction() to modify the same data.

A single set() will generate a single "value" event at the location where the set() was performed.

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר	סוּג	תיאור
ref	DatabaseReference	The location to write to.
ערך	לא ידוע	The value to be written (string, number, boolean, object, array, or null).

החזרות:

Promise<void>

Resolves when write to server is complete.

setPriority(ref, priority)

Sets a priority for the data at this Database location.

Applications need not use priority but can order collections by ordinary properties (see Sorting and filtering data ).

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר	סוּג	תיאור
ref	DatabaseReference	The location to write to.
עדיפות	מחרוזת \| number \| ריק	The priority to be written (string, number, or null).

החזרות:

Promise<void>

Resolves when write to server is complete.

setWithPriority(ref, value, priority)

Writes data the Database location. Like set() but also specifies the priority for that data.

Applications need not use priority but can order collections by ordinary properties (see Sorting and filtering data ).

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר	סוּג	תיאור
ref	DatabaseReference	The location to write to.
ערך	לא ידוע	The value to be written (string, number, boolean, object, array, or null).
עדיפות	מחרוזת \| number \| ריק	The priority to be written (string, number, or null).

החזרות:

Promise<void>

Resolves when write to server is complete.

update(ref, values)

Writes multiple values to the Database at once.

The values argument contains multiple property-value pairs that will be written to the Database together. Each child property can either be a simple property (for example, "name") or a relative path (for example, "name/first") from the current location to the data to update.

As opposed to the set() method, update() can be use to selectively update only the referenced properties at the current location (instead of replacing all the child properties at the current location).

The effect of the write will be visible immediately, and the corresponding events ('value', 'child_added', etc.) will be triggered. Synchronization of the data to the Firebase servers will also be started, and the returned Promise will resolve when complete. If provided, the onComplete callback will be called asynchronously after synchronization has finished.

A single update() will generate a single "value" event at the location where the update() was performed, regardless of how many children were modified.

Note that modifying data with update() will cancel any pending transactions at that location, so extreme care should be taken if mixing update() and transaction() to modify the same data.

Passing null to update() will remove the data at this location.

See Introducing multi-location updates and more .

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר	סוּג	תיאור
ref	DatabaseReference	The location to write to.
ערכים	לְהִתְנַגֵד	Object containing multiple values.

החזרות:

Promise<void>

Resolves when update on server is complete.

function(value, ...)

endAt(value, key)

Creates a QueryConstraint with the specified ending point.

Using startAt() , startAfter() , endBefore() , endAt() and equalTo() allows you to choose arbitrary starting and ending points for your queries.

The ending point is inclusive, so children with exactly the specified value will be included in the query. The optional key argument can be used to further limit the range of the query. If it is specified, then children that have exactly the specified value must also have a key name less than or equal to the specified key.

You can read more about endAt() in Filtering data .

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר	סוּג	תיאור
ערך	number \| מחרוזת \| boolean \| ריק	The value to end at. The argument type depends on which `orderBy ()` function was used in this query. Specify a value that matches the `orderBy ()` type. When used in combination with `orderByKey()` , the value must be a string.
מַפְתֵחַ	חוּט	The child key to end at, among the children with the previously specified priority. This argument is only allowed if ordering by child, value, or priority.

החזרות:

QueryConstraint

endBefore(value, key)

Creates a QueryConstraint with the specified ending point (exclusive).

Using startAt() , startAfter() , endBefore() , endAt() and equalTo() allows you to choose arbitrary starting and ending points for your queries.

The ending point is exclusive. If only a value is provided, children with a value less than the specified value will be included in the query. If a key is specified, then children must have a value less than or equal to the specified value and a key name less than the specified key.

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר	סוּג	תיאור
ערך	number \| מחרוזת \| boolean \| ריק	The value to end before. The argument type depends on which `orderBy ()` function was used in this query. Specify a value that matches the `orderBy ()` type. When used in combination with `orderByKey()` , the value must be a string.
מַפְתֵחַ	חוּט	The child key to end before, among the children with the previously specified priority. This argument is only allowed if ordering by child, value, or priority.

החזרות:

QueryConstraint

equalTo(value, key)

Creates a QueryConstraint that includes children that match the specified value.

Using startAt() , startAfter() , endBefore() , endAt() and equalTo() allows you to choose arbitrary starting and ending points for your queries.

The optional key argument can be used to further limit the range of the query. If it is specified, then children that have exactly the specified value must also have exactly the specified key as their key name. This can be used to filter result sets with many matches for the same value.

You can read more about equalTo() in Filtering data .

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר	סוּג	תיאור
ערך	number \| מחרוזת \| boolean \| ריק	The value to match for. The argument type depends on which `orderBy ()` function was used in this query. Specify a value that matches the `orderBy ()` type. When used in combination with `orderByKey()` , the value must be a string.
מַפְתֵחַ	חוּט	The child key to start at, among the children with the previously specified priority. This argument is only allowed if ordering by child, value, or priority.

החזרות:

QueryConstraint

startAfter(value, key)

Creates a QueryConstraint with the specified starting point (exclusive).

Using startAt() , startAfter() , endBefore() , endAt() and equalTo() allows you to choose arbitrary starting and ending points for your queries.

The starting point is exclusive. If only a value is provided, children with a value greater than the specified value will be included in the query. If a key is specified, then children must have a value greater than or equal to the specified value and aa key name greater than the specified key.

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר	סוּג	תיאור
ערך	number \| מחרוזת \| boolean \| ריק	The value to start after. The argument type depends on which `orderBy ()` function was used in this query. Specify a value that matches the `orderBy ()` type. When used in combination with `orderByKey()` , the value must be a string.
מַפְתֵחַ	חוּט	The child key to start after. This argument is only allowed if ordering by child, value, or priority.

החזרות:

QueryConstraint

startAt(value, key)

Creates a QueryConstraint with the specified starting point.

Using startAt() , startAfter() , endBefore() , endAt() and equalTo() allows you to choose arbitrary starting and ending points for your queries.

The starting point is inclusive, so children with exactly the specified value will be included in the query. The optional key argument can be used to further limit the range of the query. If it is specified, then children that have exactly the specified value must also have a key name greater than or equal to the specified key.

You can read more about startAt() in Filtering data .

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר	סוּג	תיאור
ערך	number \| מחרוזת \| boolean \| ריק	The value to start at. The argument type depends on which `orderBy ()` function was used in this query. Specify a value that matches the `orderBy ()` type. When used in combination with `orderByKey()` , the value must be a string.
מַפְתֵחַ	חוּט	The child key to start at. This argument is only allowed if ordering by child, value, or priority.

החזרות:

QueryConstraint

סוג אירוע

One of the following strings: "value", "child_added", "child_changed", "child_removed", or "child_moved."

חֲתִימָה:

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

QueryConstraintType

Describes the different query constraints available in this SDK.

חֲתִימָה:

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

בטל את המנוי

A callback that can invoked to remove a listener.

חֲתִימָה:

export declare type Unsubscribe = () => void;