database package

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

פונקציות

שיעורים

ממשקים

הקלד כינויים

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

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

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

חֲתִימָה:

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

פרמטרים

החזרות:

מאגר מידע

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

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

connectDatabaseEmulator(db, host, port, options)

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

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

חֲתִימָה:

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

פרמטרים

החזרות:

בָּטֵל

Gooffline (DB)

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

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

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

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

חֲתִימָה:

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

פרמטרים

החזרות:

בָּטֵל

gooonline (db)

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

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

חֲתִימָה:

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

פרמטרים

החזרות:

בָּטֵל

ref (db, path)

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

חֲתִימָה:

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

פרמטרים

החזרות:

DatabasereFerence

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

reffromurl (db, url)

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

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

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

חֲתִימָה:

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

פרמטרים

החזרות:

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;

פרמטרים

החזרות:

כל

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

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

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

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

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

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

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

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

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

חֲתִימָה:

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

פרמטרים

החזרות:

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;

פרמטרים

החזרות:

בָּטֵל

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

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

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

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

חֲתִימָה:

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

פרמטרים

החזרות:

בטל את המנוי

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

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

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

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

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

חֲתִימָה:

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

פרמטרים

החזרות:

בטל את המנוי

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

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

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

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

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

חֲתִימָה:

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

פרמטרים

החזרות:

בטל את המנוי

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

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;

פרמטרים

החזרות:

בטל את המנוי

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

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

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

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

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

חֲתִימָה:

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

פרמטרים

החזרות:

בטל את המנוי

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

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

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

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

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

חֲתִימָה:

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

פרמטרים

החזרות:

בטל את המנוי

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

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

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

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

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

חֲתִימָה:

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

פרמטרים

החזרות:

בטל את המנוי

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

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

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

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

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

חֲתִימָה:

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

פרמטרים

החזרות:

בטל את המנוי

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

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

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

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

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

חֲתִימָה:

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

פרמטרים

החזרות:

בטל את המנוי

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

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

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

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

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

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

חֲתִימָה:

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

פרמטרים

החזרות:

בטל את המנוי

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

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

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

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

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

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

חֲתִימָה:

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

פרמטרים

החזרות:

בטל את המנוי

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

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

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

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

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

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

חֲתִימָה:

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

פרמטרים

החזרות:

בטל את המנוי

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

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

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

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

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

חֲתִימָה:

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

פרמטרים

החזרות:

בטל את המנוי

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

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

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

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

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

חֲתִימָה:

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

פרמטרים

החזרות:

בטל את המנוי

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

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

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

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

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

חֲתִימָה:

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

פרמטרים

החזרות:

בטל את המנוי

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

query(query, queryConstraints)

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

חֲתִימָה:

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

פרמטרים

החזרות:

שאילתא

חריגים

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

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

OnDisconnect (ref)

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

חֲתִימָה:

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

פרמטרים

החזרות:

Ondisconnect

הסר (ref)

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

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

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

חֲתִימָה:

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

פרמטרים

החזרות:

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

פרמטרים

החזרות:

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

פרמטרים

החזרות:

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

פרמטרים

החזרות:

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

פרמטרים

החזרות:

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

פרמטרים

החזרות:

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;

פרמטרים

החזרות:

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;

פרמטרים

החזרות:

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;

פרמטרים

החזרות:

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;

פרמטרים

החזרות:

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;

פרמטרים

החזרות:

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;