ConditionalUpdate

Command to modify existing item attributes with a condition expression.

Example

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

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

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

const conditionalUpdateCommand = new ConditionalUpdate({
  key: { userId: 'user123' },
  update: { balance: add(50) },
  condition: { status: 'active' },
  returnValues: 'ALL_NEW',
});

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

Type Parameters

Schema

Schema extends ZodObject

The Zod schema defining the structure of the entity.

Implements

• BaseCommand<ConditionalUpdateResult<Schema>, Schema>
• WriteTransactable<Schema>

Constructors

Constructor

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

Parameters

config

ConditionalUpdateConfig<Schema>

Returns

ConditionalUpdate<Schema>

Methods

execute()

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

Parameters

entity

DynamoEntity<Schema>

Returns

Promise<ConditionalUpdateResult<Schema>>

Implementation of

BaseCommand.execute

---

prepareWriteTransaction()

prepareWriteTransaction(entity): Promise<TransactWriteOperation>;

Parameters

entity

DynamoEntity<Schema>

Returns

Promise<TransactWriteOperation>

Implementation of

WriteTransactable.prepareWriteTransaction