ldbc.schema.Default.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ldbc-schema_3 Show documentation
Type safety schema construction project
The newest version!
/**
 * Copyright (c) 2023-2024 by Takahiko Tominaga
 * This software is licensed under the MIT License (MIT).
 * For more information see LICENSE or https://opensource.org/licenses/MIT
 */

package ldbc.schema

/**
 * Trait for setting SQL Default values
 */
trait Default:

  /** Value set as the default value for DataType */
  def value: String

  /**
   * Define SQL query string for each DataType.
   *
   * @return
   *   SQL query string
   */
  def queryString: String

  override def toString: String = queryString

object Default:

  /**
   * Object for setting NULL as the Default value when the SQL DataType is NULL-allowed.
   */
  object Null extends Default:

    override def value: String = "NULL"

    override def queryString: String = s"DEFAULT $value"

  /**
   * Model to be used when a value matching the DataType type is set.
   *
   * @param _value
   *   Value set as the default value for DataType
   * @tparam T
   *   Scala types that match SQL DataType
   */
  case class Value[T](_value: T) extends Default:

    override def value: String = _value.toString

    override def queryString: String = _value match
      case _: Boolean => s"DEFAULT $value"
      case _: Short   => s"DEFAULT $value"
      case _: Int     => s"DEFAULT $value"
      case _: Long    => s"DEFAULT $value"
      case _: Double  => s"DEFAULT $value"
      case _: Float   => s"DEFAULT $value"
      case _          => s"DEFAULT '$value'"

  /**
   * Model for setting TimeStamp-specific Default values.
   *
   * @param fsp
   *   Decimal second precision value
   * @param withOn
   *   Value to determine whether to set additional information
   */
  case class TimeStamp(fsp: Option[0 | 1 | 2 | 3 | 4 | 5 | 6], withOn: Boolean) extends Default:

    override def value: String = fsp.fold("CURRENT_TIMESTAMP")(v => s"CURRENT_TIMESTAMP($v)")

    override def queryString: String =
      if withOn then s"DEFAULT $value ON UPDATE CURRENT_TIMESTAMP" ++ fsp.fold("")(v => s"($v)")
      else s"DEFAULT $value"

  /**
   * Model for setting Date-specific Default values.
   */
  case class Date() extends Default:
    override def value: String = "CURRENT_DATE"

    override def queryString: String = s"DEFAULT ($value)"