ldbc-dsl
0.3.0
API
Generated with
ldbc-dsl/ldbc.dsl

ldbc.dsl

package ldbc.dsl

Top-level imports provide aliases for the most commonly used types and modules. A typical starting set of imports might look something like this.

example:

 import ldbc.dsl.*

Attributes

Members list

Packages

package ldbc.dsl.codec
package ldbc.dsl.exception
package ldbc.dsl.syntax
package ldbc.dsl.util

Type members

Classlikes

object DBIO

Attributes

Source
DBIO.scala
Supertypes
class Object
trait Matchable
class Any
Self type
DBIO.type
sealed trait DBIOA[A]

A trait that represents the execution of a query.

A trait that represents the execution of a query.

Type parameters

A

The result type of the query

Attributes

Source
DBIO.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class HandleErrorWith[A]
class Pure[A]
class QueryA[A]
class QueryTo[G, A]
class RaiseError[A]
class Returning[A]
class Sequence
class Update
Show all
case class Mysql(statement: String, params: List[Dynamic]) extends SQL

A model with a query string and parameters to be bound to the query string that is executed by PreparedStatement, etc.

A model with a query string and parameters to be bound to the query string that is executed by PreparedStatement, etc.

Value parameters

params

statement has '?' that the statement has.

statement

an SQL statement that may contain one or more '?' IN parameter placeholders

Attributes

Source
Mysql.scala
Supertypes
trait Serializable
trait Product
trait Equals
trait SQL
class Object
trait Matchable
class Any
Show all
trait Parameter

Trait for setting Scala and Java values to PreparedStatement.

Trait for setting Scala and Java values to PreparedStatement.

Attributes

Companion
object
Source
Parameter.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait Dynamic
class Failure
class Success
class Static
object Parameter

Attributes

Companion
trait
Source
Parameter.scala
Supertypes
class Object
trait Matchable
class Any
Self type
Parameter.type
trait Query[T]

Trait for determining what type of search system statements are retrieved from the database.

Trait for determining what type of search system statements are retrieved from the database.

Type parameters

T

Column Tuples

Attributes

Companion
object
Source
Query.scala
Supertypes
class Object
trait Matchable
class Any
object Query

Attributes

Companion
trait
Source
Query.scala
Supertypes
class Object
trait Matchable
class Any
Self type
Query.type
trait ResultSetConsumer[F[_], T]

Trait for generating the specified data type from a ResultSet.

Trait for generating the specified data type from a ResultSet.

Type parameters

F

The effect type

T

Type you want to build with data obtained from ResultSet

Attributes

Companion
object
Source
ResultSetConsumer.scala
Supertypes
class Object
trait Matchable
class Any
object ResultSetConsumer

Attributes

Companion
trait
Source
ResultSetConsumer.scala
Supertypes
class Object
trait Matchable
class Any
Self type
trait SQL

A model with a query string and parameters to be bound to the query string that is executed by PreparedStatement, etc.

A model with a query string and parameters to be bound to the query string that is executed by PreparedStatement, etc.

Attributes

Companion
object
Source
SQL.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Mysql
object SQL

Attributes

Companion
trait
Source
SQL.scala
Supertypes
class Object
trait Matchable
class Any
Self type
SQL.type

Types

type DBIO[A] = Free[DBIOA, A]

Attributes

Source
DBIO.scala

Value members

Inherited methods

def and(s1: SQL, s2: SQL, ss: SQL*): Mysql

Returns (s1 AND s2 AND ... sn).

Returns (s1 AND s2 AND ... sn).

Attributes

Inherited from:
HelperFunctionsSyntax
Source
HelperFunctionsSyntax.scala
def and[M[_] : Reducible](ss: M[SQL], grouping: Boolean): Mysql

Returns (s1 AND s2 AND ... sn) for a non-empty collection.

Returns (s1 AND s2 AND ... sn) for a non-empty collection.

Attributes

Inherited from:
HelperFunctionsSyntax
Source
HelperFunctionsSyntax.scala
def andFallbackTrue[M[_] : Foldable](ss: M[SQL]): Mysql

Similar to andOpt, but defaults to TRUE if passed an empty collection

Similar to andOpt, but defaults to TRUE if passed an empty collection

Attributes

Inherited from:
HelperFunctionsSyntax
Source
HelperFunctionsSyntax.scala
def andOpt(s1: Option[SQL], s2: Option[SQL], ss: Option[SQL]*): Option[Mysql]

Returns (s1 AND s2 AND ... sn) for all defined sql, returning Empty SQL if there are no defined sql

Returns (s1 AND s2 AND ... sn) for all defined sql, returning Empty SQL if there are no defined sql

Attributes

Inherited from:
HelperFunctionsSyntax
Source
HelperFunctionsSyntax.scala
def andOpt[M[_] : Foldable](vs: M[SQL], grouping: Boolean): Option[Mysql]

Returns (s1 AND s2 AND ... sn) for a non-empty collection.

Returns (s1 AND s2 AND ... sn) for a non-empty collection.

Attributes

Inherited from:
HelperFunctionsSyntax
Source
HelperFunctionsSyntax.scala
def comma[M[_] : Reducible](ss: M[SQL]): Mysql

Returns s1, s2, ... sn.

Returns s1, s2, ... sn.

Attributes

Inherited from:
HelperFunctionsSyntax
Source
HelperFunctionsSyntax.scala
def comma(s1: SQL, s2: SQL, ss: SQL*): Mysql

Returns s1, s2, ... sn.

Returns s1, s2, ... sn.

Attributes

Inherited from:
HelperFunctionsSyntax
Source
HelperFunctionsSyntax.scala
def in[M[_] : Functor, T](s: SQL, vs: M[T])(implicit evidence$1: Reducible[M], evidence$2: Functor[M], Encoder[T]): Mysql

Returns (sql IN (s0, s1, ...)).

Returns (sql IN (s0, s1, ...)).

Attributes

Inherited from:
HelperFunctionsSyntax
Source
HelperFunctionsSyntax.scala
def in[T](s: SQL, v0: T, v1: T, vs: T*)(using Encoder[T]): Mysql

Returns (sql IN (v0, v1, ...)).

Returns (sql IN (v0, v1, ...)).

Attributes

Inherited from:
HelperFunctionsSyntax
Source
HelperFunctionsSyntax.scala
def inOpt[M[_] : Foldable, T](s: SQL, vs: M[T])(implicit evidence$1: Foldable[M], Encoder[T]): Option[Mysql]

Attributes

Inherited from:
HelperFunctionsSyntax
Source
HelperFunctionsSyntax.scala
def notIn[M[_] : Functor, T](s: SQL, vs: M[T])(implicit evidence$1: Reducible[M], evidence$2: Functor[M], Encoder[T]): Mysql

Returns (sql NOT IN (v0, v1, ...)), or true for empty fs.

Returns (sql NOT IN (v0, v1, ...)), or true for empty fs.

Attributes

Inherited from:
HelperFunctionsSyntax
Source
HelperFunctionsSyntax.scala
def notIn[T](s: SQL, v0: T, v1: T, vs: T*)(using Encoder[T]): Mysql

Returns (sql NOT IN (v0, v1, ...)).

Returns (sql NOT IN (v0, v1, ...)).

Attributes

Inherited from:
HelperFunctionsSyntax
Source
HelperFunctionsSyntax.scala
def notInOpt[M[_] : Foldable, T](s: SQL, vs: M[T])(implicit evidence$1: Foldable[M], Encoder[T]): Option[Mysql]

Attributes

Inherited from:
HelperFunctionsSyntax
Source
HelperFunctionsSyntax.scala
def or(s1: SQL, s2: SQL, ss: SQL*): SQL

Returns (s1 OR s2 OR ... sn).

Returns (s1 OR s2 OR ... sn).

Attributes

Inherited from:
HelperFunctionsSyntax
Source
HelperFunctionsSyntax.scala
def or[M[_] : Reducible](ss: M[SQL], grouping: Boolean): Mysql

Returns (s1 OR s2 OR ... sn) for a non-empty collection.

Returns (s1 OR s2 OR ... sn) for a non-empty collection.

Attributes

Inherited from:
HelperFunctionsSyntax
Source
HelperFunctionsSyntax.scala
def orFallbackFalse[M[_] : Foldable](ss: M[SQL]): Mysql

Similar to orOpt, but defaults to FALSE if passed an empty collection

Similar to orOpt, but defaults to FALSE if passed an empty collection

Attributes

Inherited from:
HelperFunctionsSyntax
Source
HelperFunctionsSyntax.scala
def orOpt(s1: Option[SQL], s2: Option[SQL], ss: Option[SQL]*): Option[Mysql]

Returns (s1 OR s2 OR ... sn) for all defined sql, returning Empty SQL if there are no defined sql

Returns (s1 OR s2 OR ... sn) for all defined sql, returning Empty SQL if there are no defined sql

Attributes

Inherited from:
HelperFunctionsSyntax
Source
HelperFunctionsSyntax.scala
def orOpt[M[_] : Foldable](vs: M[SQL], grouping: Boolean): Option[Mysql]

Returns (s1 OR s2 OR ... sn) for all defined sql, returning Empty SQL if there are no defined sql

Returns (s1 OR s2 OR ... sn) for all defined sql, returning Empty SQL if there are no defined sql

Attributes

Inherited from:
HelperFunctionsSyntax
Source
HelperFunctionsSyntax.scala
def orderBy[M[_] : Reducible](ss: M[SQL]): Mysql

Attributes

Inherited from:
HelperFunctionsSyntax
Source
HelperFunctionsSyntax.scala
def orderBy(s1: SQL, ss: SQL*): SQL

Returns ORDER BY s1, s2, ... sn.

Returns ORDER BY s1, s2, ... sn.

Attributes

Inherited from:
HelperFunctionsSyntax
Source
HelperFunctionsSyntax.scala
def orderByOpt(s1: Option[SQL], s2: Option[SQL], ss: Option[SQL]*): Mysql

Returns ORDER BY s1, s2, ... sn for defined s, if any, otherwise the empty sql.

Returns ORDER BY s1, s2, ... sn for defined s, if any, otherwise the empty sql.

Attributes

Inherited from:
HelperFunctionsSyntax
Source
HelperFunctionsSyntax.scala
def orderByOpt[M[_] : Foldable](ss: M[SQL]): Mysql

Returns ORDER BY s1, s2, ... sn or the empty sql if ss is empty.

Returns ORDER BY s1, s2, ... sn or the empty sql if ss is empty.

Attributes

Inherited from:
HelperFunctionsSyntax
Source
HelperFunctionsSyntax.scala
def parentheses(s: SQL): Mysql

Returns (sql).

Returns (sql).

Attributes

Inherited from:
HelperFunctionsSyntax
Source
HelperFunctionsSyntax.scala
def sc(value: String): Static

Function for setting parameters to be used as static strings.

Function for setting parameters to be used as static strings.

 val table = sc("table")
 sql"SELECT * FROM $table WHERE id = ${1L}"
 // SELECT * FROM table WHERE id = ?

Attributes

Inherited from:
HelperFunctionsSyntax
Source
HelperFunctionsSyntax.scala
def set[M[_] : Reducible](fs: M[SQL]): Mysql

Returns SET s1, s2, ... sn.

Returns SET s1, s2, ... sn.

Attributes

Inherited from:
HelperFunctionsSyntax
Source
HelperFunctionsSyntax.scala
def set(s1: SQL, ss: SQL*): Mysql

Returns SET s1, s2, ... sn.

Returns SET s1, s2, ... sn.

Attributes

Inherited from:
HelperFunctionsSyntax
Source
HelperFunctionsSyntax.scala
def values[M[_] : Reducible, T](vs: M[T])(implicit evidence$1: Reducible[M], Encoder[T]): Mysql

Returns VALUES (v0, v1), (v2, v3), ....

Returns VALUES (v0, v1), (v2, v3), ....

Attributes

Inherited from:
HelperFunctionsSyntax
Source
HelperFunctionsSyntax.scala
def whereAnd[M[_] : Reducible](ss: M[SQL]): Mysql

Returns WHERE s1 AND s2 AND ... sn or the empty sql if ss is empty.

Returns WHERE s1 AND s2 AND ... sn or the empty sql if ss is empty.

Attributes

Inherited from:
HelperFunctionsSyntax
Source
HelperFunctionsSyntax.scala
def whereAnd(s1: SQL, ss: SQL*): Mysql

Returns WHERE s1 AND s2 AND ... sn.

Returns WHERE s1 AND s2 AND ... sn.

Attributes

Inherited from:
HelperFunctionsSyntax
Source
HelperFunctionsSyntax.scala
def whereAndOpt[M[_] : Foldable](ss: M[SQL]): Mysql

Returns WHERE s1 AND s2 AND ... sn if collection is not empty. If collection is empty returns an empty sql.

Returns WHERE s1 AND s2 AND ... sn if collection is not empty. If collection is empty returns an empty sql.

Attributes

Inherited from:
HelperFunctionsSyntax
Source
HelperFunctionsSyntax.scala
def whereAndOpt(s1: Option[SQL], s2: Option[SQL], ss: Option[SQL]*): Mysql

Returns WHERE s1 AND s2 AND ... sn for defined s, if any, otherwise the empty sql.

Returns WHERE s1 AND s2 AND ... sn for defined s, if any, otherwise the empty sql.

Attributes

Inherited from:
HelperFunctionsSyntax
Source
HelperFunctionsSyntax.scala
def whereOr[M[_] : Reducible](ss: M[SQL]): Mysql

Returns WHERE s1 OR s2 OR ... sn or the empty sql if ss is empty.

Returns WHERE s1 OR s2 OR ... sn or the empty sql if ss is empty.

Attributes

Inherited from:
HelperFunctionsSyntax
Source
HelperFunctionsSyntax.scala
def whereOr(s1: SQL, ss: SQL*): Mysql

Returns WHERE s1 OR s2 OR ... sn.

Returns WHERE s1 OR s2 OR ... sn.

Attributes

Inherited from:
HelperFunctionsSyntax
Source
HelperFunctionsSyntax.scala
def whereOrOpt[M[_] : Foldable](ss: M[SQL]): Mysql

Returns WHERE s1 OR s2 OR ... sn if collection is not empty. If collection is empty returns an empty sql.

Returns WHERE s1 OR s2 OR ... sn if collection is not empty. If collection is empty returns an empty sql.

Attributes

Inherited from:
HelperFunctionsSyntax
Source
HelperFunctionsSyntax.scala
def whereOrOpt(s1: Option[SQL], s2: Option[SQL], ss: Option[SQL]*): Mysql

Returns WHERE s1 OR s2 OR ... sn for defined s, if any, otherwise the empty sql.

Returns WHERE s1 OR s2 OR ... sn for defined s, if any, otherwise the empty sql.

Attributes

Inherited from:
HelperFunctionsSyntax
Source
HelperFunctionsSyntax.scala

Extensions

Inherited extensions

extension (sc: StringContext)
def p(args: Dynamic*): Mysql

Attributes

Inherited from:
StringContextSyntax
Source
StringContextSyntax.scala
def sql(args: Parameter*): Mysql

Attributes

Inherited from:
StringContextSyntax
Source
StringContextSyntax.scala

Implicits

Inherited implicits

implicit def toDBIO[A](dbio: DBIO[A]): Ops[A]

Attributes

Inherited from:
HelperFunctionsSyntax
Source
HelperFunctionsSyntax.scala
Generated with