database package

قاعدة بيانات Firebase في الوقت الحقيقي

المهام

الطبقات

واجهات

اكتب الأسماء المستعارة

وظيفة (التطبيق، ...)

الحصول على قاعدة البيانات (التطبيق، عنوان url)

إرجاع مثيل Realtime Database SDK المرتبط بـ FirebaseApp المقدم . تهيئة مثيل جديد باستخدام الإعدادات الافتراضية في حالة عدم وجود مثيل أو إذا كان المثيل الحالي يستخدم عنوان URL لقاعدة بيانات مخصصة.

إمضاء:

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

حدود

عائدات:

قاعدة البيانات

مثيل قاعدة Database للتطبيق المقدم.

وظيفة (ديسيبل، ...)

ConnectDatabaseEmulator (ديسيبل، المضيف، المنفذ، الخيارات)

قم بتعديل المثيل المقدم للتواصل مع محاكي قاعدة بيانات Realtime.

ملاحظة: يجب استدعاء هذه الطريقة قبل إجراء أي عملية أخرى.

إمضاء:

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;

حدود

عائدات:

فارغ

Goonline (DB)

إعادة الاتصال إلى الخادم ويتم مزامنة حالة قاعدة البيانات في وضع عدم الاتصال مع حالة الخادم.

يجب استخدام هذه الطريقة بعد تعطيل الاتصال النشط بـ goOffline() . بمجرد إعادة الاتصال ، يقوم العميل بنقل البيانات المناسبة وإطلاق الأحداث المناسبة بحيث يلحق العميل "بالركب" تلقائيًا.

إمضاء:

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

حدود

عائدات:

فارغ

المرجع (ديسيبل، المسار)

إرجاع Reference يمثل الموقع في قاعدة البيانات المقابلة للمسار المقدم. إذا لم يتم توفير أي مسار ، فستشير Reference إلى جذر قاعدة البيانات.

إمضاء:

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

حدود

عائدات:

قاعدة البيانات

إذا تم توفير مسار ، يشير Reference إلى المسار المقدم. خلاف ذلك ، Reference تشير إلى جذر قاعدة البيانات.

reffromurl (DB ، URL)

إرجاع Reference يمثل الموقع في قاعدة البيانات المقابلة لعنوان URL Firebase المقدم.

يتم إلقاء استثناء إذا لم يكن عنوان URL عنوان URL للقاعدة بيانات Firebase ساري المفعول أو يحتوي على مجال مختلف عن مثيل Database الحالي.

لاحظ أن جميع معلمات الاستعلام ( orderBy ، limitToLast ، وما إلى ذلك) يتم تجاهلها ولا يتم تطبيقها على Reference الذي تم إرجاعه .

إمضاء:

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

حدود

عائدات:

قاعدة البيانات

Reference يشير إلى عنوان URL Firebase المقدم.

وظيفة()

forcelongpolling ()

فرض استخدام LongPolling بدلاً من WebSockets. سيتم تجاهل هذا إذا تم استخدام بروتوكول WebSocket في Databaseurl.

إمضاء:

export declare function forceLongPolling(): void;

عائدات:

فارغ

ForceWebSockets ()

فرض استخدام WebSockets بدلاً من Longpolling.

إمضاء:

export declare function forceWebSockets(): void;

عائدات:

فارغ

Orderbykey ()

يخلق QueryConstraint جديد يطلب من المفتاح.

بفرز نتائج الاستعلام من قِبل قيمها الرئيسية (الصعودية).

يمكنك قراءة المزيد حول orderByKey() في بيانات الفرز .

إمضاء:

export declare function orderByKey(): QueryConstraint;

عائدات:

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;

عائدات:

هدف

وظيفة (دلتا ، ...)

زيادة (دلتا)

إرجاع قيمة العنصر النائب الذي يمكن استخدامه لزيادة قيمة قاعدة البيانات الحالية من قبل دلتا المقدمة.

إمضاء:

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

حدود

عائدات:

هدف

قيمة العنصر النائب لتعديل البيانات من جانب الخادم ذري.

وظيفة (تمكين ، ...)

تمكين التسجيل (ممكّن، مستمر)

سجلات تصحيح المعلومات إلى وحدة التحكم.

إمضاء:

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

حدود

عائدات:

أي

وظيفة (الحد ، ...)

limittofirst (الحد)

ينشئ QueryConstraint جديد أنه إذا كان التقصر على العدد المحدد الأول من الأطفال.

يتم استخدام طريقة limitToFirst() لتعيين الحد الأقصى لعدد الأطفال المراد مزامنتهم لاستدعاء رد فعل معين. إذا حددنا 100 100 ، فسنحصل في البداية فقط على ما يصل إلى 100 حدث child_added . إذا كان لدينا أقل من 100 رسالة مخزنة في قاعدة البيانات الخاصة بنا ، فسيتم إطلاق حدث child_added لكل رسالة. ومع ذلك ، إذا كان لدينا أكثر من 100 رسالة ، فسنستقبل فقط حدث child_added لأول 100 رسالة مرتبة. مع تغير العناصر ، سوف نتلقى أحداث child_removed لكل عنصر ينطلق من القائمة النشطة بحيث يبقى العدد الإجمالي عند 100.

يمكنك قراءة المزيد حول limitToFirst() في تصفية البيانات .

إمضاء:

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

حدود

عائدات:

QueryConstraint

LimitTolast (الحد)

ينشئ QueryConstraint جديد يقتصر على إرجاع آخر عدد محدد من الأطفال.

يتم استخدام طريقة limitToLast() لتعيين الحد الأقصى لعدد الأطفال المراد مزامنتهم لاستدعاء رد فعل معين. إذا حددنا 100 100 ، فسنحصل في البداية فقط على ما يصل إلى 100 حدث child_added . إذا كان لدينا أقل من 100 رسالة مخزنة في قاعدة البيانات الخاصة بنا ، فسيتم إطلاق حدث child_added لكل رسالة. ومع ذلك ، إذا كان لدينا أكثر من 100 رسالة ، فلن نتلقى سوى حدث child_added لآخر 100 رسالة مرتبة. مع تغير العناصر ، سوف نتلقى أحداث child_removed لكل عنصر ينطلق من القائمة النشطة بحيث يبقى العدد الإجمالي عند 100.

يمكنك قراءة المزيد حول limitToLast() في تصفية البيانات .

إمضاء:

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

حدود

عائدات:

QueryConstraint

وظيفة (المسجل، ...)

تمكين التسجيل (المسجل)

سجلات تصحيح المعلومات إلى وحدة التحكم.

إمضاء:

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

حدود

عائدات:

أي

وظيفة (الوالد ، ...)

الطفل (الوالد ، المسار)

يحصل على Reference للموقع في المسار النسبي المحدد.

يمكن أن يكون المسار النسبي إما اسمًا بسيطًا للطفل (على سبيل المثال ، "ADA") أو مسار مفصل بشكل أعمق (على سبيل المثال ، "ADA/Name/First").

إمضاء:

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

حدود

عائدات:

قاعدة البيانات

موقع الطفل المحدد.

دفع (الوالد، القيمة)

يولد موقع طفل جديد باستخدام مفتاح فريد ويعيد Reference .

هذا هو النمط الأكثر شيوعًا لإضافة البيانات إلى مجموعة من العناصر.

إذا قدمت قيمة push() ، تتم كتابة القيمة إلى الموقع الذي تم إنشاؤه. إذا لم تقم بتمرير قيمة ، فلا يوجد شيء مكتوب إلى قاعدة البيانات ويظل الطفل فارغًا (ولكن يمكنك استخدام Reference في مكان آخر).

يتم طلب المفاتيح الفريدة التي تم إنشاؤها بواسطة push() في الوقت الحالي ، وبالتالي يتم فرز القائمة الناتجة للعناصر الزمنية. تم تصميم المفاتيح أيضًا لتكون غير قابلة للتخمين (فهي تحتوي على 72 بت عشوائي من الانتروبيا).

انظر إلحاق قائمة البيانات . انظر 2^120 طرق لضمان معرفات فريدة .

إمضاء:

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

حدود

عائدات:

آنذاك

Promise المشترك Reference ; يحل عند اكتمال الكتابة ، ولكن يمكن استخدامه على الفور Reference إلى موقع الطفل.

وظيفة (المسار ، ...)

Orderbychild (مسار)

ينشئ QueryConstraint جديد يطلب من مفتاح الطفل المحدد.

يمكن أن تطلب الاستعلامات فقط بمفتاح واحد في وقت واحد. استدعاء orderByChild() عدة مرات على نفس الاستعلام هو خطأ.

يتيح لك استعلامات Firebase طلب بياناتك من قبل أي مفتاح طفل أثناء الطيران. ومع ذلك ، إذا كنت تعرف مقدمًا ما ستكون عليه فهارسك ، فيمكنك تحديدها عبر قاعدة .indexon في قواعد الأمان الخاصة بك لتحسين أداء. راجع 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 ، رد الاتصال)

ينفصل رد الاتصال المرفق مسبقًا مع المقابل on*() ( onValue ، onChildAdded ) المستمع. ملاحظة: هذه ليست الطريقة الموصى بها لإزالة المستمع. بدلاً من ذلك ، يرجى استخدام وظيفة رد الاتصال التي تم إرجاعها من المعلق on* عمليات الاسترجاعات.

افصل رد الاتصال المرفق مسبقًا مع on*() . لن يتم إلغاء off() على مستمع أولياء الأمور تلقائيًا إزالة المستمعين المسجلين في العقد الفرعية ، يجب أيضًا استدعاء off() على أي مستمعين للأطفال لإزالة رد الاتصال.

إذا لم يتم تحديد رد الاتصال ، فسيتم إزالة جميع عمليات الاسترجاع الخاصة بـ EventType المحددة. وبالمثل ، في حالة عدم تحديد أي حدث ، ستتم إزالة جميع عمليات الاسترجاعات Reference .

يمكن أيضًا إزالة المستمعين الفرديين من خلال استدعاء عمليات الاسترجاعات الخاصة بهم.

إمضاء:

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

حدود

عائدات:

فارغ

Onchildadded (الاستعلام ، رد الاتصال ، CancelCallback)

يستمع لتغييرات البيانات في موقع معين.

هذه هي الطريقة الأساسية لقراءة البيانات من قاعدة بيانات. سيتم تشغيل رد الاتصال الخاص بك للبيانات الأولية ومرة ​​أخرى كلما تغيرت البيانات. استدعاء رد اتصال إلغاء الاشتراك الذي تم إرجاعه للتوقف عن تلقي التحديثات. راجع استرداد البيانات على الويب لمزيد من التفاصيل.

سيتم تشغيل حدث 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 (استعلام، رد اتصال، إلغاء رد الاتصال)

يستمع لتغييرات البيانات في موقع معين.

هذه هي الطريقة الأساسية لقراءة البيانات من قاعدة بيانات. سيتم تشغيل رد الاتصال الخاص بك للبيانات الأولية ومرة ​​أخرى كلما تغيرت البيانات. استدعاء رد اتصال إلغاء الاشتراك الذي تم إرجاعه للتوقف عن تلقي التحديثات. راجع استرداد البيانات على الويب لمزيد من التفاصيل.

سيتم تشغيل حدث 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 (الاستعلام ، رد الاتصال ، CancelCallback ، خيارات)

يستمع لتغييرات البيانات في موقع معين.

هذه هي الطريقة الأساسية لقراءة البيانات من قاعدة بيانات. سيتم تشغيل رد الاتصال الخاص بك للبيانات الأولية ومرة ​​أخرى كلما تغيرت البيانات. استدعاء رد اتصال إلغاء الاشتراك الذي تم إرجاعه للتوقف عن تلقي التحديثات. راجع استرداد البيانات على الويب لمزيد من التفاصيل.

سيتم تشغيل حدث 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;

حدود

عائدات:

إلغاء الاشتراك

وظيفة يمكن استدعاؤها لإزالة المستمع.

OnchildMoved (الاستعلام ، رد الاتصال ، CancelCallback)

يستمع لتغييرات البيانات في موقع معين.

هذه هي الطريقة الأساسية لقراءة البيانات من قاعدة بيانات. سيتم تشغيل رد الاتصال الخاص بك للبيانات الأولية ومرة ​​أخرى كلما تغيرت البيانات. استدعاء رد اتصال إلغاء الاشتراك الذي تم إرجاعه للتوقف عن تلقي التحديثات. راجع استرداد البيانات على الويب لمزيد من التفاصيل.

سيتم تشغيل حدث onChildMoved عندما يتغير ترتيب فرز الطفل بحيث يتغير موقعه بالنسبة إلى أشقائه. سيكون DataSnapshot تم نقله إلى رد الاتصال لبيانات الطفل الذي تحرك. يتم تمريره أيضًا وسيطة ثانية وهي سلسلة تحتوي على مفتاح الطفل الأخوي السابق حسب ترتيب الفرز ، أو null إذا كان الطفل الأول.

إمضاء:

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

حدود

عائدات:

إلغاء الاشتراك

وظيفة يمكن استدعاؤها لإزالة المستمع.

OnchildMoved (الاستعلام ، رد الاتصال ، الخيارات)

يستمع لتغييرات البيانات في موقع معين.

هذه هي الطريقة الأساسية لقراءة البيانات من قاعدة بيانات. سيتم تشغيل رد الاتصال الخاص بك للبيانات الأولية ومرة ​​أخرى كلما تغيرت البيانات. استدعاء رد اتصال إلغاء الاشتراك الذي تم إرجاعه للتوقف عن تلقي التحديثات. راجع استرداد البيانات على الويب لمزيد من التفاصيل.

سيتم تشغيل حدث onChildMoved عندما يتغير ترتيب فرز الطفل بحيث يتغير موقعه بالنسبة إلى أشقائه. سيكون DataSnapshot تم نقله إلى رد الاتصال لبيانات الطفل الذي تحرك. يتم تمريره أيضًا وسيطة ثانية وهي سلسلة تحتوي على مفتاح الطفل الأخوي السابق حسب ترتيب الفرز ، أو null إذا كان الطفل الأول.

إمضاء:

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

حدود

عائدات:

إلغاء الاشتراك

وظيفة يمكن استدعاؤها لإزالة المستمع.

OnchildMoved (الاستعلام ، رد الاتصال ، CancelCallback ، خيارات)

يستمع لتغييرات البيانات في موقع معين.

هذه هي الطريقة الأساسية لقراءة البيانات من قاعدة بيانات. سيتم تشغيل رد الاتصال الخاص بك للبيانات الأولية ومرة ​​أخرى كلما تغيرت البيانات. استدعاء رد اتصال إلغاء الاشتراك الذي تم إرجاعه للتوقف عن تلقي التحديثات. راجع استرداد البيانات على الويب لمزيد من التفاصيل.

سيتم تشغيل حدث onChildMoved عندما يتغير ترتيب فرز الطفل بحيث يتغير موقعه بالنسبة إلى أشقائه. سيكون DataSnapshot تم نقله إلى رد الاتصال لبيانات الطفل الذي تحرك. يتم تمريره أيضًا وسيطة ثانية وهي سلسلة تحتوي على مفتاح الطفل الأخوي السابق حسب ترتيب الفرز ، أو null إذا كان الطفل الأول.

إمضاء:

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

حدود

عائدات:

إلغاء الاشتراك

وظيفة يمكن استدعاؤها لإزالة المستمع.

onChildRemoved (الاستعلام، رد الاتصال، إلغاء رد الاتصال)

يستمع لتغييرات البيانات في موقع معين.

هذه هي الطريقة الأساسية لقراءة البيانات من قاعدة بيانات. سيتم تشغيل رد الاتصال الخاص بك للبيانات الأولية ومرة ​​أخرى كلما تغيرت البيانات. استدعاء رد اتصال إلغاء الاشتراك الذي تم إرجاعه للتوقف عن تلقي التحديثات. راجع استرداد البيانات على الويب لمزيد من التفاصيل.

سيتم تشغيل حدث onChildRemoved مرة واحدة في كل مرة يتم فيها إزالة الطفل. ستكون DataSnapshot التي تم تمريرها إلى رد الاتصال هي البيانات القديمة للطفل الذي تمت إزالته. سيتم إزالة الطفل عند: إما:

• يتصل العميل صراحة remove() على ذلك الطفل أو أحد أسلافه - set(null) على ذلك الطفل أو أحد أسلافه - أن الطفل قد تمت إزالته من جميع أطفاله - هناك استعلام في الواقع مرشحات الآن خارج الطفل (لأنه تم تغيير ترتيب الفرز أو تم ضرب الحد الأقصى)

إمضاء:

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

حدود

عائدات:

إلغاء الاشتراك

وظيفة يمكن استدعاؤها لإزالة المستمع.

onChildRemoved (الاستعلام، رد الاتصال، الخيارات)

يستمع لتغييرات البيانات في موقع معين.

هذه هي الطريقة الأساسية لقراءة البيانات من قاعدة بيانات. سيتم تشغيل رد الاتصال الخاص بك للبيانات الأولية ومرة ​​أخرى كلما تغيرت البيانات. استدعاء رد اتصال إلغاء الاشتراك الذي تم إرجاعه للتوقف عن تلقي التحديثات. راجع استرداد البيانات على الويب لمزيد من التفاصيل.

سيتم تشغيل حدث onChildRemoved مرة واحدة في كل مرة يتم فيها إزالة الطفل. ستكون DataSnapshot التي تم تمريرها إلى رد الاتصال هي البيانات القديمة للطفل الذي تمت إزالته. سيتم إزالة الطفل عند: إما:

• يتصل العميل صراحة remove() على ذلك الطفل أو أحد أسلافه - set(null) على ذلك الطفل أو أحد أسلافه - أن الطفل قد تمت إزالته من جميع أطفاله - هناك استعلام في الواقع مرشحات الآن خارج الطفل (لأنه تم تغيير ترتيب الفرز أو تم ضرب الحد الأقصى)

إمضاء:

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

حدود

عائدات:

إلغاء الاشتراك

وظيفة يمكن استدعاؤها لإزالة المستمع.

OnchildRemoved (الاستعلام ، رد الاتصال ، CancelCallback ، خيارات)

يستمع لتغييرات البيانات في موقع معين.

هذه هي الطريقة الأساسية لقراءة البيانات من قاعدة بيانات. سيتم تشغيل رد الاتصال الخاص بك للبيانات الأولية ومرة ​​أخرى كلما تغيرت البيانات. استدعاء رد اتصال إلغاء الاشتراك الذي تم إرجاعه للتوقف عن تلقي التحديثات. راجع استرداد البيانات على الويب لمزيد من التفاصيل.

سيتم تشغيل حدث onChildRemoved مرة واحدة في كل مرة يتم فيها إزالة الطفل. ستكون DataSnapshot التي تم تمريرها إلى رد الاتصال هي البيانات القديمة للطفل الذي تمت إزالته. سيتم إزالة الطفل عند: إما:

• يتصل العميل صراحة remove() على ذلك الطفل أو أحد أسلافه - set(null) على ذلك الطفل أو أحد أسلافه - أن الطفل قد تمت إزالته من جميع أطفاله - هناك استعلام في الواقع مرشحات الآن خارج الطفل (لأنه تم تغيير ترتيب الفرز أو تم ضرب الحد الأقصى)

إمضاء:

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

حدود

عائدات:

إلغاء الاشتراك

وظيفة يمكن استدعاؤها لإزالة المستمع.

onvalue (استعلام ، رد الاتصال ، CancelCallback)

يستمع لتغييرات البيانات في موقع معين.

هذه هي الطريقة الأساسية لقراءة البيانات من قاعدة بيانات. سيتم تشغيل رد الاتصال الخاص بك للبيانات الأولية ومرة ​​أخرى كلما تغيرت البيانات. استدعاء رد اتصال إلغاء الاشتراك الذي تم إرجاعه للتوقف عن تلقي التحديثات. راجع استرداد البيانات على الويب لمزيد من التفاصيل.

سيتم تشغيل حدث 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 (الاستعلام ، رد الاتصال ، CancelCallback ، خيارات)

يستمع لتغييرات البيانات في موقع معين.

هذه هي الطريقة الأساسية لقراءة البيانات من قاعدة بيانات. سيتم تشغيل رد الاتصال الخاص بك للبيانات الأولية ومرة ​​أخرى كلما تغيرت البيانات. استدعاء رد اتصال إلغاء الاشتراك الذي تم إرجاعه للتوقف عن تلقي التحديثات. راجع استرداد البيانات على الويب لمزيد من التفاصيل.

سيتم تشغيل حدث onValue مرة واحدة مع البيانات الأولية المخزنة في هذا الموقع ، ثم تشغيل مرة أخرى في كل مرة يتغير فيها البيانات. سيكون DataSnapshot تم نقله إلى رد الاتصال للموقع الذي تم استدعاء on() . لن يتم تشغيله حتى تتم مزامنة المحتويات بأكملها. إذا لم يكن الموقع لا يحتوي على بيانات ، فسيتم تشغيله باستخدام DataSnapshot ( val() null ).

إمضاء:

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

حدود

عائدات:

إلغاء الاشتراك

وظيفة يمكن استدعاؤها لإزالة المستمع.

الاستعلام (الاستعلام، الاستعلام القيود)

ينشئ مثيلًا جديدًا Query يتم تمديده ليشمل أيضًا قيودًا إضافية على الاستعلام.

إمضاء:

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

حدود

عائدات:

استفسار

الاستثناءات

إذا كان لا يمكن دمج أي من قيود الاستعلام المقدمة مع القيود الحالية أو الجديدة.

وظيفة (المرجع ، ...)

onDisconnect (المرجع)

إرجاع كائن OnDisconnect - راجع تمكين القدرات غير المتصلة بالإنترنت في JavaScript لمزيد من المعلومات حول كيفية استخدامه.

إمضاء:

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

حدود

عائدات:

onDisconnect

إزالة (المرجع)

يزيل البيانات في موقع قاعدة البيانات هذا.

سيتم أيضًا حذف أي بيانات في مواقع الأطفال.

سيكون تأثير الإزالة مرئيًا على الفور وسيتم تشغيل "قيمة" الحدث المقابل. سيتم أيضًا بدء مزامنة الإزالة إلى خوادم Firebase ، وسيتم حل الوعد الذي تم إرجاعه عند اكتماله. إذا تم توفيره ، سيتم استدعاء رد الاتصال Oncomplete بشكل غير متزامن بعد انتهاء المزامنة.

إمضاء:

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

حدود

عائدات:

وعد <doud>

يحل عند اكتمال الإزالة على الخادم.

RunTransaction (المرجع ، المعاملات ، الخيارات)

يعدل ذري البيانات في هذا الموقع.

تعديل البيانات في هذا الموقع. على عكس 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;