Skip to content

Latest commit

 

History

History
111 lines (76 loc) · 3.33 KB

README.md

File metadata and controls

111 lines (76 loc) · 3.33 KB
Raw

Build Status

SQLDroid

SQLDroid is a JDBC driver for Android's sqlite database (android.database.sqlite.SQLiteDatabase) originally conceived by Kristian Lein-Mathisen. See http://sqldroid.org/.

SQLDroid lets you access your app's database through JDBC. Android ships with the necessary interfaces needed to use JDBC drivers, but it does not officially ship with a driver for its built-in SQLite database engine. When porting code from other projects, you can conveniently replace the JDBC url to jdbc:sqlite to access an SQLite database on Android.

The SQLDroid JAR with the JDBC driver for Android is 33KB. We also offer a RubyGem "sqldroid" for use with Ruboto.

Community

Download

You can use SQLDroid in you maven project by declaring this dependency:

<dependency>
    <groupId>org.sqldroid</groupId>
    <artifactId>sqldroid</artifactId>
    <version>1.0.3</version>
</dependency>

Or if you're using gradle:

compile 'org.sqldroid:sqldroid:1.0.3'

Binary distributions are available for download from the Maven Central Repository: http://search.maven.org/#search%7Cga%7C1%7Csqldroid

Usage

Here is a minimal example of an Android Activity implemented in Java with SQLDroid.

import java.sql.DriverManager;
import java.sql.Connection;
import java.sql.Driver;
import java.sql.SQLException;

public class MainActivity extends AppCompatActivity {

    private Connection connection;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        try {
            DriverManager.registerDriver((Driver) Class.forName("org.sqldroid.SQLDroidDriver").newInstance());
        } catch (Exception e) {
            throw new RuntimeException("Failed to register SQLDroidDriver");
        }
        String jdbcUrl = "jdbc:sqldroid:" + "/data/data/" + getPackageName() + "/my-database.db";
        try {
            this.connection = DriverManager.getConnection(jdbcUrl);
        } catch (SQLException e) {
            throw new RuntimeException(e);
        }
    }

    @Override
    public void onDestroy() {
        if (connection != null) {
            try {
                connection.close();
            } catch (SQLException e) {
                throw new RuntimeException(e);
            }
        }
        super.onDestroy();
    }
}

You can find an example of how to use SQLDroid with ActiveRecord on Ruboto here:

https://github.com/ruboto/ruboto/wiki/Tutorial%3A-Using-an-SQLite-database-with-ActiveRecord

Debug output

You can set the SQLDroid log output level like this

org.sqldroid.Log.LEVEL = android.util.Log.VERBOSE;

You can turn on resultset dumps like this

org.sqldroid.SQLDroidResultSet.dump = true;

Building

The SQLDroid JAR file is a straight collection of the compiled classes. If you have Ruby installed, you can generate the JAR using

rake jar

To make a gem for use with Ruboto run

rake gem

To release the gem to rubygems.org (requires permissions on rubygems.org) run

rake release