anorm
package anorm
Anorm API
Use the SQL method to start an SQL query
import anorm._ SQL("Select 1")
- Source
- package.scala
- Alphabetic
- By Inheritance
- anorm
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
-
final
case class
AnormException(message: String) extends Exception with NoStackTrace with Product with Serializable
Anorm runtime exception
-
sealed
trait
BatchSql extends AnyRef
SQL batch
-
trait
Column[A] extends (Any, MetaDataItem) ⇒ MayErr[SqlRequestError, A]
Column mapping
Column mapping
- Annotations
- @implicitNotFound( ... )
-
trait
ColumnAliaser extends Function[(Int, ColumnName), Option[String]]
Allows to define or overwrite the alias for a column.
-
case class
ColumnName(qualified: String, alias: Option[String]) extends Product with Serializable
- qualified
the qualified column name
- alias
the column alias
-
case class
ColumnNotFound(column: String, possibilities: List[String]) extends SqlRequestError with Product with Serializable
Error raised when the specified
column
cannot be found in results.Error raised when the specified
column
cannot be found in results.- column
the name of the not found column
- possibilities
the names of the available columns
-
sealed
trait
Cursor extends AnyRef
Result cursor
- final class DefaultParameterValue[A] extends ParameterValue with Wrapper[A]
-
case class
Error(msg: SqlRequestError) extends SqlResult[Nothing] with Product with Serializable
Erroneous result (failure while parsing).
- sealed trait JavaTimeColumn extends AnyRef
- sealed trait JavaTimeParameterMetaData extends AnyRef
- sealed trait JavaTimeToStatement extends AnyRef
- sealed trait JodaColumn extends AnyRef
- sealed trait JodaToStatement extends AnyRef
-
case class
MetaDataItem(column: ColumnName, nullable: Boolean, clazz: String) extends Product with Serializable
- column
the name of the column
- nullable
true if the column is nullable
- clazz
the class of the JDBC column value
-
sealed
case class
NamedParameter(name: String, value: ParameterValue) extends Product with Serializable
Applied named parameter.
-
trait
NotNullGuard extends AnyRef
Marker trait to indicate that even if a type T accept null as value, it must be refused in some Anorm context.
-
case class
Object(value: Any) extends Product with Serializable
Untyped value wrapper.
Untyped value wrapper.
SQL("UPDATE t SET val = {o}").on('o -> anorm.Object(val))
-
trait
ParameterMetaData[T] extends AnyRef
Parameter meta data for type
T
Parameter meta data for type
T
- Annotations
- @implicitNotFound( ... )
-
sealed
trait
ParameterValue extends Show
Prepared parameter value.
Prepared parameter value.
- Annotations
- @implicitNotFound( ... )
-
sealed
trait
ResultSetParser[+A] extends (Option[Cursor]) ⇒ SqlResult[A]
Parses result from the cursor.
- trait Row extends AnyRef
- trait RowParser[+A] extends (Row) ⇒ SqlResult[A]
-
sealed
trait
ScalarRowParser[+A] extends RowParser[A]
Parser for scalar row (row of one single column).
-
sealed
trait
SeqParameter[A] extends AnyRef
Wrapper to use Seq as SQL parameter, with custom formatting.
Wrapper to use Seq as SQL parameter, with custom formatting.
SQL("SELECT * FROM t WHERE %s"). on(SeqParameter(Seq("a", "b"), " OR ", Some("cat = "))) // Will execute as: // SELECT * FROM t WHERE cat = 'a' OR cat = 'b'
-
trait
Show extends AnyRef
Typeclass for string representation
-
case class
SimpleSql[T](sql: SqlQuery, params: Map[String, ParameterValue], defaultParser: RowParser[T], resultSetOnFirstRow: Boolean = false) extends Sql with Product with Serializable
Simple/plain SQL.
- case class SqlMappingError(reason: String) extends SqlRequestError with Product with Serializable
-
sealed
trait
SqlQuery extends AnyRef
Initial SQL query, without parameter values.
-
final
case class
SqlQueryResult(resultSet: ManagedResource[ResultSet], resultSetOnFirstRow: Boolean = false) extends WithResult with Product with Serializable
A result from execution of an SQL query, row data and context (e.g.
A result from execution of an SQL query, row data and context (e.g. statement warnings).
- resultSet
Result set from executed query
-
sealed
trait
SqlRequestError extends AnyRef
Error from processing SQL
-
sealed
trait
SqlResult[+A] extends AnyRef
Parsed SQL result.
-
implicit final
class
SqlStringInterpolation extends AnyVal
Creates an SQL query using String Interpolation feature.
Creates an SQL query using String Interpolation feature. It is a 1-step alternative for SQL("...").on(...) functions.
SQL""" UPDATE computer SET name = \${computer.name}, introduced = \${computer.introduced}, discontinued = \${computer.discontinued}, company_id = \${computer.companyId} WHERE id = \$id """.executeUpdate()
- final class StringShow extends Show
-
type
StringWrapper2 = AnyRef { def stringValue: String }
Structural type for oracle.sql.ROWID wrapper.
-
case class
Success[A](a: A) extends SqlResult[A] with Product with Serializable
Successfully parsed result.
-
type
TimestampWrapper1 = AnyRef { def getTimestamp: java.sql.Timestamp }
Structural type for timestamp wrapper.
-
type
TimestampWrapper2 = AnyRef { def timestampValue: java.sql.Timestamp }
Structural type for oracle.sql.TIMESTAMP wrapper.
-
trait
ToSql[A] extends AnyRef
Set value as prepared SQL statement fragment.
Set value as prepared SQL statement fragment.
- Annotations
- @implicitNotFound( ... )
-
trait
ToStatement[A] extends AnyRef
Sets value as statement parameter.
Sets value as statement parameter.
- Annotations
- @implicitNotFound( ... )
- sealed trait ToStatementPriority0 extends AnyRef
- sealed trait ToStatementPriority1 extends ToStatementPriority0
- sealed case class TupleFlattener[F](f: F) extends Product with Serializable
-
sealed
trait
TupleFlattenerPriority1 extends AnyRef
Conversion from 2-column tuple-like to scala.Tuple2, with resolution priority 1.
-
sealed
trait
TupleFlattenerPriority10 extends TupleFlattenerPriority9
Conversion from 11-column tuple-like to scala.Tuple11, with resolution priority 10.
-
sealed
trait
TupleFlattenerPriority11 extends TupleFlattenerPriority10
Conversion from 12-column tuple-like to scala.Tuple12, with resolution priority 11.
-
sealed
trait
TupleFlattenerPriority12 extends TupleFlattenerPriority11
Conversion from 13-column tuple-like to scala.Tuple13, with resolution priority 12.
-
sealed
trait
TupleFlattenerPriority13 extends TupleFlattenerPriority12
Conversion from 14-column tuple-like to scala.Tuple14, with resolution priority 13.
-
sealed
trait
TupleFlattenerPriority14 extends TupleFlattenerPriority13
Conversion from 15-column tuple-like to scala.Tuple15, with resolution priority 14.
-
sealed
trait
TupleFlattenerPriority15 extends TupleFlattenerPriority14
Conversion from 16-column tuple-like to scala.Tuple16, with resolution priority 15.
-
sealed
trait
TupleFlattenerPriority16 extends TupleFlattenerPriority15
Conversion from 17-column tuple-like to scala.Tuple17, with resolution priority 16.
-
sealed
trait
TupleFlattenerPriority17 extends TupleFlattenerPriority16
Conversion from 18-column tuple-like to scala.Tuple18, with resolution priority 17.
-
sealed
trait
TupleFlattenerPriority18 extends TupleFlattenerPriority17
Conversion from 19-column tuple-like to scala.Tuple19, with resolution priority 18.
-
sealed
trait
TupleFlattenerPriority19 extends TupleFlattenerPriority18
Conversion from 20-column tuple-like to scala.Tuple20, with resolution priority 19.
-
sealed
trait
TupleFlattenerPriority2 extends TupleFlattenerPriority1
Conversion from 3-column tuple-like to scala.Tuple3, with resolution priority 2.
-
sealed
trait
TupleFlattenerPriority20 extends TupleFlattenerPriority19
Conversion from 21-column tuple-like to scala.Tuple21, with resolution priority 20.
-
sealed
trait
TupleFlattenerPriority21 extends TupleFlattenerPriority20
Conversion from 22-column tuple-like to scala.Tuple22, with resolution priority 21.
-
sealed
trait
TupleFlattenerPriority3 extends TupleFlattenerPriority2
Conversion from 4-column tuple-like to scala.Tuple4, with resolution priority 3.
-
sealed
trait
TupleFlattenerPriority4 extends TupleFlattenerPriority3
Conversion from 5-column tuple-like to scala.Tuple5, with resolution priority 4.
-
sealed
trait
TupleFlattenerPriority5 extends TupleFlattenerPriority4
Conversion from 6-column tuple-like to scala.Tuple6, with resolution priority 5.
-
sealed
trait
TupleFlattenerPriority6 extends TupleFlattenerPriority5
Conversion from 7-column tuple-like to scala.Tuple7, with resolution priority 6.
-
sealed
trait
TupleFlattenerPriority7 extends TupleFlattenerPriority6
Conversion from 8-column tuple-like to scala.Tuple8, with resolution priority 7.
-
sealed
trait
TupleFlattenerPriority8 extends TupleFlattenerPriority7
Conversion from 9-column tuple-like to scala.Tuple9, with resolution priority 8.
-
sealed
trait
TupleFlattenerPriority9 extends TupleFlattenerPriority8
Conversion from 10-column tuple-like to scala.Tuple10, with resolution priority 9.
- case class TypeDoesNotMatch(reason: String) extends SqlRequestError with Product with Serializable
- case class UnexpectedNullableFound(reason: String) extends SqlRequestError with Product with Serializable
-
final
case class
~[+A, +B](_1: A, _2: B) extends Product with Serializable
Columns tuple-like
Value Members
-
def
SQL(stmt: String): SqlQuery
Creates an SQL query with given statement.
Creates an SQL query with given statement.
- stmt
SQL statement
val query = SQL("SELECT * FROM Country")
- implicit def sqlToSimple(sql: SqlQuery): SimpleSql[Row]
-
object
BatchSql
SQL batch companion
-
object
Column extends JodaColumn with JavaTimeColumn
Column companion, providing default conversions.
- object ColumnAliaser
- object ColumnNotFound extends Serializable
-
object
Cursor
Cursor companion
-
object
JodaParameterMetaData
Meta data for Joda parameters
- object Macro
-
object
NamedParameter extends Serializable
Companion object for applied named parameter.
-
object
ParameterMetaData extends JavaTimeParameterMetaData
ParameterMetaData companion, providing defaults based on SQL92.
-
object
ParameterValue
Value factory for parameter.
Value factory for parameter.
val param = ParameterValue("str", null, setter) SQL("...").onParams(param)
- object ResultSetResource extends Resource[ResultSet]
-
object
Row
Companion object for row.
- object RowParser
-
object
SeqParameter
SeqParameter factory
- object Show
- object SimpleSql extends Serializable
- object Sql
- object SqlParser extends FunctionAdapter
- object SqlQuery
-
object
SqlStatementParser extends JavaTokenParsers
Parser for SQL statement.
- object StatementResource extends Resource[PreparedStatement]
- object StringWrapper2
- object TimestampWrapper1
- object TimestampWrapper2
-
object
ToSql
Provided ToSql implementations.
-
object
ToStatement extends ToStatementPriority1 with JodaToStatement with JavaTimeToStatement
Provided conversions to set statement parameter.
- object TokenGroup extends AbstractFunction2[List[StatementToken], Option[String], TokenGroup] with Serializable
-
object
TupleFlattener extends TupleFlattenerPriority21 with Serializable
Conversions to flatten columns to tuple.
-
object
features
Activable features