DBTools


Source link: https://github.com/jeffdcamp/dbtools-android

DBTools for Android

DBTools for Android is an Android ORM library that makes it easy to work with SQLite Databases.

Features

  • Clean layout of of domain classes, domain manager classes, database definitions
  • Mature/Stable library: Used in many apps for years, and large apps with millions of users
  • Fast: Benchmark as one of the fastest ORMs for both reading and writing small, medium, and large sets of data
  • Code generator generates all of the boiler plate code.
  • Table change listeners (Listeners, Rx, LiveData), to know when changes happen to specific tables
  • First class testing support: All JUnit tests can run against JDBC Sqlite in the JVM
  • Rx support: Full support for Rx java Observables
  • Android Architecture Components LiveData and Paging support
  • Injection/Dagger support
  • Kotlin support: Generator can generate Kotlin and KotlinRx classes
  • Support Android Sqlite, sqlite.org sqlite, SQLCipher
  • SQLBuilder library to simplify building of SQL queries
  • Multiple database support: Easily work with many databases at the same time, and even merge databases

Usage

The following are some examples DBTools can be used:

  • Insert

    Individual individual = new Individual();
     individual.setName("Jeff Campbell");
     individual.setPhone("801-555-1234");
     individual.setIndividualType(IndividualType.HEAD);
      individualManager.save(individual);
     
  • Update

    Individual individual = individualManager.findByRowId(1);
     individual.setPhone("801-555-0000");
     individualManager.save(individual);
     
  • Delete

    // Delete using record object Individual individual = individualManager.findByRowId(1);
     individualManager.delete(individual);
      // Delete using the primary key id
    
     individualManager.delete(1);
    
    // Delete all individuals who has "555" in their phone number individualManager.delete(IndividualConst.C_PHONE + " LIKE ?, new String[]{
    "555"
    }
    );
      
  • Transactions

    // Start transaction (all record managers share transactions) individualManager.beginTransaction();
    
    boolean success = true;  individualManager.save(individual1);
     individualManager.save(individual2);
     individualManager.save(individual3);
     individualManager.save(individual4);
     individualManager.save(individual5);
      // End transaction.  (if success false, transaction is reverted) individualManager.endTransaction(success);
      

DBTools Manager classes have many built-in methods that make working with tables even easier. Here is a few examples:

  • Find records

    // Individual Record by primary key Individual individual = individualManager.findByRowId(1);
      // Find FIRST individual who has "555" in their phone number Individual individual = individualManager.findBySelection(IndividualConst.C_PHONE + " LIKE ?", new String[]{
    "555"
    }
    );
    
    // All Records List<Individual> allIndividuals = individualManager.findAll();
      // All Records, ordered by the "NAME" column List<Individual> allOrderedIndividuals = individualManager.findAllOrderBy(IndividualConst.C_NAME);
      // ALL Records who have "555" in their phone number List<Individual> specificIndividuals = individualManager.findAllBySelection(IndividualConst.C_PHONE + " LIKE ?, new String[]{
    "555"
    }
    );
      
  • Using cursors

    // Find all, order by NAME column Cursor cursor = individualManager.findCursorBySelection(null, null, IndividualConst.C_NAME);
    
    // Find cursor of those who have "555" in their phone number Cursor cursor = individualManager.findCursorBySelection(IndividualConst.C_PHONE + " LIKE ?, new String[]{
    "555"
    }
    );
      
  • Access data from Cursor

    Cursor cursor; // populate all items from cursor into Individual Individual individual = new Individual(cursor);
    
    // Get data from a single field, from a cursor.  (for use in places such as Adapters, etc) Examples: String name = Individual.getName(cursor);
     IndividualType type = Individual.getType(cursor);
     Date birthDate = Individual.getBirthDate(cursor);
     
  • Count number of items in the database

    // Find count of ALL records in a table int count = individualManager.findCount();
      // Find count of ALL records who have "555" in their phone number int count = individualManager.findCountBySelection(IndividualConst.C_PHONE + " LIKE ?, new String[]{
    "555"
    }
    );
      

Table Change Listeners

  • Add Listener

    // Listener individualManager.addTableChangeListener(new DBToolsTableChangeListener() {
    
      @Override
      public void onTableChange(DatabaseTableChange event) {
    
    onTableChange(event);
    
      
    }
     
    }
    );
     

RxJava

  • Setup

Tell DBTools to support RxJava:


dbtools {

  rxJavaSupport true // support RxJava
 
}
 

Include the RxJava dependecy:

  // RxJava
compile 'io.reactivex:rxandroid:<latest version>'
compile 'io.reactivex:rxjava:<latest version>' 
  • Usage

Managers

Use xxxRx(...) method calls on the manager classes to return an Observable


 individualManager.findAllRx()

  .subscribe(individual -> Log.i(TAG, "Individual: " + individual.getFirstName()));
 

Subscribe to table changes (following example will output 2 table changes)


 public void changeNames() {

// Subscribe to TABLE changes

Subscription tableChangeSubscription = individualManager.tableChanges()

  .subscribe(changeType -> handleTableChange(changeType));

// Make some changes

Individual individual = individualManager.findAll().get(0);

if (individual != null) {

 // change name

 individual.setFirstName("Bobby");

 individualManager.save(individual);

 // change name (again)

 individual.setFirstName("John");

 individualManager.save(individual);

}

  // Unsubscribe

tableChangeSubscription.unsubscribe();

  
}

 public void handleTableChange(DatabaseTableChange change) {

Log.e(TAG, "Individual Table Changed: [" + change.hasChange() + "]");

  
}
 

Setup

*For a working implementation of DBTools for Android see the Android-Template application ( https://github.com/jeffdcamp/android-template)

  1. Add DBTools Gradle Plugin and dbtools-android dependency to build.gradle file

    buildscript { repositories { mavenCentral() } dependencies { classpath 'org.dbtools:gradle-dbtools-plugin:' } }

    apply plugin: 'dbtools'

    dependencies { compile 'org.dbtools:dbtools-android:'

    
    // optional dependencies
     compile 'com.google.code.findbugs:jsr305:3.0.1'
     androidTestCompile 'com.google.code.findbugs:jsr305:3.0.1' // fix conflicting issue with jsr305 annotations (espresso-core) 

    }

    dbtools { type 'ANDROID' // or 'ANDROID-KOTLIN'

    
    basePackageName 'org.company.project.domain'
     outputSrcDir 'src/main/java/org/company/project/domain'
      // optional items
     injectionSupport false // support for @Inject (using Dagger, Guice, JEE, etc)
     jsr305Support true // support for @Notnull / @Nullable etc
     includeDatabaseNameInPackage true // place each set of domain objects into a package named after its database
     dateType 'DATE' // DATE, JSR-310, JODA
     rxJavaSupport false // support RxJava 

    }

  2. For new projects, create initial schema.xml files (Default: new files will be created in src/main/database)

    ./gradlew dbtools-init

    ... or ...

    ./gradle app:dbtools-init

    ... or ...

    From Android Studio: DOUBLE-CLICK on "dbtools-init" task from the "Gradle" Tools Window

  3. Define your database: Add schema.xml file (after executing the "dbtools-init" task (from above) an XSD definition file will be created (this may help writing the XML file in some IDE's)), to the /src/main/database directory. This file contains a list of all of the databases and tables in each database. The following is a sample of this file:

    
    
     <table name="INDIVIDUAL">
    
    <field name="_id" jdbcDataType="BIGINT" increment="true" primaryKey="true" notNull="true"/>
    
    <field name="INDIVIDUAL_TYPE_ID" jdbcDataType="INTEGER" varName="individualType" foreignKeyTable="INDIVIDUAL_TYPE" foreignKeyField="_id" foreignKeyType="ENUM" enumerationDefault="HEAD"/>
    
    <field name="NAME" jdbcDataType="VARCHAR" size="255" notNull="true"/>
    
    <field name="BIRTH_DATE" jdbcDataType="TIMESTAMP"/>
    
    <field name="PHONE" jdbcDataType="VARCHAR" size="255"/>
    
    <field name="EMAIL" jdbcDataType="VARCHAR" size="255"/>
    
      </table>
     </database> 
  4. Use DBTools Generator to generate DatabaseManager and all domain classes. Execute gradle task:

    ./gradlew dbtools-genclasses

    ... or ...

    ./gradle app:dbtools-genclasses

    ... or ...

    From Android Studio: DOUBLE-CLICK on "dbtools-genclasses" task from the "Gradle" Tools Window

DBTools Generator will create the following files to manage all database connections and create/update database tables:


DatabaseManager.java (extends DatabaseBaseManager and is used for developer customizations.  Contains CONST versions of the databases) (NEVER overwritten by generator)
 DatabaseBaseManager.java (contains boiler-plate code creating all tables and views for all databases defined in the schema.xml) (this file is ALWAYS overwritten by generator)
 DatabaseManagerConst.java (contains constant values of the database names) (this file is ALWAYS overwritten by generator)
 AppDatabaseConfig.java (DatabaseManager configuration) (NEVER overwritten by generator) 

DBTools Generator will create the following files for each table (example for the Individual table):


 individual/

Individual.java (extends IndividualBaseRecord and is used for developer customizations) (NEVER overwritten by generator)

IndividualConst.java (static fields/methods for table and columns) (this file is ALWAYS overwritten by generator)

IndividualBaseRecord.java (contains boiler-plate code for doing CRUD operations and contains CONST names of the table and all columns (used to help writing queries)) (this file is ALWAYS overwritten by generator)

 IndividualManager.java (extends IndividualBaseManager and is used for developer customizations (such as adding new findByXXX(...) methods) (NEVER overwritten by generator)

IndividualBaseManager.java (contains boiler-plate code for doing CRUD operations) (this file is ALWAYS overwritten by generator) 
  1. Use DBTools

    IndividualManager individualManager = MainDatabaseManagers.getIndividualManager();

    Individual individual1 = new Individual(); individual1.setFirstName("Bob"); individual1.setPhone("555-555-1234");

    individualManager.save(individual1);

  2. Refer to sample app using DBTools: https://github.com/jeffdcamp/android-template

Documentation

DBTools-Android Javadoc: http://jeffdcamp.github.io/dbtools-android/javadoc/

Proguard Rules

# DBTools -dontwarn org.dbtools.query.** -dontwarn org.sqlite.** -dontwarn net.sqlcipher.** -dontwarn com.squareup.otto.**  # SQLCipher (if using SQLCipher) -keep public class net.sqlcipher.** {
 *; 
}
 -keep public class net.sqlcipher.database.** {
 *; 
}
  # SQLite.org (if using sqlite from sqlite.org) -keep public class org.sqlite.** {
 *; 
}
 -keep public class org.sqlite.database.** {
 *; 
}
  # Threetenbp -dontwarn org.threeten.** 

Upgrade

Migration guide ( https://github.com/jeffdcamp/dbtools-android/blob/master/MIGRATION.md)

Other Projects

DBTools Query - https://github.com/jeffdcamp/dbtools-query

Android Template - https://github.com/jeffdcamp/android-template

License

Copyright 2014 Jeff Campbell  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

Makes it easy to create a beautiful about screen for your app.

Micro-Transitions for Smooth Android To-Do List Animations.

A set of EditTexts with built-in support for Date and TimePicker's using fragments.

Mobile Test Automation Tool

  • Run the same test on different mobile devices and operating systems with a mobile test automation tool that allows tests portability
  • Perform mobile test automation using real devices and emulators
  • Create a test on one device and run it on any other device model or operating system
  • Increase coverage with full peripheral testing capabilities
  • Start your mobile test automation quickly with a simple plug, record and play tool
  • Enhance your mobile test automation by Integrating into all your major ALM environments
  • Integrate with any continuous integration environment
  • Recorder for quick test creation

This example is basically used for simple using of data binding for Views and RecyclerView using model.

This library aims to provide a chat UI view.

  • You need to write just few code to create chat view
  • Easy to use for a chat app

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