Class TransactionAttemptContext

Provides an interface to preform transactional operations in a transaction.

Index

Methods

get getMulti getMultiReplicasFromPreferredServerGroup getReplicaFromPreferredServerGroup insert query remove replace

Methods

get

get(
    collection: Collection,
    key: string,
    options?: TransactionGetOptions,
): 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.
- Optionaloptions: TransactionGetOptions
  Optional parameters for this operation.
Returns Promise<TransactionGetResult>
- Defined in lib/transactions.ts:848

getMulti

getMulti(
specs: TransactionGetMultiSpec[],
options?: TransactionGetMultiOptions,
): Promise<TransactionGetMultiResult>
Retrieves the documents specified in the list of specs.
Parameters
- specs: TransactionGetMultiSpec[]
  The documents to retrieve.
- Optionaloptions: TransactionGetMultiOptions
  Optional parameters for this operation.
Returns Promise<TransactionGetMultiResult>
- Defined in lib/transactions.ts:947

getMultiReplicasFromPreferredServerGroup

getMultiReplicasFromPreferredServerGroup(
specs: TransactionGetMultiReplicasFromPreferredServerGroupSpec[],
options?: TransactionGetMultiReplicasFromPreferredServerGroupOptions,
): Promise<TransactionGetMultiReplicasFromPreferredServerGroupResult>
Retrieves the documents specified in the list of specs.
Parameters
- specs: TransactionGetMultiReplicasFromPreferredServerGroupSpec[]
  The documents to retrieve.
- Optionaloptions: TransactionGetMultiReplicasFromPreferredServerGroupOptions
  Optional parameters for this operation.
Returns Promise<TransactionGetMultiReplicasFromPreferredServerGroupResult>
- Defined in lib/transactions.ts:909

getReplicaFromPreferredServerGroup

getReplicaFromPreferredServerGroup(
    collection: Collection,
    key: string,
    options?: TransactionGetReplicaFromPreferredServerGroupOptions,
): 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.
- Optionaloptions: TransactionGetReplicaFromPreferredServerGroupOptions
  Optional parameters for this operation.
Returns Promise<TransactionGetResult>
- Defined in lib/transactions.ts:879

insert

insert(
    collection: Collection,
    key: string,
    content: any,
    options?: TransactionInsertOptions,
): 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.
- Optionaloptions: TransactionInsertOptions
  Optional parameters for this operation.
Returns Promise<TransactionGetResult>
- Defined in lib/transactions.ts:979

query

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

remove

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

replace

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

Class TransactionAttemptContext

Index

Methods

Methods

get

Parameters

Returns Promise<TransactionGetResult>

getMulti

Parameters

Returns Promise<TransactionGetMultiResult>

getMultiReplicasFromPreferredServerGroup

Parameters

Returns Promise<TransactionGetMultiReplicasFromPreferredServerGroupResult>

getReplicaFromPreferredServerGroup

Parameters

Returns Promise<TransactionGetResult>

insert

Parameters

Returns Promise<TransactionGetResult>

query

Type Parameters

Parameters

Returns Promise<TransactionQueryResult<TRow>>

remove

Parameters

Returns Promise<void>

replace

Parameters

Returns Promise<TransactionGetResult>

Settings

On This Page