https://github.com/agrosner/dbflowdocs
DBFlow documentation project.
https://github.com/agrosner/dbflowdocs
Last synced: 3 months ago
JSON representation
DBFlow documentation project.
- Host: GitHub
- URL: https://github.com/agrosner/dbflowdocs
- Owner: agrosner
- Created: 2017-05-12T13:29:13.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2018-04-08T00:07:17.000Z (about 7 years ago)
- Last Synced: 2025-01-11T01:49:46.790Z (5 months ago)
- Size: 76.2 KB
- Stars: 18
- Watchers: 4
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# DBFlow
DBFlow is a SQLite library for Android that makes it ridiculously easy to interact and use databases. Built with Annotation Processing that generates most of the boilerplate code for you, code use within a DB is fast, efficient, and type-safe. It removes the tedious \(and tough-to-maintain\) database interaction code.
Creating a database is as easy as a few lines of code:
```java
@Database(name = AppDatabase.NAME, version = AppDatabase.VERSION)
public class AppDatabase {
public static final String NAME = "AppDatabase";
public static final int VERSION = 1;
}
```
The `@Database` annotation generates a `DatabaseDefinition` which now references your SQLite Database on disk in the file named "AppDatabase.db". You can reference it in code as:
```java
DatabaseDefinition db = FlowManager.getDatabase(AppDatabase.class);
```
To ensure generated code in DBFlow is found by the library, initialize the library in your `Application` class:
```java
public class MyApp extends Application {
@Override
public void onCreate() {
super.onCreate();
FlowManager.init(this);
}
}
```
By default, DBFlow generates the `GeneratedDatabaseHolder` class, which is instantiated once by reflection, only once in memory.
Creating a table is also very simple:
```java
@Table(database = AppDatabase.class)
public class User {
@PrimaryKey // at least one primary key required
UUID id;
@Column
String name;
@Column
int age;
}
```
Then to create, read, update, and delete the model:
```java
User user = new User();
user.id = UUID.randomUUID();
user.name = "Andrew Grosner";
user.age = 27;
ModelAdapter adapter = FlowManager.getModelAdapter(User.class);
adapter.insert(user);
user.name = "Not Andrew Grosner";
adapter.update(user);
adapter.delete(user);
// if you extend BaseModel or implement Model
user.insert();
user.update();
user.delete();
user.save();
// find adult users
List users = SQLite.select()
.from(User.class)
.where(User_Table.age.greaterThan(18))
.queryList();
// or asynchronous retrieval
SQLite.select()
.from(User.class)
.where(User_Table.age.greaterThan(18))
.async()
.queryListCallback((QueryTransaction transaction, @NonNull CursorResult result) -> {
// called when query returns on UI thread
try {
List users = result.toList();
// do something with users
} finally {
result.close();
}
})
.error((Transaction transaction, Throwable error) -> {
// handle any errors
})
.execute();
```