org.panteleyev:persistence-kt

Annotation wrapper for SQLite and MySQL database.

License	The 2-Clause BSD License
Categories	Ant Build Tools
GroupId	org.panteleyev
ArtifactId	persistence-kt
Last Version	1.2.0
Release Date	Aug 17, 2017
Type	jar
Description	org.panteleyev:persistence-kt Annotation wrapper for SQLite and MySQL database.
Project URL	https://github.com/petr-panteleyev/persistence-kt
Source Code Management	https://github.com/petr-panteleyev/persistence-kt/tree/master

Download persistence-kt

Filename	Size
persistence-kt-1.2.0.pom
persistence-kt-1.2.0.jar	44 KB
persistence-kt-1.2.0-sources.jar	15 KB
persistence-kt-1.2.0-javadoc.jar	2 KB

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/org.panteleyev/persistence-kt/ -->
<dependency>
    <groupId>org.panteleyev</groupId>
    <artifactId>persistence-kt</artifactId>
    <version>1.2.0</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/org.panteleyev/persistence-kt/
implementation 'org.panteleyev:persistence-kt:1.2.0'

Gradle Kotlin

// https://jarcasting.com/artifacts/org.panteleyev/persistence-kt/
implementation ("org.panteleyev:persistence-kt:1.2.0")

Apache Buildr

'org.panteleyev:persistence-kt:jar:1.2.0'

Apache Ivy

<dependency org="org.panteleyev" name="persistence-kt" rev="1.2.0">
  <artifact name="persistence-kt" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='org.panteleyev', module='persistence-kt', version='1.2.0')
)

Scala SBT

libraryDependencies += "org.panteleyev" % "persistence-kt" % "1.2.0"

Leiningen

[org.panteleyev/persistence-kt "1.2.0"]

Dependencies

compile (1)

Group / Artifact	Type	Version
org.jetbrains.kotlin : kotlin-stdlib-jre8	jar	1.1.4

test (3)

Group / Artifact	Type	Version
org.xerial : sqlite-jdbc	jar	3.15.1
mysql : mysql-connector-java	jar	5.1.42
org.testng : testng	jar	6.10

Project Modules

There are no modules declared in this project.

PersistenceKt

Kotlin version of annotation based wrapper for SQLite and MySQL.

Note: this library uses the same packages and classes as java-persistence which makes them mutually exclusive in class path.

Releases

https://oss.sonatype.org/content/repositories/releases/org/panteleyev/persistence-kt/

API Documentation

https://petr-panteleyev.github.io/persistence-kt/persistence-kt

Implementation Details

Database

Database manipulation is beyond the scope of this API. Calling code must supply correct DataSource and ensure database does exist and proper access control is established.

Mutable Objects

Mutable object must implement mutable properties annotated as shown below:

@Table("book")
class Book (
        @param:Field("id")
        @get:Field(value = "id", primaryKey = true)
        override var id: Integer
        
        @param:Field("title")
        @get:Field("title")
        var title: String
): Record

Immutable Objects

Immutable objects are supported by annotation @RecordBuilder as shown below.

@Table("book")
class Book @RecordBuilder constructor (
        @param:Field("id")
        @get:Field(value = "id", primaryKey = true)
        override val id: Integer
        
        @param:Field("title")
        @get:Field("title")
        val title: String
): Record

Data Types

The following data types are supported:

Java	SQLite	MySQL	Comment
int Integer	INTEGER	INTEGER
long Long	INTEGER	BIGINT
bool Boolean	BOOLEAN	BOOLEAN
String	VARCHAR (Field.length)	VARCHAR (Field.length)
BigDecimal	VARCHAR (Field.precision + 1)	DECIMAL (Field.precision, Field.scale)	MySQL representation does not guarantee that retrieved value will be equal to original one by means of Object.equals(Object). Use BigDecimal.compareTo(BigDecimal) instead.
Date	INTEGER	BIGINT	Dates are stored as long using Date.getTime()

Indexes and Foreign Keys

Parent Table

@Table("parent_table")
data class ParentTable : Record {
    @get:Field("data")
    @get:Index("data", unique = true)
    var data: String?
}

This will produce the following SQL for indexed field:

CREATE UNIQUE INDEX data ON parent_table(data)

Child Table

@Table("child_table")
data class ChildTable : Record {
        // ...
        @get:Field("cascade_value")
        @get:ForeignKey(table = ParentTable::class, field = "data",
                onDelete = ReferenceOption.RESTRICT, onUpdate = ReferenceOption.CASCADE)
        val cascadeValue: String?
        // ...
}

This will produce the following SQL for the foreign key:

CREATE FOREIGN KEY(parent_data) REFERENCES parent_table(data) ON DELETE RESTRICT ON UPDATE CASCADE

Versions

Version
1.2.0 Aug 17, 2017
1.1.0 Jul 9, 2017
1.0.0 Jun 25, 2017