Interface SingleEntityOperations<TItem, TPKSource, TSKSource> Type Parameters TItem extends TPKSource & TSKSource TPKSource TSKSource Methods delete delete < TKeySource > ( keySource , options ? ) : Promise < void > Returns Promise < void > get Or Throw get Or Throw < TKeySource > ( keySource , options ? ) : Promise < TItem > Returns Promise < TItem > get Or Undefined get Or Undefined < TKeySource > ( keySource , options ? ) : Promise < undefined | TItem > Returns Promise < undefined | TItem > put put ( item , options ? ) : Promise < TItem > Returns Promise < TItem > query All By Pk query All By Pk ( pkSource , options ? ) : Promise < TItem [] > Returns Promise < TItem [] > query All By Pk And Sk query All By Pk And Sk ( pkSource , queryRange , options ? ) : Promise < TItem [] > Returns Promise < TItem [] > query All With Gsi By Pk query All With Gsi By Pk < TGSIPKSource > ( pkSource , options ? ) : Promise < TItem [] > Returns Promise < TItem [] > query All With Gsi By Pk And Sk query All With Gsi By Pk And Sk < TGSIPKSource > ( pkSource , queryRange , options ? ) : Promise < TItem [] > Returns Promise < TItem [] > query One Page By Pk And Sk query One Page By Pk And Sk ( pkSource , queryRange , options ? ) : Promise < OnePageResponse < TItem > > query One Page With Gsi By Pk query One Page With Gsi By Pk < TGSIPKSource > ( pkSource , options ? ) : Promise < OnePageResponse < TItem > > query One Page With Gsi By Pk And Sk query One Page With Gsi By Pk And Sk < TGSIPKSource > ( pkSource , queryRange , options ? ) : Promise < OnePageResponse < TItem > > scan All scan All ( options ? ) : Promise < TItem [] > Returns Promise < TItem [] > scan All With Gsi scan All With Gsi ( options ? ) : Promise < TItem [] > Returns Promise < TItem [] > update update < TKeySource > ( keySource , options ? ) : Promise < void > Returns Promise < void >
All the operations available when working with one entity at a time. This interface contains the "simple" versions of equivalent DynamoDB operations, but if you need more advanced behavior - e.g. for reading DynamoDB metadata - then use the versions on
advancedOperations