expo-sqlite-query-helper

expo-sqlite Query Helper 🦮

SQLite query helper library for expo-sqlite

Installation

Yarn

yarn add expo-sqlite-query-helper

NPM

npm install --save expo-sqlite-query-helper

Usage

import { useEffect } from "react";
import Database, { createTable, insert } from "expo-sqlite-query-helper";

const App = () => {
  const db = Database("myDatabase.db");

  useEffect(() => {
    createTable("user", {
      name: "TEXT",
      email: "TEXT",
    }).then((row, rowAffected, insertID) =>
      console.log("success", row, rowAffected, insertID)
    );
    insert([{ name: "Jhon", email: "[e-mail]" }], "user")
      .then((row, rowAffected, insertID) => {
        console.log("success", row, rowAffected, insertID);
      })
      .catch((e) => console.log(e));
  }, []);
};

API

Initialize

import Database from "expo-sqlite-query-helper";

Database("database_name.db");

Create Table

Async function to create new table.
under the hood it runs CREATE TABLE IF NOT EXIST.

import { createTable } from "expo-sqlite-query-helper";

createTable(tableName: string, columns: { [key: string]: string });

tableName - Name of the table to create.
columns - Column object, key is name of column, value is type & other arguments for columns (as per sqlite).

Insert

Async function to run insert query, Takes array of objects to insert into specified table.
under the hood it runs INSERT INTO table (...columns) values(...values1), (...values2);

import { insert } from "expo-sqlite-query-helper";

insert(table: string, data: InsertObject[]);

tableName - Name of the table to insert data.
data - array of objects to insert into table.
example: [{name:"test1",email:"[e-mail]"},{name:"test2",email:"[e-mail]"}].
Return promise resolving with rowsAffected, insertId