aaaliua / ollie

Compile-time active record ORM for Android

Ollie

Compile-time active record ORM for Android.

• Multiple mapping methods.
  • SQLiteDatabase-like interface (QueryUtils.java).
  • Lightweight query builder (Select.from()).
  • Cursors (Ollie.processorCursor()).
• Model inheritence.
• RxJava support.
• Generated content providers.
• Query debug logging.

Usage

Define model

@Table("notes")
class Note extends Model {
	@Column("title")
	public String title;
	@Column("body")
	public String body;
}

Initialize

Ollie.with(context)
	.setName(DB_NAME)
	.setVersion(DB_VERSION)
	.setLogLevel(LogLevel.FULL)
	.setCacheSize(CACHE_SIZE)
	.init();

Update database

Note note = new Note();
note.title = "My note";
note.body = "This is my note.";
note.save();

Query database

// Get all notes
List<Note> notes = Select.from(Note.class).fetch();

// Get a single note
Note note = Select.from(Note.class).fetchSingle();

// Get notes table count
Integer count = Select.columns("COUNT(*)").from(Note.class).fetchValue(Integer.class);

// Get observable of all notes
Select.from(Note.class).observable()
	.subscribe(notes -> {
		// do stuff with notes
	});

// Get observable of a single note
Select.from(Note.class).observableSingle()
	.subscribe(note -> {
		// do stuff with note
	});
	
// Get observable of notes table count
Select.columns("COUNT(*)").from(Note.class).observableValue(Integer.class)
	.subscribe(count -> {
		// do stuff with count
	});

Download

Grab via Maven:

<dependency>
  <groupId>com.michaelpardo</groupId>
  <artifactId>ollie</artifactId>
  <version>0.3.1</version>
</dependency>
<dependency>
  <groupId>com.michaelpardo</groupId>
  <artifactId>ollie-compiler</artifactId>
  <version>0.3.1</version>
  <optional>true</optional>
</dependency>

or Gradle:

compile 'com.michaelpardo:ollie:0.3.1'
provided 'com.michaelpardo:ollie-compiler:0.3.1'

Latest snapshot: 0.3.2-SNAPSHOT

Build

To build:

$ git clone [email protected]:pardom/ollie.git
$ cd ollie/
$ ./gradlew build

License

Copyright 2014 Michael Pardo

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.