gem-hunter

Slick-pg

Currently supported pg types:

Currently supported pg features:

Usage

import com.github.tminglei.slickpg._


trait MyPostgresProfile extends ExPostgresProfile
                          with PgArraySupport
                          with PgDate2Support
                          with PgRangeSupport
                          with PgHStoreSupport
                          with PgPlayJsonSupport
                          with PgSearchSupport
                          with PgPostGISSupport
                          with PgNetSupport
                          with PgLTreeSupport {
  def pgjson = "jsonb" // jsonb support is in postgres 9.4.0 onward; for 9.3.x use "json"

  // Add back `capabilities.insertOrUpdate` to enable native `upsert` support; for postgres 9.5+
  override protected def computeCapabilities: Set[slick.basic.Capability] =
    super.computeCapabilities + slick.jdbc.JdbcCapabilities.insertOrUpdate

  override val api = MyAPI

  object MyAPI extends ExtPostgresAPI with ArrayImplicits
                                      with Date2DateTimeImplicitsDuration
                                      with JsonImplicits
                                      with NetImplicits
                                      with LTreeImplicits
                                      with RangeImplicits
                                      with HStoreImplicits
                                      with SearchImplicits
                                      with SearchAssistants {
    implicit val strListTypeMapper = new SimpleArrayJdbcType[String]("text").to(_.toList)
    implicit val playJsonArrayTypeMapper =
      new AdvancedArrayJdbcType[JsValue](pgjson,
        (s) => utils.SimpleArrayUtils.fromString[JsValue](Json.parse(_))(s).orNull,
        (v) => utils.SimpleArrayUtils.mkString[JsValue](_.toString())(v)
      ).to(_.toList)
  }
}

object MyPostgresProfile extends MyPostgresProfile

import MyPostgresProfile.api._

class TestTable(tag: Tag) extends Table[Test](tag, Some("xxx"), "Test") {
  def id = column[Long]("id", O.AutoInc, O.PrimaryKey)
  def during = column[Range[Timestamp]]("during")
  def location = column[Point]("location")
  def text = column[String]("text", O.DBType("varchar(4000)"))
  def props = column[Map[String,String]]("props_hstore")
  def tags = column[List[String]]("tags_arr")

  def * = (id, during, location, text, props, tags) <> ((Test.apply _).tupled, Test.unapply)
}

object tests extends TableQuery(new TestTable(_)) {
  // will generate sql like:
  //   select * from test where id = ?
  def byId(ids: Long*) = tests
        .filter(_.id inSetBind ids)
        .map(t => t)
  // will generate sql like:
  //   select * from test where tags && ?
  def byTag(tags: String*) = tests
        .filter(_.tags @& tags.toList.bind)
        .map(t => t)
  // will generate sql like:
  //   select * from test where during && ?
  def byTsRange(tsRange: Range[Timestamp]) = tests
        .filter(_.during @& tsRange.bind)
        .map(t => t)
  // will generate sql like:
  //   select * from test where case(props -> ? as [T]) == ?
  def byProperty[T](key: String, value: T) = tests
        .filter(_.props.>>[T](key.bind) === value.bind)
        .map(t => t)
  // will generate sql like:
  //   select * from test where ST_DWithin(location, ?, ?)
  def byDistance(point: Point, distance: Int) = tests
        .filter(r => r.location.dWithin(point.bind, distance.bind))
        .map(t => t)
  // will generate sql like:
  //   select id, text, ts_rank(to_tsvector(text), to_tsquery(?))
  //   from test where to_tsvector(text) @@ to_tsquery(?)
  //   order by ts_rank(to_tsvector(text), to_tsquery(?))
  def search(queryStr: String) = tests
        .filter( t => {tsVector(t.text) @@ tsQuery(queryStr.bind)})
        .map(r => (r.id, r.text, tsRank(tsVector(r.text), tsQuery(queryStr.bind))))
        .sortBy(_._3)
}

...

Configurable type/mappers

Built in supported type/mappers

Details

Install

libraryDependencies += "com.github.tminglei" %% "slick-pg" % "0.23.1"

libraryDependencies += "com.github.tminglei" %% "slick-pg_joda-time" % "0.23.1"

libraryDependencies += "com.github.tminglei" %% "slick-pg_jts" % "0.23.1"
or
libraryDependencies += "com.github.tminglei" %% "slick-pg_jts_lt" % "0.23.1"

libraryDependencies += "com.github.tminglei" %% "slick-pg_json4s" % "0.23.1"

libraryDependencies += "com.github.tminglei" %% "slick-pg_play-json" % "0.23.1"
or
libraryDependencies += "com.github.tminglei" %% "slick-pg_play-json3" % "0.23.1"

libraryDependencies += "com.github.tminglei" %% "slick-pg_spray-json" % "0.23.1"

libraryDependencies += "com.github.tminglei" %% "slick-pg_argonaut" % "0.23.1"

libraryDependencies += "com.github.tminglei" %% "slick-pg_circe-json" % "0.23.1"

libraryDependencies += "com.github.tminglei" %% "slick-pg_upickle-json" % "0.23.1"

<dependency>
    <groupId>com.github.tminglei</groupId>
    <artifactId>slick-pg_2.13</artifactId>
    <version>0.23.1</version>
</dependency>
<!-- other addons if necessary -->
...

Build instructions

./sbt update
./sbt compile

./sbt test

val db = Database.forURL(url = "jdbc:postgresql://localhost/test?user=postgres", driver = "org.postgresql.Driver")

License