scanamo

Type Members

1. case class AndEqualsCondition[H, R](hashEquality: H, rangeEquality: R)(implicit evidence$4: UniqueKeyCondition[H], evidence$5: UniqueKeyCondition[R]) extends Product with Serializable

   

2. case class AndQueryCondition[H, R](hashCondition: KeyEquals[H], rangeCondition: RangeKeyCondition[R])(implicit evidence$6: DynamoFormat[H], evidence$7: DynamoFormat[R]) extends Product with Serializable

   

3. final case class BatchGet(req: BatchGetItemRequest) extends ScanamoOpsA[BatchGetItemResult] with Product with Serializable

   

4. final case class BatchWrite(req: BatchWriteItemRequest) extends ScanamoOpsA[BatchWriteItemResult] with Product with Serializable

   

5. final case class Delete(req: DeleteItemRequest) extends ScanamoOpsA[DeleteItemResult] with Product with Serializable

   

6. trait DerivedDynamoFormat extends AnyRef

   

7. trait DynamoFormat[T] extends Serializable

   

   Type class for defining serialisation to and from DynamoDB's AttributeValue

   Type class for defining serialisation to and from DynamoDB's AttributeValue

   >>> val mapF = DynamoFormat[Map[String, List[Int]]]
   >>> mapF.read(mapF.write(Map("foo" -> List(1, 2, 3), "bar" -> List(3, 2, 1))))
   Valid(Map(foo -> List(1, 2, 3), bar -> List(3, 2, 1)))

   Also supports automatic derivation for case classes

   >>> case class Farm(animals: List[String])
   >>> case class Farmer(name: String, age: Long, farm: Farm)
   >>> val farmerF = DynamoFormat[Farmer]
   >>> farmerF.read(farmerF.write(Farmer("McDonald", 156L, Farm(List("sheep", "cow")))))
   Valid(Farmer(McDonald,156,Farm(List(sheep, cow))))

   Problems reading a value are detailed

   >>> case class Developer(name: String, age: String, problems: Int)
   >>> val invalid = DynamoFormat[Farmer].read(DynamoFormat[Developer].write(Developer("Alice", "none of your business", 99)))
   Invalid(OneAnd(PropertyReadError(age,OneAnd(NoPropertyOfType(N),List())),List(PropertyReadError(farm,OneAnd(MissingProperty,List())))))
   >>> invalid.leftMap(DynamoReadError.describeAll(_))
   Invalid('age': not of type: 'N', 'farm': missing)

   Optional properties are defaulted to None

   >>> case class LargelyOptional(a: Option[String], b: Option[String])
   >>> DynamoFormat[LargelyOptional].read(DynamoFormat[Map[String, String]].write(Map("b" -> "X")))
   Valid(LargelyOptional(None,Some(X)))

8. sealed abstract class DynamoOperator extends AnyRef

   

9. sealed abstract class DynamoReadError extends AnyRef

   

10. trait DynamoResultStream[Req, Res] extends AnyRef

    

11. final case class Get(req: GetItemRequest) extends ScanamoOpsA[GetItemResult] with Product with Serializable

    

12. case class KeyBeginsWith[V](key: Symbol, v: V)(implicit evidence$9: DynamoFormat[V]) extends RangeKeyCondition[V] with Product with Serializable

    

13. case class KeyEquals[V](key: Symbol, v: V)(implicit evidence$1: DynamoFormat[V]) extends Product with Serializable

    

14. case class KeyIs[V](key: Symbol, operator: DynamoOperator, v: V)(implicit evidence$8: DynamoFormat[V]) extends RangeKeyCondition[V] with Product with Serializable

    

15. case class KeyList[T](key: Symbol, values: List[T])(implicit evidence$9: DynamoFormat[T]) extends Product with Serializable

    

16. case class MultipleKeyList[H, R](keys: (Symbol, Symbol), values: List[(H, R)])(implicit evidence$10: DynamoFormat[H], evidence$11: DynamoFormat[R]) extends Product with Serializable

    

17. case class NoPropertyOfType(propertyType: String) extends DynamoReadError with Product with Serializable

    

18. case class PropertyReadError(name: String, problem: NonEmptyList[DynamoReadError]) extends DynamoReadError with Product with Serializable

    

19. final case class Put(req: PutItemRequest) extends ScanamoOpsA[PutItemResult] with Product with Serializable

    

20. case class Query[T](t: T)(implicit qkc: QueryableKeyCondition[T]) extends Product with Serializable

    

21. final case class QueryOp(req: QueryRequest) extends ScanamoOpsA[QueryResult] with Product with Serializable

    

22. trait QueryableKeyCondition[T] extends Serializable

    

23. sealed abstract class RangeKeyCondition[V] extends AnyRef

    

24. final case class Scan(req: ScanRequest) extends ScanamoOpsA[ScanResult] with Product with Serializable

    

25. type ScanamoOps[A] = Free[ScanamoOpsA, A]

    

26. sealed trait ScanamoOpsA[A] extends AnyRef

    

27. case class TypeCoercionError(e: Exception) extends DynamoReadError with Product with Serializable

    

28. case class UniqueKey[T](t: T)(implicit evidence$4: UniqueKeyCondition[T]) extends Product with Serializable

    

29. trait UniqueKeyCondition[T] extends Serializable

    

30. trait UniqueKeyConditions[T] extends Serializable

    

31. case class UniqueKeys[T](t: T)(implicit evidence$8: UniqueKeyConditions[T]) extends Product with Serializable