com.lucidchart.open.relate

Expandable

sealed trait Expandable extends ParameterizableSql

Expandable is a trait for SQL queries that can be expanded.

It defines two expansion methods:

These methods should be called in the expand method.

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

val ids = Array(1L, 2L, 3L)

SQL("""
  SELECT *
  FROM users
  WHERE id IN ({ids})
""").expand { implicit query =>
  commaSeparated("ids", ids.size)
}.on {
  longs("ids", ids)
}
Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Expandable
  2. ParameterizableSql
  3. ParameterizedSql
  4. Sql
  5. AnyRef
  6. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def getCopy(params: List[(SqlStatement) ⇒ Unit]): ParameterizableSql

    Classes that inherit the Sql trait will have to implement a method to copy themselves given just a different set of parameters.

    Classes that inherit the Sql trait will have to implement a method to copy themselves given just a different set of parameters. HINT: Use a case class!

    Attributes
    protected
    Definition Classes
    ParameterizableSql
  2. abstract val listParams: Map[String, ListParam]

    The names of list params mapped to their size

  3. abstract val params: List[(SqlStatement) ⇒ Unit]

    A list of anonymous functions that insert parameters into a SqlStatement

    A list of anonymous functions that insert parameters into a SqlStatement

    Attributes
    protected
    Definition Classes
    ParameterizableSql
  4. abstract def queryParams: QueryParams

    Attributes
    protected[com.lucidchart.open.relate]
    Definition Classes
    ParameterizedSql

Concrete Value Members

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

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

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

    Definition Classes
    AnyRef → Any
  4. def applyParams(stmt: PreparedStatement): Unit

    Attributes
    protected
    Definition Classes
    ParameterizedSqlSql
  5. def asCollection[U, T[_]](parser: RowParser[U])(implicit cbf: CanBuildFrom[T[U], U, T[U]], connection: Connection): T[U]

    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

    Definition Classes
    Sql
  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  7. def asIterable[A](parser: RowParser[A])(implicit connection: Connection): Iterable[A]

    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

    Definition Classes
    Sql
  8. def asIterator[A](parser: RowParser[A], fetchSize: Int = 100)(implicit connection: Connection): Iterator[A]

    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

    Definition Classes
    Sql
  9. def asList[A](parser: RowParser[A])(implicit connection: Connection): List[A]

    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

    Definition Classes
    Sql
  10. def asMap[U, V](parser: RowParser[(U, V)])(implicit connection: Connection): Map[U, V]

    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

    Definition Classes
    Sql
  11. def asPairCollection[U, V, T[_, _]](parser: RowParser[(U, V)])(implicit cbf: CanBuildFrom[T[U, V], (U, V), T[U, V]], connection: Connection): T[U, V]

    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

    Definition Classes
    Sql
  12. def asScalar[A]()(implicit connection: Connection): A

    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

    Definition Classes
    Sql
  13. def asScalarOption[A]()(implicit connection: Connection): Option[A]

    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

    Definition Classes
    Sql
  14. def asSeq[A](parser: RowParser[A])(implicit connection: Connection): Seq[A]

    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

    Definition Classes
    Sql
  15. def asSet[A](parser: RowParser[A])(implicit connection: Connection): Set[A]

    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

    Definition Classes
    Sql
  16. def asSingle[A](parser: RowParser[A])(implicit connection: Connection): A

    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

    Definition Classes
    Sql
  17. def asSingleOption[A](parser: RowParser[A])(implicit connection: Connection): Option[A]

    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

    Definition Classes
    Sql
  18. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. def commaSeparated(name: String, count: Int): Unit

    Replace the provided identifier with a comma separated list of parameters WARNING: modifies this Expandable in place

    Replace the provided identifier with a comma separated list of parameters WARNING: modifies this Expandable in place

    name

    the identifier for the parameter

    count

    the count of parameters in the list

  20. def commas(name: String, count: Int): Expandable

    Shorthand for calling commaSeparated within an expand block.

    Shorthand for calling commaSeparated within an expand block.

    SQL("SELECT * FROM users WHERE id IN ({ids})").commas("ids", 10)

    is equivalent to

    SQL("SELECT * FROM users WHERE id IN ({ids})").expand { implicit query =>
      commaSeparated("ids", 10)
    }

    WARNING: modifies this Expandable in place

    name

    the parameter name to expand

    count

    the number of items in the comma separated list

    returns

    this Expandable with the added list parameters

  21. final def eq(arg0: AnyRef): Boolean

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

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

    Execute a statement

    Execute a statement

    connection

    the db connection to use when executing the query

    returns

    whether the query succeeded in its execution

    Definition Classes
    Sql
  24. def executeInsertCollection[U, T[_]](parser: RowParser[U])(implicit cbf: CanBuildFrom[T[U], U, T[U]], connection: Connection): T[U]

    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

    Definition Classes
    Sql
  25. def executeInsertInt()(implicit connection: Connection): Int

    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

    Definition Classes
    Sql
  26. def executeInsertInts()(implicit connection: Connection): List[Int]

    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

    Definition Classes
    Sql
  27. def executeInsertLong()(implicit connection: Connection): Long

    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

    Definition Classes
    Sql
  28. def executeInsertLongs()(implicit connection: Connection): List[Long]

    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

    Definition Classes
    Sql
  29. def executeInsertSingle[U](parser: RowParser[U])(implicit connection: Connection): U

    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

    Definition Classes
    Sql
  30. def executeUpdate()(implicit connection: Connection): Int

    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

    Definition Classes
    Sql
  31. def expand(f: (Expandable) ⇒ Unit): Expandable

    Expand out the query by turning an TraversableOnce into several parameters

    Expand out the query by turning an TraversableOnce into several parameters

    returns

    a copy of this Expandable with the query expanded

  32. def finalize(): Unit

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

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

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

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

    Definition Classes
    AnyRef
  37. final def notify(): Unit

    Definition Classes
    AnyRef
  38. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  39. def on(f: (SqlStatement) ⇒ Unit): ParameterizableSql

    Put in values for parameters in the query

    Put in values for parameters in the query

    f

    a function that takes a SqlStatement and sets parameter values using its methods

    returns

    a copy of this Sql with the new params

    Definition Classes
    ParameterizableSql
  40. def onTuples[A](name: String, tuples: TraversableOnce[A])(f: (A, TupleStatement) ⇒ Unit): ParameterizableSql

    Put in values for tuple parameters in the query

    Put in values for tuple parameters in the query

    name

    the tuple identifier in the query

    tuples

    the objects to loop over and use to insert data into the query

    f

    a function that takes a TupleStatement and sets parameter values using its methods

    returns

    a copy of this Sql with the new tuple params

    Definition Classes
    ParameterizableSql
  41. val parsedParams: Map[String, List[Int]]

    Attributes
    protected
    Definition Classes
    ParameterizedSql
  42. val parsedQuery: String

    Attributes
    protected
    Definition Classes
    ParameterizedSqlSql
  43. def results()(implicit connection: Connection): ResultSet

    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

    Definition Classes
    Sql
  44. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  45. def toString(): String

    Definition Classes
    AnyRef → Any
  46. def tupled(name: String, columns: Seq[String], count: Int): Unit

    Replace the provided identifier with a comma separated list of tuples WARNING: modifies this Expandable in place

    Replace the provided identifier with a comma separated list of tuples WARNING: modifies this Expandable in place

    name

    the identifier for the tuples

    columns

    a list of the column names in the order they should be inserted into the tuples

    count

    the number of tuples to insert

  47. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from ParameterizableSql

Inherited from ParameterizedSql

Inherited from Sql

Inherited from AnyRef

Inherited from Any

Ungrouped