florent37/rxandroidorm

An reactive simple & fluent Android ORM, how can it be easier ? RxJava2 ready

RxAndroidOrm

Download

dependencies {
    compile 'com.github.florent37:rxandroidorm:1.0.1'
    provided 'com.github.florent37:rxandroidorm-annotations:1.0.1'
    annotationProcessor 'com.github.florent37:rxandroidorm-compiler:1.0.1'
}

A simple & fluent Android ORM, how can it be easier ? And it's compatible with RxJava2 !

Observable.fromArray(
                new Computer(Computer.WINDOWS, "MasterRace", Arrays.asList(new Software("Photoshop"))),
                new Computer(Computer.WINDOWS, "Gamerz"),
                new Computer(Computer.LINUX, "MasterRace", Arrays.asList(new Software("Gimp"))))
                .flatMap(computerDb::add)
                .subscribe();

Observable.just(new Computer(Computer.MAC, "Mac Mini"))
                .flatMap(computerDb::add)
                .doOnNext(computer -> computer.getSoftwares().add(new Software("Photoshop")))
                .flatMap(computerDb::update)
                .subscribe();

computerDb.select()
                .label().equalsTo("MasterRace")
                .or()
                .softwares(SoftwareDatabase.where().name().equalsTo("Photoshop"))

                .asObservable()
                .subscribe(computers -> Log.d(TAG, computers.toString()));

First, initialize !

Don't forget to initialise RxAndroidOrm in your applicarion:

public class MyApplicarion extends Applicarion {

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

}

Second, annotate your models

Use Annotations to mark classes to be persisted:

@Model
public class Computer {

    @Id long id;
    String name;
   
    List<Software> softwares;
}

Logging

You can log all SQL queries from entities managers:

computerDb.logQueries((query, datas) -> Log.d(TAG, query) }

TODO

• Enum support

Credits

Author: Florent Champigny http://www.florentchampigny.com/

Blog : http://www.tutos-android-france.com/

License

Copyright 2017 Florent37, Inc.

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.

rxandroidorm's Issues

Cannot get 1.0.1

Hi @florent37,

I can't get the library v1.0.1 on gradle anymore. There is probably an issue in your publish conf.

Error:Failed to resolve: annotationProcessor

Another issue

It looks like the Database interface added in #2 (and all the static java files) are not generated if there is no @model annotations in models. I didn't see it yesterday. It could be interesting to generate these files no matter if this annotation is used.
IMHO, these statics java classes could be created in your library directly (and not generated) to improve maintainability.

Thank you ;)

Parent interface on databases

Hi Florent,

I wanted to implements a version of store2store with your orm. For now I have an issue with your generated code of ObjectDatabase.

To extends and use correctly your library a common interface between databases is needed.

Something like :

public interface Database<T> {
    QueryBuilder select(final T object);    
    
    Observable<T> add(final T object);

    Observable<List<T>> add(final List<T> objects);

    Observable<T> update(final T object);

    Observable<List<T>> update(final List<T> objects);

    Observable<Boolean> exists(SQLiteDatabase db, final T object); // It should be possible to remove the SQLiteDatabase param here :)

    Observable<Boolean> delete(final T object);

    Observable<Boolean> delete(final List<T> objects);

    Observable<Boolean> deleteAll();

    Observable<Integer> count();
}

Then in the generated class :

public class ComputerDatabase extends Database<Computer> {
 // ...
}

Let the generated Databases classes implementing this interface could help us to abstract a little bit more our code and do not depends on concretes classes.

If you want me to do a pull request for that, let me know ;)

Thank you,
Thibaud.