Skip to content

Latest commit

 

History

History
83 lines (63 loc) · 2.86 KB

README.md

File metadata and controls

83 lines (63 loc) · 2.86 KB
Raw

Shillelagh

Library Icon

Build Status Android Arsenal

Shillelagh is an sqlite library. It was built to make life easier. The entire library was built around simplicity when using sqlite in Android.

Quick and dirty.

  • Create your model objects, the ones you want to persist
  • Add the @Table annotation to the model class, and make sure you have a field @Id long id
  • Create your SQLiteOpenHelper and use Shillelagh.createTable to make your tables
  • Create an instance of Shillelagh
  • Create and save your objects!

For how to use see the example or the JavaDocs.

Supported Types

Supported Types (and corresponding primitives)

  • Integer
  • Double
  • Float
  • Long
  • Short
  • String
  • Date
  • Boolean

One to Many and One to One

One to one and one to many relationships are supported. You will need to make sure that the child objects are annotated like any other tables. For one to many, make sure you use a list, arrays are currently not supported.

Blobs

Byte arrays are supported with nothing out of the ordinary needing to be done. If you would like to save another object type as a blob, you will need to tell Shillelagh that it should be serialized by adding @Column(isBlob = true) to the annotation. These objects MUST also implement the Serializable interface.

Other Notes

  • Constructors must be provided at package protected level or higher (Put in a ticket if there is a legitimate use case for private).
  • Inner classes MUST be marked static.
  • Don't forget to update your database version if you change your models (Also create migration scripts).
  • For proguard just add -keep class **$$Shillelagh { *; } to your rules.
  • If you do not provide a defualt constructor, Shillelagh will attempt to use the constructor you provided and pass in null.

Download

dependencies {
  ...
  implementation 'com.andrewreitz:shillelagh:0.5.0'
  provided 'com.andrewreitz:shillelagh-processor:0.5.0'
  ...
}

License

Copyright 2015 Andrew Reitz

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
under the License is distributed on an "AS IS" BASIS,
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
the License for the specific language governing permissions and
under the License.