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