DBSession

Type Members

type Closable = AnyRef { def close(): Unit }

Definition Classes
LoanPattern

Abstract Value Members

abstract val isReadOnly: Boolean

is read-only session
abstract def settings: SettingsProvider

Attributes
protected[scalikejdbc]

Concrete Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

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

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def batch[C[_]](template: String, paramsList: Seq[Any]*)(implicit cbf: CanBuildFrom[Nothing, Int, C[Int]]): C[Int]

Executes java.sql.PreparedStatement#executeBatch().
Executes java.sql.PreparedStatement#executeBatch().
template
SQL template
paramsList
list of parameters
returns
count list
def batchAndReturnGeneratedKey[C[_]](template: String, paramsList: Seq[Any]*)(implicit cbf: CanBuildFrom[Nothing, Long, C[Long]]): C[Long]

Executes java.sql.PreparedStatement#executeBatch() and returns numeric generated keys.
Executes java.sql.PreparedStatement#executeBatch() and returns numeric generated keys.
template
SQL template
paramsList
list of parameters
returns
generated keys
def batchAndReturnSpecifiedGeneratedKey[C[_]](template: String, key: String, paramsList: Seq[Any]*)(implicit cbf: CanBuildFrom[Nothing, Long, C[Long]]): C[Long]

Executes java.sql.PreparedStatement#executeBatch() and returns numeric generated keys.
Executes java.sql.PreparedStatement#executeBatch() and returns numeric generated keys.
template
SQL template
key
generated key name
paramsList
list of parameters
returns
generated keys
def clone(): AnyRef

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

Close the connection.
def collection[A, C[_]](template: String, params: Any*)(extract: (WrappedResultSet) ⇒ A)(implicit cbf: CanBuildFrom[Nothing, A, C[A]]): C[A]

Returns query result as any Collection object.
Returns query result as any Collection object.
A
return type
C
return collection type
template
SQL template
params
parameters
extract
extract function
returns
result as C[A]
lazy val connection: Connection

Connection
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def execute(template: String, params: Any*): Boolean

Executes java.sql.PreparedStatement#execute().
Executes java.sql.PreparedStatement#execute().
template
SQL template
params
parameters
returns
flag
def executeUpdate(template: String, params: Any*): Int

Executes java.sql.PreparedStatement#executeUpdate().
Executes java.sql.PreparedStatement#executeUpdate().
template
SQL template
params
parameters
returns
result count
def executeWithFilters(before: (PreparedStatement) ⇒ Unit, after: (PreparedStatement) ⇒ Unit, template: String, params: Any*): Boolean

Executes java.sql.PreparedStatement#execute().
Executes java.sql.PreparedStatement#execute().
before
before filter
after
after filter
template
SQL template
params
parameters
returns
flag
def fetchSize: Option[Int]

Returns fetchSize for this session.
Returns fetchSize for this session.
returns
fetch size
def fetchSize(fetchSize: Option[Int]): DBSession.this.type
def fetchSize(fetchSize: Int): DBSession.this.type

Set fetchSize for this session.
Set fetchSize for this session.
fetchSize
fetch size
returns
this
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def first[A](template: String, params: Any*)(extract: (WrappedResultSet) ⇒ A): Option[A]

Returns the first row optionally.
Returns the first row optionally.
A
return type
template
SQL template
params
parameters
extract
extract function
returns
result optionally
def foldLeft[A](template: String, params: Any*)(z: A)(op: (A, WrappedResultSet) ⇒ A): A

folding into one value.
folding into one value.
template
SQL template
params
parameters
z
initial value
op
function
returns
folded value
def foreach(template: String, params: Any*)(f: (WrappedResultSet) ⇒ Unit): Unit

Applies side-effect to each row iteratively.
Applies side-effect to each row iteratively.
template
SQL template
params
parameters
f
function
returns
result as list
def futureUsing[R <: Closable, A](resource: R)(f: (R) ⇒ Future[A])(implicit ec: ExecutionContext): Future[A]

Guarantees a Closeable resource will be closed after being passed to a block that takes the resource as a parameter and returns a Future.
Guarantees a Closeable resource will be closed after being passed to a block that takes the resource as a parameter and returns a Future.

Definition Classes
LoanPattern
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def list[A](template: String, params: Any*)(extract: (WrappedResultSet) ⇒ A): List[A]

Returns query result as scala.List object.
Returns query result as scala.List object.
A
return type
template
SQL template
params
parameters
extract
extract function
returns
result as list
val log: Log

Logger
Logger

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

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def queryTimeout: Option[Int]

Returns queryTimeout for this session.
Returns queryTimeout for this session.
returns
query timeout seconds
def queryTimeout(seconds: Option[Int]): DBSession.this.type
def queryTimeout(seconds: Int): DBSession.this.type

Set queryTimeout to this session.
Set queryTimeout to this session.
seconds
query timeout seconds
returns
this
def single[A](template: String, params: Any*)(extract: (WrappedResultSet) ⇒ A): Option[A]

Returns single result optionally.
Returns single result optionally. If the result is not single, scalikejdbc.TooManyRowsException will be thrown.
A
return type
template
SQL template
params
parameters
extract
extract function
returns
result optionally
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def tags: Seq[String]

Returns tags for this session.
Returns tags for this session.
returns
tags
def tags(tags: String*): DBSession.this.type

Set tags to this session.
Set tags to this session.
tags
tags
returns
this
def toBatchStatementExecutor(template: String): StatementExecutor
def toStatementExecutor(template: String, params: Seq[Any], returnGeneratedKeys: Boolean = false): StatementExecutor
def toString(): String

Definition Classes
AnyRef → Any
def traversable[A](template: String, params: Any*)(extract: (WrappedResultSet) ⇒ A): Traversable[A]

Returns query result as scala.collection.Traversable object.
Returns query result as scala.collection.Traversable object.
A
return type
template
SQL template
params
parameters
extract
extract function
returns
result as traversable
def tx: Option[Tx]

Returns current transaction if exists.
def unexpectedInvocation[A]: A

Attributes
protected
def update(template: String, params: Any*): Int

Executes java.sql.PreparedStatement#executeUpdate().
Executes java.sql.PreparedStatement#executeUpdate().
template
SQL template
params
parameters
returns
result count
def updateAndReturnGeneratedKey(template: String, params: Any*): Long

Executes java.sql.PreparedStatement#executeUpdate() and returns the generated key.
Executes java.sql.PreparedStatement#executeUpdate() and returns the generated key.
template
SQL template
params
parameters
returns
generated key as a long value
def updateAndReturnSpecifiedGeneratedKey(template: String, params: Any*)(key: Any): Long

Executes java.sql.PreparedStatement#executeUpdate() and returns the generated key.
Executes java.sql.PreparedStatement#executeUpdate() and returns the generated key.
template
SQL template
params
parameters
key
name
returns
generated key as a long value
def updateWithAutoGeneratedKeyNameAndFilters(returnGeneratedKeys: Boolean, generatedKeyName: String, before: (PreparedStatement) ⇒ Unit, after: (PreparedStatement) ⇒ Unit, template: String, params: Any*): Int

Executes java.sql.PreparedStatement#executeUpdate().
Executes java.sql.PreparedStatement#executeUpdate().
returnGeneratedKeys
is generated keys required
generatedKeyName
generated key name
before
before filter
after
after filter
template
SQL template
params
parameters
returns
result count
def updateWithFilters(returnGeneratedKeys: Boolean, before: (PreparedStatement) ⇒ Unit, after: (PreparedStatement) ⇒ Unit, template: String, params: Any*): Int

Executes java.sql.PreparedStatement#executeUpdate().
Executes java.sql.PreparedStatement#executeUpdate().
returnGeneratedKeys
is generated keys required
before
before filter
after
after filter
template
SQL template
params
parameters
returns
result count
def updateWithFilters(before: (PreparedStatement) ⇒ Unit, after: (PreparedStatement) ⇒ Unit, template: String, params: Any*): Int

Executes java.sql.PreparedStatement#executeUpdate().
Executes java.sql.PreparedStatement#executeUpdate().
before
before filter
after
after filter
template
SQL template
params
parameters
returns
result count
def using[R <: Closable, A](resource: R)(f: (R) ⇒ A): A

Definition Classes
DBSession → LoanPattern
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: object DBSession | package scalikejdbc

trait DBSession extends LogSupport with LoanPattern

Type Members

type Closable = AnyRef { def close(): Unit }

Abstract Value Members

abstract val isReadOnly: Boolean

abstract def settings: SettingsProvider

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def batch[C[_]](template: String, paramsList: Seq[Any]*)(implicit cbf: CanBuildFrom[Nothing, Int, C[Int]]): C[Int]

def batchAndReturnGeneratedKey[C[_]](template: String, paramsList: Seq[Any]*)(implicit cbf: CanBuildFrom[Nothing, Long, C[Long]]): C[Long]

def batchAndReturnSpecifiedGeneratedKey[C[_]](template: String, key: String, paramsList: Seq[Any]*)(implicit cbf: CanBuildFrom[Nothing, Long, C[Long]]): C[Long]

def clone(): AnyRef

def close(): Unit

def collection[A, C[_]](template: String, params: Any*)(extract: (WrappedResultSet) ⇒ A)(implicit cbf: CanBuildFrom[Nothing, A, C[A]]): C[A]

lazy val connection: Connection

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def execute(template: String, params: Any*): Boolean

def executeUpdate(template: String, params: Any*): Int

def executeWithFilters(before: (PreparedStatement) ⇒ Unit, after: (PreparedStatement) ⇒ Unit, template: String, params: Any*): Boolean

def fetchSize: Option[Int]

def fetchSize(fetchSize: Option[Int]): DBSession.this.type

def fetchSize(fetchSize: Int): DBSession.this.type

def finalize(): Unit

def first[A](template: String, params: Any*)(extract: (WrappedResultSet) ⇒ A): Option[A]

def foldLeft[A](template: String, params: Any*)(z: A)(op: (A, WrappedResultSet) ⇒ A): A

def foreach(template: String, params: Any*)(f: (WrappedResultSet) ⇒ Unit): Unit

def futureUsing[R <: Closable, A](resource: R)(f: (R) ⇒ Future[A])(implicit ec: ExecutionContext): Future[A]

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

def list[A](template: String, params: Any*)(extract: (WrappedResultSet) ⇒ A): List[A]

val log: Log

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def queryTimeout: Option[Int]

def queryTimeout(seconds: Option[Int]): DBSession.this.type

def queryTimeout(seconds: Int): DBSession.this.type

def single[A](template: String, params: Any*)(extract: (WrappedResultSet) ⇒ A): Option[A]

final def synchronized[T0](arg0: ⇒ T0): T0

def tags: Seq[String]

def tags(tags: String*): DBSession.this.type

def toBatchStatementExecutor(template: String): StatementExecutor

def toStatementExecutor(template: String, params: Seq[Any], returnGeneratedKeys: Boolean = false): StatementExecutor

def toString(): String

def traversable[A](template: String, params: Any*)(extract: (WrappedResultSet) ⇒ A): Traversable[A]

def tx: Option[Tx]

def unexpectedInvocation[A]: A

def update(template: String, params: Any*): Int

def updateAndReturnGeneratedKey(template: String, params: Any*): Long

def updateAndReturnSpecifiedGeneratedKey(template: String, params: Any*)(key: Any): Long

def updateWithAutoGeneratedKeyNameAndFilters(returnGeneratedKeys: Boolean, generatedKeyName: String, before: (PreparedStatement) ⇒ Unit, after: (PreparedStatement) ⇒ Unit, template: String, params: Any*): Int

def updateWithFilters(returnGeneratedKeys: Boolean, before: (PreparedStatement) ⇒ Unit, after: (PreparedStatement) ⇒ Unit, template: String, params: Any*): Int

def updateWithFilters(before: (PreparedStatement) ⇒ Unit, after: (PreparedStatement) ⇒ Unit, template: String, params: Any*): Int

def using[R <: Closable, A](resource: R)(f: (R) ⇒ A): A

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from LoanPattern

Inherited from LogSupport

Inherited from AnyRef

Inherited from Any

Ungrouped