ldbc-core
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
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object armscii8.type
object ascii.type
object big5.type
object binary.type
object cp1250.type
object cp1251.type
object cp1256.type
object cp1257.type
object cp850.type
object cp852.type
object cp866.type
object cp932.type
object dec8.type
object eucjpms.type
object euckr.type
object gb18030.type
object gb2312.type
object gbk.type
object geostd8.type
object greek.type
object hebrew.type
object hp8.type
object keybcs2.type
object koi8r.type
object koi8u.type
object latin1.type
object latin2.type
object latin5.type
object latin7.type
object macce.type
object macroman.type
object sjis.type
object swe7.type
object tis620.type
object ucs2.type
object ujis.type
object utf16.type
object utf16le.type
object utf32.type
object utf8mb3.type
object utf8mb4.type
Show all
object Character

Attributes

Companion
trait
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
Supertypes
class Object
trait Matchable
class Any
object Collate

Attributes

Companion
trait
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
Supertypes
class Object
trait Matchable
class Any
object Column

Attributes

Companion
trait
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
Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait BlobType[T]
trait StringType[T]
Self type
object DataType

Attributes

Companion
trait
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

Supertypes
class Object
trait Matchable
class Any
trait Database

A model representing SQL database information.

A model representing SQL database information.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object Database

Attributes

Companion
trait
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
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Date
object Null.type
class TimeStamp
class Value[T]
object Default

Attributes

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

Attributes

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
Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
case Unknown
object JdbcType

Attributes

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

Attributes

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
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Reference

Attributes

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

Attributes

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

Attributes

Companion
object
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
Supertypes
class Object
trait Matchable
class Any
Self type
object UniqueKey

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
UniqueKey.type

Inherited classlikes

object COLUMN_FORMAT

Attributes

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

Attributes

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

Inherited types

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

Inherited from:
Alias (hidden)

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)
inline def BIGINT[T <: Long | BigInt | Option[Long | BigInt]]: Bigint[T]

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

Inherited from:
DataTypes
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
def COMMENT[T](message: String): Comment[T]

Attributes

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

Attributes

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

Attributes

Inherited from:
Alias (hidden)
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
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
inline def DATETIME[T <: String | Instant | LocalDateTime | OffsetTime | Option[String | Instant | LocalDateTime | OffsetTime]]: DateTime[T]

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

Inherited from:
DataTypes
def INVISIBLE[T]: InVisible[T]

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

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

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

Inherited from:
DataTypes
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
inline def TIMESTAMP[T <: String | Instant | LocalDateTime | OffsetDateTime | ZonedDateTime | Option[String | Instant | LocalDateTime | OffsetDateTime | ZonedDateTime]]: TimeStamp[T]

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

Inherited from:
DataTypes
def VISIBLE[T]: Visible[T]

Attributes

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

Attributes

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

Attributes

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

Attributes

Inherited from:
Alias (hidden)

Deprecated and Inherited methods

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

Attributes

Deprecated
true
Inherited from:
DataTypes
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
inline def INT[T <: Int | Long | Option[Int | Long]](inline length: Int): Integer[T]

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

Deprecated
true
Inherited from:
DataTypes
Generated with