Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/novoda/sqlite-analyzer
Code generation for Java/Android database access.
https://github.com/novoda/sqlite-analyzer
novoda open-source sqlite-analyzer sqlite-database
Last synced: 3 months ago
JSON representation
Code generation for Java/Android database access.
- Host: GitHub
- URL: https://github.com/novoda/sqlite-analyzer
- Owner: novoda
- License: other
- Archived: true
- Created: 2014-01-17T16:27:22.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2022-02-11T01:11:49.000Z (almost 3 years ago)
- Last Synced: 2024-07-01T10:57:10.524Z (5 months ago)
- Topics: novoda, open-source, sqlite-analyzer, sqlite-database
- Language: Java
- Homepage:
- Size: 4.58 MB
- Stars: 65
- Watchers: 54
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# 🛑 THIS REPOSITORY IS OFFICIALLY NO LONGER UNDER MAINTENANCE since 10/02/2022 🛑
# sqlite-analyzer [](https://ci.novoda.com/job/sqlite-analyzer/lastBuild/console) [](https://bintray.com/novoda/maven/sqlite-analyzer/_latestVersion) [](https://github.com/novoda/sqlite-analyzer/blob/master/LICENSE.txt)
Code generation for Java/Android database access.
## Description
Generates java/android database access code by analysing sqlite migration files or sqlite databases,
keeping full control of what code is generated.
sqlite-analyzer creates an in-memory sqlite database, either from a given database file or by reading sql migrations,
and analyzes its tables to construct a DatabaseModel. This model is then used to generate database access code.
This project uses [sqlite-jdbc](https://bitbucket.org/xerial/sqlite-jdbc) to create and analyze the database.
[Groovy](http://groovy.codehaus.org/) is used to generate code, [Gradle](http://www.gradle.org/) to hook
the functionality into the [android build system](http://tools.android.com/tech-docs/new-build-system).
## Adding to your project
To integrate sqlite-analyzer into your project, add the following at the beginning of the `build.gradle` of your project:
```groovy
buildscript {
repositories {
jcenter()
}
dependencies {
classpath 'com.novoda:sqlite-analyzer:0.3.2'
}
}
```
To use the library with [sqlite-provider](https://github.com/novoda/sqlite-provider), add these lines to the `build.gradle` of your project:
```groovy
apply plugin: 'com.novoda.sqlite-analyzer'
sqliteAccess {
migrationsDir 'src/main/assets/migrations'
packageName 'com.novoda.sqliteprovider.demo.simple'
}
```
See the sample projects for setup with [android-sqlite-asset-helper](https://github.com/jgilfelt/android-sqlite-asset-helper).
## Simple usage
Try `./gradlew clean assembleDebug` and observe the generated code under `build/generated/source/sqlite/debug/`.
By default, it contains one single class `DB` that defines constants for the names of the tables and columns and
introduces static accessor methods as well as model classes for all tables data.
The project comes with 2 demo applications that create and use database access code,
one uses [sqlite-provider](https://github.com/novoda/sqlite-provider),
the other uses [android-sqlite-asset-helper](https://github.com/jgilfelt/android-sqlite-asset-helper).
**Use column names**
``` java
queryBuilder.appendWhere(DB.Columns.Shop.Name + " like 'A%'")
```
Simplified use with static import
``` java
projection = new String[] {Employees.Firstname, Employees.Lastname};
```
**Use model classes**
``` java
public void onLoadFinished(Loader cursorLoader, Cursor cursor) {
DB.Shop shop = DB.Shop.fromCursor(cursor);
}
```
**Use helpers for ContentValues**
``` java
ContentValues values = new ContentValues(1);
DB.Shop.setName("New Shop", values);
```
## Links
Here are a list of useful links:
* We always welcome people to contribute new features or bug fixes, [here is how](https://github.com/novoda/novoda/blob/master/CONTRIBUTING.md)
* If you have a problem check the [Issues Page](https://github.com/novoda/sqlite-analyzer/issues) first to see if we are working on it
* For further usage or to delve more deeply checkout the [Project Wiki](https://github.com/novoda/sqlite-analyzer/wiki)
* Looking for community help, browse the already asked [Stack Overflow Questions](http://stackoverflow.com/questions/tagged/support-sqlite-analyzer) or use the tag: `support-sqlite-analyzer` when posting a new question