BatchGet

Command to perform a batch get operation on a DynamoDB table.

Example

import { DynamoTable, DynamoEntity, key, BatchGet } 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(),
    age: z.number(),
  }),
  partitionKey: user => key('USER', user.userId),
  sortKey: () => 'USER',
});

const batchGetCommand = new BatchGet({
  keys: [
    { userId: 'user1' },
    { userId: 'user2' },
  ],
  consistent: true,
});

const { items } = await batchGetCommand.execute(userEntity);

Type Parameters

Schema

Schema extends ZodObject

The Zod schema defining the structure of the entity.

Implements

• BaseCommand<BatchGetResult<Schema>, Schema>

Constructors

Constructor

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

Parameters

config

BatchGetConfig<Schema>

Returns

BatchGet<Schema>

Methods

execute()

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

Parameters

entity

DynamoEntity<Schema>

Returns

Promise<BatchGetResult<Schema>>

Implementation of

BaseCommand.execute