Skip to content

Latest commit

 

History

History
145 lines (131 loc) · 4.51 KB

LibDocumentation.md

File metadata and controls

145 lines (131 loc) · 4.51 KB
Raw

Dependencies

Exposed modules are available from Maven Central repository. To use them you have to add appropriate dependency into your repositories mapping.

Maven

<!-- Versions after 0.30.1 -->
<!-- Versions before 0.30.1 is unavailable for now-->
<repositories>
    <repository>
        <id>mavenCentral</id>
        <name>mavenCentral</name>
        <url>https://repo1.maven.org/maven2/</url>
    </repository>
</repositories>

Gradle Groovy and Kotlin DSL

repositories {
    // Versions after 0.30.1
    // Versions before 0.30.1 is unavailable for now
    mavenCentral()
}

Base Modules

Exposed 0.17.x and lower

Prior Exposed 0.18.1 there was only one base module exposed which contains everything you may need including JodaTime as date-time library. To add Exposed framework of that version you had to use:

Maven

<dependencies>
  <dependency>
    <groupId>org.jetbrains.exposed</groupId>
    <artifactId>exposed</artifactId>
    <version>0.17.7</version>
  </dependency>
</dependencies>

Gradle Groovy

dependencies {
  implementation 'org.jetbrains.exposed:exposed:0.17.7'
}

Gradle Kotlin DSL

dependencies {
    implementation("org.jetbrains.exposed", "exposed", "0.17.7")
}

Exposed 0.18.1 and higher

To move forward and support such features as Java 8 Time, async drivers and so on it was decided to split Exposed into more specific modules. It will allow you to take the only modules you need and will add flexibility in the future.

At the moment Exposed coexists of provided modules

  • exposed-core - base module, which contains both DSL api along with mapping
  • exposed-dao - DAO api
  • exposed-jdbc - transport level implementation based on Java JDBC API
  • exposed-jodatime - date-time extensions based on JodaTime library
  • exposed-java-time - date-time extensions based on Java8 Time API
  • exposed-kotlin-datetime - date-time extensions based on kotlinx-datetime
  • exposed-money - extensions to support MonetaryAmount from "javax.money:money-api"
  • exposed-crypt - provides additional column types to store encrypted data in DB and encode/decode it on client-side
  • exposed-json - JSON and JSONB data type extensions (see [[How to use Json and JsonB types|DataTypes#how-to-use-json-and-jsonb-types]])

Dependencies mapping listed bellow is similar (by functionality) to the previous versions:

Maven

<dependencies>
  <dependency>
    <groupId>org.jetbrains.exposed</groupId>
    <artifactId>exposed-core</artifactId>
    <version>0.43.0</version>
  </dependency>
  <dependency>
    <groupId>org.jetbrains.exposed</groupId>
    <artifactId>exposed-dao</artifactId>
    <version>0.43.0</version>
  </dependency>
  <dependency>
    <groupId>org.jetbrains.exposed</groupId>
    <artifactId>exposed-jdbc</artifactId>
    <version>0.43.0</version>
  </dependency>
  <dependency>
    <groupId>org.jetbrains.exposed</groupId>
    <artifactId>exposed-jodatime</artifactId>
    <version>0.43.0</version>
  </dependency>
  <dependency>
    <groupId>org.jetbrains.exposed</groupId>
    <artifactId>exposed-java-time</artifactId>
    <version>0.43.0</version>
  </dependency>
</dependencies>

Gradle Groovy

dependencies {
  implementation 'org.jetbrains.exposed:exposed-core:0.43.0'
  implementation 'org.jetbrains.exposed:exposed-dao:0.43.0'
  implementation 'org.jetbrains.exposed:exposed-jdbc:0.43.0'
  implementation 'org.jetbrains.exposed:exposed-jodatime:0.43.0'
  // or
  implementation 'org.jetbrains.exposed:exposed-java-time:0.43.0'
}

Gradle Kotlin DSL

In build.gradle.kts:

val exposedVersion: String by project
dependencies {
    implementation("org.jetbrains.exposed:exposed-core:$exposedVersion")
    implementation("org.jetbrains.exposed:exposed-dao:$exposedVersion")
    implementation("org.jetbrains.exposed:exposed-jdbc:$exposedVersion")
    implementation("org.jetbrains.exposed:exposed-jodatime:$exposedVersion")
    // or
    implementation("org.jetbrains.exposed:exposed-java-time:$exposedVersion")
}

and in gradle.properties

exposedVersion=0.43.0

JDBC driver and logging

You also need a JDBC driver for the database system you are using (see [[Database and DataSource|Database-and-DataSource]]) and a logger for addLogger(StdOutSqlLogger). Example (Gradle syntax):

dependencies {
    // for H2
    implementation("com.h2database:h2:2.1.214")
    // for logging (StdOutSqlLogger), see
    // http://www.slf4j.org/codes.html#StaticLoggerBinder
    implementation("org.slf4j:slf4j-nop:1.7.30")
}