Skip to content

Latest commit

 

History

History
68 lines (45 loc) · 2.54 KB

database.databasereference.md

File metadata and controls

68 lines (45 loc) · 2.54 KB

Project: /docs/reference/js/_project.yaml Book: /docs/reference/_book.yaml page_type: reference

{% comment %} DO NOT EDIT THIS FILE! This is generated by the JS SDK team, and any local changes will be overwritten. Changes should be made in the source code at https://github.com/firebase/firebase-js-sdk {% endcomment %}

DatabaseReference interface

A DatabaseReference represents a specific location in your Database and can be used for reading or writing data to that Database location.

You can reference the root or child location in your Database by calling ref() or ref("child/path").

Writing is done with the set() method and reading can be done with the on*() method. See https://firebase.google.com/docs/database/web/read-and-write

Signature:

export declare interface DatabaseReference extends Query 

Extends: Query

Properties

Property Type Description
key string | null The last part of the DatabaseReference's path.For example, "ada" is the key for https://<DATABASE_NAME>.firebaseio.com/users/ada.The key of a root DatabaseReference is null.
parent DatabaseReference | null The parent location of a DatabaseReference.The parent of a root DatabaseReference is null.
root DatabaseReference The root DatabaseReference of the Database.

DatabaseReference.key

The last part of the DatabaseReference's path.

For example, "ada" is the key for https://<DATABASE_NAME>.firebaseio.com/users/ada.

The key of a root DatabaseReference is null.

Signature:

readonly key: string | null;

DatabaseReference.parent

The parent location of a DatabaseReference.

The parent of a root DatabaseReference is null.

Signature:

readonly parent: DatabaseReference | null;

DatabaseReference.root

The root DatabaseReference of the Database.

Signature:

readonly root: DatabaseReference;