Trait

com.lucidchart.relate

Sql

Related Doc: package relate

Permalink

trait Sql extends AnyRef

Sql is a trait for basic SQL queries.

It provides methods for parameter insertion and query execution.

import com.lucidchart.relate._
import com.lucidchart.relate.Query._

case class User(id: Long, name: String)

SQL("""
  SELECT id, name
  FROM users
  WHERE id={id}
""").on { implicit query =>
  long("id", 1L)
}.asSingle(RowParser { row =>
  User(row.long("id"), row.string("name"))
})
Self Type
Sql
Linear Supertypes
AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Sql
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. class BaseStatement extends AnyRef

    Permalink
    Attributes
    protected[com.lucidchart.relate]

Abstract Value Members

  1. abstract def applyParams(stmt: PreparedStatement): Unit

    Permalink
    Attributes
    protected
  2. abstract val parsedQuery: String

    Permalink
    Attributes
    protected

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  4. def as[A]()(implicit arg0: RowParser[A], connection: Connection): A

    Permalink
  5. def asCollection[U, T[_]]()(implicit arg0: RowParser[U], cbf: CanBuildFrom[T[U], U, T[U]], connection: Connection): T[U]

    Permalink
  6. def asCollection[U, T[_]](parser: (SqlRow) ⇒ U)(implicit cbf: CanBuildFrom[T[U], U, T[U]], connection: Connection): T[U]

    Permalink

    Execute this query and get back the result as an arbitrary collection of records

    Execute this query and get back the result as an arbitrary collection of records

    parser

    the RowParser to use when parsing the result set

    connection

    the connection to use when executing the query

    returns

    the results as an arbitrary collection of records

  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  8. def asIterable[A]()(implicit arg0: RowParser[A], connection: Connection): Iterable[A]

    Permalink
  9. def asIterable[A](parser: (SqlRow) ⇒ A)(implicit connection: Connection): Iterable[A]

    Permalink

    Execute this query and get back the result as an iterable of records

    Execute this query and get back the result as an iterable of records

    parser

    the RowParser to use when parsing the result set

    connection

    the connection to use when executing the query

    returns

    the results as an iterable of records

  10. def asIterator[A](parser: (SqlRow) ⇒ A, fetchSize: Int = 100)(implicit connection: Connection): Iterator[A]

    Permalink

    The asIterator method returns an Iterator that will stream data out of the database.

    The asIterator method returns an Iterator that will stream data out of the database. This avoids an OutOfMemoryError when dealing with large datasets. Bear in mind that many JDBC implementations will not allow additional queries to the connection before all records in the Iterator have been retrieved.

    parser

    the RowParser to parse rows with

    fetchSize

    the number of rows to fetch at a time, defaults to 100. If the JDBC Driver is MySQL, the fetchSize will always default to Int.MinValue, as MySQL's JDBC implementation ignores all other fetchSize values and only streams if fetchSize is Int.MinValue

  11. def asList[A]()(implicit arg0: RowParser[A], connection: Connection): List[A]

    Permalink
  12. def asList[A](parser: (SqlRow) ⇒ A)(implicit connection: Connection): List[A]

    Permalink

    Execute this query and get back the result as a List of records

    Execute this query and get back the result as a List of records

    parser

    the RowParser to use when parsing the result set

    connection

    the connection to use when executing the query

    returns

    the results as a List of records

  13. def asMap[U, V]()(implicit connection: Connection, p: RowParser[(U, V)]): Map[U, V]

    Permalink
  14. def asMap[U, V](parser: (SqlRow) ⇒ (U, V))(implicit connection: Connection): Map[U, V]

    Permalink

    Execute this query and get back the result as a Map of records

    Execute this query and get back the result as a Map of records

    parser

    the RowParser to use when parsing the result set. The RowParser should return a Tuple of size 2 containing the key and value

    connection

    the connection to use when executing the query

    returns

    the results as a Map of records

  15. def asMultiMap[U, V]()(implicit connection: Connection, p: RowParser[(U, V)]): Map[U, Set[V]]

    Permalink
  16. def asMultiMap[U, V](parser: (SqlRow) ⇒ (U, V))(implicit connection: Connection): Map[U, Set[V]]

    Permalink
  17. def asPairCollection[U, V, T[_, _]]()(implicit cbf: CanBuildFrom[T[U, V], (U, V), T[U, V]], connection: Connection, p: RowParser[(U, V)]): T[U, V]

    Permalink
  18. def asPairCollection[U, V, T[_, _]](parser: (SqlRow) ⇒ (U, V))(implicit cbf: CanBuildFrom[T[U, V], (U, V), T[U, V]], connection: Connection): T[U, V]

    Permalink

    Execute this query and get back the result as an arbitrary collection of key value pairs

    Execute this query and get back the result as an arbitrary collection of key value pairs

    parser

    the RowParser to use when parsing the result set

    connection

    the connection to use when executing the query

    returns

    the results as an arbitrary collection of key value pairs

  19. def asScalar[A]()(implicit connection: Connection): A

    Permalink

    Execute this query and get back the result as a single value.

    Execute this query and get back the result as a single value. Assumes that there is only one row and one value in the result set.

    connection

    the connection to use when executing the query

    returns

    the results as a single value

  20. def asScalarOption[A]()(implicit connection: Connection): Option[A]

    Permalink

    Execute this query and get back the result as an optional single value.

    Execute this query and get back the result as an optional single value. Assumes that there is only one row and one value in the result set.

    connection

    the connection to use when executing the query

    returns

    the results as an optional single value

  21. def asSeq[A]()(implicit arg0: RowParser[A], connection: Connection): Seq[A]

    Permalink
  22. def asSeq[A](parser: (SqlRow) ⇒ A)(implicit connection: Connection): Seq[A]

    Permalink

    Execute this query and get back the result as a sequence of records

    Execute this query and get back the result as a sequence of records

    parser

    the RowParser to use when parsing the result set

    connection

    the connection to use when executing the query

    returns

    the results as a sequence of records

  23. def asSet[A]()(implicit arg0: RowParser[A], connection: Connection): Set[A]

    Permalink
  24. def asSet[A](parser: (SqlRow) ⇒ A)(implicit connection: Connection): Set[A]

    Permalink

    Execute this query and get back the result as a Set of records

    Execute this query and get back the result as a Set of records

    parser

    the RowParser to use when parsing the result set

    connection

    the connection to use when executing the query

    returns

    the results as a Set of records

  25. def asSingle[A]()(implicit arg0: RowParser[A], connection: Connection): A

    Permalink
  26. def asSingle[A](parser: (SqlRow) ⇒ A)(implicit connection: Connection): A

    Permalink

    Execute this query and get back the result as a single record

    Execute this query and get back the result as a single record

    parser

    the RowParser to use when parsing the result set

    connection

    the connection to use when executing the query

    returns

    the results as a single record

  27. def asSingleOption[A]()(implicit arg0: RowParser[A], connection: Connection): Option[A]

    Permalink
  28. def asSingleOption[A](parser: (SqlRow) ⇒ A)(implicit connection: Connection): Option[A]

    Permalink

    Execute this query and get back the result as an optional single record

    Execute this query and get back the result as an optional single record

    parser

    the RowParser to use when parsing the result set

    connection

    the connection to use when executing the query

    returns

    the results as an optional single record

  29. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  31. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  32. def execute()(implicit connection: Connection): Boolean

    Permalink

    Execute a statement

    Execute a statement

    connection

    the db connection to use when executing the query

    returns

    whether the query succeeded in its execution

  33. def executeInsertCollection[U, T[_]](parser: (SqlRow) ⇒ U)(implicit cbf: CanBuildFrom[T[U], U, T[U]], connection: Connection): T[U]

    Permalink

    Execute the query and get the auto-incremented keys using a RowParser.

    Execute the query and get the auto-incremented keys using a RowParser. Provided for the case that a primary key is not an Int or BigInt

    parser

    the RowParser that can parse the returned keys

    connection

    the connection to use when executing the query

    returns

    the auto-incremented keys

  34. def executeInsertInt()(implicit connection: Connection): Int

    Permalink

    Execute the query and get the auto-incremented key as an Int

    Execute the query and get the auto-incremented key as an Int

    connection

    the connection to use when executing the query

    returns

    the auto-incremented key as an Int

  35. def executeInsertInts()(implicit connection: Connection): List[Int]

    Permalink

    Execute the query and get the auto-incremented keys as a List of Ints

    Execute the query and get the auto-incremented keys as a List of Ints

    connection

    the connection to use when executing the query

    returns

    the auto-incremented keys as a List of Ints

  36. def executeInsertLong()(implicit connection: Connection): Long

    Permalink

    Execute the query and get the auto-incremented key as a Long

    Execute the query and get the auto-incremented key as a Long

    connection

    the connection to use when executing the query

    returns

    the auto-incremented key as a Long

  37. def executeInsertLongs()(implicit connection: Connection): List[Long]

    Permalink

    Execute the query and get the auto-incremented keys as a a List of Longs

    Execute the query and get the auto-incremented keys as a a List of Longs

    connection

    the connection to use when executing the query

    returns

    the auto-incremented keys as a a List of Longs

  38. def executeInsertSingle[U](parser: (SqlRow) ⇒ U)(implicit connection: Connection): U

    Permalink

    Execute the query and get the auto-incremented key using a RowParser.

    Execute the query and get the auto-incremented key using a RowParser. Provided for the case that a primary key is not an Int or BigInt

    parser

    the RowParser that can parse the returned key

    connection

    the connection to use when executing the query

    returns

    the auto-incremented key

  39. def executeUpdate()(implicit connection: Connection): Int

    Permalink

    Execute an update

    Execute an update

    connection

    the db connection to use when executing the query

    returns

    the number of rows update by the query

  40. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  41. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  42. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  43. def insertionStatement(implicit connection: Connection): BaseStatement with InsertionStatementPreparer

    Permalink
    Attributes
    protected
  44. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  45. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  46. def normalStatement(implicit connection: Connection): BaseStatement with NormalStatementPreparer

    Permalink
    Attributes
    protected
  47. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  48. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  49. def results()(implicit connection: Connection): ResultSet

    Permalink

    Provides direct access to the underlying java.sql.ResultSet.

    Provides direct access to the underlying java.sql.ResultSet. Note that this ResultSet must be closed manually or by wrapping it in SqlResult.

    val results = SQL(query).results()
    . . .
    SqlResult(results).asList[A](parser)
    // or
    results.close()
    returns

    java.sql.ResultSet

  50. def statementString(implicit connection: Connection): String

    Permalink

    Calls PreparedStatement#toString, which for many JDBC implementations is the SQL query after parameter substitution.

    Calls PreparedStatement#toString, which for many JDBC implementations is the SQL query after parameter substitution. This is intended primarily for ad-hoc debugging.

    For more routine logging, consider other solutions, such as log4jdbc.

  51. def streamedStatement(fetchSize: Int)(implicit connection: Connection): BaseStatement with StreamedStatementPreparer

    Permalink
    Attributes
    protected
  52. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  53. def toString(): String

    Permalink

    Returns the SQL query, before parameter substitution.

    Returns the SQL query, before parameter substitution.

    Definition Classes
    Sql → AnyRef → Any
  54. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped