zio-dynamodb
API
Generated with
zio-dynamodb/zio.dynamodb/DynamoDBQuery

DynamoDBQuery

zio.dynamodb.DynamoDBQuery
See theDynamoDBQuery companion object
sealed trait DynamoDBQuery[-In, +Out]

Attributes

Companion
object
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait Constructor[In, A]
trait Write[In, A]
Self type
DynamoDBQuery[In, Out]

Members list

Value members

Concrete methods

final def *>[In1 <: In, B](that: DynamoDBQuery[In1, B]): DynamoDBQuery[In1, B]
final def <*[In1 <: In, B](that: DynamoDBQuery[In1, B]): DynamoDBQuery[In1, Out]
final def <*>[In1 <: In, B](that: DynamoDBQuery[In1, B]): DynamoDBQuery[In1, (Out, B)]
final def capacity(capacity: ReturnConsumedCapacity): DynamoDBQuery[In, Out]
final def consistency(consistency: ConsistencyMode): DynamoDBQuery[In, Out]
def filter[B](filterExpression: ConditionExpression[B])(implicit ev: CanFilter[B, Out]): DynamoDBQuery[In, Out]

Filter a Scan or a Query

Filter a Scan or a Query

Attributes

def gsi(indexName: String, keySchema: KeySchema, projection: ProjectionType, readCapacityUnit: Long, writeCapacityUnit: Long): DynamoDBQuery[In, Out]
def gsi(indexName: String, keySchema: KeySchema, projection: ProjectionType): DynamoDBQuery[In, Out]
final def indexName(indexName: String): DynamoDBQuery[In, Out]
def lsi(indexName: String, keySchema: KeySchema, projection: ProjectionType): DynamoDBQuery[In, Out]
final def map[B](f: Out => B): DynamoDBQuery[In, B]
def metrics(itemMetrics: ReturnItemCollectionMetrics): DynamoDBQuery[In, Out]
def parallel(n: Int): DynamoDBQuery[In, Out]

Executes a DynamoDB Scan in parallel. There are no guarantees on order of returned items.

Executes a DynamoDB Scan in parallel. There are no guarantees on order of returned items.

Value parameters

n

The number of parallel requests to make to DynamoDB

Attributes

def returns(returnValues: ReturnValues): DynamoDBQuery[In, Out]

Note for update(...) ATM both ReturnValues.UpdatedNew and ReturnValues.UpdatedOld will potentially cause a decode error for the high level API if all the attributes are not updated as this will result in partial data being returned and hence a decode error so should not be use.

Note for update(...) ATM both ReturnValues.UpdatedNew and ReturnValues.UpdatedOld will potentially cause a decode error for the high level API if all the attributes are not updated as this will result in partial data being returned and hence a decode error so should not be use.

If these are required then use the low level API for now.

Attributes

def selectCount: DynamoDBQuery[In, Out]
def sortOrder(ascending: Boolean): DynamoDBQuery[In, Out]
def startKey(exclusiveStartKey: LastEvaluatedKey): DynamoDBQuery[In, Out]
final def transaction: DynamoDBQuery[In, Out]
def where[B](conditionExpression: ConditionExpression[B])(implicit ev: CanWhere[B, Out]): DynamoDBQuery[In, Out]
def whereKey[From](keyConditionExpression: KeyConditionExpr[From]): DynamoDBQuery[In, Out]

Adds a KeyConditionExpr to a DynamoDBQuery. Example:

Adds a KeyConditionExpr to a DynamoDBQuery. Example:

// high level type safe API where "email" and "subject" keys are defined using ProjectionExpression.accessors[Student]
val newQuery = query.whereKey(email.partitionKey === "[email protected]" && subject.sortKey === "maths")

// low level API
val newQuery = query.whereKey($("email").partitionKey === "[email protected]" && $("subject").sortKey === "maths")

Attributes

def withRetryPolicy(retryPolicy: Schedule[Any, Throwable, Any]): DynamoDBQuery[In, Out]
final def zip[In1 <: In, B](that: DynamoDBQuery[In1, B])(implicit z: Zippable[Out, B]): DynamoDBQuery[In1, z.Out]
final def zipLeft[In1 <: In, B](that: DynamoDBQuery[In1, B]): DynamoDBQuery[In1, Out]
final def zipRight[In1 <: In, B](that: DynamoDBQuery[In1, B]): DynamoDBQuery[In1, B]
final def zipWith[In1 <: In, B, C](that: DynamoDBQuery[In1, B])(f: (Out, B) => C): DynamoDBQuery[In1, C]
Generated with