DBFlow for Android lets you write very efficient database code while remaining expressive and concise.
@Table(database = AppDatabase.class)
public class Automobile extends BaseModel { // extending BaseModel not required, you can also implement Model
@PrimaryKey
String vin;
@Column
String make;
@Column
String model;
@Column
int year;
}
Automobile venza = new Automobile();
venza.vin = "499499449";
venza.make = "Toyota";
venza.model = "Venza";
venza.year = 2013;
venza.save(); // inserts if not exists by primary key, updates if exists.
// querying
// SELECT * FROM `Automobile` WHERE `year`=2001 AND `model`='Camry'
// we autogen a "_Table" class that contains convenience Properties which provide easy SQL ops.
SQLite().select()
.from(Automobile.class)
.where(Automobile_Table.year.is(2001))
.and(Automobile_Table.model.is("Camry"))
.async()
.queryResultCallback(new QueryTransaction.QueryResultCallback<TestModel1>() {
@Override
public void onQueryResult(QueryTransaction transaction, @NonNull CursorResult<TestModel1> tResult) {
// called when query returns on UI thread
List<Automobile> autos = tResult.toListClose();
// do something with results
}
}, new Transaction.Error() {
@Override
public void onError(Transaction transaction, Throwable error) {
// handle any errors
}
}).execute();
// run a transaction synchronous easily.
DatabaseDefinition database = FlowManager.getDatabase(AppDatabase.class);
database.executeTransaction(new ITransaction() {
@Override
public void execute(DatabaseWrapper databaseWrapper) {
// do something here
}
});
// run asynchronous transactions easily, with expressive builders
database.beginTransactionAsync(new ITransaction() {
@Override
public void execute(DatabaseWrapper databaseWrapper) {
// do something in BG
}
}).success(successCallback).error(errorCallback).build().execute();Since DBFlow uses annotation processing, which is run pre-proguard phase, the configuration is highly minimal:
-keep class * extends com.raizlabs.android.dbflow.config.DatabaseHolder { *; }
For migrating from 2.x to 3.0, read here
The list of documentation is listed here:
For advanced DBFlow usages: