Interface MultipleEntityOperations

Hierarchy

MultipleEntityOperations

Index

Methods

queryAllByPk queryAllByPkAndSk queryAllWithGsiByPk queryAllWithGsiByPkAndSk queryOnePageByPk queryOnePageByPkAndSk queryOnePageWithGsiByPk queryOnePageWithGsiByPkAndSk scanAll scanOnePage

Methods

queryAllByPk

queryAllByPk<TKeyItem, TPKSource>(keyEntity, pkSource, options?): Promise<MultipleEntityCollectionResponse>
Type Parameters
- TKeyItem
- TPKSource
Parameters
- keyEntity: Entity<TKeyItem, TPKSource, unknown>
- pkSource: TPKSource
- Optional options: AdvancedQueryAllOptions
Returns Promise<MultipleEntityCollectionResponse>
- Defined in src/lib/multipleEntityOperations.ts:14

queryAllByPkAndSk

queryAllByPkAndSk<TKeyItem, TPKSource>(keyEntity, pkSource, queryRange, options?): Promise<MultipleEntityCollectionResponse>
Type Parameters
- TKeyItem
- TPKSource
Parameters
- keyEntity: Entity<TKeyItem, TPKSource, unknown>
- pkSource: TPKSource
- queryRange: SkQueryRange
- Optional options: AdvancedQueryAllOptions
Returns Promise<MultipleEntityCollectionResponse>
- Defined in src/lib/multipleEntityOperations.ts:26

queryAllWithGsiByPk

queryAllWithGsiByPk<TKeyItem, TGSIPKSource>(keyEntity, pkSource, options?): Promise<MultipleEntityCollectionResponse>
Type Parameters
- TKeyItem
- TGSIPKSource
Parameters
- keyEntity: Entity<TKeyItem, unknown, unknown>
- pkSource: TGSIPKSource
- Optional options: AdvancedGsiQueryAllOptions
Returns Promise<MultipleEntityCollectionResponse>
- Defined in src/lib/multipleEntityOperations.ts:40

queryAllWithGsiByPkAndSk

queryAllWithGsiByPkAndSk<TKeyItem, TGSIPKSource>(keyEntity, pkSource, queryRange, options?): Promise<MultipleEntityCollectionResponse>
Type Parameters
- TKeyItem
- TGSIPKSource
Parameters
- keyEntity: Entity<TKeyItem, unknown, unknown>
- pkSource: TGSIPKSource
- queryRange: SkQueryRange
- Optional options: AdvancedGsiQueryAllOptions
Returns Promise<MultipleEntityCollectionResponse>
- Defined in src/lib/multipleEntityOperations.ts:52

queryOnePageByPk

queryOnePageByPk<TKeyItem, TPKSource>(keyEntity, pkSource, options?): Promise<MultipleEntityCollectionResponse>
Type Parameters
- TKeyItem
- TPKSource
Parameters
- keyEntity: Entity<TKeyItem, TPKSource, unknown>
- pkSource: TPKSource
- Optional options: AdvancedQueryOnePageOptions
Returns Promise<MultipleEntityCollectionResponse>
- Defined in src/lib/multipleEntityOperations.ts:20

queryOnePageByPkAndSk

queryOnePageByPkAndSk<TKeyItem, TPKSource>(keyEntity, pkSource, queryRange, options?): Promise<MultipleEntityCollectionResponse>
Type Parameters
- TKeyItem
- TPKSource
Parameters
- keyEntity: Entity<TKeyItem, TPKSource, unknown>
- pkSource: TPKSource
- queryRange: SkQueryRange
- Optional options: AdvancedQueryOnePageOptions
Returns Promise<MultipleEntityCollectionResponse>
- Defined in src/lib/multipleEntityOperations.ts:33

queryOnePageWithGsiByPk

queryOnePageWithGsiByPk<TKeyItem, TGSIPKSource>(keyEntity, pkSource, options?): Promise<MultipleEntityCollectionResponse>
Type Parameters
- TKeyItem
- TGSIPKSource
Parameters
- keyEntity: Entity<TKeyItem, unknown, unknown>
- pkSource: TGSIPKSource
- Optional options: AdvancedGsiQueryOnePageOptions
Returns Promise<MultipleEntityCollectionResponse>
- Defined in src/lib/multipleEntityOperations.ts:46

queryOnePageWithGsiByPkAndSk

queryOnePageWithGsiByPkAndSk<TKeyItem, TGSIPKSource>(keyEntity, pkSource, queryRange, options?): Promise<MultipleEntityCollectionResponse>
Type Parameters
- TKeyItem
- TGSIPKSource
Parameters
- keyEntity: Entity<TKeyItem, unknown, unknown>
- pkSource: TGSIPKSource
- queryRange: SkQueryRange
- Optional options: AdvancedGsiQueryOnePageOptions
Returns Promise<MultipleEntityCollectionResponse>
- Defined in src/lib/multipleEntityOperations.ts:59

scanAll

scanAll(options?): Promise<MultipleEntityCollectionResponse>
Parameters
- Optional options: AdvancedScanAllOptions
Returns Promise<MultipleEntityCollectionResponse>
- Defined in src/lib/multipleEntityOperations.ts:66

scanOnePage

scanOnePage(options?): Promise<MultipleEntityCollectionResponse>
Parameters
- Optional options: AdvancedScanOnePageOptions
Returns Promise<MultipleEntityCollectionResponse>
- Defined in src/lib/multipleEntityOperations.ts:68

Generated using TypeDoc