BatchProjectedGet
Command to retrieve specific attributes of multiple items by primary keys in a single operation.
Example
Section titled “Example”import { DynamoTable, DynamoEntity, key, BatchProjectedGet } 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(), age: z.number(), }), partitionKey: user => key('USER', user.userId), sortKey: () => 'METADATA',});
const batchProjectedGetCommand = new BatchProjectedGet({ keys: [ { userId: 'user1' }, { userId: 'user2' }, ], projection: ['name', 'email'], projectionSchema: z.object({ name: z.string(), email: z.string(), }),});
const { items } = await userEntity.send(batchProjectedGetCommand);Type Parameters
Section titled “Type Parameters”Schema
Section titled “Schema”Schema extends ZodObject
The Zod schema defining the structure of the entity.
ProjectionSchema
Section titled “ProjectionSchema”ProjectionSchema extends ZodObject
The Zod schema defining the structure of the projected attributes.
Implements
Section titled “Implements”BaseCommand<BatchProjectedGetResult<ProjectionSchema>,Schema>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new BatchProjectedGet<Schema, ProjectionSchema>(config): BatchProjectedGet<Schema, ProjectionSchema>;Parameters
Section titled “Parameters”config
Section titled “config”BatchProjectedGetConfig<Schema, ProjectionSchema>
Returns
Section titled “Returns”BatchProjectedGet<Schema, ProjectionSchema>
Methods
Section titled “Methods”execute()
Section titled “execute()”execute(entity): Promise<BatchProjectedGetResult<ProjectionSchema>>;Parameters
Section titled “Parameters”entity
Section titled “entity”DynamoEntity<Schema>
Returns
Section titled “Returns”Promise<BatchProjectedGetResult<ProjectionSchema>>