Insanely easy way to work with Android databases.
Official documentation can be found here - Check some examples below. The example application is provided in the example folder in the source.
Sugar ORM was built in contrast to other ORM's to have:
- A simple, concise, and clean integration process with minimal configuration.
- Automatic table and column naming through reflection.
- Support for migrations between different schema versions.
- Automatic modification of tables when changing fields.
- Automatic creation of tables during app installation.
In order to install Sugar:
Add it in your root build.gradle at the end of repositories:
allprojects {
repositories {
...
maven { url 'https://jitpack.io' }
}
}
Step 2. Add the dependency
dependencies {
implementation 'com.github.mohammadaminha:sugar:v1.0'
}
First, download sugar repository
git clone [email protected]:mohammadaminha/sugar.git
include this in your settings.gradle
include ':app' // your module app
include ':sugar'
def getLocalProperty(prop) {
Properties properties = new Properties()
properties.load(new File(rootDir.absolutePath '/local.properties').newDataInputStream())
return properties.getProperty(prop, '')
}
project(':sugar').projectDir = new File(getLocalProperty('sugar.dir'))
include this in your local.properties
sugar.dir=/path/to/sugar/library
add sugar project to the dependencies of your main project (build.gradle)
dependencies {
compile project(':sugar')
}
You should also comment this line just comment this line (library/build.gradle): https://github.com/satyan/sugar/blob/master/library/build.gradle#L2
// apply from: '../maven_push.gradle'
===================
After installing, check out how to set up your first database in official documentation. Check examples of 1.0 and master below:
public class Book extends SugarRecord {
String isbn;
String title;
String edition;
// Default constructor is necessary for SugarRecord
public Book() {
}
public Book(String isbn, String title, String edition) {
this.isbn = isbn;
this.title = title;
this.edition = edition;
}
}
or
public class Book { ... }
Book book = new Book("isbn123", "Title here", "2nd edition")
book.save();
or
SugarRecord.save(book); // if using the @Table annotation
Book book = Book.findById(Book.class, 1);
Book book = Book.findById(Book.class, 1);
book.title = "updated title here"; // modify the values
book.edition = "3rd edition";
book.save(); // updates the previous entry with new values.
Book book = Book.findById(Book.class, 1);
book.delete();
or
SugarRecord.delete(book); // if using the @Table annotation
Book book = new Book("isbn123", "Title here", "2nd edition")
book.save();
// Update book with isbn123
Book sameBook = new Book("isbn123", "New Title", "5th edition")
sameBook.update();
book.getId() == sameBook.getId(); // true
or
SugarRecord.update(sameBook); // if using the @Table annotation
List<Book> books = new ArrayList<>();
books.add(new Book("isbn123", "Title here", "2nd edition"))
books.add(new Book("isbn456", "Title here 2", "3nd edition"))
books.add(new Book("isbn789", "Title here 3", "4nd edition"))
SugarRecord.saveInTx(books);
# Ensures entities remain un-obfuscated so table and columns are named correctly
-keep class com.yourpackage.yourapp.domainclasspackage.** { *; }
Please fork this repository and contribute back using pull requests. Features can be requested using issues. All code, comments, and critiques are greatly appreciated.