Docs-logo

Expo

Get Started
API Reference
Slash-shortcut-icon
Hamburger-icon

SQLite

expo-sqlite gives your app access to a database that can be queried through a WebSQL-like API. The database is persisted across restarts of your app.
An example to do list app is available that uses this module for storage.

Platform Compatibility

Android DeviceAndroid EmulatoriOS DeviceiOS SimulatorWeb
Status-success-iconStatus-success-iconStatus-success-iconStatus-success-iconStatus-failed-icon

Guides

In order to open a new SQLite database using an existing .db file you already have, you need to do three things:
  • expo install expo-file-system expo-asset
  • create a metro.config.js file in the root of your project with the following contents (curious why? read here):
const { getDefaultConfig } = require('expo/metro-config');

const defaultConfig = getDefaultConfig(__dirname);

defaultConfig.resolver.assetExts.push('db');

module.exports = defaultConfig;
  • Use the following function (or similar) to open your database:
async function openDatabase(pathToDatabaseFile: string): Promise<SQLite.WebSQLDatabase> {
  if (!(await FileSystem.getInfoAsync(FileSystem.documentDirectory + 'SQLite')).exists) {
    await FileSystem.makeDirectoryAsync(FileSystem.documentDirectory + 'SQLite');
  }
  await FileSystem.downloadAsync(
    Asset.fromModule(require(pathToDatabaseFile)).uri,
    FileSystem.documentDirectory + 'SQLite/myDatabaseName.db'
  );
  return SQLite.openDatabase('myDatabaseName.db');
}

Info-icon
Please note that you should use this kind of execution only when it is necessary. For instance, when code is a no-op within transactions (like eg. PRAGMA foreign_keys = ON;).
const db = SQLite.openDatabase('dbName', version);

db.exec([{ sql: 'PRAGMA foreign_keys = ON;', args: [] }], false, () =>
  console.log('Foreign keys turned on')
);

Terminal
→ expo install expo-sqlite

If you're installing this in a bare React Native app, you should also follow these additional installation instructions.

import * as SQLite from 'expo-sqlite';

  • Type: number


  • Type: string


  • Type: number


  • Type: number


  • Type: number


  • Type: number


  • Type: number


  • Type: number


  • Type: number


  • Type: number



Arguments

NameTypeDescription
namestringName of the database file to open.
versionstring-
descriptionstring-
sizenumber-
callback
(optional)
(db: WebSQLDatabase) => void-

Open a database, creating it if it doesn't exist, and return a Database object. On disk, the database will be created under the app's documents directory, i.e. ${FileSystem.documentDirectory}/SQLite/${name}.

Info-icon
The version, description and size arguments are ignored, but are accepted by the function

for compatibility with the WebSQL specification.

  • WebSQLDatabase

Arguments

NameTypeDescription
databaseDatabase-

NameTypeDescription
argsunknown[]-
sqlstring-

ResultSet objects are returned through second parameter of the success callback for the tx.executeSql() method on a SQLTransaction (see above).

NameTypeDescription
insertId
(optional)
numberThe row ID of the row that the SQL statement inserted into the database, if a row was inserted.
rows{ [column]: any }-
rowsAffectednumberThe number of rows that were changed by the SQL statement.

NameTypeDescription
errorError-

NameTypeDescription
insertId
(optional)
numberThe row ID of the row that the SQL statement inserted into the database, if a row was inserted.
rowsSQLResultSetRowList-
rowsAffectednumberThe number of rows that were changed by the SQL statement.

Arguments

NameTypeDescription
transactionSQLTransaction-
resultSetSQLResultSet-

Arguments

NameTypeDescription
transactionSQLTransaction-
errorSQLError-

Arguments

NameTypeDescription
transactionSQLTransaction-

Arguments

NameTypeDescription
errorSQLError-

Arguments

NameTypeDescription
error
(optional)
Error | null-
resultSet
(optional)
(ResultSetError | ResultSet)[]-

Database objects are returned by calls to SQLite.openDatabase(). Such an object represents a connection to a database on your device.

Returns: voidReturns: void
Execute a database transaction.
NameTypeDescription
versionstring-
readTransaction()(callback, errorCallback, successCallback) => void
callbackSQLTransactionCallback-
errorCallback
(optional)
SQLTransactionErrorCallback-
successCallback
(optional)
() => void-
transaction()(callback, errorCallback, successCallback) => void
callbackSQLTransactionCallbackA function representing the transaction to perform. Takes a Transaction (see below) as its only parameter, on which it can add SQL statements to execute.
errorCallback
(optional)
SQLTransactionErrorCallbackCalled if an error occurred processing this transaction. Takes a single parameter describing the error.
successCallback
(optional)
() => voidCalled when the transaction has completed executing on the database.

Returns: any
Returns the row with the given index. If there is no such row, returns null.
NameTypeDescription
_arrayany[]The actual array of rows returned by the query. Can be used directly instead of getting rows through rows.item().
lengthnumberThe number of rows returned by the query.
item()(index) => any
indexnumberIndex of row to get.

A SQLTransaction object is passed in as a parameter to the callback parameter for the db.transaction() method on a Database (see above). It allows enqueuing SQL statements to perform in a database transaction.

Returns: void
Enqueue a SQL statement to execute in the transaction. Authors are strongly recommended to make use of the ? placeholder feature of the method to avoid against SQL injection attacks, and to never construct SQL statements on the fly.
NameTypeDescription
executeSql()(sqlStatement, args, callback, errorCallback) => void
sqlStatementstringA string containing a database query to execute expressed as SQL. The string may contain ? placeholders, with values to be substituted listed in the arguments parameter.
args
(optional)
(string | number)[]An array of values (numbers or strings) to substitute for ? placeholders in the SQL statement.
callback
(optional)
SQLStatementCallbackCalled when the query is successfully completed during the transaction. Takes two parameters: the transaction itself, and a ResultSet object (see below) with the results of the query.
errorCallback
(optional)
SQLStatementErrorCallbackCalled if an error occurred executing this particular query in the transaction. Takes two parameters: the transaction itself, and the error object.

Extends: Database

Returns: void
NameTypeDescription
close()() => voidReturns: void
Close the database.
deleteAsync()() => Promise<void>Returns: Promise<void>
Delete the database file.
exec()(queries, readOnly, callback) => void
queriesQuery[]-
readOnlyboolean-
callbackSQLiteCallback-

Returns: Database
NameTypeDescription
openDatabase()
(optional)
(name, version, displayName, estimatedSize, creationCallback) => Database
namestring-
versionstring-
displayNamestring-
estimatedSizenumber-
creationCallback
(optional)
DatabaseCallback-