Example of SQLite Database in React Native

Example of SQLite Database in React Native

Here is an Example of SQLite Database in React Native. We are hoping you have read our previous post on Local Database in React Native App. SQLite database is one of the databases that we have discussed in our previous post. To define the SQLite we can say it is an open-source SQL database that stores data to a text file on a device. We can perform all the CRUD SQL transactions in this database and it is the most common database that we have heard of for mobile development. Let’s get started.

For SQLite database, we will use the SQLite3 Native Plugin which will work in both Android and iOS. It is based on Cordova SQLite plugin.

In this Example, we will make a HomeScreen with the option to go to other screens like

  • RegisterUser: To Register the User. (Create/Insert)
  • ViewAllUser: To View All Users. (Read)
  • ViewUser: To View Singel Users By Id. (Read)
  • UpdateUser: To Update the User.(Update)
  • DeleteUser: To Delete the User.

We will be having some custom components like Mybutton, Mytext, Mytextinput which will be used in place of react-native Button, Text, and TextInput.

How to Use

You just have to import the library like this:

and open the database using

Now, whenever you need to make some database call you can use db variable to execute the database query.

Please note down we are using callback function not real-time feedback because while running a query it does not provide the response instantly. Execution of query takes some time and give the response in the callback function.

To Make a React Native App

Getting started with React Native will help you to know more about the way you can make a React Native project. We are going to use react-native init to make our React Native App. Assuming that you have node installed, you can use npm to install the react-native-cli command line utility. Open the terminal and go to the workspace and run

npm install -g react-native-cli

Run the following commands to create a new React Native project

react-native init ProjectName

If you want to start a new project with a specific React Native version, you can use the --version argument:

react-native init ProjectName --version X.XX.X
react-native init ProjectName --version react-native@next

This will make a project structure with an index file named App.js in your project directory.

Installation of Dependencies

This example is updated for the React Navigation 4.0+. For more about React Navigation 4 please have a look at Using React Navigation 4.0 in React Native apps.

To install the dependencies open the terminal and jump into your project

1. Install react-native-sqlite-storage dependency to use SQLite

2. Install react-navigation dependency to import createAppContainer

3. Install react-native-gesture-handler dependency to support gesture navigation

4. Install react-navigation-stack to import createStackNavigator

These commands will copy all the dependencies into your node_module directory.

CocoaPods Installation

After the updation of React Native 0.60, they have introduced autolinking so we do not require to link the libraries but need to install pods.

In this example we need to install the pods for react-native-gesture-handler and react-native-sqlite-storage.

Please use the following command to install CocoaPods

Database Setup

While working with React Native it provides two option:

  1. You can make the database in runtime.
  2. You can use the pre-populated database so that you can start working directly.

In this example, we will make the database on runtime and for the pre-populated database, You can visit Example of Pre Populated SQLite Database in React Native.

Example of SQLite

We will perform a complete CRUD operation in this example. Please create the following project structure and copy the code given below

Open the project directory and replace the following code

App.js

Mybutton.js

Mytext.js

Mytextinput.js

HomeScreen.js

RegisterUser.js

UpdateUser.js

ViewAllUser.js

ViewUser.js

DeleteUser.js

To Run the React Native App

Open the terminal again and jump into your project using.
cd ProjectName
To run the project on an Android Virtual Device or on real debugging device
react-native run-android
or on the iOS Simulator by running
react-native run-ios (macOS only).

Here are the screenshots of the final outcome

               
               
               

This is how you can use SQLite Database in React Native Application. If you want to see how to use pre-populated SQLite database then please visit Example of Pre Populated SQLite Database in React Native.

If you have any doubt or you want to share something about the topic you can comment below or contact us here. There will be more posts coming soon. Stay tuned!

Hope you liked it. 🙂

47 thoughts on “Example of SQLite Database in React Native”

  1. I wanted to know one more thing about the sql
    query I see that in the example do a SELECT of a field but as it would be
    if I want to look for part of the id, the name of the user in the same query,
    I would appreciate your help. Thanks in advance

      • already great look this is my table and I did a like to search by name but in addition to search by name I want to search by its id
        tx.executeSql(
        “SELECT * FROM tabla1 where name like ?”,
        [‘%’ + input_user + ‘%’],

        • Try this:

          The concept is you can add as many as “?” you want in place of dynamic values and after that, you have to pass the array of values you want to pass but please be aware to manage the sequence of the values.

          tx.executeSql(
          “SELECT * FROM tabla1 where id = ? AND name like ?”,
          [id_value_here, ‘%’ + input_user + ‘%’],

  2. Hi, Where and How to handle onUpgrade() version increase of DB. Thanks for good article. It really helped alot to learn React Native with SQLITE.

    • Hello Nikhil,
      I think you are from the Android Development Background. Let me tell you in case of React Native you don’t have the way like android to upgrade the database, if you want to upgrade the database then you need to drop the table by the query. For this, you can manage the database version on your own.
      If you need some suggestion then you can use the following example
      Example: If you are releasing your application put the application version somewhere on the server and check the version from the application. if the application version and the server application version is same then go ahead else drop the old database and make a new one.

      • Hi, in that case it is fine. But my question was, I have released the app with some Database version and if in next release I need to alter the table without deleting existing data, As in android and in iOS we do have version management, onUpgrade function will call, How to manage such scenario as its very important in offline apps. Thanks!!

        • Hello Nikhil,

          In that case, you have to manage it using the database version. For example, I have a customer table in an offline database with [id, name, address] now you need to add pin code in the table. So in the next release create a global variable with name DB_VERSION =1.1 and make sync varriableDB_VERSION.
          Now on the starting of the app check whether async DB_VERSION is equal to DB_VERSION in the global variable. If they are equal just move else
          1. Copy the data from the old customer table into an array.
          2. Drop the old table.
          3. Create a new one.
          4. Insert the copied array from array to new table.
          5. insert the DB_VESRION of the global variable into Async Storage.

          Thus you can alter the table in the live application. I have done it one of my application. Can you please see and suggest if any problem in this concept? as it is working fine in my case.

  3. I have a question I created a base like in the point: You can make the database in runtime. How can I view the base physically in SQLite? e.g. View records in the database.

    • 1. For Android connect the device which has the application now open the project in Android Studio and You can see the option called “Device File Explore” in the rightmost upper/bottom corner.

      2. Now click the option and data > data and your application package name which can be found in the AndroidManifest.xml file (It is something link xyz.abd.kjh).

      3. you can right-click to save the database and it can be opened via SQLite Browser.

      Can you please check your inbox for further information.

  4. Hello sir ! thanks for the tutorial I tried but can’t build my project BUILD FAILED *What went wrong: java.io.IOException unable to delete directory D:\test\node_modules\react-native-sqlite-storage\src\android\build\generated\source\buildConfig\debug.
    how can i solve this…?

    • Hello Gulshan,
      Just delete D:\testpro\node_modules\react-native-sqlite-storage\src\android\build\generated\ directory and run again. This is a usual problem after Android Studio 3.+

  5. Hello,
    I read your post on local storage in React Native and It was very helpful compared to other post I have been reading.
    Thank You, for that first.

    Now my question is,

    I need offline storage,
    And when I mean that, I need the database to be persisted even after the app is un installed.
    How to go about that ?

    • Hello Madara,
      Thank you for your words. 🙂
      If we talk about your query then it is not possible. Device OS removes the database and everything related to the application when we uninstall the app. The only thing that remains is the external files like images and videos.
      If you want you can export the database and can take the backup of it and when user installed the app you can import that again but the files are visible to the user so he/she can remove it also.

  6. Hello Snehal,

    I am able to see data over android mobile. But while opening the database locally on laptop which is connected to mobile , it is showing empty db in sqlite browser. I followed the steps that you mentioned while replying to @ola’s question.
    How to proceed further?
    One more doubt, are we able to have .db copy in phone memory also? If yes, what is the location.

  7. Hi Snehal Agrawal,
    It is very helpful to me. I would like to display ten items from sqlite DB by swipeing left and right in react native. can you please give an example solution..? By which I can learn more for my project.. Kindly help me out in this situation.. Thank you.

  8. Bonjour Snehal, bon travail.
    Au fait est ce que vous pouvez créer une base de données sqlite avec 2 o 3 tables avec des clés étrangères juste comme un exemple. Je galère vraiment sur ça

  9. hello sir
    i create a SqlLite database from react native.
    database working correctly.
    how can i found the location of database in my device and make backup?

  10. Hi Snehal Agrawal,
    Can you help in , How to sync Realm DB data to Amazon Dynamo DB, Is there any listener to do this, I am trying but unable to that thing.
    Appreciating You for providing these good tutorials!!

    Thank you!!

  11. Im savind data throw my app mobile but where it save this? I look into www/Database.db but dont have data. But I select * in table have data here.

  12. [From Brazil]

    Olá, eu gosto muito do seu site.
    Os exemplos são sensacionais!!

    Me ajudam muito a entender e aprender React-Native.

    Parabéns e obrigado.

  13. Hi

    Thanks for great tutorial..I just want to save array into table . So Please guide me the syntax for table creation

    Eg: [‘cat’,’dog’,’rat’] this array should save into table

  14. sir your code is awesome
    1) i want to also learn REDUX that how to store TextInput value in redux store and how to show alert on button onPress

    2)check stored value. If TextInput value is store or not

    so i need a program on REDUX please sir help me

Leave a Comment

This site uses Akismet to reduce spam. Learn how your comment data is processed.