Class QueryResult<T>

Readonlyitems

commitID

• get commitID(): bigint

• The commit ID associated with this query result, if any.

  This ID uniquely identifies the commit in which this change was accepted into the local store. The commit ID is available for all query results involving insertions, updates, or deletions. This ID can be used to track whether a local change has been synced to other peers.

  For write transactions, the commit ID is only available after the transaction has been successfully committed. Queries executed within an uncommitted transaction will not have a commit ID.

  Returns bigint

mutatedDocumentIDs

• mutatedDocumentIDs(): DocumentID[]

• IDs of documents that were mutated locally by a mutating DQL query passed to execute(). Empty array if no documents have been mutated.

  **Note: Query results received from a StoreObserver never contain mutated document IDs because a store observer is always registered using a non-mutating SELECT query.

  Important: The returned document IDs are not cached, make sure to call this method once and keep the return value for as long as needed.

  Returns DocumentID[]

  an array of document IDs

  Deprecated

  Use mutatedDocumentIDsV2() instead. This method will be removed in a future version.

mutatedDocumentIDsV2

• mutatedDocumentIDsV2(): any[]

• IDs of documents that were mutated locally by a mutating DQL query passed to execute(). Empty array if no documents have been mutated.

  **Note: Query results received from a StoreObserver never contain mutated document IDs because a store observer is always registered using a non-mutating SELECT query.

  Important: The returned document IDs are not cached, make sure to call this method once and keep the return value for as long as needed.

  Returns any[]

  an array of document ID values as JSON-compatible values