scalikejdbc

DB

case class DB (conn: Connection) extends DBConnection with Product with Serializable

Basic Database Accessor

Using DBSession:

  import scalikejdbc._
  case class User(id: Int, name: String)

  using(connectionPool(context).borrow()) { conn =>

    val users = DB(conn) readOnly { session =>
      session.list("select * from user") { rs =>
        User(rs.int("id"), rs.string("name"))
      }
    }

    DB(conn) autoCommit { session =>
      session.update("insert into user values (?,?)", 123, "Alice")
    }

    DB(conn) localTx { session =>
      session.update("insert into user values (?,?)", 123, "Alice")
    }

  }

Using SQL:

  import scalikejdbc._
  case class User(id: Int, name: String)

  using(ConnectionPool.borrow()) { conn =>

    val users = DB(conn) readOnly { session =>
      SQL("select * from user").map { rs =>
        User(rs.int("id"), rs.string("name"))
      }.list.apply()
    }

    DB(conn) autoCommit { session =>
      SQL("insert into user values (?,?)").bind(123, "Alice").update.apply()
    }

    DB(conn) localTx { session =>
      SQL("insert into user values (?,?)").bind(123, "Alice").update.apply()
    }

  }
Linear Supertypes
Serializable, Serializable, Product, Equals, DBConnection, LogSupport, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. DB
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. DBConnection
  7. LogSupport
  8. AnyRef
  9. Any
Visibility
  1. Public
  2. All

Instance Constructors

  1. new DB (conn: Connection)

Type Members

  1. type RSTraversable = ResultSetTraversable

    Definition Classes
    DBConnection

Value Members

  1. def != (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  2. def != (arg0: Any): Boolean

    Attributes
    final
    Definition Classes
    Any
  3. def ## (): Int

    Attributes
    final
    Definition Classes
    AnyRef → Any
  4. def == (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  5. def == (arg0: Any): Boolean

    Attributes
    final
    Definition Classes
    Any
  6. def asInstanceOf [T0] : T0

    Attributes
    final
    Definition Classes
    Any
  7. def autoCommit [A] (execution: (DBSession) ⇒ A): A

    Provides auto-commit session block.

    Provides auto-commit session block.

    A

    return type

    execution

    block

    returns

    result value

    Definition Classes
    DBConnection
  8. def autoCommitSession (): DBSession

    Returns auto-commit session.

    Returns auto-commit session.

    returns

    session

    Definition Classes
    DBConnection
  9. def autoCommitWithConnection [A] (execution: (Connection) ⇒ A): A

    Provides auto-commit session block.

    Provides auto-commit session block.

    A

    return type

    execution

    block

    returns

    result value

    Definition Classes
    DBConnection
  10. def begin (): Unit

    Begins a new transaction.

    Begins a new transaction.

    Definition Classes
    DBConnection
  11. def beginIfNotYet (): Unit

    Begins a new transaction if the other one does not already start.

    Begins a new transaction if the other one does not already start.

    Definition Classes
    DBConnection
  12. def canEqual (arg0: Any): Boolean

    Definition Classes
    DB → Equals
  13. def clone (): AnyRef

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  14. def close (): Unit

    Close the connection.

    Close the connection.

    Definition Classes
    DBConnection
  15. def commit (): Unit

    Commits the current transaction.

    Commits the current transaction.

    Definition Classes
    DBConnection
  16. val conn : Connection

    Definition Classes
    DBDBConnection
  17. def currentTx : Tx

    Returns the current transaction.

    Returns the current transaction. If the transaction has not started yet, IllegalStateException will be thrown.

    returns

    tx

    Definition Classes
    DBConnection
  18. def describe (table: String): String

    Returns describe style string value for the table

    Returns describe style string value for the table

    table

    table name (with schema optionally)

    returns

    described information

    Definition Classes
    DBConnection
  19. def eq (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  20. def equals (arg0: Any): Boolean

    Definition Classes
    DB → Equals → AnyRef → Any
  21. def finalize (): Unit

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  22. def getClass (): java.lang.Class[_]

    Attributes
    final
    Definition Classes
    AnyRef → Any
  23. def getColumnNames (tableName: String, tableTypes: Array[String] = Array("TABLE", "VIEW")): List[String]

    Returns all the column names on the matched table name

    Returns all the column names on the matched table name

    Definition Classes
    DBConnection
  24. def getTable (table: String): Option[Table]

    Returns table information if exists

    Returns table information if exists

    table

    table name (with schema optionally)

    returns

    table information

    Definition Classes
    DBConnection
  25. def getTableNames (tableNamePattern: String = "%", tableTypes: Array[String] = Array("TABLE", "VIEW")): List[String]

    Returns all the table information that match the pattern

    Returns all the table information that match the pattern

    tableNamePattern

    table name pattern (with schema optionally)

    returns

    table information

    Definition Classes
    DBConnection
  26. def hashCode (): Int

    Definition Classes
    DB → AnyRef → Any
  27. def isInstanceOf [T0] : Boolean

    Attributes
    final
    Definition Classes
    Any
  28. def isTxAlreadyStarted : Boolean

    Returns is the current transaction already started.

    Returns is the current transaction already started.

    returns

    result

    Definition Classes
    DBConnection
  29. def isTxNotActive : Boolean

    Returns is the current transaction is active.

    Returns is the current transaction is active.

    returns

    result

    Definition Classes
    DBConnection
  30. def isTxNotYetStarted : Boolean

    Returns is the current transaction hasn't started yet.

    Returns is the current transaction hasn't started yet.

    returns

    result

    Definition Classes
    DBConnection
  31. def localTx [A] (execution: (DBSession) ⇒ A): A

    Provides local-tx session block.

    Provides local-tx session block.

    A

    return type

    execution

    block

    returns

    result value

    Definition Classes
    DBConnection
  32. def localTxWithConnection [A] (execution: (Connection) ⇒ A): A

    Provides local-tx session block.

    Provides local-tx session block.

    A

    return type

    execution

    block

    returns

    result value

    Definition Classes
    DBConnection
  33. val log : Log

    Logger

    Logger

    Attributes
    protected
    Definition Classes
    LogSupport
  34. def ne (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  35. def newTx : Tx

    Starts a new transaction and returns it.

    Starts a new transaction and returns it.

    returns

    tx

    Definition Classes
    DBConnection
  36. def notify (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
  37. def notifyAll (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
  38. def productArity : Int

    Definition Classes
    DB → Product
  39. def productElement (arg0: Int): Any

    Definition Classes
    DB → Product
  40. def productIterator : Iterator[Any]

    Definition Classes
    Product
  41. def productPrefix : String

    Definition Classes
    DB → Product
  42. def readOnly [A] (execution: (DBSession) ⇒ A): A

    Provides read-only session block.

    Provides read-only session block.

    A

    return type

    execution

    block

    returns

    result value

    Definition Classes
    DBConnection
  43. def readOnlySession (): DBSession

    Returns read-only session.

    Returns read-only session.

    returns

    session

    Definition Classes
    DBConnection
  44. def readOnlyWithConnection [A] (execution: (Connection) ⇒ A): A

    Provides read-only session block.

    Provides read-only session block.

    A

    return type

    execution

    block

    returns

    result value

    Definition Classes
    DBConnection
  45. def rollback (): Unit

    Rolls back the current transaction.

    Rolls back the current transaction.

    Definition Classes
    DBConnection
  46. def rollbackIfActive (): Unit

    Rolls back the current transaction if the transaction is still active.

    Rolls back the current transaction if the transaction is still active.

    Definition Classes
    DBConnection
  47. def showTables (tableNamePattern: String = "%", tableTypes: Array[String] = Array("TABLE", "VIEW")): String

    Returns table name list

    Returns table name list

    tableNamePattern

    table name pattern

    tableTypes

    table types

    returns

    table name list

    Definition Classes
    DBConnection
  48. def synchronized [T0] (arg0: ⇒ T0): T0

    Attributes
    final
    Definition Classes
    AnyRef
  49. def toString (): String

    Definition Classes
    DB → AnyRef → Any
  50. def tx : Tx

    Returns the current transaction.

    Returns the current transaction. If the transaction has not started yet, IllegalStateException will be thrown.

    returns

    tx

    Definition Classes
    DBConnection
  51. def wait (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()
  52. def wait (arg0: Long, arg1: Int): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()
  53. def wait (arg0: Long): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()
  54. def withinTx [A] (execution: (DBSession) ⇒ A): A

    Provides within-tx session block.

    Provides within-tx session block.

    A

    return type

    execution

    block

    returns

    result value

    Definition Classes
    DBConnection
  55. def withinTxSession (tx: Tx = currentTx): DBSession

    Returns within-tx session.

    Returns within-tx session.

    returns

    session

    Definition Classes
    DBConnection
  56. def withinTxWithConnection [A] (execution: (Connection) ⇒ A): A

    Provides within-tx session block.

    Provides within-tx session block.

    A

    return type

    execution

    block

    returns

    result value

    Definition Classes
    DBConnection

Deprecated Value Members

  1. def productElements : Iterator[Any]

    Definition Classes
    Product
    Annotations
    @deprecated
    Deprecated

    use productIterator instead

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from DBConnection

Inherited from LogSupport

Inherited from AnyRef

Inherited from Any