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

ldbc.core

package ldbc.core

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.core.*

Attributes

Members list

Packages

package ldbc.core.attribute
package ldbc.core.builder
package ldbc.core.interpreter
package ldbc.core.model
package ldbc.core.syntax

Type members

Classlikes

trait Character

A model for representing character sets to be set in column definitions for the string data types CHAR, VARCHAR, TEXT, ENUM, SET, and any synonym.

A model for representing character sets to be set in column definitions for the string data types CHAR, VARCHAR, TEXT, ENUM, SET, and any synonym.

Attributes

Companion
object
Source
Character.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object armscii8
object ascii
object big5
object binary
object cp1250
object cp1251
object cp1256
object cp1257
object cp850
object cp852
object cp866
object cp932
object dec8
object eucjpms
object euckr
object gb18030
object gb2312
object gbk
object geostd8
object greek
object hebrew
object hp8
object keybcs2
object koi8r
object koi8u
object latin1
object latin2
object latin5
object latin7
object macce
object macroman
object sjis
object swe7
object tis620
object ucs2
object ujis
object utf16
object utf16le
object utf32
object utf8mb3
object utf8mb4
Show all
object Character

Attributes

Companion
trait
Source
Character.scala
Supertypes
class Object
trait Matchable
class Any
Self type
Character.type
trait Collate[T <: COLLATION_TYPE]

A model for representing collations to be set in column definitions for the string data types CHAR, VARCHAR, TEXT, ENUM, SET, and any synonym.

A model for representing collations to be set in column definitions for the string data types CHAR, VARCHAR, TEXT, ENUM, SET, and any synonym.

Attributes

Companion
object
Source
Character.scala
Supertypes
class Object
trait Matchable
class Any
object Collate

Attributes

Companion
trait
Source
Character.scala
Supertypes
class Object
trait Matchable
class Any
Self type
Collate.type
trait Column[T]

Trait for representing SQL Column

Trait for representing SQL Column

Type parameters

T

Scala types that match SQL DataType

Attributes

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

Attributes

Companion
trait
Source
Column.scala
Supertypes
class Object
trait Matchable
class Any
Self type
Column.type
sealed trait DataType[T]

Trait for representing SQL DataType

Trait for representing SQL DataType

Type parameters

T

Scala types that match SQL DataType

Attributes

Companion
object
Source
DataType.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait BlobType[T]
trait StringType[T]
Self type
object DataType

Attributes

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

A set of methods for constructing DataType

A set of methods for constructing DataType

Attributes

Source
DataTypes.scala
Supertypes
class Object
trait Matchable
class Any
trait Database

A model representing SQL database information.

A model representing SQL database information.

Attributes

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

Attributes

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

Trait for setting SQL Default values

Trait for setting SQL Default values

Attributes

Companion
object
Source
Default.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Date
object Null
class TimeStamp
class Value[T]
object Default

Attributes

Companion
trait
Source
Default.scala
Supertypes
class Object
trait Matchable
class Any
Self type
Default.type
object Index

Attributes

Source
Key.scala
Supertypes
class Object
trait Matchable
class Any
Self type
Index.type
enum JdbcType(val code: Int)

Enum that defines constants to identify generic SQL types called JDBC types.

Enum that defines constants to identify generic SQL types called JDBC types.

Attributes

Companion
object
Source
JdbcType.scala
Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
class Unknown
object JdbcType

Attributes

Companion
enum
Source
JdbcType.scala
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
JdbcType.type
object PrimaryKey

Attributes

Source
Key.scala
Supertypes
class Object
trait Matchable
class Any
Self type
PrimaryKey.type
case class Reference[T <: Tuple](table: Table[_], keyPart: T, onDelete: Option[ReferenceOption], onUpdate: Option[ReferenceOption])(using x$5: IsColumn[T] =:= true)

A model for setting reference options used for foreign key constraints, etc.

A model for setting reference options used for foreign key constraints, etc.

Value parameters

keyPart

List of columns for which the Index key is set

onDelete

Reference action on delete

onUpdate

Reference action on update

table

Referenced table model

Attributes

Companion
object
Source
Reference.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Reference

Attributes

Companion
class
Source
Reference.scala
Supertypes
class Object
trait Matchable
class Any
Self type
Reference.type
object Table extends Dynamic

Attributes

Source
Table.scala
Supertypes
trait Dynamic
class Object
trait Matchable
class Any
Self type
Table.type
trait TableOption

Attributes

Companion
object
Source
TableOption.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class AVGRowLength
class CheckSum
class Comment
class Compression
class Connection
class Directory
class Encryption
class Engine
class InsertMethod
class KeyBlockSize
class MaxRows
class MinRows
class PackKeys
class RowFormat
class Tablespace
class Union
Show all
object TableOption

Attributes

Companion
trait
Source
TableOption.scala
Supertypes
class Object
trait Matchable
class Any
Self type
object UniqueKey

Attributes

Source
Key.scala
Supertypes
class Object
trait Matchable
class Any
Self type
UniqueKey.type

Inherited classlikes

object COLUMN_FORMAT

Attributes

Inherited from:
Alias (hidden)
Source
Alias.scala
Supertypes
class Object
trait Matchable
class Any
object STORAGE

Attributes

Inherited from:
Alias (hidden)
Source
Alias.scala
Supertypes
class Object
trait Matchable
class Any

Inherited types

type BIGINT[T <: Long | BigInt | Option[Long | BigInt]] = Bigint[T]

Attributes

Inherited from:
Alias (hidden)
Source
Alias.scala
type BINARY[T <: Array[Byte] | Option[Array[Byte]]] = Binary[T]

Attributes

Inherited from:
Alias (hidden)
Source
Alias.scala
type BIT[T <: Byte | Short | Int | Long | Option[Byte | Short | Int | Long]] = Bit[T]

Attributes

Inherited from:
Alias (hidden)
Source
Alias.scala
type BLOB[T <: Array[Byte] | Option[Array[Byte]]] = Blob[T]

Attributes

Inherited from:
Alias (hidden)
Source
Alias.scala
type CHAR[T <: String | Option[String]] = CChar[T]

Attributes

Inherited from:
Alias (hidden)
Source
Alias.scala
type DATE[T <: LocalDate | Option[LocalDate]] = Date[T]

Attributes

Inherited from:
Alias (hidden)
Source
Alias.scala
type DATETIME[T <: Instant | LocalDateTime | Option[Instant | LocalDateTime]] = DateTime[T]

Attributes

Inherited from:
Alias (hidden)
Source
Alias.scala
type DECIMAL[T <: BigDecimal | Option[BigDecimal]] = Decimal[T]

Attributes

Inherited from:
Alias (hidden)
Source
Alias.scala
type FLOAT[T <: Double | Float | Option[Double | Float]] = CFloat[T]

Attributes

Inherited from:
Alias (hidden)
Source
Alias.scala
type INTEGER[T <: Int | Long | Option[Int | Long]] = Integer[T]

Attributes

Inherited from:
Alias (hidden)
Source
Alias.scala
type LONGBLOB[T <: Array[Byte] | Option[Array[Byte]]] = LongBlob[T]

Attributes

Inherited from:
Alias (hidden)
Source
Alias.scala
type LONGTEXT[T <: String | Option[String]] = LongText[T]

Attributes

Inherited from:
Alias (hidden)
Source
Alias.scala
type MEDIUMBLOB[T <: Array[Byte] | Option[Array[Byte]]] = Mediumblob[T]

Attributes

Inherited from:
Alias (hidden)
Source
Alias.scala
type MEDIUMINT[T <: Int | Option[Int]] = Mediumint[T]

Attributes

Inherited from:
Alias (hidden)
Source
Alias.scala
type MEDIUMTEXT[T <: String | Option[String]] = MediumText[T]

Attributes

Inherited from:
Alias (hidden)
Source
Alias.scala
type SMALLINT[T <: Short | Int | Option[Short | Int]] = Smallint[T]

Attributes

Inherited from:
Alias (hidden)
Source
Alias.scala
type TABLE[P <: Product] = Table[P]

Attributes

Inherited from:
Alias (hidden)
Source
Alias.scala
type TEXT[T <: String | Option[String]] = Text[T]

Attributes

Inherited from:
Alias (hidden)
Source
Alias.scala
type TIME[T <: LocalTime | Option[LocalTime]] = Time[T]

Attributes

Inherited from:
Alias (hidden)
Source
Alias.scala
type TIMESTAMP[T <: Instant | LocalDateTime | Option[Instant | LocalDateTime]] = TimeStamp[T]

Attributes

Inherited from:
Alias (hidden)
Source
Alias.scala
type TINYBLOB[T <: Array[Byte] | Option[Array[Byte]]] = Tinyblob[T]

Attributes

Inherited from:
Alias (hidden)
Source
Alias.scala
type TINYINT[T <: Byte | Short | Option[Byte | Short]] = Tinyint[T]

Attributes

Inherited from:
Alias (hidden)
Source
Alias.scala
type TINYTEXT[T <: String | Option[String]] = TinyText[T]

Attributes

Inherited from:
Alias (hidden)
Source
Alias.scala
type VARCHAR[T <: String | Option[String]] = Varchar[T]

Attributes

Inherited from:
Alias (hidden)
Source
Alias.scala
type YEAR[T <: Instant | LocalDate | Year | Option[Instant | LocalDate | Year]] = Year[T]

Attributes

Inherited from:
Alias (hidden)
Source
Alias.scala

Value members

Inherited methods

def AUTO_INCREMENT[T <: Byte | Short | Int | Long | BigInt | Option[Byte | Short | Int | Long | BigInt]]: AutoInc[T]

Attributes

Inherited from:
Alias (hidden)
Source
Alias.scala
inline def BIGINT[T <: Long | BigInt | Option[Long | BigInt]]: Bigint[T]

Attributes

Inherited from:
DataTypes
Source
DataTypes.scala
inline def BINARY[T <: Array[Byte] | Option[Array[Byte]]](inline length: Int): Binary[T]

Attributes

Inherited from:
DataTypes
Source
DataTypes.scala
inline def BIT[T <: Byte | Short | Int | Long | Option[Byte | Short | Int | Long]]: Bit[T]

Attributes

Inherited from:
DataTypes
Source
DataTypes.scala
inline def BLOB[T <: Array[Byte] | Option[Array[Byte]]](inline length: Long): Blob[T]

Attributes

Inherited from:
DataTypes
Source
DataTypes.scala
inline def BLOB[T <: Array[Byte] | Option[Array[Byte]]](): Blob[T]

Attributes

Inherited from:
DataTypes
Source
DataTypes.scala
inline def BOOLEAN[T <: Boolean | Option[Boolean]]: Bool[T]

Attributes

Inherited from:
DataTypes
Source
DataTypes.scala
inline def CHAR[T <: String | Option[String]](inline length: Int): CChar[T]

===== List of String Data Types =====

===== List of String Data Types =====

Attributes

Inherited from:
DataTypes
Source
DataTypes.scala
def COMMENT[T](message: String): Comment[T]

Attributes

Inherited from:
Alias (hidden)
Source
Alias.scala
def CONSTRAINT(symbol: String, key: PrimaryKey | UniqueKey | ForeignKey[_]): Constraint

Attributes

Inherited from:
Alias (hidden)
Source
Alias.scala
def CONSTRAINT(key: PrimaryKey | UniqueKey | ForeignKey[_]): Constraint

Attributes

Inherited from:
Alias (hidden)
Source
Alias.scala
inline def DATE[T <: String | LocalDate | Option[String | LocalDate]]: Date[T]

===== List of Date Data Types =====

===== List of Date Data Types =====

Attributes

Inherited from:
DataTypes
Source
DataTypes.scala
inline def DATETIME[T <: String | Instant | LocalDateTime | OffsetTime | Option[String | Instant | LocalDateTime | OffsetTime]](inline fsp: 0 | 1 | 2 | 3 | 4 | 5 | 6): DateTime[T]

Attributes

Inherited from:
DataTypes
Source
DataTypes.scala
inline def DATETIME[T <: String | Instant | LocalDateTime | OffsetTime | Option[String | Instant | LocalDateTime | OffsetTime]]: DateTime[T]

Attributes

Inherited from:
DataTypes
Source
DataTypes.scala
inline def DECIMAL[T <: BigDecimal | Option[BigDecimal]](inline accuracy: Int, inline scale: Int): Decimal[T]

Attributes

Inherited from:
DataTypes
Source
DataTypes.scala
inline def DOUBLE[T <: Double | Option[Double]](inline accuracy: Int): CFloat[T]

Attributes

Inherited from:
DataTypes
Source
DataTypes.scala
inline def ENUM[T <: Enum | Option[Enum]](using EnumDataType[_]): Enum[T]

Attributes

Inherited from:
DataTypes
Source
DataTypes.scala
inline def FLOAT[T <: Float | Option[Float]](inline accuracy: Int): CFloat[T]

Attributes

Inherited from:
DataTypes
Source
DataTypes.scala
def FOREIGN_KEY[T <: Tuple](name: Option[String], columns: T, reference: Reference[T])(using IsColumn[T] =:= true): ForeignKey[T]

Attributes

Inherited from:
Alias (hidden)
Source
Alias.scala
def FOREIGN_KEY[T <: Tuple](name: String, columns: T, reference: Reference[T])(using IsColumn[T] =:= true): ForeignKey[T]

Attributes

Inherited from:
Alias (hidden)
Source
Alias.scala
def FOREIGN_KEY[T <: Tuple](columns: T, reference: Reference[T])(using IsColumn[T] =:= true): ForeignKey[T]

Attributes

Inherited from:
Alias (hidden)
Source
Alias.scala
def FOREIGN_KEY[T](name: String, column: Column[T], reference: Reference[Column[T] *: EmptyTuple]): ForeignKey[Column[T] *: EmptyTuple]

Attributes

Inherited from:
Alias (hidden)
Source
Alias.scala
def FOREIGN_KEY[T](column: Column[T], reference: Reference[Column[T] *: EmptyTuple]): ForeignKey[Column[T] *: EmptyTuple]

Attributes

Inherited from:
Alias (hidden)
Source
Alias.scala
def INDEX_KEY(indexName: Option[String], indexType: Option[Type], indexOption: Option[IndexOption], keyPart: Column[_]*): IndexKey

Attributes

Inherited from:
Alias (hidden)
Source
Alias.scala
def INDEX_KEY(keyPart: Column[_]*): IndexKey

Attributes

Inherited from:
Alias (hidden)
Source
Alias.scala
inline def INT[T <: Int | Long | Option[Int | Long]]: Integer[T]

Attributes

Inherited from:
DataTypes
Source
DataTypes.scala
def INVISIBLE[T]: InVisible[T]

Attributes

Inherited from:
Alias (hidden)
Source
Alias.scala
inline def LONGBLOB[T <: Array[Byte] | Option[Array[Byte]]](): LongBlob[T]

Attributes

Inherited from:
DataTypes
Source
DataTypes.scala
inline def LONGTEXT[T <: String | Option[String]](): LongText[T]

Attributes

Inherited from:
DataTypes
Source
DataTypes.scala
inline def MEDIUMBLOB[T <: Array[Byte] | Option[Array[Byte]]](): Mediumblob[T]

Attributes

Inherited from:
DataTypes
Source
DataTypes.scala
inline def MEDIUMINT[T <: Int | Option[Int]]: Mediumint[T]

Attributes

Inherited from:
DataTypes
Source
DataTypes.scala
inline def MEDIUMTEXT[T <: String | Option[String]](): MediumText[T]

Attributes

Inherited from:
DataTypes
Source
DataTypes.scala
def PRIMARY_KEY(indexType: Type, indexOption: IndexOption, keyPart: Column[_]*): PrimaryKey & Index

Attributes

Inherited from:
Alias (hidden)
Source
Alias.scala
def PRIMARY_KEY(keyPart: List[Column[_]], indexOption: IndexOption): PrimaryKey & Index

Attributes

Inherited from:
Alias (hidden)
Source
Alias.scala
def PRIMARY_KEY(indexType: Type, keyPart: Column[_]*): PrimaryKey & Index

Attributes

Inherited from:
Alias (hidden)
Source
Alias.scala
def PRIMARY_KEY(keyPart: Column[_]*): PrimaryKey & Index

Attributes

Inherited from:
Alias (hidden)
Source
Alias.scala
def PRIMARY_KEY(keyPart: Column[_]): PrimaryKey & Index

Attributes

Inherited from:
Alias (hidden)
Source
Alias.scala
def PRIMARY_KEY[T]: PrimaryKey & Attribute[T]

Attributes

Inherited from:
Alias (hidden)
Source
Alias.scala
def REFERENCE[T <: Tuple](table: Table[_], columns: T)(using IsColumn[T] =:= true): Reference[T]

Attributes

Inherited from:
Alias (hidden)
Source
Alias.scala
def REFERENCE[T](table: Table[_], column: Column[T]): Reference[Column[T] *: EmptyTuple]

Attributes

Inherited from:
Alias (hidden)
Source
Alias.scala
def SERIAL[T <: BigInt]: Serial[T]

===== List of Alias Date Data Types =====

===== List of Alias Date Data Types =====

Attributes

Inherited from:
DataTypes
Source
DataTypes.scala
inline def SMALLINT[T <: Short | Int | Option[Short | Int]]: Smallint[T]

Attributes

Inherited from:
DataTypes
Source
DataTypes.scala
inline def TEXT[T <: String | Option[String]](): Text[T]

Attributes

Inherited from:
DataTypes
Source
DataTypes.scala
inline def TIME[T <: String | LocalTime | Option[String | LocalTime]](fsp: 0 | 1 | 2 | 3 | 4 | 5 | 6): Time[T]

Attributes

Inherited from:
DataTypes
Source
DataTypes.scala
inline def TIME[T <: String | LocalTime | Option[String | LocalTime]]: Time[T]

Attributes

Inherited from:
DataTypes
Source
DataTypes.scala
inline def TIMESTAMP[T <: String | Instant | LocalDateTime | OffsetDateTime | ZonedDateTime | Option[String | Instant | LocalDateTime | OffsetDateTime | ZonedDateTime]](fsp: 0 | 1 | 2 | 3 | 4 | 5 | 6): TimeStamp[T]

Attributes

Inherited from:
DataTypes
Source
DataTypes.scala
inline def TIMESTAMP[T <: String | Instant | LocalDateTime | OffsetDateTime | ZonedDateTime | Option[String | Instant | LocalDateTime | OffsetDateTime | ZonedDateTime]]: TimeStamp[T]

Attributes

Inherited from:
DataTypes
Source
DataTypes.scala
inline def TINYBLOB[T <: Array[Byte] | Option[Array[Byte]]](): Tinyblob[T]

Attributes

Inherited from:
DataTypes
Source
DataTypes.scala
inline def TINYINT[T <: Byte | Short | Option[Byte | Short]]: Tinyint[T]

Attributes

Inherited from:
DataTypes
Source
DataTypes.scala
inline def TINYTEXT[T <: String | Option[String]](): TinyText[T]

Attributes

Inherited from:
DataTypes
Source
DataTypes.scala
def UNIQUE_KEY(indexName: Option[String], indexType: Option[Type], indexOption: Option[IndexOption], keyPart: Column[_]*): UniqueKey & Index

Attributes

Inherited from:
Alias (hidden)
Source
Alias.scala
def UNIQUE_KEY(indexName: String, indexType: Type, indexOption: IndexOption, keyPart: Column[_]*): UniqueKey & Index

Attributes

Inherited from:
Alias (hidden)
Source
Alias.scala
def UNIQUE_KEY(indexName: String, indexType: Type, keyPart: Column[_]*): UniqueKey & Index

Attributes

Inherited from:
Alias (hidden)
Source
Alias.scala
def UNIQUE_KEY(indexName: String, keyPart: Column[_]*): UniqueKey & Index

Attributes

Inherited from:
Alias (hidden)
Source
Alias.scala
def UNIQUE_KEY(keyPart: Column[_]*): UniqueKey & Index

Attributes

Inherited from:
Alias (hidden)
Source
Alias.scala
def UNIQUE_KEY[T]: UniqueKey & Attribute[T]

Attributes

Inherited from:
Alias (hidden)
Source
Alias.scala
inline def VARBINARY[T <: Array[Byte] | Option[Array[Byte]]](inline length: Int): Varbinary[T]

Attributes

Inherited from:
DataTypes
Source
DataTypes.scala
inline def VARCHAR[T <: String | Option[String]](inline length: Int): Varchar[T]

Attributes

Inherited from:
DataTypes
Source
DataTypes.scala
def VISIBLE[T]: Visible[T]

Attributes

Inherited from:
Alias (hidden)
Source
Alias.scala
inline def YEAR[T <: Int | Instant | LocalDate | Year | Option[Int | Instant | LocalDate | Year]]: Year[T]

Attributes

Inherited from:
DataTypes
Source
DataTypes.scala
def column[T](label: String, dataType: DataType[T], attributes: Attribute[T]*): Column[T]

Attributes

Inherited from:
Alias (hidden)
Source
Alias.scala
def column[T](label: String, dataType: DataType[T]): Column[T]

Attributes

Inherited from:
Alias (hidden)
Source
Alias.scala

Deprecated and Inherited methods

inline def BIGINT[T <: Long | BigInt | Option[Long | BigInt]](inline length: Int): Bigint[T]

Attributes

Deprecated
true
Inherited from:
DataTypes
Source
DataTypes.scala
inline def BIT[T <: Byte | Short | Int | Long | Option[Byte | Short | Int | Long]](inline length: Int): Bit[T]

===== List of Numeric Data Types =====

===== List of Numeric Data Types =====

Attributes

Deprecated
true
Inherited from:
DataTypes
Source
DataTypes.scala
inline def INT[T <: Int | Long | Option[Int | Long]](inline length: Int): Integer[T]

Attributes

Deprecated
true
Inherited from:
DataTypes
Source
DataTypes.scala
inline def MEDIUMINT[T <: Int | Option[Int]](inline length: Int): Mediumint[T]

Attributes

Deprecated
true
Inherited from:
DataTypes
Source
DataTypes.scala
inline def SMALLINT[T <: Short | Int | Option[Short | Int]](inline length: Int): Smallint[T]

Attributes

Deprecated
true
Inherited from:
DataTypes
Source
DataTypes.scala
inline def TINYINT[T <: Byte | Short | Option[Byte | Short]](inline length: Int): Tinyint[T]

Attributes

Deprecated
true
Inherited from:
DataTypes
Source
DataTypes.scala
inline def YEAR[T <: Int | Instant | LocalDate | Year | Option[Int | Instant | LocalDate | Year]](digit: 4): Year[T]

Attributes

Deprecated
true
Inherited from:
DataTypes
Source
DataTypes.scala
Generated with