Interface SingleEntityAdvancedOperations<TItem, TPKSource, TSKSource>

interface SingleEntityAdvancedOperations<TItem, TPKSource, TSKSource> {
    batchDelete<TKeySource>(keySources: TKeySource[], options?: BatchDeleteOptions): Promise<AdvancedBatchWriteResponse>;
    batchGet<TKeySource>(keySources: TKeySource[], options?: BatchGetOptions): Promise<AdvancedBatchGetResponse<TItem, TPKSource, TSKSource>>;
    batchPut(items: TItem[], options?: BatchPutOptions): Promise<AdvancedBatchWriteResponse>;
    delete<TKeySource>(keySource: TKeySource, options?: AdvancedDeleteOptions): Promise<AdvancedDeleteResponse>;
    getOrThrow<TKeySource>(keySource: TKeySource, options?: AdvancedGetOptions): Promise<AdvancedGetOrThrowResponse<TItem, TPKSource, TSKSource>>;
    getOrUndefined<TKeySource>(keySource: TKeySource, options?: AdvancedGetOptions): Promise<AdvancedGetResponse<TItem, TPKSource, TSKSource>>;
    put(item: TItem, options?: AdvancedPutOptions): Promise<AdvancedPutResponse>;
    queryAllByPk(pkSource: TPKSource, options?: AdvancedQueryAllOptions): Promise<AdvancedCollectionResponse<TItem>>;
    queryAllByPkAndSk(pkSource: TPKSource, queryRange: SkQueryRange, options?: AdvancedQueryAllOptions): Promise<AdvancedCollectionResponse<TItem>>;
    queryAllWithGsiByPk<TGSIPKSource>(pkSource: TGSIPKSource, options?: AdvancedGsiQueryAllOptions): Promise<AdvancedCollectionResponse<TItem>>;
    queryAllWithGsiByPkAndSk<TGSIPKSource>(pkSource: TGSIPKSource, queryRange: SkQueryRange, options?: AdvancedGsiQueryAllOptions): Promise<AdvancedCollectionResponse<TItem>>;
    queryOnePageByPk(pkSource: TPKSource, options?: AdvancedQueryOnePageOptions): Promise<AdvancedCollectionResponse<TItem>>;
    queryOnePageByPkAndSk(pkSource: TPKSource, queryRange: SkQueryRange, options?: AdvancedQueryOnePageOptions): Promise<AdvancedCollectionResponse<TItem>>;
    queryOnePageWithGsiByPk<TGSIPKSource>(pkSource: TGSIPKSource, options?: AdvancedGsiQueryOnePageOptions): Promise<AdvancedCollectionResponse<TItem>>;
    queryOnePageWithGsiByPkAndSk<TGSIPKSource>(pkSource: TGSIPKSource, queryRange: SkQueryRange, options?: AdvancedGsiQueryOnePageOptions): Promise<AdvancedCollectionResponse<TItem>>;
    scanAll(options?: AdvancedScanAllOptions): Promise<AdvancedCollectionResponse<TItem>>;
    scanAllWithGsi(options?: AdvancedGsiScanAllOptions): Promise<AdvancedCollectionResponse<TItem>>;
    scanOnePage(options?: AdvancedScanOnePageOptions): Promise<AdvancedCollectionResponse<TItem>>;
    scanOnePageWithGsi(options?: AdvancedGsiScanOnePageOptions): Promise<AdvancedCollectionResponse<TItem>>;
    update<TKeySource>(keySource: TKeySource, options?: AdvancedUpdateOptions): Promise<AdvancedUpdateResponse>;
}

Type Parameters

TItem extends TPKSource & TSKSource
TPKSource
TSKSource

Methods

batchDelete

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

batchGet

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

batchPut

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

delete

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

getOrThrow

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

getOrUndefined

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

put

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

queryAllByPk

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

queryAllByPkAndSk

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

queryAllWithGsiByPk

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

queryAllWithGsiByPkAndSk

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

queryOnePageByPk

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

queryOnePageByPkAndSk

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

queryOnePageWithGsiByPk

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

queryOnePageWithGsiByPkAndSk

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

scanAll

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

scanAllWithGsi

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

scanOnePage

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

scanOnePageWithGsi

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

update

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