ReadManyRequest | @shiftcoders/dynamo-easy

Type parameters

T
T2
I: QueryInput | ScanInput
O: QueryOutput | ScanOutput
Z: QueryResponse<T2> | ScanResponse<T2>
R: QueryRequest<T, T2> | ScanRequest<T, T2>
R2: QueryRequest<T, Partial<T>> | ScanRequest<T, Partial<T>>

Hierarchy

StandardRequest<T, T2, I, ReadManyRequest<T, T2, I, O, Z, R, R2>>
- ReadManyRequest
  - ScanRequest
  - QueryRequest

Index

Constructors

constructor

Properties

Methods

Constructors

Protected constructor

new ReadManyRequest(dynamoDBWrapper: DynamoDbWrapper, modelClazz: ModelConstructor<T>): ReadManyRequest

Overrides StandardRequest.constructor
- Defined in dynamo/request/read-many.request.ts:50
Parameters
- dynamoDBWrapper: DynamoDbWrapper
- modelClazz: ModelConstructor<T>
Returns ReadManyRequest

Properties

dynamoDBWrapper

dynamoDBWrapper: DynamoDbWrapper

Protected Abstract logger

logger: Logger

metadata

metadata: Metadata<T>

modelClazz

modelClazz: ModelConstructor<T>

params

params: I

Protected Optional secondaryIndex

secondaryIndex: SecondaryIndex<T>

tableName

tableName: string

Static INFINITE_LIMIT

INFINITE_LIMIT: number = -1

Methods

consistentRead

consistentRead(consistentRead?: boolean): this

- Defined in dynamo/request/read-many.request.ts:107
Parameters
- Default value consistentRead: boolean = true
Returns this

Protected Abstract doRequest

doRequest(params: I): Promise<O>

- Defined in dynamo/request/read-many.request.ts:50
Parameters
- params: I
Returns Promise<O>

exclusiveStartKey

exclusiveStartKey(key: DynamoDB.Key | null): this

- Defined in dynamo/request/read-many.request.ts:61
Parameters
- key: DynamoDB.Key | null
Returns this

exec

exec(): Promise<T2[]>

Overrides BaseRequest.exec
- Defined in dynamo/request/read-many.request.ts:192
Returns Promise<T2[]>

execCount

execCount(): Promise<number>

- Defined in dynamo/request/read-many.request.ts:174
Returns Promise<number>

execFetchAll

execFetchAll(): Promise<T2[]>

- Defined in dynamo/request/read-many.request.ts:215
Returns Promise<T2[]>

execFullResponse

execFullResponse(): Promise<Z>

Overrides BaseRequest.execFullResponse
- Defined in dynamo/request/read-many.request.ts:204
Returns Promise<Z>

execNoMap

execNoMap(): Promise<O>

- Defined in dynamo/request/read-many.request.ts:147
Returns Promise<O>

execSingle

execSingle(): Promise<T2 | null>

- Defined in dynamo/request/read-many.request.ts:155
Returns Promise<T2 | null>

index

index(indexName: string): this

- Defined in dynamo/request/read-many.request.ts:75
Parameters
- indexName: string
Returns this

limit

limit(limit: number): this

- Defined in dynamo/request/read-many.request.ts:90
Parameters
- limit: number
Returns this

Protected mapFromDb

mapFromDb(output: O): Z

- Defined in dynamo/request/read-many.request.ts:219
Parameters
- output: O
Returns Z

projectionExpression

projectionExpression(attributesToGet: Array<keyof T | string>): R2

- Defined in dynamo/request/read-many.request.ts:116
Parameters
- Rest attributesToGet: Array<keyof T | string>
Returns R2

returnConsumedCapacity

returnConsumedCapacity(level: DynamoDB.ReturnConsumedCapacity): ReadManyRequest<T, T2, I, O, Z, R, R2>

Inherited from BaseRequest.returnConsumedCapacity
- Defined in dynamo/request/base.request.ts:77
Parameters
- level: DynamoDB.ReturnConsumedCapacity
Returns ReadManyRequest<T, T2, I, O, Z, R, R2>

where

where(conditionDefFns: ConditionExpressionDefinitionFunction[]): this

- Defined in dynamo/request/read-many.request.ts:138
Parameters
- Rest conditionDefFns: ConditionExpressionDefinitionFunction[]
Returns this

whereAttribute

whereAttribute<K>(attributePath: K): RequestConditionFunctionTyped<this, T, K>
whereAttribute(attributePath: string): RequestConditionFunction<this, T>

- Defined in dynamo/request/read-many.request.ts:125
Type parameters
- K: keyof T
Parameters
- attributePath: K
Returns RequestConditionFunctionTyped<this, T, K>
- Defined in dynamo/request/read-many.request.ts:126
Parameters
- attributePath: string
Returns RequestConditionFunction<this, T>