src/Pure/General/sql.scala
author wenzelm
Mon May 08 15:13:40 2017 +0200 (2017-05-08)
changeset 65774 1001fb86d7f7
parent 65748 1f4a80e80c88
child 65775 123f2c0995b8
permissions -rw-r--r--
clarified signature;
wenzelm@63788
     1
/*  Title:      Pure/General/sql.scala
wenzelm@63778
     2
    Author:     Makarius
wenzelm@63778
     3
wenzelm@65006
     4
Support for SQL databases: SQLite and PostgreSQL.
wenzelm@63778
     5
*/
wenzelm@63778
     6
wenzelm@63778
     7
package isabelle
wenzelm@63778
     8
wenzelm@65021
     9
import java.time.OffsetDateTime
wenzelm@65021
    10
import java.sql.{DriverManager, Connection, PreparedStatement, ResultSet}
wenzelm@63779
    11
wenzelm@65740
    12
import scala.collection.mutable
wenzelm@65740
    13
wenzelm@63779
    14
wenzelm@63778
    15
object SQL
wenzelm@63778
    16
{
wenzelm@65006
    17
  /** SQL language **/
wenzelm@65006
    18
wenzelm@65730
    19
  type Source = String
wenzelm@65730
    20
wenzelm@65730
    21
wenzelm@63778
    22
  /* concrete syntax */
wenzelm@63778
    23
wenzelm@65321
    24
  def escape_char(c: Char): String =
wenzelm@63778
    25
    c match {
wenzelm@63778
    26
      case '\u0000' => "\\0"
wenzelm@63778
    27
      case '\'' => "\\'"
wenzelm@63778
    28
      case '\"' => "\\\""
wenzelm@63778
    29
      case '\b' => "\\b"
wenzelm@63778
    30
      case '\n' => "\\n"
wenzelm@63778
    31
      case '\r' => "\\r"
wenzelm@63778
    32
      case '\t' => "\\t"
wenzelm@63778
    33
      case '\u001a' => "\\Z"
wenzelm@63778
    34
      case '\\' => "\\\\"
wenzelm@63778
    35
      case _ => c.toString
wenzelm@63778
    36
    }
wenzelm@63778
    37
wenzelm@65730
    38
  def string(s: String): Source =
wenzelm@65321
    39
    "'" + s.map(escape_char(_)).mkString + "'"
wenzelm@63778
    40
wenzelm@65730
    41
  def ident(s: String): Source =
wenzelm@65677
    42
    Long_Name.implode(Long_Name.explode(s).map(a => quote(a.replace("\"", "\"\""))))
wenzelm@63779
    43
wenzelm@65730
    44
  def enclose(s: Source): Source = "(" + s + ")"
wenzelm@65730
    45
  def enclosure(ss: Iterable[Source]): Source = ss.mkString("(", ", ", ")")
wenzelm@63791
    46
wenzelm@65774
    47
  def select(columns: List[Column] = Nil, distinct: Boolean = false): Source =
wenzelm@65774
    48
    "SELECT " + (if (distinct) "DISTINCT " else "") +
wenzelm@65774
    49
    (if (columns.isEmpty) "*" else commas(columns.map(_.ident))) + " FROM "
wenzelm@65644
    50
wenzelm@63779
    51
wenzelm@65008
    52
  /* types */
wenzelm@65008
    53
wenzelm@65008
    54
  object Type extends Enumeration
wenzelm@65008
    55
  {
wenzelm@65011
    56
    val Boolean = Value("BOOLEAN")
wenzelm@65008
    57
    val Int = Value("INTEGER")
wenzelm@65008
    58
    val Long = Value("BIGINT")
wenzelm@65008
    59
    val Double = Value("DOUBLE PRECISION")
wenzelm@65008
    60
    val String = Value("TEXT")
wenzelm@65008
    61
    val Bytes = Value("BLOB")
wenzelm@65014
    62
    val Date = Value("TIMESTAMP WITH TIME ZONE")
wenzelm@65008
    63
  }
wenzelm@65008
    64
wenzelm@65730
    65
  def sql_type_default(T: Type.Value): Source = T.toString
wenzelm@65013
    66
wenzelm@65730
    67
  def sql_type_sqlite(T: Type.Value): Source =
wenzelm@65019
    68
    if (T == Type.Boolean) "INTEGER"
wenzelm@65019
    69
    else if (T == Type.Date) "TEXT"
wenzelm@65019
    70
    else sql_type_default(T)
wenzelm@65013
    71
wenzelm@65730
    72
  def sql_type_postgresql(T: Type.Value): Source =
wenzelm@65019
    73
    if (T == Type.Bytes) "BYTEA"
wenzelm@65019
    74
    else sql_type_default(T)
wenzelm@65008
    75
wenzelm@65008
    76
wenzelm@63779
    77
  /* columns */
wenzelm@63779
    78
wenzelm@63779
    79
  object Column
wenzelm@63779
    80
  {
wenzelm@65280
    81
    def bool(name: String, strict: Boolean = false, primary_key: Boolean = false): Column =
wenzelm@65018
    82
      Column(name, Type.Boolean, strict, primary_key)
wenzelm@65280
    83
    def int(name: String, strict: Boolean = false, primary_key: Boolean = false): Column =
wenzelm@65018
    84
      Column(name, Type.Int, strict, primary_key)
wenzelm@65280
    85
    def long(name: String, strict: Boolean = false, primary_key: Boolean = false): Column =
wenzelm@65018
    86
      Column(name, Type.Long, strict, primary_key)
wenzelm@65280
    87
    def double(name: String, strict: Boolean = false, primary_key: Boolean = false): Column =
wenzelm@65018
    88
      Column(name, Type.Double, strict, primary_key)
wenzelm@65280
    89
    def string(name: String, strict: Boolean = false, primary_key: Boolean = false): Column =
wenzelm@65018
    90
      Column(name, Type.String, strict, primary_key)
wenzelm@65280
    91
    def bytes(name: String, strict: Boolean = false, primary_key: Boolean = false): Column =
wenzelm@65018
    92
      Column(name, Type.Bytes, strict, primary_key)
wenzelm@65280
    93
    def date(name: String, strict: Boolean = false, primary_key: Boolean = false): Column =
wenzelm@65018
    94
      Column(name, Type.Date, strict, primary_key)
wenzelm@63779
    95
  }
wenzelm@63779
    96
wenzelm@65018
    97
  sealed case class Column(
wenzelm@65280
    98
    name: String, T: Type.Value, strict: Boolean = false, primary_key: Boolean = false)
wenzelm@63779
    99
  {
wenzelm@65691
   100
    def apply(table: Table): Column =
wenzelm@65691
   101
      Column(Long_Name.qualify(table.name, name), T, strict = strict, primary_key = primary_key)
wenzelm@65644
   102
wenzelm@65730
   103
    def ident: Source = SQL.ident(name)
wenzelm@65695
   104
wenzelm@65730
   105
    def decl(sql_type: Type.Value => Source): Source =
wenzelm@65695
   106
      ident + " " + sql_type(T) + (if (strict || primary_key) " NOT NULL" else "")
wenzelm@63781
   107
wenzelm@65730
   108
    def where_equal(s: String): Source = "WHERE " + ident + " = " + string(s)
wenzelm@65593
   109
wenzelm@65730
   110
    override def toString: Source = ident
wenzelm@63779
   111
  }
wenzelm@63779
   112
wenzelm@63780
   113
wenzelm@63780
   114
  /* tables */
wenzelm@63780
   115
wenzelm@65730
   116
  sealed case class Table(name: String, columns: List[Column], body: Source = "")
wenzelm@63780
   117
  {
wenzelm@63790
   118
    private val columns_index: Map[String, Int] =
wenzelm@63790
   119
      columns.iterator.map(_.name).zipWithIndex.toMap
wenzelm@63790
   120
wenzelm@63781
   121
    Library.duplicates(columns.map(_.name)) match {
wenzelm@63781
   122
      case Nil =>
wenzelm@63781
   123
      case bad => error("Duplicate column names " + commas_quote(bad) + " for table " + quote(name))
wenzelm@63781
   124
    }
wenzelm@63781
   125
wenzelm@65730
   126
    def ident: Source = SQL.ident(name)
wenzelm@65691
   127
wenzelm@65730
   128
    def query: Source =
wenzelm@65696
   129
      if (body == "") error("Missing SQL body for table " + quote(name))
wenzelm@65696
   130
      else SQL.enclose(body)
wenzelm@65649
   131
wenzelm@65730
   132
    def query_name: Source = query + " AS " + SQL.ident(name)
wenzelm@65702
   133
wenzelm@65730
   134
    def create(strict: Boolean = false, sql_type: Type.Value => Source): Source =
wenzelm@65325
   135
    {
wenzelm@65325
   136
      val primary_key =
wenzelm@65325
   137
        columns.filter(_.primary_key).map(_.name) match {
wenzelm@65325
   138
          case Nil => Nil
wenzelm@65325
   139
          case keys => List("PRIMARY KEY " + enclosure(keys))
wenzelm@65325
   140
        }
wenzelm@65701
   141
      "CREATE TABLE " + (if (strict) "" else "IF NOT EXISTS ") +
wenzelm@65701
   142
        ident + " " + enclosure(columns.map(_.decl(sql_type)) ::: primary_key)
wenzelm@63781
   143
    }
wenzelm@63781
   144
wenzelm@65698
   145
    def create_index(index_name: String, index_columns: List[Column],
wenzelm@65730
   146
        strict: Boolean = false, unique: Boolean = false): Source =
wenzelm@63791
   147
      "CREATE " + (if (unique) "UNIQUE " else "") + "INDEX " +
wenzelm@65695
   148
        (if (strict) "" else "IF NOT EXISTS ") + SQL.ident(index_name) + " ON " +
wenzelm@65695
   149
        ident + " " + enclosure(index_columns.map(_.name))
wenzelm@63791
   150
wenzelm@65730
   151
    def insert_cmd(cmd: Source, sql: Source = ""): Source =
wenzelm@65703
   152
      cmd + " INTO " + ident + " VALUES " + enclosure(columns.map(_ => "?")) +
wenzelm@65698
   153
        (if (sql == "") "" else " " + sql)
wenzelm@63791
   154
wenzelm@65730
   155
    def insert(sql: Source = ""): Source = insert_cmd("INSERT", sql)
wenzelm@65703
   156
wenzelm@65730
   157
    def delete(sql: Source = ""): Source =
wenzelm@65698
   158
      "DELETE FROM " + ident +
wenzelm@65698
   159
        (if (sql == "") "" else " " + sql)
wenzelm@65319
   160
wenzelm@65774
   161
    def select(
wenzelm@65774
   162
        select_columns: List[Column] = Nil, sql: Source = "", distinct: Boolean = false): Source =
wenzelm@65698
   163
      SQL.select(select_columns, distinct = distinct) + ident +
wenzelm@65698
   164
        (if (sql == "") "" else " " + sql)
wenzelm@63790
   165
wenzelm@65730
   166
    override def toString: Source = ident
wenzelm@63780
   167
  }
wenzelm@63790
   168
wenzelm@63790
   169
wenzelm@65012
   170
wenzelm@65012
   171
  /** SQL database operations **/
wenzelm@65012
   172
wenzelm@65740
   173
  /* statements */
wenzelm@65740
   174
wenzelm@65740
   175
  class Statement private[SQL](val db: Database, val rep: PreparedStatement)
wenzelm@65740
   176
  {
wenzelm@65740
   177
    stmt =>
wenzelm@65740
   178
wenzelm@65748
   179
    object bool
wenzelm@65740
   180
    {
wenzelm@65748
   181
      def update(i: Int, x: Boolean) { rep.setBoolean(i, x) }
wenzelm@65748
   182
      def update(i: Int, x: Option[Boolean])
wenzelm@65748
   183
      {
wenzelm@65748
   184
        if (x.isDefined) update(i, x.get)
wenzelm@65748
   185
        else rep.setNull(i, java.sql.Types.BOOLEAN)
wenzelm@65748
   186
      }
wenzelm@65740
   187
    }
wenzelm@65748
   188
    object int
wenzelm@65740
   189
    {
wenzelm@65748
   190
      def update(i: Int, x: Int) { rep.setInt(i, x) }
wenzelm@65748
   191
      def update(i: Int, x: Option[Int])
wenzelm@65748
   192
      {
wenzelm@65748
   193
        if (x.isDefined) update(i, x.get)
wenzelm@65748
   194
        else rep.setNull(i, java.sql.Types.INTEGER)
wenzelm@65748
   195
      }
wenzelm@65740
   196
    }
wenzelm@65748
   197
    object long
wenzelm@65740
   198
    {
wenzelm@65748
   199
      def update(i: Int, x: Long) { rep.setLong(i, x) }
wenzelm@65748
   200
      def update(i: Int, x: Option[Long])
wenzelm@65748
   201
      {
wenzelm@65748
   202
        if (x.isDefined) update(i, x.get)
wenzelm@65748
   203
        else rep.setNull(i, java.sql.Types.BIGINT)
wenzelm@65748
   204
      }
wenzelm@65740
   205
    }
wenzelm@65748
   206
    object double
wenzelm@65740
   207
    {
wenzelm@65748
   208
      def update(i: Int, x: Double) { rep.setDouble(i, x) }
wenzelm@65748
   209
      def update(i: Int, x: Option[Double])
wenzelm@65748
   210
      {
wenzelm@65748
   211
        if (x.isDefined) update(i, x.get)
wenzelm@65748
   212
        else rep.setNull(i, java.sql.Types.DOUBLE)
wenzelm@65748
   213
      }
wenzelm@65748
   214
    }
wenzelm@65748
   215
    object string
wenzelm@65748
   216
    {
wenzelm@65748
   217
      def update(i: Int, x: String) { rep.setString(i, x) }
wenzelm@65748
   218
      def update(i: Int, x: Option[String]): Unit = update(i, x.orNull)
wenzelm@65740
   219
    }
wenzelm@65748
   220
    object bytes
wenzelm@65740
   221
    {
wenzelm@65748
   222
      def update(i: Int, bytes: Bytes)
wenzelm@65748
   223
      {
wenzelm@65748
   224
        if (bytes == null) rep.setBytes(i, null)
wenzelm@65748
   225
        else rep.setBinaryStream(i, bytes.stream(), bytes.length)
wenzelm@65748
   226
      }
wenzelm@65748
   227
      def update(i: Int, bytes: Option[Bytes]): Unit = update(i, bytes.orNull)
wenzelm@65740
   228
    }
wenzelm@65748
   229
    object date
wenzelm@65748
   230
    {
wenzelm@65748
   231
      def update(i: Int, date: Date): Unit = db.update_date(stmt, i, date)
wenzelm@65748
   232
      def update(i: Int, date: Option[Date]): Unit = update(i, date.orNull)
wenzelm@65748
   233
    }
wenzelm@65740
   234
wenzelm@65740
   235
    def execute(): Boolean = rep.execute()
wenzelm@65740
   236
    def execute_query(): Result = new Result(this, rep.executeQuery())
wenzelm@65740
   237
wenzelm@65740
   238
    def close(): Unit = rep.close
wenzelm@65740
   239
  }
wenzelm@65740
   240
wenzelm@65740
   241
wenzelm@63790
   242
  /* results */
wenzelm@63790
   243
wenzelm@65740
   244
  class Result private[SQL](val stmt: Statement, val rep: ResultSet)
wenzelm@63790
   245
  {
wenzelm@65740
   246
    res =>
wenzelm@65740
   247
wenzelm@65740
   248
    def next(): Boolean = rep.next()
wenzelm@65740
   249
wenzelm@65740
   250
    def iterator[A](get: Result => A): Iterator[A] = new Iterator[A]
wenzelm@65740
   251
    {
wenzelm@65740
   252
      private var _next: Boolean = res.next()
wenzelm@65740
   253
      def hasNext: Boolean = _next
wenzelm@65740
   254
      def next: A = { val x = get(res); _next = res.next(); x }
wenzelm@65740
   255
    }
wenzelm@65740
   256
wenzelm@65740
   257
    def bool(column: Column): Boolean = rep.getBoolean(column.name)
wenzelm@65740
   258
    def int(column: Column): Int = rep.getInt(column.name)
wenzelm@65740
   259
    def long(column: Column): Long = rep.getLong(column.name)
wenzelm@65740
   260
    def double(column: Column): Double = rep.getDouble(column.name)
wenzelm@65740
   261
    def string(column: Column): String =
wenzelm@65740
   262
    {
wenzelm@65740
   263
      val s = rep.getString(column.name)
wenzelm@65740
   264
      if (s == null) "" else s
wenzelm@65740
   265
    }
wenzelm@65740
   266
    def bytes(column: Column): Bytes =
wenzelm@65740
   267
    {
wenzelm@65740
   268
      val bs = rep.getBytes(column.name)
wenzelm@65740
   269
      if (bs == null) Bytes.empty else Bytes(bs)
wenzelm@65740
   270
    }
wenzelm@65740
   271
    def date(column: Column): Date = stmt.db.date(res, column)
wenzelm@65740
   272
wenzelm@65741
   273
    def timing(c1: Column, c2: Column, c3: Column) =
wenzelm@65741
   274
      Timing(Time.ms(long(c1)), Time.ms(long(c2)), Time.ms(long(c3)))
wenzelm@65741
   275
wenzelm@65740
   276
    def get[A](column: Column, f: Column => A): Option[A] =
wenzelm@65740
   277
    {
wenzelm@65740
   278
      val x = f(column)
wenzelm@65740
   279
      if (rep.wasNull) None else Some(x)
wenzelm@65740
   280
    }
wenzelm@65740
   281
    def get_bool(column: Column): Option[Boolean] = get(column, bool _)
wenzelm@65740
   282
    def get_int(column: Column): Option[Int] = get(column, int _)
wenzelm@65740
   283
    def get_long(column: Column): Option[Long] = get(column, long _)
wenzelm@65740
   284
    def get_double(column: Column): Option[Double] = get(column, double _)
wenzelm@65740
   285
    def get_string(column: Column): Option[String] = get(column, string _)
wenzelm@65740
   286
    def get_bytes(column: Column): Option[Bytes] = get(column, bytes _)
wenzelm@65740
   287
    def get_date(column: Column): Option[Date] = get(column, date _)
wenzelm@63790
   288
  }
wenzelm@65006
   289
wenzelm@65740
   290
wenzelm@65740
   291
  /* database */
wenzelm@65740
   292
wenzelm@65006
   293
  trait Database
wenzelm@65006
   294
  {
wenzelm@65740
   295
    db =>
wenzelm@65740
   296
wenzelm@65740
   297
wenzelm@65008
   298
    /* types */
wenzelm@65008
   299
wenzelm@65730
   300
    def sql_type(T: Type.Value): Source
wenzelm@65008
   301
wenzelm@65008
   302
wenzelm@65006
   303
    /* connection */
wenzelm@65006
   304
wenzelm@65006
   305
    def connection: Connection
wenzelm@65006
   306
wenzelm@65006
   307
    def close() { connection.close }
wenzelm@65006
   308
wenzelm@65006
   309
    def transaction[A](body: => A): A =
wenzelm@65006
   310
    {
wenzelm@65006
   311
      val auto_commit = connection.getAutoCommit
wenzelm@65006
   312
      try {
wenzelm@65006
   313
        connection.setAutoCommit(false)
wenzelm@65022
   314
        val savepoint = connection.setSavepoint
wenzelm@65022
   315
        try {
wenzelm@65022
   316
          val result = body
wenzelm@65022
   317
          connection.commit
wenzelm@65022
   318
          result
wenzelm@65022
   319
        }
wenzelm@65022
   320
        catch { case exn: Throwable => connection.rollback(savepoint); throw exn }
wenzelm@65006
   321
      }
wenzelm@65006
   322
      finally { connection.setAutoCommit(auto_commit) }
wenzelm@65006
   323
    }
wenzelm@65006
   324
wenzelm@65006
   325
wenzelm@65740
   326
    /* statements and results */
wenzelm@65740
   327
wenzelm@65740
   328
    def statement(sql: Source): Statement =
wenzelm@65740
   329
      new Statement(db, connection.prepareStatement(sql))
wenzelm@65006
   330
wenzelm@65740
   331
    def using_statement[A](sql: Source)(f: Statement => A): A =
wenzelm@65740
   332
      using(statement(sql))(f)
wenzelm@65006
   333
wenzelm@65748
   334
    def update_date(stmt: Statement, i: Int, date: Date): Unit
wenzelm@65740
   335
    def date(res: Result, column: Column): Date
wenzelm@65006
   336
wenzelm@65730
   337
    def insert_permissive(table: Table, sql: Source = ""): Source
wenzelm@65703
   338
wenzelm@65006
   339
wenzelm@65669
   340
    /* tables and views */
wenzelm@65006
   341
wenzelm@65006
   342
    def tables: List[String] =
wenzelm@65740
   343
    {
wenzelm@65740
   344
      val result = new mutable.ListBuffer[String]
wenzelm@65740
   345
      val rs = connection.getMetaData.getTables(null, null, "%", null)
wenzelm@65740
   346
      while (rs.next) { result += rs.getString(3) }
wenzelm@65740
   347
      result.toList
wenzelm@65740
   348
    }
wenzelm@65006
   349
wenzelm@65730
   350
    def create_table(table: Table, strict: Boolean = false, sql: Source = ""): Unit =
wenzelm@65698
   351
      using_statement(
wenzelm@65698
   352
        table.create(strict, sql_type) + (if (sql == "") "" else " " + sql))(_.execute())
wenzelm@65006
   353
wenzelm@65018
   354
    def create_index(table: Table, name: String, columns: List[Column],
wenzelm@65280
   355
        strict: Boolean = false, unique: Boolean = false): Unit =
wenzelm@65698
   356
      using_statement(table.create_index(name, columns, strict, unique))(_.execute())
wenzelm@65006
   357
wenzelm@65691
   358
    def create_view(table: Table, strict: Boolean = false): Unit =
wenzelm@65691
   359
    {
wenzelm@65691
   360
      if (strict || !tables.contains(table.name)) {
wenzelm@65731
   361
        val sql = "CREATE VIEW " + table + " AS " + { table.query; table.body }
wenzelm@65698
   362
        using_statement(sql)(_.execute())
wenzelm@65690
   363
      }
wenzelm@65691
   364
    }
wenzelm@65006
   365
  }
wenzelm@63778
   366
}
wenzelm@65006
   367
wenzelm@65006
   368
wenzelm@65006
   369
wenzelm@65006
   370
/** SQLite **/
wenzelm@65006
   371
wenzelm@65006
   372
object SQLite
wenzelm@65006
   373
{
wenzelm@65021
   374
  // see https://www.sqlite.org/lang_datefunc.html
wenzelm@65021
   375
  val date_format: Date.Format = Date.Format("uuuu-MM-dd HH:mm:ss.SSS x")
wenzelm@65021
   376
wenzelm@65292
   377
  lazy val init_jdbc: Unit = Class.forName("org.sqlite.JDBC")
wenzelm@65292
   378
wenzelm@65006
   379
  def open_database(path: Path): Database =
wenzelm@65006
   380
  {
wenzelm@65292
   381
    init_jdbc
wenzelm@65006
   382
    val path0 = path.expand
wenzelm@65006
   383
    val s0 = File.platform_path(path0)
wenzelm@65006
   384
    val s1 = if (Platform.is_windows) s0.replace('\\', '/') else s0
wenzelm@65006
   385
    val connection = DriverManager.getConnection("jdbc:sqlite:" + s1)
wenzelm@65007
   386
    new Database(path0.toString, connection)
wenzelm@65006
   387
  }
wenzelm@65006
   388
wenzelm@65007
   389
  class Database private[SQLite](name: String, val connection: Connection) extends SQL.Database
wenzelm@65006
   390
  {
wenzelm@65007
   391
    override def toString: String = name
wenzelm@65006
   392
wenzelm@65730
   393
    def sql_type(T: SQL.Type.Value): SQL.Source = SQL.sql_type_sqlite(T)
wenzelm@65011
   394
wenzelm@65748
   395
    def update_date(stmt: SQL.Statement, i: Int, date: Date): Unit =
wenzelm@65748
   396
      if (date == null) stmt.string(i) = (null: String)
wenzelm@65748
   397
      else stmt.string(i) = date_format(date)
wenzelm@65598
   398
wenzelm@65740
   399
    def date(res: SQL.Result, column: SQL.Column): Date =
wenzelm@65740
   400
      date_format.parse(res.string(column))
wenzelm@65021
   401
wenzelm@65730
   402
    def insert_permissive(table: SQL.Table, sql: SQL.Source = ""): SQL.Source =
wenzelm@65703
   403
      table.insert_cmd("INSERT OR IGNORE", sql = sql)
wenzelm@65703
   404
wenzelm@65698
   405
    def rebuild { using_statement("VACUUM")(_.execute()) }
wenzelm@65006
   406
  }
wenzelm@65006
   407
}
wenzelm@65006
   408
wenzelm@65006
   409
wenzelm@65006
   410
wenzelm@65006
   411
/** PostgreSQL **/
wenzelm@65006
   412
wenzelm@65006
   413
object PostgreSQL
wenzelm@65006
   414
{
wenzelm@65006
   415
  val default_port = 5432
wenzelm@65006
   416
wenzelm@65292
   417
  lazy val init_jdbc: Unit = Class.forName("org.postgresql.Driver")
wenzelm@65292
   418
wenzelm@65006
   419
  def open_database(
wenzelm@65006
   420
    user: String,
wenzelm@65006
   421
    password: String,
wenzelm@65006
   422
    database: String = "",
wenzelm@65006
   423
    host: String = "",
wenzelm@65594
   424
    port: Int = 0,
wenzelm@65636
   425
    ssh: Option[SSH.Session] = None,
wenzelm@65636
   426
    ssh_close: Boolean = false): Database =
wenzelm@65006
   427
  {
wenzelm@65292
   428
    init_jdbc
wenzelm@65292
   429
wenzelm@65641
   430
    if (user == "") error("Undefined database user")
wenzelm@65009
   431
wenzelm@65717
   432
    val db_host = proper_string(host) getOrElse "localhost"
wenzelm@65594
   433
    val db_port = if (port > 0 && port != default_port) ":" + port else ""
wenzelm@65717
   434
    val db_name = "/" + (proper_string(database) getOrElse user)
wenzelm@65009
   435
wenzelm@65010
   436
    val (url, name, port_forwarding) =
wenzelm@65009
   437
      ssh match {
wenzelm@65010
   438
        case None =>
wenzelm@65010
   439
          val spec = db_host + db_port + db_name
wenzelm@65010
   440
          val url = "jdbc:postgresql://" + spec
wenzelm@65010
   441
          val name = user + "@" + spec
wenzelm@65010
   442
          (url, name, None)
wenzelm@65009
   443
        case Some(ssh) =>
wenzelm@65594
   444
          val fw =
wenzelm@65594
   445
            ssh.port_forwarding(remote_host = db_host,
wenzelm@65636
   446
              remote_port = if (port > 0) port else default_port,
wenzelm@65636
   447
              ssh_close = ssh_close)
wenzelm@65010
   448
          val url = "jdbc:postgresql://localhost:" + fw.local_port + db_name
wenzelm@65010
   449
          val name = user + "@" + fw + db_name + " via ssh " + ssh
wenzelm@65010
   450
          (url, name, Some(fw))
wenzelm@65009
   451
      }
wenzelm@65009
   452
    try {
wenzelm@65010
   453
      val connection = DriverManager.getConnection(url, user, password)
wenzelm@65010
   454
      new Database(name, connection, port_forwarding)
wenzelm@65009
   455
    }
wenzelm@65009
   456
    catch { case exn: Throwable => port_forwarding.foreach(_.close); throw exn }
wenzelm@65006
   457
  }
wenzelm@65006
   458
wenzelm@65009
   459
  class Database private[PostgreSQL](
wenzelm@65009
   460
      name: String, val connection: Connection, port_forwarding: Option[SSH.Port_Forwarding])
wenzelm@65009
   461
    extends SQL.Database
wenzelm@65006
   462
  {
wenzelm@65010
   463
    override def toString: String = name
wenzelm@65008
   464
wenzelm@65730
   465
    def sql_type(T: SQL.Type.Value): SQL.Source = SQL.sql_type_postgresql(T)
wenzelm@65009
   466
wenzelm@65021
   467
    // see https://jdbc.postgresql.org/documentation/head/8-date-time.html
wenzelm@65748
   468
    def update_date(stmt: SQL.Statement, i: Int, date: Date): Unit =
wenzelm@65740
   469
      if (date == null) stmt.rep.setObject(i, null)
wenzelm@65740
   470
      else stmt.rep.setObject(i, OffsetDateTime.from(date.to_utc.rep))
wenzelm@65598
   471
wenzelm@65740
   472
    def date(res: SQL.Result, column: SQL.Column): Date =
wenzelm@65704
   473
    {
wenzelm@65740
   474
      val obj = res.rep.getObject(column.name, classOf[OffsetDateTime])
wenzelm@65704
   475
      if (obj == null) null else Date.instant(obj.toInstant)
wenzelm@65704
   476
    }
wenzelm@65021
   477
wenzelm@65730
   478
    def insert_permissive(table: SQL.Table, sql: SQL.Source = ""): SQL.Source =
wenzelm@65703
   479
      table.insert_cmd("INSERT",
wenzelm@65703
   480
        sql = sql + (if (sql == "") "" else " ") + "ON CONFLICT DO NOTHING")
wenzelm@65703
   481
wenzelm@65009
   482
    override def close() { super.close; port_forwarding.foreach(_.close) }
wenzelm@65006
   483
  }
wenzelm@65006
   484
}