FirebaseDatabase Framework Reference
Stay organized with collections
Save and categorize content based on your preferences.
Classes
The following classes are available globally.
-
A DataSnapshot contains data from a Firebase Database location. Any time
you read Firebase data, you receive the data as a DataSnapshot.
DataSnapshots are passed to the blocks you attach with
observe(_:with:) or observeSingleEvent(of:with:). They are
efficiently-generated immutable copies of the data at a Firebase Database
location. They can’t be modified and will never change. To modify data at a
location, use a DatabaseReference (e.g. with setValue(_:)).
Declaration
Swift
class DataSnapshot : NSObject, @unchecked Sendable
-
A FIRDatabaseReference represents a particular location in your Firebase
Database and can be used for reading or writing data to that Firebase
Database location.
This class is the starting point for all Firebase Database operations. After
you’ve obtained your first FIRDatabaseReference via [FIRDatabase reference],
you can use it to read data (ie. observeEventType:withBlock:), write data
(ie. setValue:), and to create new FIRDatabaseReferences (ie. child:).
-
The entry point for accessing a Firebase Database. You can get an instance
by calling Database.database(). To access a location in the database and
read or write data, use FIRDatabase.reference().
Declaration
Swift
class Database : NSObject
-
A DatabaseQuery instance represents a query over the data at a particular
location.
You create one by calling one of the query methods (queryOrdered(byChild:),
queryStarting(atValue:), etc.) on a DatabaseReference. The query methods
can be chained to further specify the data you are interested in observing.
Declaration
Swift
class DatabaseQuery : NSObject
-
A MutableData instance is populated with data from a Firebase Database
location. When you are using runTransactionBlock(_:), you will be given an
instance containing the current data at that location. Your block will be
responsible for updating that instance to the data you wish to save at that
location, and then returning using TransactionResult.success(withValue:).
To modify the data, set its value property to any of the Objective-C types
supported by Firebase Database, or any equivalent natively bridgeable Swift
type:
NSNumber (includes booleans)NSDictionaryNSArrayNSStringnil / NSNull to remove the data
Note that changes made to a child MutableData instance will be visible to
the parent.
Declaration
Swift
class MutableData : NSObject
-
Placeholder values you may write into Firebase Database as a value or
priority that will automatically be populated by the Firebase Database
server.
Declaration
Swift
class ServerValue : NSObject
-
Used for runTransactionBlock(_:). A TransactionResult instance is a
container for the results of the transaction.
Declaration
Swift
class TransactionResult : NSObject
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-11 UTC.
[null,null,["Last updated 2025-03-11 UTC."],[],[],null,["# FirebaseDatabase Framework Reference\n\nClasses\n=======\n\nThe following classes are available globally.\n- `\n ``\n ``\n `\n\n ### [DataSnapshot](/docs/reference/swift/firebasedatabase/api/reference/Classes/DataSnapshot)\n\n `\n ` \n A DataSnapshot contains data from a Firebase Database location. Any time\n you read Firebase data, you receive the data as a DataSnapshot.\n\n DataSnapshots are passed to the blocks you attach with\n `observe(_:with:)` or `observeSingleEvent(of:with:)`. They are\n efficiently-generated immutable copies of the data at a Firebase Database\n location. They can't be modified and will never change. To modify data at a\n location, use a DatabaseReference (e.g. with `setValue(_:)`). \n\n #### Declaration\n\n Swift \n\n class DataSnapshot : NSObject, @unchecked Sendable\n\n- `\n ``\n ``\n `\n\n ### [DatabaseReference](/docs/reference/swift/firebasedatabase/api/reference/Classes/DatabaseReference)\n\n `\n ` \n A FIRDatabaseReference represents a particular location in your Firebase\n Database and can be used for reading or writing data to that Firebase\n Database location.\n\n This class is the starting point for all Firebase Database operations. After\n you've obtained your first FIRDatabaseReference via \\[FIRDatabase reference\\],\n you can use it to read data (ie. observeEventType:withBlock:), write data\n (ie. setValue:), and to create new FIRDatabaseReferences (ie. child:). \n\n #### Declaration\n\n Swift \n\n class DatabaseReference : /docs/reference/swift/firebasedatabase/api/reference/Classes/DatabaseQuery\n\n- `\n ``\n ``\n `\n\n ### [Database](/docs/reference/swift/firebasedatabase/api/reference/Classes/Database)\n\n `\n ` \n The entry point for accessing a Firebase Database. You can get an instance\n by calling [Database.database()](/docs/reference/swift/firebasedatabase/api/reference/Classes/Database#/c:objc(cs)FIRDatabase(cm)database). To access a location in the database and\n read or write data, use `FIRDatabase.reference()`. \n\n #### Declaration\n\n Swift \n\n class Database : NSObject\n\n- `\n ``\n ``\n `\n\n ### [DatabaseQuery](/docs/reference/swift/firebasedatabase/api/reference/Classes/DatabaseQuery)\n\n `\n ` \n A `DatabaseQuery` instance represents a query over the data at a particular\n location.\n\n You create one by calling one of the query methods (`queryOrdered(byChild:)`,\n `queryStarting(atValue:)`, etc.) on a [DatabaseReference](/docs/reference/swift/firebasedatabase/api/reference/Classes/DatabaseReference). The query methods\n can be chained to further specify the data you are interested in observing. \n\n #### Declaration\n\n Swift \n\n class DatabaseQuery : NSObject\n\n- `\n ``\n ``\n `\n\n ### [MutableData](/docs/reference/swift/firebasedatabase/api/reference/Classes/MutableData)\n\n `\n ` \n A `MutableData` instance is populated with data from a Firebase Database\n location. When you are using `runTransactionBlock(_:)`, you will be given an\n instance containing the current data at that location. Your block will be\n responsible for updating that instance to the data you wish to save at that\n location, and then returning using [TransactionResult.success(withValue:)](/docs/reference/swift/firebasedatabase/api/reference/Classes/TransactionResult#/c:objc(cs)FIRTransactionResult(cm)successWithValue:).\n\n To modify the data, set its value property to any of the Objective-C types\n supported by Firebase Database, or any equivalent natively bridgeable Swift\n type:\n - `NSNumber` (includes booleans)\n - `NSDictionary`\n - `NSArray`\n - `NSString`\n - `nil` / `NSNull` to remove the data\n\n Note that changes made to a child `MutableData` instance will be visible to\n the parent. \n\n #### Declaration\n\n Swift \n\n class MutableData : NSObject\n\n- `\n ``\n ``\n `\n\n ### [ServerValue](/docs/reference/swift/firebasedatabase/api/reference/Classes/ServerValue)\n\n `\n ` \n Placeholder values you may write into Firebase Database as a value or\n priority that will automatically be populated by the Firebase Database\n server. \n\n #### Declaration\n\n Swift \n\n class ServerValue : NSObject\n\n- `\n ``\n ``\n `\n\n ### [TransactionResult](/docs/reference/swift/firebasedatabase/api/reference/Classes/TransactionResult)\n\n `\n ` \n Used for `runTransactionBlock(_:)`. A `TransactionResult` instance is a\n container for the results of the transaction. \n\n #### Declaration\n\n Swift \n\n class TransactionResult : NSObject"]]
