Class TransactionAttemptContext

Provides an interface to preform transactional operations in a transaction.

Index

Methods

get insert query remove replace

Methods

get

get(collection, key, options?): Promise<TransactionGetResult>
Retrieves the value of a document from the collection.
Parameters
- collection: Collection
  The collection the document lives in.
- key: string
  The document key to retrieve.
- Optional options: TransactionGetOptions
  Optional parameters for this operation.
Returns Promise<TransactionGetResult>
- Defined in lib/transactions.ts:468

insert

insert(collection, key, content, options?): Promise<TransactionGetResult>
Inserts a new document to the collection, failing if the document already exists.
Parameters
- collection: Collection
  The collection the document lives in.
- key: string
  The document key to insert.
- content: any
  The document content to insert.
- Optional options: TransactionInsertOptions
  Optional parameters for this operation.
Returns Promise<TransactionGetResult>
- Defined in lib/transactions.ts:500

query

query<TRow>(statement, options?): Promise<TransactionQueryResult<TRow>>
Executes a query in the context of this transaction.
Type Parameters
- TRow = any
Parameters
- statement: string
  The statement to execute.
- Optional options: TransactionQueryOptions
  Optional parameters for this operation.
Returns Promise<TransactionQueryResult<TRow>>
- Defined in lib/transactions.ts:608

remove

remove(doc): Promise<void>
Removes a document from a collection.
Parameters
- doc: TransactionGetResult
  The document to remove.
Returns Promise<void>
- Defined in lib/transactions.ts:579

replace

replace(doc, content, options?): Promise<TransactionGetResult>
Replaces a document in a collection.
Parameters
- doc: TransactionGetResult
  The document to replace.
- content: any
  The document content to insert.
- Optional options: TransactionReplaceOptions
  Optional parameters for this operation.
Returns Promise<TransactionGetResult>
- Defined in lib/transactions.ts:537