Java API for MySQL

Annotation based Java API for MySQL.

The library is intended for desktop applications that perform insert/update/delete operations only.

Limitations

• Each new version may introduce incompatible changes
• No queries, either mapped or raw
• Basic support for constraints
• No support for schema migration in case of changes

Java Records

Java records are supported same way as usual immutable objects (more details in javadoc) with the following limitations:

• The canonical constructor plays the role of record builder, @RecordBuilder annotation is ignored even if present.
• All record components must be annotated with @Column, i.e., record must be an exact representation of database table.

Data Types

Java	MySQL
String	VARCHAR
String with Column.isJson() = true	JSON
BigDecimal	DECIMAL ( Column.precision(), Column.scale() )
Date	BIGINT
LocalDate	BIGINT
byte[]	VARBINARY ( Column.length() )
UUID	BINARY(16) or VARCHAR(36)

java.util.Date are stored as long using Date.getTime() java.time.LocalDate is stored as long using LocalDate.toEpochDay()

The following types can be used as primary keys:

• Integer, int
• Long, long
• String
• UUID

Database independent auto-increment is supported for integer and long keys.

Usage Examples

Immutable Object

@Table("book")
public class Book implements Record {
    @PrimaryKey
    @Column(Field.ID)
    private final int id;
    
    @Column("title")
    private final String title;

    @RecordBuilder
    public Book(@Column(Column.ID) int id, 
                @Column("title") String title) 
    {
        this.id = id;
        this.title = title;
    }

    public int getId() {
        return id;
    }

    public String getTitle() {
        return title;
    }
}

Java Record

@Table("record_as_record_table")
public record Book(
    @PrimaryKey
    @Column(Column.ID)
    Integer id,

    @Column("title")
    String title
) implements Record<Integer> {    
}

Foreign Keys

@Table("parent_table")
public class ParentTable implements Record {
    @Column(value = "data", unique = true)
    private String data;

    public String getData() {
        return data;
    }
}

@Table("child_table")
public class ChildTable implements Record {
    @Column("parent_data")
    @ForeignKey(table = ParentTable.class, column = "data",
        onDelete = ReferenceOption.RESTRICT, onUpdate = ReferenceOption.CASCADE)
    private final String parentData;

    public String getParentData() {
        return parentData;
    }
}