firestore library
Firestore service.
See: firebase.google.com/docs/reference/js/firebase.firestore.
Classes
- Blob
- CollectionReference
- A CollectionReference class can be used for adding documents, getting document references, and querying for documents (using the methods inherited from Query).
- DocumentChange
- A DocumentChange represents a change to the documents matching a query. It contains the document affected and the type of change that occurred.
- DocumentReference
- A DocumentReference refers to a document location in a Firestore database and can be used to write, read, or listen to the location. The document at the referenced location may or may not exist.
- DocumentSnapshot
- A DocumentSnapshot contains data read from a document in your Cloud Firestore database. The data can be extracted with data() or get(<field>) to get a specific field.
- FieldPath
- A FieldPath refers to a field in a document. The path may consist of a single field name (referring to a top-level field in the document), or a list of field names (referring to a nested field in the document).
- FieldValue
- Sentinel values that can be used when writing document fields with set() or update().
- Firestore
- The Cloud Firestore service interface.
- GeoPoint
- An immutable object representing a geo point in Cloud Firestore. The geo point is represented as latitude/longitude pair.
- PersistenceSettings
-
Settings that can be passed to
Firestore.enablePersistenceto configure Firestore persistence. -
Query<
T extends QueryJsImpl> - A Query refers to a Query which you can read or listen to. You can also construct refined Query objects by adding filters and ordering.
- QuerySnapshot
- A QuerySnapshot contains zero or more DocumentSnapshot objects representing the results of a query. The documents can be accessed as an array via the docs property or enumerated using the forEach() method. The number of documents can be determined via the empty and size properties.
- SetOptions
-
An object to configure the WriteBatch.set behavior.
Pass
{merge: true}to only replace the values specified in the data argument. Fields omitted will remain untouched. - Settings
- Specifies custom configurations for your Cloud Firestore instance. You must set these before invoking any other methods.
- SnapshotMetadata
- Metadata about a snapshot, describing the state of the snapshot.
- Transaction
-
A reference to a transaction.
The Transaction object passed to a transaction's
updateFunction()provides the methods to read and write data within the transaction context. See: Firestore.runTransaction(). - WriteBatch
- A write batch, used to perform multiple writes as a single atomic unit.
Functions
-
setLogLevel(
String logLevel) → void - Sets the verbosity of Cloud Firestore logs.