Merge pull request #62 from ospfranco/proxy-object

Author: Oscar Franco

README.md

@@ -135,14 +135,13 @@ openDatabase(
 
 # Usage
 
-Import as early as possible, auto-installs bindings in a thread-safe manner.
+Just import the package and fire away
 
 ```typescript
 // Thanks to @mrousavy for this installation method, see one example: https://github.com/mrousavy/react-native-mmkv/blob/75b425db530e26cf10c7054308583d03ff01851f/src/createMMKV.ts#L56
-import 'react-native-quick-sqlite';
+import { QuickSQLite } from 'react-native-quick-sqlite';
 
-// Afterwards `sqlite` is a globally registered object, so you can directly call it from anywhere in your javascript
-const dbOpenResult = sqlite.open('myDatabase', 'databases');
+const dbOpenResult = QuickSQLite.open('myDatabase', 'databases');
 
 // status === 1, operation failed
 if (dbOpenResult.status) {
@@ -155,7 +154,7 @@ if (dbOpenResult.status) {
 The basic query is **synchronous**, it will block rendering on large operations, below there are async versions.
 
 ```typescript
-let { status, rows } = sqlite.executeSql(
+let { status, rows } = QuickSQLite.executeSql(
   'myDatabase',
   'SELECT somevalue FROM sometable'
 );
@@ -165,7 +164,7 @@ if (!status) {
   });
 }
 
-let { status, rowsAffected } = sqlite.executeSql(
+let { status, rowsAffected } = QuickSQLite.executeSql(
   'myDatabase',
   'UPDATE sometable SET somecolumn = ? where somekey = ?',
   [0, 1]
@@ -182,7 +181,7 @@ Transactions are supported. However, due to the library being opinionated and mo
 JSI bindings are fast but there is still some overhead calling `executeSql` for single queries, if you want to execute a large set of commands as fast as possible you should use the `executeSqlBatch` method below, it still uses transactions, but only transmits data between JS and native once.
 
 ```typescript
-sqlite.transaction('myDatabase', (tx) => {
+QuickSQLite.transaction('myDatabase', (tx) => {
   const {
     status,
   } = tx.executeSql('UPDATE sometable SET somecolumn = ? where somekey = ?', [
@@ -209,7 +208,7 @@ const commands = [
     ('INSERT INTO TABLE TEST (id) VALUES (?)', [2])
   ][('INSERT INTO TABLE TEST (id) VALUES (?)', [[3], [4], [5], [6]])],
 ];
-const result = sqlite.executeSqlBatch('myDatabase', commands);
+const result = QuickSQLite.executeSqlBatch('myDatabase', commands);
 if (!result.status) {
   // result.status undefined or 0 === success
   console.log(`Batch affected ${result.rowsAffected} rows`);
@@ -225,7 +224,7 @@ sqlite datatypes. When fetching data directly from tables or views linked to tab
 to identify the table declared types:
 
 ```typescript
-let { status, metadata } = sqlite.executeSql(
+let { status, metadata } = QuickSQLite.executeSql(
   'myDatabase',
   'SELECT int_column_1, bol_column_2 FROM sometable'
 );
@@ -244,7 +243,7 @@ if (!status) {
 You might have too much SQL to process and it will cause your application to freeze. There are async versions for some of the operations. This will offload the SQLite processing to a different thread.
 
 ```ts
-sqlite.asyncExecuteSql(
+QuickSQLite.asyncExecuteSql(
   'myDatabase',
   'SELECT * FROM "User";',
   [],
@@ -270,21 +269,29 @@ SQLite have a limit for attached databases: A default of 10, and a global max of
 References: [Attach](https://www.sqlite.org/lang_attach.html) - [Detach](https://www.sqlite.org/lang_detach.html)
 
 ```ts
-const result = sqlite.attach('mainDatabase', 'statistics', 'stats', '../databases',);
+const result = QuickSQLite.attach(
+  'mainDatabase',
+  'statistics',
+  'stats',
+  '../databases'
+);
 
 // Database is attached sucefully
-if(!result.status) {
-  const data = sqlite.executeSql('mainDatabase', 'SELECT * FROM some_table_from_mainschema a INNER JOIN stats.some_table b on a.id_column = b.id_column');
+if (!result.status) {
+  const data = QuickSQLite.executeSql(
+    'mainDatabase',
+    'SELECT * FROM some_table_from_mainschema a INNER JOIN stats.some_table b on a.id_column = b.id_column'
+  );
   // Consume the results
-  if(!data.status) {}
+  if (!data.status) {
+  }
 }
 
 // You can detach databases at any moment
-const detachResult = sqlite.detach('mainDatabase', 'stats');
-if(!detachResult.status) {
+const detachResult = QuickSQLite.detach('mainDatabase', 'stats');
+if (!detachResult.status) {
   // Database dettached
 }
-
 ```
 
 ## Use built-in SQLite

cpp/installer.cpp

@@ -498,5 +498,5 @@ void install(jsi::Runtime &rt, std::shared_ptr<react::CallInvoker> jsCallInvoker
   module.setProperty(rt, "loadSqlFile", move(loadSQLFile));
   module.setProperty(rt, "asyncLoadSqlFile", move(loadSQLFileAsync));
 
-  rt.global().setProperty(rt, "sqlite", move(module));
+  rt.global().setProperty(rt, "__QuickSQLiteProxy", move(module));
 }

example/ios/Podfile

@@ -11,7 +11,7 @@ target 'SequelExample' do
     :hermes_enabled => true
   )
 
-  # pod 'react-native-quick-sqlite', :path => '../..'
+  pod 'react-native-quick-sqlite', :path => '../..'
 
   post_install do |installer|
     react_native_post_install(installer)

example/ios/Podfile.lock

@@ -228,7 +228,7 @@ PODS:
   - React-jsinspector (0.67.3)
   - React-logger (0.67.3):
     - glog
-  - react-native-quick-sqlite (3.1.6):
+  - react-native-quick-sqlite (3.1.9):
     - React
     - React-callinvoker
     - React-Core
@@ -322,7 +322,7 @@ DEPENDENCIES:
   - React-jsiexecutor (from `../node_modules/react-native/ReactCommon/jsiexecutor`)
   - React-jsinspector (from `../node_modules/react-native/ReactCommon/jsinspector`)
   - React-logger (from `../node_modules/react-native/ReactCommon/logger`)
-  - react-native-quick-sqlite (from `../node_modules/react-native-quick-sqlite`)
+  - react-native-quick-sqlite (from `../..`)
   - React-perflogger (from `../node_modules/react-native/ReactCommon/reactperflogger`)
   - React-RCTActionSheet (from `../node_modules/react-native/Libraries/ActionSheetIOS`)
   - React-RCTAnimation (from `../node_modules/react-native/Libraries/NativeAnimation`)
@@ -381,7 +381,7 @@ EXTERNAL SOURCES:
   React-logger:
     :path: "../node_modules/react-native/ReactCommon/logger"
   react-native-quick-sqlite:
-    :path: "../node_modules/react-native-quick-sqlite"
+    :path: "../.."
   React-perflogger:
     :path: "../node_modules/react-native/ReactCommon/reactperflogger"
   React-RCTActionSheet:
@@ -431,7 +431,7 @@ SPEC CHECKSUMS:
   React-jsiexecutor: 15ea57ead631a11fad57634ff69f78e797113a39
   React-jsinspector: 1e1e03345cf6d47779e2061d679d0a87d9ae73d8
   React-logger: 1e10789cb84f99288479ba5f20822ce43ced6ffe
-  react-native-quick-sqlite: 0ef475fce0dc4bf4fdc2a9844d79a698414ea0b9
+  react-native-quick-sqlite: 839371a5e9ee06ce460a3e4f27f93fd51c2d31b4
   React-perflogger: 93d3f142d6d9a46e635f09ba0518027215a41098
   React-RCTActionSheet: 87327c3722203cc79cf79d02fb83e7332aeedd18
   React-RCTAnimation: 009c87c018d50e0b38692699405ebe631ff4872d
@@ -446,6 +446,6 @@ SPEC CHECKSUMS:
   ReactCommon: 650e33cde4fb7d36781cd3143f5276da0abb2f96
   Yoga: 90dcd029e45d8a7c1ff059e8b3c6612ff409061a
 
-PODFILE CHECKSUM: d17e982a36a0c00f901deed42f61b5a036acbc9f
+PODFILE CHECKSUM: 23fbb34cc9cd3db2810e5bb10e37bce3ce025dee
 
 COCOAPODS: 1.11.3

example/package.json

@@ -15,7 +15,6 @@
     "buffer": "^6.0.3",
     "react": "17.0.2",
     "react-native": "0.67.3",
-    "react-native-quick-sqlite": "./..",
     "reflect-metadata": "^0.1.13",
     "typeorm": "^0.3.6"
   },

example/src/App.tsx

@@ -15,8 +15,8 @@ import {
   queryUsers,
   testInsert,
   testTransaction,
-  typeORMGetBooks,
-  typeORMInit,
+  // typeORMGetBooks,
+  // typeORMInit,
   executeFailingTypeORMQuery,
 } from './Database';
 import type { User } from './model/User';
@@ -26,14 +26,15 @@ export default function App() {
   let [users, setUsers] = React.useState<User[]>([]);
 
   React.useEffect(() => {
-    // lowLevelInit();
-    // const users = queryUsers();
-    // setUsers(users);
-    typeORMInit().then(() => {
-      typeORMGetBooks().then((books) => {
-        // console.warn('typeORM books', books);
-      });
-    });
+    lowLevelInit();
+    const users = queryUsers();
+    console.warn('db users', users);
+    setUsers(users);
+    // typeORMInit().then(() => {
+    //   typeORMGetBooks().then((books) => {
+    //     // console.warn('typeORM books', books);
+    //   });
+    // });
   }, []);
 
   return (
@@ -58,6 +59,10 @@ export default function App() {
         title="Create user (with transaction)"
         onPress={() => {
           testTransaction();
+          setTimeout(() => {
+            const users = queryUsers();
+            setUsers(users);
+          }, 1000);
         }}
       />
       <Button

example/src/Database.ts

@@ -1,5 +1,5 @@
 /* eslint-disable no-undef */
-import '../..';
+import { QuickSQLite as sqlite } from 'react-native-quick-sqlite';
 import { DataSource } from 'typeorm';
 import { Book } from './model/Book';
 import { User } from './model/User';
@@ -30,47 +30,35 @@ export const lowLevelInit = () => {
 export const testTransaction = () => {
   sqlite.transaction('test', (tx) => {
     tx.executeSql(
-      'INSERT INTO "User" (id, name, age, networth) VALUES(?, ?, ?, ?)',
+      'INSERT INTO "User" (id, name, age, networth) VALUES(?, ?, ?, ?);',
       [new Date().getMilliseconds(), `Jerry`, 45, 20.23]
     );
-
-    tx.executeSql(
-      'INSERT INTO "User" (id, name, age, networth) VALUES(?, ?, ?, ?)',
-      [new Date().getMilliseconds(), `Tom`, 23, 100]
-    );
-
+    console.warn('committing transaction');
     // return true to commit transaction, false to revert
     return true;
   });
 };
 
 export const testInsert = () => {
   // Basic request
-  const { status: createUserStatus } = sqlite.executeSql(
+  const { status: createUserStatus, message } = sqlite.executeSql(
     'test',
-    'INSERT INTO "User" (id, name, age, networth) VALUES(?, ?, ?, ?)',
-    [
-      new Date().getMilliseconds(),
-      `{"nickname":"mike", "name":"michael"}`,
-      32,
-      3000.23,
-    ]
+    'INSERT INTO "User" (id, name, age, networth) VALUES(?, ?, ?, ?);',
+    [new Date().getMilliseconds(), `TOM`, 32, 3000.23]
   );
 
   // handle error
   if (createUserStatus) {
-    console.error('Failed to insert user');
+    console.error('Failed to insert user:', message);
   }
 
+  console.warn('user inserted', createUserStatus);
+
   return queryUsers();
 };
 
 export const queryUsers = () => {
-  const queryResult = sqlite.executeSql(
-    'test',
-    `SELECT *, json_extract("User".name, '$.nickname') as name FROM "User"`,
-    []
-  );
+  const queryResult = sqlite.executeSql('test', `SELECT * FROM "User"`, []);
 
   return queryResult.rows?._array;
 
@@ -83,9 +71,9 @@ export const queryUsers = () => {
 export async function typeORMInit() {
   datasource = new DataSource({
     type: 'react-native',
-    database: 'test2',
+    database: 'test',
     location: '.',
-    entities: [Book],
+    entities: [Book, User],
     synchronize: true,
   });
 

ios/QuickSQLite.mm

@@ -1,51 +1,42 @@
-/*
- * Sequel.mm
- *
- * Created by Oscar Franco on 2021/03/07
- * Copyright (c) 2021 Oscar Franco
- *
- * This code is licensed under the MIT license
- */
-
 #import "QuickSQLite.h"
-#import "installer.h"
 
 #import <React/RCTBridge+Private.h>
-#import <jsi/jsi.h>
-#import <ReactCommon/RCTTurboModuleManager.h>
 
 #import <React/RCTUtils.h>
-#import <ReactCommon/CallInvoker.h>
+#import <ReactCommon/RCTTurboModule.h>
+#import <jsi/jsi.h>
 
-#import <memory>
+#import "../cpp/installer.h"
 
 @implementation QuickSQLite
 
-@synthesize bridge = _bridge;
-@synthesize methodQueue = _methodQueue;
+RCT_EXPORT_MODULE(QuickSQLite)
 
-RCT_EXPORT_MODULE()
 
-+ (BOOL)requiresMainQueueSetup {
-  return YES;
-}
+RCT_EXPORT_BLOCKING_SYNCHRONOUS_METHOD(install) {
+  NSLog(@"Installing QuickSQLite module...");
+
+  RCTBridge *bridge = [RCTBridge currentBridge];
+  RCTCxxBridge *cxxBridge = (RCTCxxBridge *)bridge;
+  if (cxxBridge == nil) {
+    return @false;
+  }
 
-- (void)setBridge:(RCTBridge *)bridge {
-  _bridge = bridge;
-  _setBridgeOnMainQueue = RCTIsMainQueue();
+  using namespace facebook;
 
-  RCTCxxBridge *cxxBridge = (RCTCxxBridge *)self.bridge;
-  if (!cxxBridge.runtime) {
-    return;
+  auto jsiRuntime = (jsi::Runtime *)cxxBridge.runtime;
+  if (jsiRuntime == nil) {
+    return @false;
   }
-  
+  auto &runtime = *jsiRuntime;
   auto callInvoker = bridge.jsCallInvoker;
 
   // Get iOS app's document directory (to safely store database .sqlite3 file)
   NSArray *paths = NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, true);
   NSString *documentPath = [paths objectAtIndex:0];
 
-  install(*(facebook::jsi::Runtime *)cxxBridge.runtime, callInvoker,[documentPath UTF8String]);
+  install(runtime, callInvoker,[documentPath UTF8String]);
+  return @true;
 }
 
 @end

package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-quick-sqlite",
-  "version": "3.1.9",
+  "version": "4.0.0",
   "description": "Fast SQLite for react-native",
   "main": "lib/commonjs/index",
   "module": "lib/module/index",