https://github.com/zoff99/sorma2
Simple ORM(Android) based on https://github.com/maskarade/Android-Orma
https://github.com/zoff99/sorma2
android desktop generator java jdbc jvm linux macos orm sqlcipher sqlite windows
Last synced: about 1 month ago
JSON representation
Simple ORM(Android) based on https://github.com/maskarade/Android-Orma
- Host: GitHub
- URL: https://github.com/zoff99/sorma2
- Owner: zoff99
- License: gpl-3.0
- Created: 2024-04-14T10:39:06.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2026-03-28T19:10:28.000Z (2 months ago)
- Last Synced: 2026-03-28T21:06:23.843Z (2 months ago)
- Topics: android, desktop, generator, java, jdbc, jvm, linux, macos, orm, sqlcipher, sqlite, windows
- Language: Java
- Homepage:
- Size: 200 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Sorma2 - Simple ORM(Android)2 (also for Desktop)
sorma2 is a two-phase ORM system that generates Java code from annotated schema definitions during development, then uses that generated code at runtime for database operations.
It is based on the wonderful https://github.com/maskarade/Android-Orma by [FUJI Goro](https://github.com/gfx)
This is a rewrite in pure java, to generate most stuff you need and then add it to your project
either as a ```.jar file``` or as ```java source```.
You still need to add ```sqlite-jdbc-3.51.3.0.jar``` to your project to use it.
~~sadly [sqlite-jdbc](https://github.com/xerial/sqlite-jdbc) project decided that it needs ```slf4j-api jar``` (for no good reason).~~
this was solved by: https://github.com/xerial/sqlite-jdbc/pull/1178
see: https://github.com/xerial/sqlite-jdbc/issues/1094
[](https://github.com/zoff99/iocipher_pack/actions/workflows/ci.yml)
[](https://www.gnu.org/licenses/gpl-3.0.en.html)
[](https://liberapay.com/zoff/donate)
[](https://deepwiki.com/zoff99/sorma2)
## What is Sorma2?
sorma2 is a pure Java code generator designed for efficient SQLite database access. It is suitable for both Android and Desktop Java applications.
- **Purpose:** Generates Java source code for SQLite ORM based on schema definition files.
- **Approach:** Unlike runtime ORMs, Sorma2 generates all necessary code at development time, avoiding reflection overhead and ensuring compile-time type safety.
## Architecture
### 1. Development Phase
- Developers write schema files prefixed with `_sorm_`.
- Schema files contain annotated Java class definitions.
- The **Generator** class processes these files to produce complete ORM implementation code.
### 2. Runtime Phase
- The generated code offers a fluent API for database operations.
- Platform-specific JDBC drivers handle actual SQLite communication.
## Key Characteristics
- **No Reflection at Runtime:** Improves performance and type safety.
- **Readable Java Source Code:** Generated code is clear and maintainable.
- **Type-safe Query Building API:** Ensures compile-time correctness.
- **Support for Encrypted Databases:** Compatible with SQLCipher.
- **Multi-threaded Operation:** Supports WAL mode for concurrency.
- **Cross-platform Compatibility:** Works on Android API 21+ and Desktop Java 17+.
# Usage
create one file for each database table that you need.
create file for db table `Person` as `./gen/_sorm_Person.java`
(don't worry it is not really Java, we just use the syntax here)
```Java
@Table
public class Person
{
@PrimaryKey(autoincrement = true)
public long id;
@Column
public String name;
@Column
public String address;
@Column
public int social_number;
}
```
now create the Java sources with the Java SORMA2 Generator. you need at least java 17.
```bash
java -classpath ".:sqlite-jdbc-3.51.3.0.jar:sorma2.jar" \
com/zoffcc/applications/sorm/Generator "gen"
```
your project is now ready to start.
enter the generator directory:
```bash
cd ./gen/
ls -al
```
now move or copy all *.java files from the generator directory into your Android or Java project source tree
```bash
cd gen/
# remove class files
find . -name '*.class'|xargs rm -v
cp -av ./com /home/user/your/project/source/tree/
```
in your Java project you will need the `sqlite jdbc jar` and in your
Android project you will need `com.github.zoff99:pkgs_zoffccAndroidJDBC` from [jitpack.io](https://jitpack.io/#zoff99/pkgs_zoffccAndroidJDBC)
add this dependency to your `build.gradle` file
```
implementation 'com.github.zoff99:pkgs_zoffccAndroidJDBC:1.0.24'
```
Android Example App:
------------------------
see: https://github.com/zoff99/sorma2/tree/master/example_android
Linux Java Example App:
------------------------
see: https://github.com/zoff99/sorma2/tree/master/test
Use the `sorma_generated.jar` (that is generated in the `gen` directory) and `sqlite-jdbc-3.51.3.0.jar` for the Java project.
Check `TestSorma.java` for an Example usage.
Desktop (Linux / Windows / macOS) Gradle Example Project
------------------------
see: https://github.com/zoff99/sorma2/tree/master/example_gradle_linux
Any use of this project's code by GitHub Copilot, past or present, is done
without our permission. We do not consent to GitHub's use of this project's
code in Copilot.
No part of this work may be used or reproduced in any manner for the purpose of training artificial intelligence technologies or systems.