DeleteItemCommand
Performs a DeleteItem Operation on an entity item:
import { DeleteItemCommand } from 'dynamodb-toolbox/entity/actions/delete'
const deleteItemCommand = PokemonEntity.build(
DeleteItemCommand
)
const params = deleteItemCommand.params()
await deleteItemCommand.send()
Requestβ
.key(...)
β
(required)
The key of the item to delete (i.e. attributes that are tagged as part of the primary key):
await PokemonEntity.build(DeleteItemCommand)
.key({ pokemonId: 'pikachu1' })
.send()
You can use the KeyInputItem
generic type to explicitly type an object as a DeleteItemCommand
key object:
import type { KeyInputItem } from 'dynamodb-toolbox/entity'
const key: KeyInputItem<typeof PokemonEntity> = {
pokemonId: 'pikachu1'
}
await PokemonEntity.build(DeleteItemCommand).key(key).send()
.options(...)
β
Provides additional options:
await PokemonEntity.build(DeleteItemCommand)
.key(...)
.options({
returnValues: 'ALL_OLD',
capacity: 'TOTAL',
...
})
.send()
You can use the DeleteItemOptions
type to explicitly type an object as DeleteItemCommand
options object:
import type { DeleteItemOptions } from 'dynamodb-toolbox/entity/actions/delete'
const options: DeleteItemOptions<typeof PokemonEntity> = {
returnValues: 'ALL_OLD',
capacity: 'TOTAL',
...
}
await PokemonEntity.build(DeleteItemCommand)
.key(...)
.options(options)
.send()
Available options (see the DynamoDB documentation for more details):
Option | Type | Default | Description |
---|---|---|---|
condition | Condition<typeof PokemonEntity> | - | A condition that must be satisfied in order for the DeleteItemCommand to succeed.See the ConditionParser action for more details on how to write conditions. |
returnValues | ReturnValuesOption | "NONE" | To get the item attributes as they appeared before they were deleted with the request. Possible values are "NONE" and "ALL_OLD" . |
metrics | MetricsOption | "NONE" | Determines whether item collection metrics are returned. Possible values are "NONE" and "SIZE" . |
capacity | CapacityOption | "NONE" | Determines the level of detail about provisioned or on-demand throughput consumption that is returned in the response. Possible values are "NONE" , "TOTAL" and "INDEXES" . |
tableName | string | - | Overrides the Table name. Mostly useful for multitenancy. |
Examples
- Conditional write
- Return values
- Multitenancy
await PokemonEntity.build(DeleteItemCommand)
.key({ pokemonId: 'pikachu1' })
.options({
condition: { attr: 'archived', eq: true }
})
.send()
const { Attributes: prevPikachu } =
await PokemonEntity.build(DeleteItemCommand)
.key({ pokemonId: 'pikachu1' })
.options({
returnValues: 'ALL_OLD'
})
.send()
await PokemonEntity.build(DeleteItemCommand)
.key({ pokemonId: 'pikachu1' })
.options({
tableName: `tenant-${tenantId}-pokemons`
})
.send()
Responseβ
The data is returned using the same response syntax as the DynamoDB DeleteItem API. If present, the returned item is formatted by the Entity.
You can use the DeleteItemResponse
type to explicitly type an object as a DeleteItemCommand
response object:
import type { DeleteItemResponse } from 'dynamodb-toolbox/entity/actions/delete'
const deleteItemResponse: DeleteItemResponse<
typeof PokemonEntity,
// π Optional options
{ returnValues: 'ALL_OLD' }
// π Typed as PokemonΒ | undefined
> = { Attributes: ... }