SqliteMagic


Source link: https://github.com/SiimKinks/sqlitemagic/

SqliteMagic

Simple yet powerful SQLite database layer for Android that makes database handling feel like magic.

Overview:

  • Simple, intuitive & typesafe API
  • Minimal setup needed
  • Built in RxJava support with reactive stream semantics on queries and operations
  • Built in AutoValue immutable objects support
  • Built in kotlin support
  • Full support for complex columns
  • Support for SQLite views
  • Persist any third party object with fully customizable object transformers
  • Support for migrations
  • No reflection
  • Compile time annotation processing
  • Probably the fastest library for Android SQLite database operations (without memory caching)

Getting Started

Install IntelliJ Plugin (for non-kotlin project):

The Intellij plugin can be installed from Android Studio by navigating Android Studio -> Preferences -> Plugins -> Browse repositories -> Search for SqliteMagic

Add SqliteMagic to Project:

buildscript {

repositories {

  jcenter()

}

dependencies {

  classpath 'com.android.tools.build:gradle:<latest version>'
  classpath 'com.siimkinks.sqlitemagic:sqlitemagic-plugin:0.15.2'

}
 
}
  apply plugin: 'com.android.application' apply plugin: 'com.siimkinks.sqlitemagic'

Initialize Library:

SqliteMagic.init(applicationContext);

Note: any place with a reference to Application context is ok to use for initialization, but it must happen before a database is accessed. During initialization default db connection is opened, db schema is created and migration scripts are executed - no other hidden runtime performance costs.

Define Database:

Note that there is no need to extend or implement any base classes or interfaces

POJO AutoValue
  @Table(persistAll = true) public class Author {

 @Id(autoIncrement = false)
long id;

String firstName;

String lastName;

... 
}

 @Table(persistAll = true) public class Book {

 @Id(autoIncrement = false)
long id();

String title;

Author author;

... 
}
  
@Table(persistAll = true) @AutoValue public abstract class Author {

 @Id(autoIncrement = false)
public abstract long id();

public abstract String firstName();

public abstract String lastName();

... 
}
  @Table(persistAll = true) @AutoValue public abstract class Book {

 @Id(autoIncrement = false)
public abstract long id();

public abstract String title();

public abstract Author author();

... 
}
Kotlin
@Table(persistAll = true, useAccessMethods = true) data class Author(
@Id(autoIncrement = false) val id: Long,
val firstName: String,
val lastName: String )
 @Table(persistAll = true, useAccessMethods = true) data class Book(
@Id(autoIncrement = false) val id: Long,
val title: String,
val author: Author ) 

Database operation builder methods for Java are "automagically" generated during compile time on objects with @Table annotation using bytecode manipulation and AST transformations. These methods may seem like "magic", but actually they are only glue methods that call corresponding table generated class methods. This way one can still see human readable code during debugging - just press "step into" when magic method is encountered.

For kotlin, database operation builder methods are generated as extensions functions.

Do Operations With Objects:

Synchronous RxJava
Author author = new Author(73, "Foo", "Bar");
 Book book = new Book(77, "Bar", author);
  // insert -- NOTE: author object also gets // inserted and the whole operation // is wrapped in transaction long id = book
  .insert()
  .execute();
  // update boolean success = author
  .update()
  .execute();
  // update or insert id = author
  .persist()
  .execute();

// update or insert but ignore null values id = author
  .persist()
  .ignoreNullValues()
  .execute();

// delete int nrOfDeletedRows = author
  .delete()
  .execute();

// Bulk operations are also supported success = Author
  .persist(someAuthors)
  .ignoreNullValues()
  .execute();
 
Author author = new Author(73, "Foo", "Bar");
 Book book = new Book(77, "Bar", author);
  // insert -- NOTE: author object also gets // inserted and the whole operation is // wrapped in transaction when result // object gets subscribed Single<Long> insert = book
  .insert()
  .observe();
  // update Completable update = author
  .update()
  .observe();
  // update or insert Single<Long> persist = author
  .persist()
  .observe();

// update or insert but ignore null values persist = author
  .persist()
  .ignoreNullValues()
  .observe();

// delete Single<Integer> delete = author
  .delete()
  .observe();

// Bulk operations are also supported Completable bulkPersist = Author
  .persist(someAuthors)
  .ignoreNullValues()
  .observe();

(All database operations trigger RxJava notifications on active queries that listen to table that is being modified)

Use Typesafe Operation Builders:

Synchronous RxJava
import static com.siimkinks.sqlitemagic
  .BookTable.BOOK; ...  int nrOfUpdatedRows = Update
  .table(BOOK)
  .set(BOOK.TITLE, "Foo")
  .where(BOOK.ID.is(77L))
  .execute();
  int nrOfDeletedRows = Delete
  .from(BOOK)
  .where(BOOK.ID.isNot(77L)

.and(BOOK.TITLE.is("Foo")))
  .execute();
import static com.siimkinks.sqlitemagic
  .BookTable.BOOK; ...  Single<Integer> update = Update
  .table(BOOK)
  .set(BOOK.TITLE, "Foo")
  .where(BOOK.ID.is(77L))
  .observe();
  Single<Integer> delete = Delete
  .from(BOOK)
  .where(BOOK.ID.isNot(77L)

.and(BOOK.TITLE.is("Foo")))
  .observe();

Query Data:

SqliteMagic ships with its own DSL (or Domain Specific Language) that emulates SQL in Java (inspired by JOOQ).

Synchronous RxJava
import static com.siimkinks.sqlitemagic
  .AuthorTable.AUTHOR; ...  List<Author> authors = Select
  .from(AUTHOR)
  .where(AUTHOR.FIRST_NAME.like("Foo%")

.and(AUTHOR.LAST_NAME.isNot("Bar")))
  .orderBy(AUTHOR.LAST_NAME.desc())
  .limit(10)
  .execute();
  
import static com.siimkinks.sqlitemagic
  .AuthorTable.AUTHOR; ...  // QueryObservable is an rx.Observable of Query // which offers query-specific convenience // operators. QueryObservable<List<Author>> observable = Select
  .from(AUTHOR)
  .where(AUTHOR.FIRST_NAME.like("Foo%")

.and(AUTHOR.LAST_NAME.isNot("Bar")))
  .orderBy(AUTHOR.LAST_NAME.desc())
  .limit(10)
  .observe();

Query Complex Data:

Synchronous RxJava
import static com.siimkinks.sqlitemagic
  .AuthorTable.AUTHOR; import static com.siimkinks.sqlitemagic
  .BookTable.BOOK; ...  // the resulting Book objects also contain // Author objects List<Book> books = Select
  .from(BOOK)
  .where(BOOK.TITLE.is("Bar")

.and(AUTHOR.is(someAuthorObject)))
  .orderBy(AUTHOR.LAST_NAME.asc())
  .limit(10)
  // this tells to query all complex data
  // which is queried in a single
  // SELECT statement
  .queryDeep()
  .execute();
import static com.siimkinks.sqlitemagic
  .AuthorTable.AUTHOR; import static com.siimkinks.sqlitemagic
  .BookTable.BOOK; ...  // the resulting Book objects also contain // Author objects QueryObservable<List<Book>> observable = Select
  .from(BOOK)
  .where(BOOK.TITLE.is("Bar")

.and(AUTHOR.is(someAuthorObject)))
  .orderBy(AUTHOR.LAST_NAME.asc())
  .limit(10)
  // this tells to query all complex data
  // which is queried in a single
  // SELECT statement
  .queryDeep()
  .observe();

There is so much more to querying data like SQL functions, views, more type safety, selecting columns, querying only the first result, counting, RxJava convenience operators, etc. Take a deeper look at the wiki.

Documentation

Updates

All updates can be found in the CHANGELOG.

Bugs and Feedback

For bugs, questions and discussions please use the Github Issues.

License

Copyright 2017 Siim Kinks  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. 

Resources

Stream API from Java 8 rewrited on iterators for Java 7 and below.

Includes:

  • Functional interfaces;
  • Stream (without parallel processing);
  • Optional class;
  • Objects from Java 7.

Sticker-Camera is an Android application which allows to add stickers and tags on the picture.

A Firefox extension that adds view source links for the Android SDK.

A set of views which allow for easy sharing of content.

A set of social buttons with shares count, and interactions with native apps, to let the user share links using his favourite social apps.

An cross-platform bridge for sending messages between Obj-C/Java/Javascript and JavaScript in UIWebViews/WebViews.

Topics


2D Engines   3D Engines   9-Patch   Action Bars   Activities   ADB   Advertisements   Analytics   Animations   ANR   AOP   API   APK   APT   Architecture   Audio   Autocomplete   Background Processing   Backward Compatibility   Badges   Bar Codes   Benchmarking   Bitmaps   Bluetooth   Blur Effects   Bread Crumbs   BRMS   Browser Extensions   Build Systems   Bundles   Buttons   Caching   Camera   Canvas   Cards   Carousels   Changelog   Checkboxes   Cloud Storages   Color Analysis   Color Pickers   Colors   Comet/Push   Compass Sensors   Conferences   Content Providers   Continuous Integration   Crash Reports   Credit Cards   Credits   CSV   Curl/Flip   Data Binding   Data Generators   Data Structures   Database   Database Browsers   Date &   Debugging   Decompilers   Deep Links   Dependency Injections   Design   Design Patterns   Dex   Dialogs   Distributed Computing   Distribution Platforms   Download Managers   Drawables   Emoji   Emulators   EPUB   Equalizers &   Event Buses   Exception Handling   Face Recognition   Feedback &   File System   File/Directory   Fingerprint   Floating Action   Fonts   Forms   Fragments   FRP   FSM   Functional Programming   Gamepads   Games   Geocaching   Gestures   GIF   Glow Pad   Gradle Plugins   Graphics   Grid Views   Highlighting   HTML   HTTP Mocking   Icons   IDE   IDE Plugins   Image Croppers   Image Loaders   Image Pickers   Image Processing   Image Views   Instrumentation   Intents   Job Schedulers   JSON   Keyboard   Kotlin   Layouts   Library Demos   List View   List Views   Localization   Location   Lock Patterns   Logcat   Logging   Mails   Maps   Markdown   Mathematics   Maven Plugins   MBaaS   Media   Menus   Messaging   MIME   Mobile Web   Native Image   Navigation   NDK   Networking   NFC   NoSQL   Number Pickers   OAuth   Object Mocking   OCR Engines   OpenGL   ORM   Other Pickers   Parallax List   Parcelables   Particle Systems   Password Inputs   PDF   Permissions   Physics Engines   Platforms   Plugin Frameworks   Preferences   Progress Indicators   ProGuard   Properties   Protocol Buffer   Pull To   Purchases   Push/Pull   QR Codes   Quick Return   Radio Buttons   Range Bars   Ratings   Recycler Views   Resources   REST   Ripple Effects   RSS   Screenshots   Scripting   Scroll Views   SDK   Search Inputs   Security   Sensors   Services   Showcase Views   Signatures   Sliding Panels   Snackbars   SOAP   Social Networks   Spannable   Spinners   Splash Screens   SSH   Static Analysis   Status Bars   Styling   SVG   System   Tags   Task Managers   TDD &   Template Engines   Testing   Testing Tools   Text Formatting   Text Views   Text Watchers   Text-to   Toasts   Toolkits For   Tools   Tooltips   Trainings   TV   Twitter   Updaters   USB   User Stories   Utils   Validation   Video   View Adapters   View Pagers   Views   Watch Face   Wearable Data   Wearables   Weather   Web Tools   Web Views   WebRTC   WebSockets   Wheel Widgets   Wi-Fi   Widgets   Windows   Wizards   XML   XMPP   YAML   ZIP Codes