Skip to content
A database API for Scala
Branch: master
Clone or download
Pull request Compare This branch is 253 commits ahead, 1 commit behind wdacom:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
base
cassandra
examples
h2
jdbc
mariadb
postgresql
project
sqlserver
.gitignore
DIALECT.md
EXAMPLES.md
LICENSE.txt
README.md
build.sbt
rootdoc.txt

README.md

SDBC by Rocketfuel

Description

SDBC is a collection of database APIs for Scala. It originally was meant to be an alternative to Anorm, but has also borrowed ideas from from Doobie. SDBC is not an ORM.

It currently supports Apache Cassandra, H2, MariaDB, Microsoft SQL Server, and PostgreSQL.

JDBC connection pools are provided by HikariCP. The pools can be created with a HikariConfig or Typesafe Config object.

Examples

Adding a dialect

Requirements

  • Java 8
  • Scala 2.11 or 2.12.
  • Cassandra, H2, MariaDB, Microsoft SQL Server, or PostgreSQL

Include an implementation of the SLF4J logging interface, turn on debug logging, and all your query executions will be logged with the query text and the parameter name-value map.

SBT Library Dependency

Packages exist on Maven Central for Scala 2.11 and 2.12.

Cassandra

"com.rocketfuel.sdbc" %% "cassandra-datastax" % "3.0.0"

H2

"com.rocketfuel.sdbc" %% "h2-jdbc" % "3.0.0"

MariaDB

"com.rocketfuel.sdbc" %% "mariadb-jdbc" % "3.0.0"

Microsoft SQL Server

"com.rocketfuel.sdbc" %% "sqlserver-jdbc" % "3.0.0"

PostgreSql

"com.rocketfuel.sdbc" %% "postgresql-jdbc" % "3.0.0"

License

BSD 3-Clause, so SDBC can be used anywhere Scala is used.

Features

  • Use generics and implicit conversions to retrieve column or row values.
  • Get tuples or case classes from rows without any extra work. (thanks to shapeless)
  • Use tuples or case classes to set query parameters. (thanks to shapeless)
  • Use named parameters with queries.
  • Use Scala collection combinators to manipulate result sets.
  • Log queries with SLF4J.
  • Supports Java 8's java.time package.
  • FS2 Streams for streaming to or from a DBMS.
  • Easily add column or row types.
  • Type classes for each query type.

Feature restrictions

H2

  • The H2 JDBC driver does not support getResultSet on inner arrays, so only 1 dimensional arrays are supported.
  • The H2 JDBC driver does not support ResultSet#updateArray, so updating arrays is not supported.

Scaladoc

Java 8 time notes

column type column time zone java.time type
timestamp or datetime GMT Instant
timestamp or datetime same as client LocalDateTime
timestamp or datetime not GMT and not client's Timestamp, then convert to LocalDateTime with desired time zone
timestamptz or timestamp with time zone or datetimeoffset OffsetDateTime
date LocalDate
time LocalTime
timetz or time with time zone OffsetTime

Benchmarks

Starting with 2.0, there are benchmarks to ensure that some common operations don't have too much overhead over jdbc. There are two so far. The first batch inserts a collection of a case class. The second selects a colletion of a case class.

select benchmark results

batch insert benchmark results

Changelog

3.0.0

  • Select, Selectable, Query, and Queryable now have map methods

2.0.2

  • The wrong index was used for null parameters in jdbc queries.

2.0.1

  • Correct publishing to Maven Central

2.0

  • MariaDB & MySQL support
  • JDBC Connection types are now per-DBMS (i.e. they are path dependent).
  • Update scalaz streams to FS2.
  • Stream support is built-in. Try using methods such as stream, pipe, and sink.
  • Support for multiple result sets per query from MariaDB and SQL Server using MultiQuery.
  • A datetime without an offset from a DBMS is interpreted as being in UTC rather than the system default time zone.
  • No longer supports Scala 2.10.
  • Moved database objects to com.rocketfuel.sdbc.{Cassandra, H2, PostgreSql, SqlServer}.
  • Renamed Execute to Ignore.
  • Added Insert, Delete, and their type classes.
  • Typeclass methods are now in their respective companion objects. For example, Selectable.select.
  • There are objects you can import to have type class methods added to type class members. For example import com.rocketfuel.sdbc.PostgreSql.syntax._ would let you do something like Person.Name(3, "Judy").update() to update the name of record 3 to Judy.
  • SelectForUpdate takes the update function as an argument. It returns a summary of the number of rows deleted, inserted, and updated.
  • Maven package names changed again. Hopefully the last time.

1.0

  • The sigil for a parameter is '@' (was '$').
  • Added support for string interpolation for parameters.
  • Cassandra support.
  • Scalaz streaming helpers in com.rocketfuel.sdbc.scalaz.
  • Connections and other types are no longer path dependent.
  • Package paths are implementation dependent. (E.G. import ...postgresql.jdbc to use the JDBC driver to access PostgreSQL.)
  • You can use scodec's ByteVector instead of Array[Byte].
  • Remove Byte getters, setters, and updaters from PostgreSQL (the JDBC driver uses Short under the hood).

0.10

Java 7

  • Added Joda Time support.

0.9

  • Only Hikari configuration parameters are sent to the HikariConfig constructor.
  • Added support for Java 7.

0.8

  • XML getters and setters use Node instead of Elem.

0.7

  • PostgreSQL was missing some keywords in its Identifier implementation.

0.6

  • Add support for H2.
  • Test packages have better support for building and destroying test catalogs.
  • Some method names were shortened: executeBatch() to batch(), executeUpdate() to update().
You can’t perform that action at this time.