Interface SingleEntityAdvancedOperations<TItem, TPKSource, TSKSource>

Type Parameters

TItem extends TPKSource & TSKSource
TPKSource
TSKSource

Hierarchy

SingleEntityAdvancedOperations

Methods

batchDelete

batchDelete<TKeySource>(keySources, options?): Promise<AdvancedBatchWriteResponse>
Type Parameters
- TKeySource
Parameters
- keySources: TKeySource[]
- Optional options: BatchDeleteOptions
Returns Promise<AdvancedBatchWriteResponse>
- Defined in src/lib/singleEntityAdvancedOperations.ts:105

batchGet

batchGet<TKeySource>(keySources, options?): Promise<AdvancedBatchGetResponse<TItem, TPKSource, TSKSource>>
Type Parameters
- TKeySource
Parameters
- keySources: TKeySource[]
- Optional options: BatchGetOptions
Returns Promise<AdvancedBatchGetResponse<TItem, TPKSource, TSKSource>>
- Defined in src/lib/singleEntityAdvancedOperations.ts:110

batchPut

batchPut(items, options?): Promise<AdvancedBatchWriteResponse>
Parameters
- items: TItem[]
- Optional options: BatchPutOptions
Returns Promise<AdvancedBatchWriteResponse>
- Defined in src/lib/singleEntityAdvancedOperations.ts:103

delete

delete<TKeySource>(keySource, options?): Promise<AdvancedDeleteResponse>
Type Parameters
- TKeySource
Parameters
- keySource: TKeySource
- Optional options: AdvancedDeleteOptions
Returns Promise<AdvancedDeleteResponse>
- Defined in src/lib/singleEntityAdvancedOperations.ts:46

getOrThrow

getOrThrow<TKeySource>(keySource, options?): Promise<AdvancedGetOrThrowResponse<TItem, TPKSource, TSKSource>>
Type Parameters
- TKeySource
Parameters
- keySource: TKeySource
- Optional options: AdvancedGetOptions
Returns Promise<AdvancedGetOrThrowResponse<TItem, TPKSource, TSKSource>>
- Defined in src/lib/singleEntityAdvancedOperations.ts:41

getOrUndefined

getOrUndefined<TKeySource>(keySource, options?): Promise<AdvancedGetResponse<TItem, TPKSource, TSKSource>>
Type Parameters
- TKeySource
Parameters
- keySource: TKeySource
- Optional options: AdvancedGetOptions
Returns Promise<AdvancedGetResponse<TItem, TPKSource, TSKSource>>
- Defined in src/lib/singleEntityAdvancedOperations.ts:36

put

put(item, options?): Promise<AdvancedPutResponse>
Parameters
- item: TItem
- Optional options: AdvancedPutOptions
Returns Promise<AdvancedPutResponse>
- Defined in src/lib/singleEntityAdvancedOperations.ts:29

queryAllByPk

queryAllByPk(pkSource, options?): Promise<AdvancedCollectionResponse<TItem>>
Parameters
- pkSource: TPKSource
- Optional options: AdvancedQueryAllOptions
Returns Promise<AdvancedCollectionResponse<TItem>>
- Defined in src/lib/singleEntityAdvancedOperations.ts:51

queryAllByPkAndSk

queryAllByPkAndSk(pkSource, queryRange, options?): Promise<AdvancedCollectionResponse<TItem>>
Parameters
- pkSource: TPKSource
- queryRange: SkQueryRange
- Optional options: AdvancedQueryAllOptions
Returns Promise<AdvancedCollectionResponse<TItem>>
- Defined in src/lib/singleEntityAdvancedOperations.ts:61

queryAllWithGsiByPk

queryAllWithGsiByPk<TGSIPKSource>(pkSource, options?): Promise<AdvancedCollectionResponse<TItem>>
Type Parameters
- TGSIPKSource
Parameters
- pkSource: TGSIPKSource
- Optional options: AdvancedGsiQueryAllOptions
Returns Promise<AdvancedCollectionResponse<TItem>>
- Defined in src/lib/singleEntityAdvancedOperations.ts:73

queryAllWithGsiByPkAndSk

queryAllWithGsiByPkAndSk<TGSIPKSource>(pkSource, queryRange, options?): Promise<AdvancedCollectionResponse<TItem>>
Type Parameters
- TGSIPKSource
Parameters
- pkSource: TGSIPKSource
- queryRange: SkQueryRange
- Optional options: AdvancedGsiQueryAllOptions
Returns Promise<AdvancedCollectionResponse<TItem>>
- Defined in src/lib/singleEntityAdvancedOperations.ts:83

queryOnePageByPk

queryOnePageByPk(pkSource, options?): Promise<AdvancedCollectionResponse<TItem>>
Parameters
- pkSource: TPKSource
- Optional options: AdvancedQueryOnePageOptions
Returns Promise<AdvancedCollectionResponse<TItem>>
- Defined in src/lib/singleEntityAdvancedOperations.ts:56

queryOnePageByPkAndSk

queryOnePageByPkAndSk(pkSource, queryRange, options?): Promise<AdvancedCollectionResponse<TItem>>
Parameters
- pkSource: TPKSource
- queryRange: SkQueryRange
- Optional options: AdvancedQueryOnePageOptions
Returns Promise<AdvancedCollectionResponse<TItem>>
- Defined in src/lib/singleEntityAdvancedOperations.ts:67

queryOnePageWithGsiByPk

queryOnePageWithGsiByPk<TGSIPKSource>(pkSource, options?): Promise<AdvancedCollectionResponse<TItem>>
Type Parameters
- TGSIPKSource
Parameters
- pkSource: TGSIPKSource
- Optional options: AdvancedGsiQueryOnePageOptions
Returns Promise<AdvancedCollectionResponse<TItem>>
- Defined in src/lib/singleEntityAdvancedOperations.ts:78

queryOnePageWithGsiByPkAndSk

queryOnePageWithGsiByPkAndSk<TGSIPKSource>(pkSource, queryRange, options?): Promise<AdvancedCollectionResponse<TItem>>
Type Parameters
- TGSIPKSource
Parameters
- pkSource: TGSIPKSource
- queryRange: SkQueryRange
- Optional options: AdvancedGsiQueryOnePageOptions
Returns Promise<AdvancedCollectionResponse<TItem>>
- Defined in src/lib/singleEntityAdvancedOperations.ts:89

scanAll

scanAll(options?): Promise<AdvancedCollectionResponse<TItem>>
Parameters
- Optional options: AdvancedScanAllOptions
Returns Promise<AdvancedCollectionResponse<TItem>>
- Defined in src/lib/singleEntityAdvancedOperations.ts:95

scanAllWithGsi

scanAllWithGsi(options?): Promise<AdvancedCollectionResponse<TItem>>
Parameters
- Optional options: AdvancedGsiScanAllOptions
Returns Promise<AdvancedCollectionResponse<TItem>>
- Defined in src/lib/singleEntityAdvancedOperations.ts:99

scanOnePage

scanOnePage(options?): Promise<AdvancedCollectionResponse<TItem>>
Parameters
- Optional options: AdvancedScanOnePageOptions
Returns Promise<AdvancedCollectionResponse<TItem>>
- Defined in src/lib/singleEntityAdvancedOperations.ts:97

scanOnePageWithGsi

scanOnePageWithGsi(options?): Promise<AdvancedCollectionResponse<TItem>>
Parameters
- Optional options: AdvancedGsiScanOnePageOptions
Returns Promise<AdvancedCollectionResponse<TItem>>
- Defined in src/lib/singleEntityAdvancedOperations.ts:101

update

update<TKeySource>(keySource, options?): Promise<AdvancedUpdateResponse>
Type Parameters
- TKeySource
Parameters
- keySource: TKeySource
- Optional options: AdvancedUpdateOptions
Returns Promise<AdvancedUpdateResponse>
- Defined in src/lib/singleEntityAdvancedOperations.ts:31

Generated using TypeDoc