Put

Command to create or replace an item in a DynamoDB table.

Example

import { DynamoTable, DynamoEntity, key, Put } 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 putCommand = new Put({
  item: {
    userId: 'user123',
    name: 'John Doe',
    email: 'john@example.com',
  },
  returnValues: 'ALL_OLD',
});

const { returnItem } = await userEntity.send(putCommand);

Type Parameters

Schema

Schema extends ZodObject

The Zod schema defining the structure of the entity.

Implements

BaseCommand<PutResult<Schema>, Schema>
WriteTransactable<Schema>

Constructors

Constructor

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

Parameters

config

PutConfig<Schema>

Returns

Put<Schema>

Methods

buildItem()

buildItem(entity): Promise<
  | output<Schema> & DynamoKey
  | input<Schema> & DynamoKey>;

Parameters

entity

DynamoEntity<Schema>

Returns

Promise< | output<Schema> & DynamoKey | input<Schema> & DynamoKey>

execute()

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

Parameters

entity

DynamoEntity<Schema>

Returns

Promise<PutResult<Schema>>

Implementation of

BaseCommand.execute

prepareWriteTransaction()

prepareWriteTransaction(entity): Promise<TransactWriteOperation>;

Parameters