Yet another Android library for database
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
app
gradle/wrapper
.gitignore
.travis.yml
LICENSE
README.md
build.gradle
gradle.properties
gradlew
gradlew.bat
settings.gradle

README.md

SQLite Apache License Build Status Coverage Status

Yet another Android library for database

Database library for Android based on SQLite and ContentProvider, which provides simple way for all operations with data.

Advantages:

  • 0 reflection
  • Full customization (since library is a simple wrapper on ContentProvider you can always have direct access to it)
  • Flexible interface for manipulating data
  • Data migration
  • RxJava support

Gradle

compile 'ru.arturvasilov:sqlite:0.2.0'

Tables:

Instead of generating code and using your model classes for database directly, this library uses tables classes for each table in database (or in fact for each class you want to store). It's routine to write these classes but it also give you more control, which is useful for features like data migration.

So for each table in database you have to create a class which extends Table interface or BaseTable class like this:

public class PersonTable extends BaseTable<Person> {

    public static final Table<Person> TABLE = new PersonTable();

    public static final String ID = "id";
    public static final String NAME = "name";
    public static final String AGE = "age";

    @Override
    public void onCreate(@NonNull SQLiteDatabase database) {
        TableBuilder.create(this)
                .intColumn(ID)
                .textColumn(NAME)
                .intColumn(AGE)
                .primaryKey(ID)
                .execute(database);
    }

    @NonNull
    @Override
    public ContentValues toValues(@NonNull Person person) {
        ContentValues values = new ContentValues();
        values.put(ID, person.getId());
        values.put(NAME, person.getName());
        values.put(AGE, person.getAge());
        return values;
    }

    @NonNull
    @Override
    public Person fromCursor(@NonNull Cursor cursor) {
        int id = cursor.getInt(cursor.getColumnIndex(ID));
        String name = cursor.getString(cursor.getColumnIndex(NAME));
        int age = cursor.getInt(cursor.getColumnIndex(AGE));
        return new Person(id, name, age);
    }
}

Setting Up

After creating tables your need to specify ContentProvider, where you add these tables:

public class SQLiteProvider extends SQLiteContentProvider {

    private static final String DATABASE_NAME = "mydatabase.db";
    private static final String CONTENT_AUTHORITY = "com.myapp";

    @Override
    protected void prepareConfig(@NonNull SQLiteConfig config) {
        config.setDatabaseName(DATABASE_NAME);
        config.setAuthority(CONTENT_AUTHORITY);
    }

    @Override
    protected void prepareSchema(@NonNull Schema schema) {
        schema.register(PersonTable.TABLE);
    }
}

And register it in the AndroidManifest.xml:

<provider
    android:name=".sqlite.SQLiteProvider"
    android:authorities="com.myapp"
    android:exported="false"/>

And initialize SQLite:

public class MyApplication extends Application {

    @Override
    public void onCreate() {
        super.onCreate();
        SQLite.initialize(this);
    }
}

Supported data types

  1. int, short and long are supported with intColumn method
  2. boolean is also supported with intColumn method, but you still have to manually convert it in Table#toValues and Table#fromCursor methods
  3. double and float are supported with realColumn.
  4. String, enums and custom objects should be saved as TEXT with textColumn method. For custom objects you may consider json serialization (relations is not in the nearest plan).

Operations

All operations should go through the SQLite or RxSQLite classes. You can access to ContentProvider directly, but note that you can loose features like observing changes in tables.

Every operation (query, insert, update, delete) exist both in direct and rx ways.

You can query for data like so:

Person person = SQLite.get().queryObject(PersonTable.TABLE);
// or for list
List<Person> persons = SQLite.get().query(PersonTable.TABLE);
// or with where
List<Person> adults = SQLite.get().query(PersonTable.TABLE, Where.create().greaterThanOrEqualTo(PersonTable.AGE, 18));

Similar way for RxSQLite:

RxSQLite.get().query(PersonTable.TABLE)
        .subscribe(persons -> {
            //do something with persons
        });

Note: RxSQLite doesn't take care about doing operations in background - it's up to your.

And it's all the same for other operations.

Observing changes

Observing changes in database is a great way for communication between your UI classes and network layer. This library provides flexible implementation of this pattern.

Note that starting from version 0.1.3 automatic notifications are disabled by default. You can either update call SQLite.get().notifyTableChanged(Table) manually or enable automatic notifications (notifications will be send for each single operation) with SQLite.get().enableAutomaticNotifications().

Notifications about changes in table are called in the main thread.

Get notified when table changed:

public class MainActivity extends AppCompatActivity implements BasicTableObserver {

    // ...

    @Override
    protected void onResume() {
        super.onResume();
        SQLite.get().registerObserver(PersonTable.TABLE, this);
    }

    @Override
    protected void onPause() {
        super.onPause();
        SQLite.get().unregisterObserver(this);
    }

    @Override
    public void onTableChanged() {
        // You now know that content in the table has changed
    }

}

If you also want to get all the content from database (typical for the observing changes), you can change BasicTableObserver to ContentTableObserver and implement it's method:

@Override
public void onTableChanged(@NonNull List<Person> persons) {
    // handle changed persons
}

Everything else is the same! And more, you don't need to care about performance, for these changes library reads queries tables in the background already. Note: that's why you should be careful using this type of subscribption - frequent changes in table may affect your app.

It's even more flexible with RxSQLite:

private Disposable mPersonsDisposable;

//...

@Override
protected void onResume() {
    super.onResume();
    mPersonsDisposable = RxSQLite.get().observeChanges(PersonTable.TABLE)
                .subscribe(value -> {
                    // table changed
                });
}

@Override
protected void onPause() {
    super.onPause();
    mPersonsDisposable.dispose();
}

You can also query all the table with one simple call:

mPersonsDisposable = RxSQLite.get().observeChanges(PersonTable.TABLE).withQuery().subscribe(persons -> {});

Note you still have to manage subscription manually.

Data migration

Data migration is always is most painful part. Library provides you a way to update the table and decide how it should be updated.

Each table has method getLastUpgradeVersion, which by default returns 1. Current database version is the maximum of all tables versions.

If you changed any table, simple update it's version. All others table won't be affected, if their version is less than maximum:

@Override
public int getLastUpgradeVersion() {
    return 2;
}

By default, onUpdate method simply recreates the table, but you can customize it by overriding this method:

@Override
public void onUpgrade(@NonNull SQLiteDatabase database) {
    database.execSQL("DROP TABLE IF EXISTS " + getTableName());
    onCreate(database);
}

Samples:

StackDroid application uses this library to work with database.

Future plans

  1. Support temporary entries in database
  2. Generate most of boilerplate code
  3. Support relations
  4. Add triggers and functions

Issues

Feel free to create issues or even pull requests!