Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chennaione/sugar
Insanely easy way to work with Android Database.
https://github.com/chennaione/sugar
Last synced: 6 days ago
JSON representation
Insanely easy way to work with Android Database.
- Host: GitHub
- URL: https://github.com/chennaione/sugar
- Owner: chennaione
- License: mit
- Created: 2011-08-12T13:44:41.000Z (over 13 years ago)
- Default Branch: master
- Last Pushed: 2021-09-02T12:51:46.000Z (over 3 years ago)
- Last Synced: 2024-10-29T17:51:09.733Z (about 1 month ago)
- Language: Java
- Homepage: http://satyan.github.com/sugar/
- Size: 9.23 MB
- Stars: 2,618
- Watchers: 103
- Forks: 583
- Open Issues: 302
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-android - Sugar
- awesome - sugar - Insanely easy way to work with Android Database. (etc)
- awesome - sugar - Insanely easy way to work with Android Database. (etc)
README
# Sugar ORM [](https://travis-ci.org/satyan/sugar) [](https://coveralls.io/r/satyan/sugar?branch=master) [](http://www.codetriage.com/satyan/sugar)
[](https://gitter.im/satyan/sugar?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
Insanely easy way to work with Android databases.
Official documentation can be found [here](http://satyan.github.io/sugar) - Check some examples below. The example application is provided in the **example** folder in the source.
## Looking for contributors
We need contributors to help maintain this project, ask @satyan for repo permission
Otherwise you can use another ORM, like https://github.com/requery/requery or https://realm.io/
## Features
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.
## Installing
There are four ways to install Sugar:
#### As a Gradle dependency
This is the preferred way. Simply add:
```groovy
compile 'com.github.satyan:sugar:1.5'
```
to your project dependencies and run `gradle build` or `gradle assemble`.
#### As a Maven dependency
Declare the dependency in Maven:
```xml
com.github.satyan
sugar
1.5
```
#### As a library project
Download the source code and import it as a library project in Eclipse. The project is available in the folder **library**. For more information on how to do this, read [here](http://developer.android.com/tools/projects/index.html#LibraryProjects).
#### As a jar
Visit the [releases](https://github.com/satyan/sugar/releases) page to download jars directly. You can drop them into your `libs` folder and configure the Java build path to include the library. See this [tutorial](http://www.vogella.com/tutorials/AndroidLibraryProjects/article.html) for an excellent guide on how to do this.
### How to use master version
First, download sugar repository
```
git clone [email protected]:satyan/sugar.git
```
include this in your **settings.gradle**
```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)
```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%2Fbuild.gradle#L2
```gradle
// apply from: '../maven_push.gradle'
```
===================
After installing, check out how to set up your first database and models [here](http://satyan.github.io/sugar/getting-started.html) **Outdated**. Check examples of 1.4 and master below:
## Examples
### SugarRecord
```java
public class Book extends SugarRecord {
@Unique
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
```java
@Table
public class Book { ... }
```
### Save Entity
```java
Book book = new Book("isbn123", "Title here", "2nd edition")
book.save();
```
or
```java
SugarRecord.save(book); // if using the @Table annotation
```
### Load Entity
```java
Book book = Book.findById(Book.class, 1);
```
### Update Entity
```java
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.
```
### Delete Entity
```java
Book book = Book.findById(Book.class, 1);
book.delete();
```
or
```java
SugarRecord.delete(book); // if using the @Table annotation
```
### Update Entity based on Unique values
```java
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
```java
SugarRecord.update(sameBook); // if using the @Table annotation
```
### Bulk Insert
```java
List 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);
```
### When using ProGuard
```java
# Ensures entities remain un-obfuscated so table and columns are named correctly
-keep class com.yourpackage.yourapp.domainclasspackage.** { *; }
```
### Known Issues.
#### 1. Instant Run.
Instant-Run seems to prevent Sugar ORM from finding the "table" classes, therefore it cannot create the DB tables if you run the app for the first time
When running your app for the first time Turn off Instant run once to allow for the DB tables to be created
You can enable it after the tables have been created.
To disable Instant-Run in Android Studio:
``(Preferences (Mac) or Settings (PC) -> Build, Execution, Deployment -> Instant Run -> Untick "Enable Instant Run..." )``
## [CHANGELOG](https://github.com/satyan/sugar/blob/master/CHANGELOG.md)
## Contributing
Please fork this repository and contribute back using [pull requests](https://github.com/satyan/sugar/pulls). Features can be requested using [issues](https://github.com/satyan/sugar/issues). All code, comments, and critiques are greatly appreciated.