Update

Command to modify existing item attributes in a DynamoDB table.

Example

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

const updateCommand = new Update({
  key: { userId: 'user123' },
  update: {
    name: 'Jane Doe',
    loginCount: add(1),
  },
  returnValues: 'ALL_NEW',
});

const { updatedItem } = await userEntity.send(updateCommand);

Type Parameters

Schema

Schema extends ZodObject

The Zod schema defining the structure of the entity.

Implements

BaseCommand<UpdateResult<Schema>, Schema>
WriteTransactable<Schema>

Constructors

Constructor

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

Parameters

config

UpdateConfig<Schema>

Returns

Update<Schema>

Methods

execute()

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

Parameters

entity

DynamoEntity<Schema>

Returns

Promise<UpdateResult<Schema>>

Implementation of

BaseCommand.execute

prepareWriteTransaction()

prepareWriteTransaction(entity): Promise<TransactWriteOperation>;

Parameters