Trait/Object

com.github.dwhjames.awswrap.dynamodb

AmazonDynamoDBScalaMapper

Related Docs: object AmazonDynamoDBScalaMapper | package dynamodb

Permalink

trait AmazonDynamoDBScalaMapper extends AnyRef

An object mapping for DynamoDB items.

This trait provides the interface to an object mapper for DynamoDB. It depends on a concrete implementation of AmazonDynamoDBScalaClient.

Source
mapper.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. AmazonDynamoDBScalaMapper
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Type Members

  1. trait BatchDeleteByKeysMagnet[T] extends AnyRef

    Permalink

    A method overloading container for batchDeleteByKeys.

    A method overloading container for batchDeleteByKeys.

    This class contains the overloaded implementation of batchDeleteByKeys.

    T

    the type of the objects deleted by the batch delete.

    See also

    batchDeleteByKeys

  2. trait BatchLoadByKeysMagnet[T] extends AnyRef

    Permalink

    A method overloading container for batchLoadByKeys.

    A method overloading container for batchLoadByKeys.

    This class contains the overloaded implementation of batchLoadByKeys.

    T

    the type of the objects returned by the batch load.

    See also

    batchLoadByKeys

  3. trait CountQueryMagnet[T] extends AnyRef

    Permalink

    A method overloading container for countQuery.

    A method overloading container for countQuery.

    This class contains the overloaded implementations of countQuery.

    T

    the type of object queried.

    See also

    countQuery

  4. trait DeleteByKeyMagnet[T] extends AnyRef

    Permalink

    A method overloading container for deleteByKey.

    A method overloading container for deleteByKey.

    This class contains the overloaded implementations of deleteByKey.

    T

    the type of the object to be deleted.

    See also

    deleteByKey

  5. trait LoadByKeyMagnet[T] extends AnyRef

    Permalink

    A method overloading container for loadByKey.

    A method overloading container for loadByKey.

    This class contains the two overloaded implementations of loadByKey.

    T

    the type of the object to be loaded.

    See also

    loadByKey

  6. trait QueryMagnet[T] extends AnyRef

    Permalink

    A method overloading container for query.

    A method overloading container for query.

    This class contains the overloaded implementations of query.

    T

    the type of the object returned by the query.

    See also

    query

  7. trait QueryOnceMagnet[T] extends AnyRef

    Permalink
  8. type RangeCondition = (String, Condition)

    Permalink

Abstract Value Members

  1. abstract val client: AmazonDynamoDBScalaClient

    Permalink

    An abstract AmazonDynamoDBScalaClient.

  2. implicit abstract val execCtx: ExecutionContext

    Permalink

    An abstract ExecutionContext.

    An abstract ExecutionContext.

    Attributes
    protected

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. object BatchDeleteByKeysMagnet

    Permalink
  5. object BatchLoadByKeysMagnet

    Permalink
  6. object CountQueryMagnet

    Permalink
  7. object DeleteByKeyMagnet

    Permalink
  8. object LoadByKeyMagnet

    Permalink
  9. object QueryMagnet

    Permalink
  10. object QueryOnceMagnet

    Permalink
  11. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  12. def batchDelete[T](objs: Seq[T])(implicit serializer: DynamoDBSerializer[T]): Future[Unit]

    Permalink

    Delete a sequence of objects.

    Delete a sequence of objects.

    This method will internally make repeated batchWriteItem calls, with up to 25 objects at a time, until all the input objects have been deleted.

    T

    the type of objects to delete.

    objs

    a sequence of objects to delete.

    serializer

    an implicit object serializer.

  13. def batchDeleteByKeys[T](magnet: BatchDeleteByKeysMagnet[T]): Future[Unit]

    Permalink

    Delete items by a sequence of keys.

    Delete items by a sequence of keys.

    This method will internally make repeated batchWriteItem calls, with up to 25 keys at a time, until all the input keys have been deleted.

    T

    the type of the objects deleted by the batch delete.

    See also

    BatchDeleteByKeysMagnet

  14. def batchDump[T](objs: Seq[T])(implicit serializer: DynamoDBSerializer[T]): Future[Unit]

    Permalink

    Dump a sequence of objects into DynamoDB

    Dump a sequence of objects into DynamoDB

    This method will internally make repeated batchWriteItem calls, with up to 25 objects at a time, until all the input objects have been written.

    Objects that are new will create new items in DynamoDB, otherwise they will overwrite exisiting items.

    objs

    the sequence of objects to write to DynamoDB.

  15. def batchLoadByKeys[T](magnet: BatchLoadByKeysMagnet[T]): Future[Seq[T]]

    Permalink

    Load a sequence of objects by a sequence of keys.

    Load a sequence of objects by a sequence of keys.

    This method will internally make repeated batchGetItem calls, with up to 25 keys at a time, until all of the given keys have been requested.

    T

    the type of the objects returned by the batch load.

    See also

    BatchLoadByKeysMagnet

  16. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  17. val config: AmazonDynamoDBScalaMapperConfig

    Permalink

    The mapping configuration.

    The mapping configuration.

    AmazonDynamoDBScalaMapperConfig.Default is used by default.

    Attributes
    protected
  18. def countQuery[T](magnet: CountQueryMagnet[T]): Future[Long]

    Permalink

    Query a table, counting the results.

    Query a table, counting the results.

    This method will internally make repeated query calls until the full result of the query has been retrieved.

    T

    the type of object queried.

    See also

    queryOnce

    query

    CountQueryMagnet

  19. def countScan[T](scanFilter: Map[String, Condition] = Map.empty)(implicit serializer: DynamoDBSerializer[T]): Future[Long]

    Permalink

    Scan a table and return a count.

    Scan a table and return a count.

    This method will internally make repeated scan calls until the full result of the scan has been retrieved.

    scanFilter

    the optional filter conditions for the scan

    returns

    the total number of scanned items in a future

    See also

    scan

  20. def delete[T](obj: T)(implicit serializer: DynamoDBSerializer[T]): Future[Unit]

    Permalink

    Delete the DynamoDB item that corresponds to the given object

    Delete the DynamoDB item that corresponds to the given object

    T

    the type of the object to delete.

    obj

    the object to delete.

    serializer

    an implicit object serializer.

  21. def deleteByKey[T](magnet: DeleteByKeyMagnet[T]): Future[Option[T]]

    Permalink

    Delete a DynamoDB item by a hash key (and range key).

    Delete a DynamoDB item by a hash key (and range key).

    If an item with the given key was deleted then the deleted object returned, otherwise none.

    T

    the type of the object to be deleted.

    See also

    DeleteByKeyMagnet

  22. def dump[T](obj: T)(implicit serializer: DynamoDBSerializer[T]): Future[Unit]

    Permalink

    Dumps an object into DynamoDB

    Dumps an object into DynamoDB

    If the object is new, then this creates the item in DynamoDB, otherwise it overwrites the exisiting item.

    T

    the type of the object to put.

    obj

    the object to put.

    serializer

    an implicit object serializer.

  23. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  24. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  25. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  26. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  27. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  28. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  29. def loadByKey[T](magnet: LoadByKeyMagnet[T]): Future[Option[T]]

    Permalink

    Load an object by its hash key (and range key).

    Load an object by its hash key (and range key).

    If the item is not found in the DynamoDB table, then None is returned.

    T

    the type of the object to be loaded.

    See also

    LoadByKeyMagnet

  30. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  31. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  32. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  33. def query[T](magnet: QueryMagnet[T]): Future[Seq[T]]

    Permalink

    Query a table.

    Query a table.

    This method will internally make repeated query calls until the full result of the query has been retrieved, or the at most the size of the limit, if specified.

    T

    the type of the object returned by the query.

    See also

    countQuery

    queryOnce

    QueryMagnet

  34. def queryOnce[T](magnet: QueryOnceMagnet[T]): Future[Seq[T]]

    Permalink

    Query a table.

    Query a table.

    This method will issue one query request, stopping either at the supplied limit or at the response size limit.

    T

    the type of the object returned by the query.

    See also

    countQuery

    query

    QueryOnceMagnet

  35. def scan[T](scanFilter: Map[String, Condition] = Map.empty)(implicit serializer: DynamoDBSerializer[T]): Future[Seq[T]]

    Permalink

    Scan a table.

    Scan a table.

    This method will internally make repeated scan calls until the full result of the scan has been retrieved.

    scanFilter

    the optional filter conditions for the scan.

    returns

    sequence of scanned objects in a future.

    See also

    countScan

  36. def scanOnce[T](scanFilter: Map[String, Condition] = Map.empty, limit: Int = 0)(implicit serializer: DynamoDBSerializer[T]): Future[Seq[T]]

    Permalink

    Scan a table.

    Scan a table.

    This method will issue one scan request, stopping either at the supplied limit or at the response size limit.

    scanFilter

    the optional filter conditions for the scan.

    limit

    the optional limit for the number of items to return.

    returns

    sequence of scanned objects in a future.

    See also

    countScan

  37. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  38. def tableName[T](implicit serializer: DynamoDBSerializer[T]): String

    Permalink

    Returns the table name.

    Returns the table name.

    Determines the table name, by transforming the table name of the implict serializer using the mapper's configuration.

    serializer

    the object serializer.

    returns

    the transformed table name.

    Attributes
    protected
  39. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  40. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  41. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  42. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped