A simple, locally stored, document database for Android.
Java
Switch branches/tags
Nothing to show
Clone or download
Pull request Compare This branch is 1 commit ahead, 2 commits behind CalorieCount:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
dependencies
src/TattooDB
.gitignore
README.md

README.md

TattooDB

A simple, locally stored, document database for Android.

TattooDB db = new TattooDB(context);

MyModel model = new MyModel();
model.name = "Joel";

// store a record
db.put("1", model);

// retrieve a record;
MyModel retrieved = db.get("1", MyModel.class);
Log.i(TAG, retrieved.name); // "Joel"

// delete a record
db.delete("1", MyModel.class);

This was designed to reduce the number of concepts a developer would have to understand in order to store data locally. All you have to worry about is three methods: put, get, delete. You can store any Java class, and there is no setup or configuration needed. TattooDB uses SQLite as the underlying storage mechanism by default, but this can be overridden and a custom implementation provided if you would rather use something else (such as manually writing to disk).

As this is a document database, you will have to be mindful about how you design your object model. There are many "NoSQL" schema design resources on the web, but the basic idea is that you design your data model to encapsulate an entire document in a record. You would usually just "Denormalize" everything to be a part of the object graph, and thus everything would be stored in that same record. Of course, nothing is stopping you from storing the ID to another record stored in another repository.

Installation Currently, you can use this library by simply cloning (or downloading) the repository and adding it to your workspace. Then you can add the GSON 2.2.2 dependency (which you can find in this repository in /dependencies). Once the project matures, we will provide a jar and make it available via maven.