react-native-sqlite

NOTE: This hasn't been maintained for a while and was never very complete to start with. Check out https://github.com/andpor/react-native-sqlite-storage for a more usable library!

A binding for sqlite3 for React Native. Allows a database to be opened and for SQL queries to be run on it.

Written by Thomas Parslow (almostobsolete.net and tomparslow.co.uk) as part of Active Inbox (activeinboxhq.com).

Installation

Install using npm with npm install --save react-native-sqlite

You then need to add the Objective C part to your XCode project. Drag AIBSQLite.xcodeproj from the node_modules/react-native-sqlite folder into your XCode project. Click on the project in XCode, goto Build Phases then Link Binary With Libraries and add libAIBSQLite.a and libsqlite3.dylib.

NOTE: Make sure you don't have the AIBSQLite project open seperately in XCode otherwise it won't work.

Usage

var sqlite = require('react-native-sqlite');
sqlite.open("filename.sqlite", function (error, database) {
  if (error) {
    console.log("Failed to open database:", error);
    return;
  }
  var sql = "SELECT a, b FROM table WHERE field=? AND otherfield=?";
  var params = ["somestring", 99];
  database.executeSQL(sql, params, rowCallback, completeCallback);
  function rowCallback(rowData) {
    console.log("Got row data:", rowData);
  }
  function completeCallback(error) {
    if (error) {
      console.log("Failed to execute query:", error);
      return
    }
    console.log("Query complete!");
    database.close(function (error) {
      if (error) {
        console.log("Failed to close database:", error);
        return
      }
    });
  }
});

Database Location

It will first look for the database filename you give in the Documents directory inside the app sandbox. If it doesn't find anything there it will look in the app bundle and try and copy it to the Documents directory. If it doesn't find the database in either place then it will create a new blank database in the Documents directory.

In the future it should probably be made possible to open/create databases in the tmp and Libraries directories.

Known Issues

• Doesn't support reading of BLOB fields right now. I'm not entirely sure what would be the best way to pass back binary data. Maybe Base64?
• Database needs to be closed manually. I'm not sure how I could do this automatically.

Feedback Welcome!

Feedback, questions, suggestions and most of all Pull Requests are very welcome. This is an early version and I want to figure out the best way to continue it.

I'm also available for freelance work!

I'm @almostobsolete on Twitter my email is [email protected] and you can find me on the web at tomparslow.co.uk and almostobsolete.net