TransactGet

Command to perform a transactional read of multiple items (all-or-nothing, strongly consistent).

Example

import { DynamoTable, DynamoEntity, key, TransactGet } from 'dynamo-document-builder';

const table = new DynamoTable({
  tableName: 'ExampleTable',
  documentClient,
});

const userEntity = new DynamoEntity({
  table,
  schema: z.object({
    userId: z.string(),
    name: z.string(),
  }),
  partitionKey: user => key('USER', user.userId),
  sortKey: () => 'METADATA',
});

const transactGetCommand = new TransactGet({
  keys: [
    { userId: 'user1' },
    { userId: 'user2' },
  ],
});

const { items } = await userEntity.send(transactGetCommand);
// items array has same order as keys, undefined if not found

Type Parameters

Schema

Schema extends ZodObject

The Zod schema defining the structure of the entity.

Implements

• BaseCommand<TransactGetResult<Schema>, Schema>

Constructors

Constructor

new TransactGet<Schema>(config): TransactGet<Schema>;

Parameters

config

TransactGetConfig<Schema>

Returns

TransactGet<Schema>

Methods

execute()

execute(entity): Promise<TransactGetResult<Schema>>;

Parameters

entity

DynamoEntity<Schema>

Returns

Promise<TransactGetResult<Schema>>

Implementation of

BaseCommand.execute