Get

Command to retrieve a single item by primary key from a DynamoDB table.

Example

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

const getCommand = new Get({
  key: { userId: 'user123' },
  consistent: true,
});

const { item } = await userEntity.send(getCommand);

Type Parameters

Schema

Schema extends ZodObject

The Zod schema defining the structure of the entity.

Implements

• BaseCommand<GetResult<Schema>, Schema>

Constructors

Constructor

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

Parameters

config

GetConfig<Schema>

Returns

Get<Schema>

Methods

execute()

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

Parameters

entity

DynamoEntity<Schema>

Returns

Promise<GetResult<Schema>>

Implementation of

BaseCommand.execute