Table

Instance Constructors

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

Value Members

final def !=(arg0: Any): Boolean

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

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

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )

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

>>> case class City(country: String, name: String)

>>> import com.amazonaws.services.dynamodbv2.model.ScalarAttributeType._
>>> val client = LocalDynamoDB.client()
>>> val (get, scan, query) = LocalDynamoDB.withRandomTable(client)('country -> S, 'name -> S) { t =>
...   import org.scanamo.syntax._
...   import org.scanamo.auto._
...   val cityTable = Table[City](t)
...   val ops = for {
...     putRes <- cityTable.putAll(Set(
...       City("US", "Nashville"), City("IT", "Rome"), City("IT", "Siena"), City("TZ", "Dar es Salaam")))
...     get <- cityTable.consistently.get('country -> "US" and 'name -> "Nashville")
...     scan <- cityTable.consistently.scan()
...     query <- cityTable.consistently.query('country -> "IT")
...   } yield (get, scan, query)
...   Scanamo.exec(client)(ops)
... }
>>> get
Some(Right(City(US,Nashville)))

>>> scan
List(Right(City(US,Nashville)), Right(City(IT,Rome)), Right(City(IT,Siena)), Right(City(TZ,Dar es Salaam)))

>>> query
List(Right(City(IT,Rome)), Right(City(IT,Siena)))

def delete(key: UniqueKey[_]): ScanamoOps[DeleteItemResult]

def deleteAll(items: UniqueKeys[_]): ScanamoOps[List[BatchWriteItemResult]]

Deletes multiple items by a unique key

>>> case class Farm(animals: List[String])
>>> case class Farmer(name: String, age: Long, farm: Farm)

>>> import com.amazonaws.services.dynamodbv2.model.ScalarAttributeType._
>>> import org.scanamo.syntax._
>>> import org.scanamo.auto._

>>> val client = LocalDynamoDB.client()

>>> val dataSet = Set(
...   Farmer("Patty", 200L, Farm(List("unicorn"))),
...   Farmer("Ted", 40L, Farm(List("T-Rex"))),
...   Farmer("Jack", 2L, Farm(List("velociraptor"))))
>>> LocalDynamoDB.withRandomTable(client)('name -> S) { t =>
...   val farm = Table[Farmer](t)
...   val operations = for {
...     _       <- farm.putAll(dataSet)
...     _       <- farm.deleteAll('name -> dataSet.map(_.name))
...     scanned <- farm.scan
...   } yield scanned.toList
...   Scanamo.exec(client)(operations)
... }
List()

final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef

def filter[C](condition: C)(implicit arg0: ConditionExpression[C]): TableWithOptions[V]

Filter the results of a Scan or Query

>>> case class Bear(name: String, favouriteFood: String, antagonist: Option[String])

>>> val client = LocalDynamoDB.client()
>>> import com.amazonaws.services.dynamodbv2.model.ScalarAttributeType._

>>> import org.scanamo.syntax._
>>> import org.scanamo.auto._

>>> LocalDynamoDB.withRandomTable(client)('name -> S) { t =>
...   val table = Table[Bear](t)
...   val ops = for {
...     _ <- table.put(Bear("Pooh", "honey", None))
...     _ <- table.put(Bear("Yogi", "picnic baskets", Some("Ranger Smith")))
...     honeyBears <- table.filter('favouriteFood -> "honey").scan()
...     competitiveBears <- table.filter(attributeExists('antagonist)).scan()
...   } yield (honeyBears, competitiveBears)
...   Scanamo.exec(client)(ops)
... }
(List(Right(Bear(Pooh,honey,None))),List(Right(Bear(Yogi,picnic baskets,Some(Ranger Smith)))))

>>> case class Station(line: String, name: String, zone: Int)


>>> import com.amazonaws.services.dynamodbv2.model.ScalarAttributeType._

>>> LocalDynamoDB.withRandomTable(client)('line -> S, 'name -> S) { t =>
...   val stationTable = Table[Station](t)
...   val ops = for {
...     _ <- stationTable.putAll(Set(
...       Station("Metropolitan", "Chalfont & Latimer", 8),
...       Station("Metropolitan", "Chorleywood", 7),
...       Station("Metropolitan", "Rickmansworth", 7),
...       Station("Metropolitan", "Croxley", 7),
...       Station("Jubilee", "Canons Park", 5)
...     ))
...     filteredStations <- stationTable.filter('zone -> Set(8, 7)).query('line -> "Metropolitan" and ('name beginsWith "C"))
...   } yield filteredStations
...   Scanamo.exec(client)(ops)
... }
List(Right(Station(Metropolitan,Chalfont & Latimer,8)), Right(Station(Metropolitan,Chorleywood,7)), Right(Station(Metropolitan,Croxley,7)))

def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )

def from[K](key: UniqueKey[K])(implicit arg0: UniqueKeyCondition[K]): TableWithOptions[V]

Primes a search request with a key to start from:

>>> import org.scanamo.syntax._
>>> import org.scanamo.auto._
>>> import org.scanamo.query._
>>> import com.amazonaws.services.dynamodbv2.model.ScalarAttributeType._
>>> val client = LocalDynamoDB.client()

>>> case class Bear(name: String, favouriteFood: String)

>>> LocalDynamoDB.withRandomTable(client)('name -> S) { t =>
...   val table = Table[Bear](t)
...   val ops = for {
...     _ <- table.put(Bear("Pooh", "honey"))
...     _ <- table.put(Bear("Baloo", "ants"))
...     _ <- table.put(Bear("Yogi", "picnic baskets"))
...     bears <- table.from('name -> "Baloo").scan()
...   } yield bears
...   Scanamo.exec(client)(ops)
... }
List(Right(Bear(Pooh,honey)), Right(Bear(Yogi,picnic baskets)))

Of course it works with queries too:

>>> case class Event(`type`: String, tag: String, count: Int)

>>> LocalDynamoDB.withRandomTable(client)('type -> S, 'tag -> S) { t =>
...   val table = Table[Event](t)
...   val ops = for {
...     _ <- table.putAll(Set(
...            Event("click", "paid", 600),
...            Event("play", "profile", 100),
...            Event("play", "politics", 200),
...            Event("click", "profile", 400),
...            Event("play", "print", 600),
...            Event("click", "print", 300),
...            Event("play", "paid", 900)
...          ))
...     events <- table.from('type -> "play" and 'tag -> "politics").query('type -> "play" and ('tag beginsWith "p"))
...   } yield events
...   Scanamo.exec(client)(ops)
... }
List(Right(Event(play,print,600)), Right(Event(play,profile,100)))

def get(key: UniqueKey[_]): ScanamoOps[Option[Either[DynamoReadError, V]]]
def getAll(keys: UniqueKeys[_]): ScanamoOps[Set[Either[DynamoReadError, V]]]
final def getClass(): Class[_]

Definition Classes
AnyRef → Any

def given[T](condition: T)(implicit arg0: ConditionExpression[T]): ConditionalOperation[V, T]

Performs the chained operation, put if the condition is met

>>> case class Farm(animals: List[String], hectares: Int)
>>> case class Farmer(name: String, age: Long, farm: Farm)

>>> import org.scanamo.syntax._
>>> import org.scanamo.auto._
>>> import org.scanamo.query._
>>> import com.amazonaws.services.dynamodbv2.model.ScalarAttributeType._
>>> val client = LocalDynamoDB.client()

>>> LocalDynamoDB.withRandomTable(client)('name -> S) { t =>
...   val farmersTable = Table[Farmer](t)
...   val farmerOps = for {
...     _ <- farmersTable.put(Farmer("McDonald", 156L, Farm(List("sheep", "cow"), 30)))
...     _ <- farmersTable.given('age -> 156L).put(Farmer("McDonald", 156L, Farm(List("sheep", "chicken"), 30)))
...     _ <- farmersTable.given('age -> 15L).put(Farmer("McDonald", 156L, Farm(List("gnu", "chicken"), 30)))
...     farmerWithNewStock <- farmersTable.get('name -> "McDonald")
...   } yield farmerWithNewStock
...   Scanamo.exec(client)(farmerOps)
... }
Some(Right(Farmer(McDonald,156,Farm(List(sheep, chicken),30))))

>>> case class Letter(roman: String, greek: String)
>>> LocalDynamoDB.withRandomTable(client)('roman -> S) { t =>
...   val lettersTable = Table[Letter](t)
...   val ops = for {
...     _ <- lettersTable.putAll(Set(Letter("a", "alpha"), Letter("b", "beta"), Letter("c", "gammon")))
...     _ <- lettersTable.given('greek beginsWith "ale").put(Letter("a", "aleph"))
...     _ <- lettersTable.given('greek beginsWith "gam").put(Letter("c", "gamma"))
...     letters <- lettersTable.scan()
...   } yield letters
...   Scanamo.exec(client)(ops).toList
... }
List(Right(Letter(b,beta)), Right(Letter(c,gamma)), Right(Letter(a,alpha)))

>>> import cats.implicits._
>>> case class Turnip(size: Int, description: Option[String])
>>> LocalDynamoDB.withRandomTable(client)('size -> N) { t =>
...   val turnipsTable = Table[Turnip](t)
...   val ops = for {
...     _ <- turnipsTable.putAll(Set(Turnip(1, None), Turnip(1000, None)))
...     initialTurnips <- turnipsTable.scan()
...     _ <- initialTurnips.flatMap(_.toOption).traverse(t =>
...       turnipsTable.given('size > 500).put(t.copy(description = Some("Big turnip in the country."))))
...     turnips <- turnipsTable.scan()
...   } yield turnips
...   Scanamo.exec(client)(ops).toList
... }
List(Right(Turnip(1,None)), Right(Turnip(1000,Some(Big turnip in the country.))))

Conditions can also make use of negation via not:

>>> case class Thing(a: String, maybe: Option[Int])
>>> LocalDynamoDB.withRandomTable(client)('a -> S) { t =>
...   val thingTable = Table[Thing](t)
...   val ops = for {
...     _ <- thingTable.putAll(Set(Thing("a", None), Thing("b", Some(1)), Thing("c", None)))
...     _ <- thingTable.given(attributeExists('maybe)).put(Thing("a", Some(2)))
...     _ <- thingTable.given(attributeExists('maybe)).put(Thing("b", Some(3)))
...     _ <- thingTable.given(Not(attributeExists('maybe))).put(Thing("c", Some(42)))
...     _ <- thingTable.given(Not(attributeExists('maybe))).put(Thing("b", Some(42)))
...     things <- thingTable.scan()
...   } yield things
...   Scanamo.exec(client)(ops).toList
... }
List(Right(Thing(b,Some(3))), Right(Thing(c,Some(42))), Right(Thing(a,None)))

be combined with and

>>> case class Compound(a: String, maybe: Option[Int])
>>> LocalDynamoDB.withRandomTable(client)('a -> S) { t =>
...   val compoundTable = Table[Compound](t)
...   val ops = for {
...     _ <- compoundTable.putAll(Set(Compound("alpha", None), Compound("beta", Some(1)), Compound("gamma", None)))
...     _ <- compoundTable.given(attributeExists('maybe) and 'a -> "alpha").put(Compound("alpha", Some(2)))
...     _ <- compoundTable.given(attributeExists('maybe) and 'a -> "beta").put(Compound("beta", Some(3)))
...     _ <- compoundTable.given(Condition('a -> "gamma") and attributeExists('maybe)).put(Compound("gamma", Some(42)))
...     compounds <- compoundTable.scan()
...   } yield compounds
...   Scanamo.exec(client)(ops).toList
... }
List(Right(Compound(beta,Some(3))), Right(Compound(alpha,None)), Right(Compound(gamma,None)))

or with or

>>> case class Choice(number: Int, description: String)
>>> LocalDynamoDB.withRandomTable(client)('number -> N) { t =>
...   val choicesTable = Table[Choice](t)
...   val ops = for {
...     _ <- choicesTable.putAll(Set(Choice(1, "cake"), Choice(2, "crumble"), Choice(3, "custard")))
...     _ <- choicesTable.given(Condition('description -> "cake") or Condition('description -> "death")).put(Choice(1, "victoria sponge"))
...     _ <- choicesTable.given(Condition('description -> "cake") or Condition('description -> "death")).put(Choice(2, "victoria sponge"))
...     choices <- choicesTable.scan()
...   } yield choices
...   Scanamo.exec(client)(ops).toList
... }
List(Right(Choice(2,crumble)), Right(Choice(1,victoria sponge)), Right(Choice(3,custard)))

The same forms of condition can be applied to deletions

>>> case class Gremlin(number: Int, wet: Boolean, friendly: Boolean)
>>> LocalDynamoDB.withRandomTable(client)('number -> N) { t =>
...   val gremlinsTable = Table[Gremlin](t)
...   val ops = for {
...     _ <- gremlinsTable.putAll(Set(Gremlin(1, false, true), Gremlin(2, true, false)))
...     _ <- gremlinsTable.given('wet -> true).delete('number -> 1)
...     _ <- gremlinsTable.given('wet -> true).delete('number -> 2)
...     remainingGremlins <- gremlinsTable.scan()
...   } yield remainingGremlins
...   Scanamo.exec(client)(ops).toList
... }
List(Right(Gremlin(1,false,true)))

and updates

>>> LocalDynamoDB.withRandomTable(client)('number -> N) { t =>
...   val gremlinsTable = Table[Gremlin](t)
...   val ops = for {
...     _ <- gremlinsTable.putAll(Set(Gremlin(1, false, true), Gremlin(2, true, true)))
...     _ <- gremlinsTable.given('wet -> true).update('number -> 1, set('friendly -> false))
...     _ <- gremlinsTable.given('wet -> true).update('number -> 2, set('friendly -> false))
...     remainingGremlins <- gremlinsTable.scan()
...   } yield remainingGremlins
...   Scanamo.exec(client)(ops).toList
... }
List(Right(Gremlin(2,true,false)), Right(Gremlin(1,false,true)))

Conditions can also be placed on nested attributes

>>> LocalDynamoDB.withRandomTable(client)('name -> S) { t =>
...   val smallscaleFarmersTable = Table[Farmer](t)
...   val farmerOps = for {
...     _ <- smallscaleFarmersTable.put(Farmer("McDonald", 156L, Farm(List("sheep", "cow"), 30)))
...     _ <- smallscaleFarmersTable.given('farm \ 'hectares < 40L).put(Farmer("McDonald", 156L, Farm(List("gerbil", "hamster"), 20)))
...     _ <- smallscaleFarmersTable.given('farm \ 'hectares > 40L).put(Farmer("McDonald", 156L, Farm(List("elephant"), 50)))
...     _ <- smallscaleFarmersTable.given('farm \ 'hectares -> 20L).update('name -> "McDonald", append('farm \ 'animals -> "squirrel"))
...     farmerWithNewStock <- smallscaleFarmersTable.get('name -> "McDonald")
...   } yield farmerWithNewStock
...   Scanamo.exec(client)(farmerOps)
... }
Some(Right(Farmer(McDonald,156,Farm(List(gerbil, hamster, squirrel),20))))

def index(indexName: String): SecondaryIndex[V]

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

>>> case class Transport(mode: String, line: String, colour: String)

>>> val client = LocalDynamoDB.client()
>>> import com.amazonaws.services.dynamodbv2.model.ScalarAttributeType._
>>> import org.scanamo.syntax._
>>> import org.scanamo.auto._

>>> LocalDynamoDB.withRandomTableWithSecondaryIndex(client)('mode -> S, 'line -> S)('colour -> S) { (t, i) =>
...   val transport = Table[Transport](t)
...   val operations = for {
...     _ <- transport.putAll(Set(
...       Transport("Underground", "Circle", "Yellow"),
...       Transport("Underground", "Metropolitan", "Magenta"),
...       Transport("Underground", "Central", "Red")))
...     MagentaLine <- transport.index(i).query('colour -> "Magenta")
...   } yield MagentaLine.toList
...   Scanamo.exec(client)(operations)
... }
List(Right(Transport(Underground,Metropolitan,Magenta)))

>>> case class GithubProject(organisation: String, repository: String, language: String, license: String)

>>> import org.scanamo.auto._

>>> LocalDynamoDB.withRandomTableWithSecondaryIndex(client)('organisation -> S, 'repository -> S)('language -> S, 'license -> S) { (t, i) =>
...   val githubProjects = Table[GithubProject](t)
...   val operations = for {
...     _ <- githubProjects.putAll(Set(
...       GithubProject("typelevel", "cats", "Scala", "MIT"),
...       GithubProject("localytics", "sbt-dynamodb", "Scala", "MIT"),
...       GithubProject("tpolecat", "tut", "Scala", "MIT"),
...       GithubProject("guardian", "scanamo", "Scala", "Apache 2")
...     ))
...     scalaMIT <- githubProjects.index(i).query('language -> "Scala" and ('license -> "MIT"))
...   } yield scalaMIT.toList
...   Scanamo.exec(client)(operations)
... }
List(Right(GithubProject(typelevel,cats,Scala,MIT)), Right(GithubProject(tpolecat,tut,Scala,MIT)), Right(GithubProject(localytics,sbt-dynamodb,Scala,MIT)))

final def isInstanceOf[T0]: Boolean

Definition Classes
Any

def limit(n: Int): TableWithOptions[V]

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

>>> case class Transport(mode: String, line: String)

>>> val client = LocalDynamoDB.client()
>>> import com.amazonaws.services.dynamodbv2.model.ScalarAttributeType._

>>> LocalDynamoDB.withRandomTable(client)('mode -> S, 'line -> S) { t =>
...   import org.scanamo.syntax._
...   import org.scanamo.auto._
...   val transport = Table[Transport](t)
...   val operations = for {
...     _ <- transport.putAll(Set(
...       Transport("Underground", "Circle"),
...       Transport("Underground", "Metropolitan"),
...       Transport("Underground", "Central")))
...     results <- transport.limit(1).query('mode -> "Underground" and ('line beginsWith "C"))
...   } yield results.toList
...   Scanamo.exec(client)(operations)
... }
List(Right(Transport(Underground,Central)))

val name: String
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def put(v: V): ScanamoOps[Option[Either[DynamoReadError, V]]]
def putAll(vs: Set[V]): ScanamoOps[List[BatchWriteItemResult]]

def query(query: Query[_]): ScanamoOps[List[Either[DynamoReadError, V]]]

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

>>> case class Transport(mode: String, line: String)

>>> val client = LocalDynamoDB.client()

>>> import org.scanamo.syntax._
>>> import org.scanamo.auto._
>>> import com.amazonaws.services.dynamodbv2.model.ScalarAttributeType._

>>> LocalDynamoDB.withRandomTable(client)('mode -> S, 'line -> S) { t =>
...   val table = Table[Transport](t)
...   val ops = for {
...     _ <- table.putAll(Set(
...       Transport("Underground", "Circle"),
...       Transport("Underground", "Metropolitan"),
...       Transport("Underground", "Central")
...     ))
...     linesBeginningWithC <- table.query('mode -> "Underground" and ('line beginsWith "C"))
...   } yield linesBeginningWithC
...   Scanamo.exec(client)(ops)
... }
List(Right(Transport(Underground,Central)), Right(Transport(Underground,Circle)))

def query0(query: Query[_]): ScanamoOps[QueryResult]

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 QueryResult 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!

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

>>> case class Transport(mode: String, line: String)

>>> val client = LocalDynamoDB.client()

>>> import collection.JavaConverters._
>>> import cats.implicits._
>>> import org.scanamo.error._
>>> import org.scanamo.ops._
>>> import org.scanamo.syntax._
>>> import org.scanamo.auto._
>>> import org.scanamo.query._
>>> import com.amazonaws.services.dynamodbv2.model.ScalarAttributeType._

>>> LocalDynamoDB.withRandomTable(client)('mode -> S, 'line -> S) { t =>
...   val table = Table[Transport](t)
...   val ops = for {
...     _ <- table.putAll(Set(
...       Transport("Underground", "Circle"),
...       Transport("Underground", "Metropolitan"),
...       Transport("Underground", "Central"),
...       Transport("Bus", "390"),
...       Transport("Bus", "143"),
...       Transport("Bus", "234")
...     ))
...     res <- table.limit(1).query0('mode -> "Bus" and 'line -> "234")
...     uniqueKeyCondition = UniqueKeyCondition[AndEqualsCondition[KeyEquals[String], KeyEquals[String]]]
...     lastKey = uniqueKeyCondition.fromAVMap(('mode, 'line), res.getLastEvaluatedKey.asScala.toMap)
...     ts <- lastKey.fold(List.empty[Either[DynamoReadError, Transport]].pure[ScanamoOps])(table.from(_).scan())
...   } yield ts
...   Scanamo.exec(client)(ops)
... }
List(Right(Transport(Bus,390)), Right(Transport(Underground,Central)), Right(Transport(Underground,Circle)), Right(Transport(Underground,Metropolitan)))

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

Scans all elements of a table

>>> case class Bear(name: String, favouriteFood: String)

>>> val client = LocalDynamoDB.client()
>>> import com.amazonaws.services.dynamodbv2.model.ScalarAttributeType._

>>> LocalDynamoDB.withRandomTable(client)('name -> S) { t =>
...   import org.scanamo.auto._
...   val table = Table[Bear](t)
...   val ops = for {
...     _ <- table.put(Bear("Pooh", "honey"))
...     _ <- table.put(Bear("Yogi", "picnic baskets"))
...     bears <- table.scan()
...   } yield bears
...   Scanamo.exec(client)(ops)
... }
List(Right(Bear(Pooh,honey)), Right(Bear(Yogi,picnic baskets)))

def scan0: ScanamoOps[ScanResult]

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 ScanResult 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:

>>> case class Transport(mode: String, line: String)

>>> val client = LocalDynamoDB.client()

>>> import collection.JavaConverters._
>>> import cats.implicits._
>>> import org.scanamo.error._
>>> import org.scanamo.ops._
>>> import org.scanamo.syntax._
>>> import org.scanamo.auto._
>>> import org.scanamo.query._
>>> import com.amazonaws.services.dynamodbv2.model.ScalarAttributeType._

>>> LocalDynamoDB.withRandomTable(client)('mode -> S, 'line -> S) { t =>
...   val table = Table[Transport](t)
...   val ops = for {
...     _ <- table.putAll(Set(
...       Transport("Underground", "Circle"),
...       Transport("Underground", "Metropolitan"),
...       Transport("Underground", "Central")
...     ))
...     res <- table.limit(1).scan0
...     uniqueKeyCondition = UniqueKeyCondition[AndEqualsCondition[KeyEquals[String], KeyEquals[String]]]
...     lastKey = uniqueKeyCondition.fromAVMap(('mode, 'line), res.getLastEvaluatedKey.asScala.toMap)
...     ts <- lastKey.fold(List.empty[Either[DynamoReadError, Transport]].pure[ScanamoOps])(table.from(_).scan())
...   } yield ts
...   Scanamo.exec(client)(ops)
... }
List(Right(Transport(Underground,Circle)), Right(Transport(Underground,Metropolitan)))

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

Definition Classes
AnyRef

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

To set an attribute:

>>> case class Forecast(location: String, weather: String)

>>> val client = LocalDynamoDB.client()
>>> import com.amazonaws.services.dynamodbv2.model.ScalarAttributeType._

>>> LocalDynamoDB.withRandomTable(client)('location -> S) { t =>
...   import org.scanamo.syntax._
...   import org.scanamo.auto._
...   val forecast = Table[Forecast](t)
...   val operations = for {
...     _ <- forecast.put(Forecast("London", "Rain"))
...     updated <- forecast.update('location -> "London", set('weather -> "Sun"))
...   } yield updated
...   Scanamo.exec(client)(operations)
... }
Right(Forecast(London,Sun))

List attributes can also be appended or prepended to:

>>> case class Character(name: String, actors: List[String])

>>> LocalDynamoDB.withRandomTable(client)('name -> S) { t =>
...   import org.scanamo.syntax._
...   import org.scanamo.auto._
...   val characters = Table[Character](t)
...   val operations = for {
...     _ <- characters.put(Character("The Doctor", List("Ecclestone", "Tennant", "Smith")))
...     _ <- characters.update('name -> "The Doctor", append('actors -> "Capaldi"))
...     _ <- characters.update('name -> "The Doctor", prepend('actors -> "McCoy"))
...     results <- characters.scan()
...   } yield results.toList
...   Scanamo.exec(client)(operations)
... }
List(Right(Character(The Doctor,List(McCoy, Ecclestone, Tennant, Smith, Capaldi))))

Appending or prepending creates the list if it does not yet exist:

>>> LocalDynamoDB.withRandomTable(client)('name -> S) { t =>
...   import org.scanamo.syntax._
...   import org.scanamo.auto._
...   val characters = Table[Character](t)
...   val operations = for {
...     _ <- characters.update('name -> "James Bond", append('actors -> "Craig"))
...     results <- characters.query('name -> "James Bond")
...   } yield results.toList
...   Scanamo.exec(client)(operations)
... }
List(Right(Character(James Bond,List(Craig))))

To concatenate a list to the front or end of an existing list, use appendAll/prependAll:

>>> case class Fruit(kind: String, sources: List[String])

>>> LocalDynamoDB.withRandomTable(client)('kind -> S) { t =>
...   import org.scanamo.syntax._
...   import org.scanamo.auto._
...   val fruits = Table[Fruit](t)
...   val operations = for {
...     _ <- fruits.put(Fruit("watermelon", List("USA")))
...     _ <- fruits.update('kind -> "watermelon", appendAll('sources -> List("China", "Turkey")))
...     _ <- fruits.update('kind -> "watermelon", prependAll('sources -> List("Brazil")))
...     results <- fruits.query('kind -> "watermelon")
...   } yield results.toList
...   Scanamo.exec(client)(operations)
... }
List(Right(Fruit(watermelon,List(Brazil, USA, China, Turkey))))

Multiple operations can also be performed in one call:

>>> case class Foo(name: String, bar: Int, l: List[String])

>>> LocalDynamoDB.withRandomTable(client)('name -> S) { t =>
...   import org.scanamo.syntax._
...   import org.scanamo.auto._
...   val foos = Table[Foo](t)
...   val operations = for {
...     _ <- foos.put(Foo("x", 0, List("First")))
...     updated <- foos.update('name -> "x",
...       append('l -> "Second") and set('bar -> 1))
...   } yield updated
...   Scanamo.exec(client)(operations)
... }
Right(Foo(x,1,List(First, Second)))

It's also possible to perform ADD and DELETE updates

>>> case class Bar(name: String, counter: Long, set: Set[String])

>>> LocalDynamoDB.withRandomTable(client)('name -> S) { t =>
...   import org.scanamo.syntax._
...   import org.scanamo.auto._
...   val bars = Table[Bar](t)
...   val operations = for {
...     _ <- bars.put(Bar("x", 1L, Set("First")))
...     _ <- bars.update('name -> "x",
...       add('counter -> 10L) and add('set -> Set("Second")))
...     updatedBar <- bars.update('name -> "x", delete('set -> Set("First")))
...   } yield updatedBar
...   Scanamo.exec(client)(operations)
... }
Right(Bar(x,11,Set(Second)))

Updates may occur on nested attributes

>>> case class Inner(session: String)
>>> case class Middle(name: String, counter: Long, inner: Inner, list: List[Int])
>>> case class Outer(id: java.util.UUID, middle: Middle)

>>> LocalDynamoDB.withRandomTable(client)('id -> S) { t =>
...   import org.scanamo.syntax._
...   import org.scanamo.auto._
...   val outers = Table[Outer](t)
...   val id = java.util.UUID.fromString("a8345373-9a93-43be-9bcd-e3682c9197f4")
...   val operations = for {
...     _ <- outers.put(Outer(id, Middle("x", 1L, Inner("alpha"), List(1, 2))))
...     updatedOuter <- outers.update('id -> id,
...       set('middle \ 'inner \ 'session -> "beta") and add(('middle \ 'list)(1) ->  1)
...     )
...   } yield updatedOuter
...   Scanamo.exec(client)(operations)
... }
Right(Outer(a8345373-9a93-43be-9bcd-e3682c9197f4,Middle(x,1,Inner(beta),List(1, 3))))

It's possible to update one field to the value of another

>>> case class Thing(id: String, mandatory: Int, optional: Option[Int])

>>> LocalDynamoDB.withRandomTable(client)('id -> S) { t =>
...   import org.scanamo.syntax._
...   import org.scanamo.auto._
...   val things = Table[Thing](t)
...   val operations = for {
...     _ <- things.put(Thing("a1", 3, None))
...     updated <- things.update('id -> "a1", set('optional -> 'mandatory))
...   } yield updated
...   Scanamo.exec(client)(operations)
... }
Right(Thing(a1,3,Some(3)))

final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package scanamo

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

Instance Constructors

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

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def consistently: ConsistentlyReadTable[V]

def delete(key: UniqueKey[_]): ScanamoOps[DeleteItemResult]

def deleteAll(items: UniqueKeys[_]): ScanamoOps[List[BatchWriteItemResult]]

final def eq(arg0: AnyRef): Boolean

def filter[C](condition: C)(implicit arg0: ConditionExpression[C]): TableWithOptions[V]

def finalize(): Unit

def from[K](key: UniqueKey[K])(implicit arg0: UniqueKeyCondition[K]): TableWithOptions[V]

def get(key: UniqueKey[_]): ScanamoOps[Option[Either[DynamoReadError, V]]]

def getAll(keys: UniqueKeys[_]): ScanamoOps[Set[Either[DynamoReadError, V]]]

final def getClass(): Class[_]

def given[T](condition: T)(implicit arg0: ConditionExpression[T]): ConditionalOperation[V, T]

def index(indexName: String): SecondaryIndex[V]

final def isInstanceOf[T0]: Boolean

def limit(n: Int): TableWithOptions[V]

val name: String

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def put(v: V): ScanamoOps[Option[Either[DynamoReadError, V]]]

def putAll(vs: Set[V]): ScanamoOps[List[BatchWriteItemResult]]

def query(query: Query[_]): ScanamoOps[List[Either[DynamoReadError, V]]]

def query0(query: Query[_]): ScanamoOps[QueryResult]

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

def scan0: ScanamoOps[ScanResult]

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

def update(key: UniqueKey[_], expression: UpdateExpression): ScanamoOps[Either[DynamoReadError, V]]

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped