QueryRequest | @shiftcoders/dynamo-easy

Type parameters

T
T2

Hierarchy

ReadManyRequest<T, T2, QueryInput, QueryOutput, QueryResponse<T2>, QueryRequest<T, T2>, QueryRequest<T, Partial<T>>>
- QueryRequest

Index

Constructors

constructor

Properties

Constructors

constructor

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

Overrides ReadManyRequest.constructor
- Defined in dynamo/request/query/query.request.ts:25
Parameters
- dynamoDBWrapper: DynamoDbWrapper
- modelClazz: ModelConstructor<T>
Returns QueryRequest

Properties

dynamoDBWrapper

dynamoDBWrapper: DynamoDbWrapper

Protected logger

logger: Logger

metadata

metadata: Metadata<T>

modelClazz

modelClazz: ModelConstructor<T>

params

params: QueryInput

Protected Optional secondaryIndex

secondaryIndex: SecondaryIndex<T>

tableName

tableName: string

Static INFINITE_LIMIT

INFINITE_LIMIT: number = -1

Methods

ascending

ascending(): this

- Defined in dynamo/request/query/query.request.ts:67
Returns this

consistentRead

consistentRead(consistentRead?: boolean): this

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

descending

descending(): this

- Defined in dynamo/request/query/query.request.ts:72
Returns this

Protected doRequest

doRequest(params: QueryInput): Promise<QueryOutput>

Overrides ReadManyRequest.doRequest
- Defined in dynamo/request/query/query.request.ts:77
Parameters
- params: QueryInput
Returns Promise<QueryOutput>

exclusiveStartKey

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

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

exec

exec(): Promise<T2[]>

Inherited from ReadManyRequest.exec

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

execCount

execCount(): Promise<number>

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

execFetchAll

execFetchAll(): Promise<T2[]>

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

execFullResponse

execFullResponse(): Promise<QueryResponse<T2>>

Inherited from ReadManyRequest.execFullResponse

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

execNoMap

execNoMap(): Promise<O>

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

execSingle

execSingle(): Promise<T2 | null>

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

index

index(indexName: string): this

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

limit

limit(limit: number): this

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

Protected mapFromDb

mapFromDb(output: QueryOutput): Z

Inherited from ReadManyRequest.mapFromDb
- Defined in dynamo/request/read-many.request.ts:219
Parameters
- output: QueryOutput
Returns Z

projectionExpression

projectionExpression(attributesToGet: Array<keyof T | string>): QueryRequest<T, Partial<T>>

Inherited from ReadManyRequest.projectionExpression
- Defined in dynamo/request/read-many.request.ts:116
Parameters
- Rest attributesToGet: Array<keyof T | string>
Returns QueryRequest<T, Partial<T>>

returnConsumedCapacity

returnConsumedCapacity(level: DynamoDB.ReturnConsumedCapacity): ReadManyRequest<T, T2, QueryInput, QueryOutput, QueryResponse<T2>, QueryRequest<T, T2>, QueryRequest<T, Partial<T>>>

Inherited from BaseRequest.returnConsumedCapacity
- Defined in dynamo/request/base.request.ts:77
Parameters
- level: DynamoDB.ReturnConsumedCapacity
Returns ReadManyRequest<T, T2, QueryInput, QueryOutput, QueryResponse<T2>, QueryRequest<T, T2>, QueryRequest<T, Partial<T>>>

where

where(conditionDefFns: ConditionExpressionDefinitionFunction[]): this

Inherited from ReadManyRequest.where
- 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>

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

wherePartitionKey

wherePartitionKey(partitionKeyValue: any): this

- Defined in dynamo/request/query/query.request.ts:32
Parameters
- partitionKeyValue: any
Returns this

whereSortKey

whereSortKey(): SortKeyConditionFunction<this>

- Defined in dynamo/request/query/query.request.ts:49
Returns SortKeyConditionFunction<this>