Type Alias DurableStorageTx

A durable storage transaction. It is used to perform multiple operations on the storage in a single transaction.

type DurableStorageTx = {
    insertTaskExecutions: (
        executions: DurableTaskExecutionStorageObject[],
    ) => void | Promise<void>;
    getTaskExecutionIds: (
        where: DurableTaskExecutionStorageWhere,
        limit?: number,
    ) => string[] | Promise<string[]>;
    getTaskExecutions: (
        where: DurableTaskExecutionStorageWhere,
        limit?: number,
    ) =>
        | DurableTaskExecutionStorageObject[]
        | Promise<DurableTaskExecutionStorageObject[]>;
    updateTaskExecutions: (
        where: DurableTaskExecutionStorageWhere,
        update: DurableTaskExecutionStorageObjectUpdate,
    ) => string[] | Promise<string[]>;
}

Index

Properties

insertTaskExecutions getTaskExecutionIds getTaskExecutions updateTaskExecutions

Properties

insertTaskExecutions

insertTaskExecutions: (
executions: DurableTaskExecutionStorageObject[],
) => void | Promise<void>

Insert durable task executions.

Type declaration

- (executions: DurableTaskExecutionStorageObject[]): void | Promise<void>
- Parameters
  - executions: DurableTaskExecutionStorageObject[]
    The durable task executions to insert.
  Returns void | Promise<void>

getTaskExecutionIds

getTaskExecutionIds: (
where: DurableTaskExecutionStorageWhere,
limit?: number,
) => string[] | Promise<string[]>

Get durable task execution ids.

Type declaration

- (
  where: DurableTaskExecutionStorageWhere,
  limit?: number,
  ): string[] | Promise<string[]>
- Parameters
  - where: DurableTaskExecutionStorageWhere
    The where clause to filter the durable task executions.
  - Optionallimit: number
    The maximum number of durable task execution ids to return.
  Returns string[] | Promise<string[]>
  The ids of the durable task executions.

getTaskExecutions

getTaskExecutions: (
    where: DurableTaskExecutionStorageWhere,
    limit?: number,
) =>
    | DurableTaskExecutionStorageObject[]
    | Promise<DurableTaskExecutionStorageObject[]>

Get durable task executions.

Type declaration

- (
      where: DurableTaskExecutionStorageWhere,
      limit?: number,
  ):
      | DurableTaskExecutionStorageObject[]
      | Promise<DurableTaskExecutionStorageObject[]>
- Parameters
  - where: DurableTaskExecutionStorageWhere
    The where clause to filter the durable task executions.
  - Optionallimit: number
    The maximum number of durable task executions to return.
  Returns
  | DurableTaskExecutionStorageObject[]
  | Promise<DurableTaskExecutionStorageObject[]>
  The durable task executions.

updateTaskExecutions

updateTaskExecutions: (
where: DurableTaskExecutionStorageWhere,
update: DurableTaskExecutionStorageObjectUpdate,
) => string[] | Promise<string[]>

Update durable task executions.

Type declaration

- (
  where: DurableTaskExecutionStorageWhere,
  update: DurableTaskExecutionStorageObjectUpdate,
  ): string[] | Promise<string[]>
- Parameters
  - where: DurableTaskExecutionStorageWhere
    The where clause to filter the durable task executions.
  - update: DurableTaskExecutionStorageObjectUpdate
    The update object.
  Returns string[] | Promise<string[]>
  The ids of the durable task executions that were updated.