c

org.scanamo

Table

case class Table[V](name: String)(implicit evidence$1: DynamoFormat[V]) extends Product with Serializable

Represents a DynamoDB table that operations can be performed against

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Table
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Table(name: String)(implicit arg0: DynamoFormat[V])

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  6. def consistently: ConsistentlyReadTable[V]

    Perform strongly consistent (http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadConsistency.html) read operations against this table.

    Perform strongly consistent (http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadConsistency.html) read operations against this table. Note that there is no equivalent on table indexes as consistent reads from secondary indexes are not supported by DynamoDB

  7. def delete(key: UniqueKey[_]): ScanamoOps[Unit]
  8. def deleteAll(items: UniqueKeys[_]): ScanamoOps[Unit]

    Deletes multiple items by a unique key

  9. def deleteAndReturn(ret: DeleteReturn)(key: UniqueKey[_]): ScanamoOps[Option[Either[DynamoReadError, V]]]
  10. def descending: TableWithOptions[V]
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def filter[C](condition: C)(implicit arg0: ConditionExpression[C]): TableWithOptions[V]

    Filter the results of a Scan or Query

  13. def from(exclusiveStartKey: DynamoObject): TableWithOptions[V]

    Primes a search request with a key to start from:

    Primes a search request with a key to start from:

    exclusiveStartKey

    A DynamoObject containing attributes that match the partition key and sort key of the table

    returns

    A new Table which when queried will return items after the provided exclusive start key

    Example: 

    1. import org.scanamo._
import org.scanamo.syntax._

val table: Table[_] = ???
val exclusiveStartKey = DynamoObject(
  Map(
    "myPartitionKeyName" -> myPartitionKeyValue.asDynamoValue,
    "mySortKeyName" -> mySortKeyValue.asDynamoValue
  )
)
val tableStartingFromExclusiveStartKey: Table[_] = table.from(exclusiveStartKey)
  14. def from[K](key: UniqueKey[K])(implicit arg0: UniqueKeyCondition[K]): TableWithOptions[V]

    Primes a search request with a key to start from:

  15. def get(key: UniqueKey[_]): ScanamoOps[Option[Either[DynamoReadError, V]]]
  16. def getAll(keys: UniqueKeys[_]): ScanamoOps[Set[Either[DynamoReadError, V]]]
  17. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  18. def index(indexName: String): SecondaryIndex[V]

    A secondary index on the table which can be scanned, or queried against

  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. def limit(n: Int): TableWithOptions[V]

    Query or scan a table, limiting the number of items evaluated by Dynamo

  21. val name: String
  22. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  24. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  25. def put(v: V): ScanamoOps[Unit]
  26. def putAll(vs: Set[V]): ScanamoOps[Unit]
  27. def putAndReturn(ret: PutReturn)(v: V): ScanamoOps[Option[Either[DynamoReadError, V]]]
  28. def query(query: Query[_]): ScanamoOps[List[Either[DynamoReadError, V]]]

    Query a table based on the hash key and optionally the range key

  29. final def queryM[M[_]](query: Query[_])(implicit arg0: Monad[M], arg1: MonoidK[M]): ScanamoOpsT[M, List[Either[DynamoReadError, V]]]

    Performs a query with the ability to introduce effects into the computation.

    Performs a query with the ability to introduce effects into the computation. This is useful for huge tables when you don't want to load the whole of it in memory, but scan it page by page.

    To control how many maximum items to load at once, use queryPaginatedM

  30. def queryPaginatedM[M[_]](query: Query[_], pageSize: Int)(implicit arg0: Monad[M], arg1: MonoidK[M]): ScanamoOpsT[M, List[Either[DynamoReadError, V]]]

    Performs a scan with the ability to introduce effects into the computation.

    Performs a scan with the ability to introduce effects into the computation. This is useful for huge tables when you don't want to load the whole of it in memory, but scan it page by page, with a maximum of pageSize items per page.

    Note

    DynamoDB will only ever return maximum 1MB of data per query, so pageSize is an upper bound.

  31. def queryRaw(query: Query[_]): ScanamoOps[QueryResponse]

    Queries the table and returns the raw DynamoDB result.

    Queries the table and returns the raw DynamoDB result. Sometimes, one might want to access metadata returned in the QueryResponse object, such as the last evaluated key for example. Table#query only returns a list of results, so there is no place for putting that information: this is where query0 comes in handy!

  32. def scan(): ScanamoOps[List[Either[DynamoReadError, V]]]

    Scans all elements of a table

  33. final def scanM[M[_]](implicit arg0: Monad[M], arg1: MonoidK[M]): ScanamoOpsT[M, List[Either[DynamoReadError, V]]]

    Performs a scan with the ability to introduce effects into the computation.

    Performs a scan with the ability to introduce effects into the computation. This is useful for huge tables when you don't want to load the whole of it in memory, but scan it page by page.

    To control how many maximum items to load at once, use scanPaginatedM

  34. def scanPaginatedM[M[_]](pageSize: Int)(implicit arg0: Monad[M], arg1: MonoidK[M]): ScanamoOpsT[M, List[Either[DynamoReadError, V]]]

    Performs a scan with the ability to introduce effects into the computation.

    Performs a scan with the ability to introduce effects into the computation. This is useful for huge tables when you don't want to load the whole of it in memory, but scan it page by page, with a maximum of pageSize items per page..

    Note

    DynamoDB will only ever return maximum 1MB of data per scan, so pageSize is an upper bound.

  35. def scanRaw: ScanamoOps[ScanResponse]

    Scans the table and returns the raw DynamoDB result.

    Scans the table and returns the raw DynamoDB result. Sometimes, one might want to access metadata returned in the ScanResponse object, such as the last evaluated key for example. Table#scan only returns a list of results, so there is no place for putting that information: this is where scan0 comes in handy!

    A particular use case is when one wants to paginate through result sets, say:

  36. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  37. def transactDeleteAll(vs: List[UniqueKey[_]]): ScanamoOps[TransactWriteItemsResponse]
  38. def transactPutAll(vs: List[V]): ScanamoOps[TransactWriteItemsResponse]
  39. def transactUpdateAll(vs: List[(UniqueKey[_], UpdateExpression)]): ScanamoOps[TransactWriteItemsResponse]
  40. def update(key: UniqueKey[_], expression: UpdateExpression): ScanamoOps[Either[DynamoReadError, V]]

    Updates an attribute that is not part of the key and returns the updated row

  41. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  42. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  43. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  44. def when[T](condition: T)(implicit arg0: ConditionExpression[T]): ConditionalOperation[V, T]

    Performs the chained operation, put if the condition is met

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated
  2. def query0(query: Query[_]): ScanamoOps[QueryResponse]
    Annotations
    @deprecated
    Deprecated

    (Since version 1.0) use queryRaw

  3. def scan0: ScanamoOps[ScanResponse]
    Annotations
    @deprecated
    Deprecated

    (Since version 1.0) use scanRaw

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped