Callable

Index

Type aliases

DocumentChangeType

DocumentChangeType:"added" |"removed" |"modified"

The type of aDocumentChange may be 'added', 'removed', or 'modified'.

DocumentData

DocumentData:{}

Document data (for use withDocumentReference.set()) consists of fieldsmapped to values.

Type declaration

  • [field:string]:any

EmulatorMockTokenOptions

EmulatorMockTokenOptions:EmulatorMockTokenOptions

FirestoreErrorCode

FirestoreErrorCode:"cancelled" |"unknown" |"invalid-argument" |"deadline-exceeded" |"not-found" |"already-exists" |"permission-denied" |"resource-exhausted" |"failed-precondition" |"aborted" |"out-of-range" |"unimplemented" |"internal" |"unavailable" |"data-loss" |"unauthenticated"

The set of Firestore status codes. The codes are the same at the onesexposed by gRPC here:https://github.com/grpc/grpc/blob/master/doc/statuscodes.md

Possible values:

  • 'cancelled': The operation was cancelled (typically by the caller).
  • 'unknown': Unknown error or an error from a different error domain.
  • 'invalid-argument': Client specified an invalid argument. Note that thisdiffers from 'failed-precondition'. 'invalid-argument' indicatesarguments that are problematic regardless of the state of the system(e.g. an invalid field name).
  • 'deadline-exceeded': Deadline expired before operation could complete.For operations that change the state of the system, this error may bereturned even if the operation has completed successfully. For example,a successful response from a server could have been delayed long enoughfor the deadline to expire.
  • 'not-found': Some requested document was not found.
  • 'already-exists': Some document that we attempted to create alreadyexists.
  • 'permission-denied': The caller does not have permission to execute thespecified operation.
  • 'resource-exhausted': Some resource has been exhausted, perhaps aper-user quota, or perhaps the entire file system is out of space.
  • 'failed-precondition': Operation was rejected because the system is notin a state required for the operation's execution.
  • 'aborted': The operation was aborted, typically due to a concurrencyissue like transaction aborts, etc.
  • 'out-of-range': Operation was attempted past the valid range.
  • 'unimplemented': Operation is not implemented or not supported/enabled.
  • 'internal': Internal errors. Means some invariants expected byunderlying system has been broken. If you see one of these errors,something is very broken.
  • 'unavailable': The service is currently unavailable. This is most likelya transient condition and may be corrected by retrying with a backoff.
  • 'data-loss': Unrecoverable data loss or corruption.
  • 'unauthenticated': The request does not have valid authenticationcredentials for the operation.

LogLevel

LogLevel:"debug" |"error" |"silent"

OrderByDirection

OrderByDirection:"desc" |"asc"

The direction of aQuery.orderBy() clause is specified as 'desc' or 'asc'(descending or ascending).

TaskState

TaskState:"Error" |"Running" |"Success"

Represents the state of bundle loading tasks.

Both 'Error' and 'Success' are sinking state: task will abort or complete and there willbe no more updates after they are reported.

UpdateData

UpdateData:{}

Update data (for use withDocumentReference.update()) consists of fieldpaths (e.g. 'foo' or 'foo.baz') mapped to values. Fields that contain dotsreference nested fields within the document.

Type declaration

  • [fieldPath:string]:any

WhereFilterOp

WhereFilterOp:"<" |"<=" |"==" |"!=" |">=" |">" |"array-contains" |"in" |"array-contains-any" |"not-in"

Filter conditions in aQuery.where() clause are specified using thestrings '<', '<=', '==', '!=', '>=', '>', 'array-contains', 'in','array-contains-any', and 'not-in'.

Variables

Const CACHE_SIZE_UNLIMITED

CACHE_SIZE_UNLIMITED:number

Constant used to indicate the LRU garbage collection should be disabled.Set this value as thecacheSizeBytes on the settings passed to theFirestore instance.

Functions

setLogLevel

  • setLogLevel(logLevel: LogLevel):void

  • Sets the verbosity of Cloud Firestore logs (debug, error, or silent).

    Parameters

    • logLevel:LogLevel

      The verbosity you set for activity and error logging. Can be any ofthe following values:

      • debug for the most verbose logging level, primarily fordebugging.
      • error to log errors only.
      • silent to turn off logging.

    Returnsvoid

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2022-07-27 UTC.