setup template

Author: jatcwang

README.md

@@ -1,3 +1,18 @@
-# Scala starter
+# Doobie Quick Start 
+
+This is a template to help you get started playing with doobie (or to reproduce doobie bugs 🫣)
+
+## Getting started
+
+1. Clone this repository
+1. Edit `build.sbt` to set the Scala/doobie version you're using
+1. Run `docker-compose up -d --force-recreate` to start the DB container
+1. `sbt run`
+
+## Next steps
+
+Once you have the example running
+
+- Edit `docker_db_init/setup.sql` to change the set of your database schema and data. Don't forget to to run `docker-compose up -d --force-recreate` to make sure the database is recreated with your updated setup.sql!
+- Edit the Scala code. The entry point of the application is `src/main/scala/example/Main.scala`
 
-Quick starter project for scala

build.sbt

@@ -1,21 +1,28 @@
+val doobieVersion = "<SET_THIS_DOOBIE_VERSION>"
+// val doobieVersion = "1.0.0-RC2"
+
 lazy val root = Project("root", file("."))
   .settings(commonSettings)
   .settings(
-    name := "Scala Starter",
+    name := "Doobie",
     libraryDependencies ++= Seq(
-      "org.typelevel" %% "cats-core" % "2.9.0",
-      "org.scalameta" %% "munit" % "0.7.29" % Test,
+      "org.tpolecat" %% "doobie-core" % doobieVersion,
+      "org.tpolecat" %% "doobie-postgres" % doobieVersion,
+      "org.postgresql" % "postgresql" % "42.5.3",
     ),
   )
 
 lazy val commonSettings = Seq(
   version := "0.1.0",
-  scalaVersion := "3.2.1",
+  scalaVersion := "<SET_THIS_SCALA_VERSION>",
+//  scalaVersion := "3.2.2",
+//  scalaVersion := "2.13.10",
   scalacOptions --= {
     if (sys.env.get("CI").isDefined) {
       Seq.empty
     } else {
       Seq("-Xfatal-warnings")
     }
   },
+  scalacOptions ++= Seq("-Xsource:3"),
 )

docker-compose.yaml

@@ -0,0 +1,24 @@
+version: '3.8'
+
+services:
+
+  postgres:
+    image: postgis/postgis:15-3.3
+    environment:
+      POSTGRES_USER: postgres
+      POSTGRES_PASSWORD: postgres
+      POSTGRES_DB: repro
+    ports:
+      - 5432:5432
+    volumes:
+      - ./docker_db_init/:/docker-entrypoint-initdb.d/
+
+  # mysql:
+  #   image: mysql:8
+  #   environment:
+  #     MYSQL_ROOT_PASSWORD: root
+  #     MYSQL_DATABASE: repro
+  #   ports:
+  #     - 3306:3306
+  #   volumes:
+  #     - ./docker_db_init/:/docker-entrypoint-initdb.d/

docker_db_init/setup.sql

@@ -0,0 +1,3 @@
+create table person(name TEXT, age INT);
+
+insert into person (name, age) values ('Alice', 30), ('Bob', 30);

project/build.properties

@@ -1 +1 @@
-sbt.version=1.6.2
+sbt.version=1.8.2

src/main/scala/example/Main.scala

@@ -1,8 +1,22 @@
 package example
 
-object Main {
+import cats.effect.{IO, IOApp}
+import doobie.Transactor
+import doobie.implicits.*
 
-  def main(args: Array[String]): Unit =
-    println("Hello com.example.Empty Project!")
+object Main extends IOApp.Simple {
+
+  override def run: IO[Unit] = {
+    val transactor: Transactor[IO] = Transactor.fromDriverManager[IO](
+      "org.postgresql.Driver", // driver classname
+      "jdbc:postgresql:repro", // connect URL (driver-specific)
+      "postgres", // user
+      "postgres", // password
+    )
+
+    sql"SELECT name FROM person".query[String].to[List].transact(transactor).map { names =>
+      println(names)
+    }
+  }
 
 }