package anorm

Anorm API

Use the SQL method to start an SQL query

import anorm._

SQL("Select 1")
Linear Supertypes
AnyRef, Any
  1. Alphabetic
  2. By inheritance
  1. anorm
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
  1. Public
  2. All

Type Members

  1. sealed trait BatchSql extends AnyRef

    SQL batch

  2. trait Column[A] extends (Any, MetaDataItem) ⇒ MayErr[SqlRequestError, A]

    Column mapping

  3. case class ColumnName(qualified: String, alias: Option[String]) extends Product with Serializable

  4. case class ColumnNotFound(column: String, possibilities: List[String]) extends SqlRequestError with Product with Serializable

  5. sealed trait Cursor extends AnyRef

    Result cursor

  6. final class DefaultParameterValue[A] extends ParameterValue with Wrapper[A]

  7. case class Error(msg: SqlRequestError) extends SqlResult[Nothing] with Product with Serializable

    Erroneous result (failure while parsing).

  8. case class Id[ID](id: ID) extends Deprecated[ID] with Product with Serializable

  9. sealed trait JavaTimeColumn extends AnyRef

  10. sealed trait JavaTimeParameterMetaData extends AnyRef

  11. sealed trait JavaTimeToStatement extends AnyRef

  12. sealed trait JodaColumn extends AnyRef

  13. sealed trait JodaToStatement extends AnyRef

  14. case class MetaDataItem(column: ColumnName, nullable: Boolean, clazz: String) extends Product with Serializable

  15. sealed case class NamedParameter(name: String, value: ParameterValue) extends Product with Serializable

    Applied named parameter.

  16. 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.

  17. 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))
  18. trait ParameterMetaData[T] extends AnyRef

    Parameter meta data for type T

  19. sealed trait ParameterValue extends Show

    Prepared parameter value.

  20. sealed trait ResultSetParser[+A] extends (Option[Cursor]) ⇒ SqlResult[A]

    Parses result from the cursor.

  21. trait Row extends AnyRef

  22. trait RowParser[+A] extends (Row) ⇒ SqlResult[A]

  23. sealed trait ScalarRowParser[+A] extends RowParser[A]

    Parser for scalar row (row of one single column).

  24. 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'
  25. trait Show extends AnyRef

  26. 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.

  27. case class SqlMappingError(reason: String) extends SqlRequestError with Product with Serializable

  28. sealed trait SqlQuery extends AnyRef

    Initial SQL query, without parameter values.

  29. 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).


    Result set from executed query

  30. sealed trait SqlRequestError extends AnyRef

    Error from processing SQL

  31. sealed trait SqlResult[+A] extends AnyRef

    Parsed SQL result.

  32. 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.

      UPDATE computer SET name = \${},
      introduced = \${computer.introduced},
      discontinued = \${computer.discontinued},
      company_id = \${computer.companyId}
      WHERE id = \$id
  33. case class Success[A](a: A) extends SqlResult[A] with Product with Serializable

    Successfully parsed result.

  34. type TimestampWrapper1 = AnyRef { def getTimestamp: java.sql.Timestamp }

    Structural type for timestamp wrapper.

  35. trait ToSql[A] extends AnyRef

    Set value as prepared SQL statement fragment.

  36. trait ToStatement[A] extends AnyRef

    Sets value as statement parameter.

  37. sealed trait ToStatementPriority0 extends AnyRef

  38. sealed trait ToStatementPriority1 extends ToStatementPriority0

  39. sealed case class TupleFlattener[F](f: F) extends Product with Serializable

  40. sealed trait TupleFlattenerPriority1 extends AnyRef

    Conversion from 2-column tuple-like to scala.Tuple2, with resolution priority 1.

  41. sealed trait TupleFlattenerPriority10 extends TupleFlattenerPriority9

    Conversion from 11-column tuple-like to scala.Tuple11, with resolution priority 10.

  42. sealed trait TupleFlattenerPriority11 extends TupleFlattenerPriority10

    Conversion from 12-column tuple-like to scala.Tuple12, with resolution priority 11.

  43. sealed trait TupleFlattenerPriority12 extends TupleFlattenerPriority11

    Conversion from 13-column tuple-like to scala.Tuple13, with resolution priority 12.

  44. sealed trait TupleFlattenerPriority13 extends TupleFlattenerPriority12

    Conversion from 14-column tuple-like to scala.Tuple14, with resolution priority 13.

  45. sealed trait TupleFlattenerPriority14 extends TupleFlattenerPriority13

    Conversion from 15-column tuple-like to scala.Tuple15, with resolution priority 14.

  46. sealed trait TupleFlattenerPriority15 extends TupleFlattenerPriority14

    Conversion from 16-column tuple-like to scala.Tuple16, with resolution priority 15.

  47. sealed trait TupleFlattenerPriority16 extends TupleFlattenerPriority15

    Conversion from 17-column tuple-like to scala.Tuple17, with resolution priority 16.

  48. sealed trait TupleFlattenerPriority17 extends TupleFlattenerPriority16

    Conversion from 18-column tuple-like to scala.Tuple18, with resolution priority 17.

  49. sealed trait TupleFlattenerPriority18 extends TupleFlattenerPriority17

    Conversion from 19-column tuple-like to scala.Tuple19, with resolution priority 18.

  50. sealed trait TupleFlattenerPriority19 extends TupleFlattenerPriority18

    Conversion from 20-column tuple-like to scala.Tuple20, with resolution priority 19.

  51. sealed trait TupleFlattenerPriority2 extends TupleFlattenerPriority1

    Conversion from 3-column tuple-like to scala.Tuple3, with resolution priority 2.

  52. sealed trait TupleFlattenerPriority20 extends TupleFlattenerPriority19

    Conversion from 21-column tuple-like to scala.Tuple21, with resolution priority 20.

  53. sealed trait TupleFlattenerPriority21 extends TupleFlattenerPriority20

    Conversion from 22-column tuple-like to scala.Tuple22, with resolution priority 21.

  54. sealed trait TupleFlattenerPriority3 extends TupleFlattenerPriority2

    Conversion from 4-column tuple-like to scala.Tuple4, with resolution priority 3.

  55. sealed trait TupleFlattenerPriority4 extends TupleFlattenerPriority3

    Conversion from 5-column tuple-like to scala.Tuple5, with resolution priority 4.

  56. sealed trait TupleFlattenerPriority5 extends TupleFlattenerPriority4

    Conversion from 6-column tuple-like to scala.Tuple6, with resolution priority 5.

  57. sealed trait TupleFlattenerPriority6 extends TupleFlattenerPriority5

    Conversion from 7-column tuple-like to scala.Tuple7, with resolution priority 6.

  58. sealed trait TupleFlattenerPriority7 extends TupleFlattenerPriority6

    Conversion from 8-column tuple-like to scala.Tuple8, with resolution priority 7.

  59. sealed trait TupleFlattenerPriority8 extends TupleFlattenerPriority7

    Conversion from 9-column tuple-like to scala.Tuple9, with resolution priority 8.

  60. sealed trait TupleFlattenerPriority9 extends TupleFlattenerPriority8

    Conversion from 10-column tuple-like to scala.Tuple10, with resolution priority 9.

  61. case class TypeDoesNotMatch(reason: String) extends SqlRequestError with Product with Serializable

  62. case class UnexpectedNullableFound(message: String) extends SqlRequestError with Product with Serializable

  63. final case class ~[+A, +B](_1: A, _2: B) extends Product with Serializable

    Columns tuple-like

  64. case class MayErr[+E, +A](toEither: Either[E, A]) extends Product with Serializable


    (Since version 2.3.6) For internal use, will be made private

  65. trait Pk[+ID] extends NotNull


    (Since version 2.3.0) Do not use directly, but consider Id or NotAssigned.

Value Members

  1. object BatchSql

    SQL batch companion

  2. object Column extends JodaColumn with JavaTimeColumn

    Column companion, providing default conversions.

  3. object ColumnNotFound extends Serializable

  4. object Cursor

    Cursor companion

  5. object JodaParameterMetaData

    Meta data for Joda parameters

  6. object MayErr extends Serializable

  7. object NamedParameter extends Serializable

    Companion object for applied named parameter.

  8. object NotAssigned extends Deprecated[Nothing] with Product with Serializable

  9. object ParameterMetaData extends JavaTimeParameterMetaData

    ParameterMetaData companion, providing defaults based on SQL92.

  10. object ParameterValue

    Value factory for parameter.

    Value factory for parameter.

    val param = ParameterValue("str", null, setter)
  11. object ResultSetResource extends Resource[ResultSet]

  12. object Row

    Companion object for row.

  13. object RowParser

  14. def SQL(stmt: String): SqlQuery

    Creates an SQL query with given statement.

    Creates an SQL query with given statement.


    SQL statement

    val query = SQL("SELECT * FROM Country")
  15. object SeqParameter

    SeqParameter factory

  16. object Sql

  17. object SqlParser extends FunctionAdapter

  18. object SqlQuery

  19. object SqlStatementParser extends JavaTokenParsers

    Parser for SQL statement.

  20. object StatementResource extends Resource[PreparedStatement]

  21. object ToSql

    Provided ToSql implementations.

  22. object ToStatement extends ToStatementPriority1 with JodaToStatement with JavaTimeToStatement

    Provided conversions to set statement parameter.

  23. object TupleFlattener extends TupleFlattenerPriority21 with Serializable

    Conversions to flatten columns to tuple.

  24. object features

    Activable features

  25. implicit def implicitID[ID](id: Id[ID]): ID

  26. implicit def sqlToSimple(sql: SqlQuery): SimpleSql[Row]

Deprecated Value Members

  1. object Useful


    (Since version 2.3.3) Use directly Stream

Inherited from AnyRef

Inherited from Any