Class WriteTransactionCollection

Represents a collection of a Ditto store that is used in the context of a write transaction.

Supports most of a regular collection's functionality but cannot be subscribed or live queried and can not be used to create attachments.

Create a WriteTransactionCollection by starting a WriteTransaction and using its scoped method.

Implements

CollectionInterface

Index

Properties

Methods

find findAll findByID upsert

Properties

`Readonly` name

name: string

The name of the collection.

Methods

find

find(query, queryArgs?): WriteTransactionPendingCursorOperation
Search for documents in this collection using the provided query string.

The returned cursor operation can be used to chain operations on the resulting document set.
Parameters
- query: string
  The query to run against the collection.
- Optional queryArgs: QueryArguments
  These arguments replace placeholders in the provided query.
Returns WriteTransactionPendingCursorOperation
Implementation of CollectionInterface.find

findAll

findAll(): WriteTransactionPendingCursorOperation
Convenience method, equivalent to calling find() and passing the query "true".

Returns WriteTransactionPendingCursorOperation
Implementation of CollectionInterface.findAll

findByID

findByID(id): WriteTransactionPendingIDSpecificOperation
Generates a WriteTransactionPendingIDSpecificOperation with the provided document ID.

The returned object can be used to find and return the document. It can also be used to update, remove or evict the document.
Parameters
- id: any
  The ID of the document to find.
Returns WriteTransactionPendingIDSpecificOperation
Implementation of CollectionInterface.findByID

upsert

upsert(value, options?): Promise<DocumentID>
Inserts a new document into the collection and returns its ID.

If the document already exists, the contents of both are merged by default. You can change this by providing a different writeStrategy via options.
Parameters
- value: DocumentValue
  The content of the document to be inserted or updated. Must not contain any non-finite numbers (NaN, Infinity, -Infinity).
- Optional options: UpsertOptions
  Change defaults for the behavior of the operation, such as the write strategy.
Returns Promise<DocumentID>
Implementation of CollectionInterface.upsert