Skip to content
Simpler DynamoDB access for Scala
Branch: master
Clone or download
Latest commit 686b4fb May 22, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
alpakka/src fmt May 21, 2019
cats/src Rename spec May 21, 2019
docs/src/main Merge branch 'master' of https://github.com/scanamo/scanamo into rk-a… May 21, 2019
formats/src Revert "Update scalafmt and format files" May 19, 2019
java-time/src Revert "Update scalafmt and format files" May 19, 2019
joda/src/main/scala/org/scanamo/joda Fix folder hierarchy Jan 31, 2019
project Revert "Update scalafmt and format files" May 19, 2019
refined/src Revert "Update scalafmt and format files" May 19, 2019
scalaz-zio/src Cleanup API May 18, 2019
scalaz/src Cleanup API May 18, 2019
scanamo/src Cleanup API May 18, 2019
testkit/src/main/scala/org/scanamo Revert "Update scalafmt and format files" May 19, 2019
.codecov.yml Add codecov repo yaml Dec 21, 2018
.gitignore Ignore all dynamo local folders Jul 8, 2018
.ruby-version Add ruby version May 19, 2018
.sbtopts Update dependencies Nov 7, 2017
.scala-steward.conf Ignore updates for the dynamo db sdk Feb 21, 2019
.scalafmt.conf Merge branch 'master' of https://github.com/scanamo/scanamo into rk-a… May 21, 2019
.travis.yml Restore 2.11 cross build Dec 26, 2018
CHANGES.md Update changes doc Oct 25, 2018
CONTRIBUTING.md #380 Add jekyll installation hint to Contributing.md Apr 11, 2019
LICENCE Add a LICENSE file, so that Github recognises it May 31, 2017
README.md Update README.md Jan 31, 2019
build.sbt Revert "Update scalafmt and format files" May 19, 2019

README.md

CI Coverage Release Issues Users Chat
Build Status Coverage Status Release Artifacts Average time to resolve an issue Scaladex dependencies badge Gitter

Scanamo is a library to make using DynamoDB with Scala simpler and less error-prone.

The main focus is on making it easier to avoid mistakes and typos by leveraging Scala's type system and some higher level abstractions.

Installation

libraryDependencies += "org.scanamo" %% "scanamo" % "1.0.0-M9"

Scanamo is published for Scala 2.12 and Scala 2.11

Basic Usage

Note: the LocalDynamoDB object is provided by the scanamo-testkit package.

scala> import org.scanamo._
scala> import org.scanamo.syntax._
scala> import org.scanamo.auto._
 
scala> val client = LocalDynamoDB.client()
scala> import com.amazonaws.services.dynamodbv2.model.ScalarAttributeType._
scala> val farmersTableResult = LocalDynamoDB.createTable(client)("farmer")('name -> S)

scala> case class Farm(animals: List[String])
scala> case class Farmer(name: String, age: Long, farm: Farm)
scala> val table = Table[Farmer]("farmer")

scala> val ops = for {
     |   _ <- table.putAll(Set(
     |       Farmer("McDonald", 156L, Farm(List("sheep", "cow"))),
     |       Farmer("Boggis", 43L, Farm(List("chicken")))
     |     ))
     |   mcdonald <- table.get('name -> "McDonald")
     | } yield mcdonald
scala> Scanamo.exec(client)(ops)
res1: Option[Either[error.DynamoReadError, Farmer]] = Some(Right(Farmer(McDonald,156,Farm(List(sheep, cow)))))

For more details, please see the Scanamo site.

License

Scanamo is licensed under the Apache License, Version 2.0 (the "License"); you may not use this software except in compliance with the License.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

You can’t perform that action at this time.