Add example db entity and readme images

Author: Henus321

README.md

@@ -1,6 +1,6 @@
 # react-native-sqlite-explorer
 
-Explorer for react-native-sqlite-storage library database inside react native app
+Explorer for react-native-sqlite-storage inside react native app
 
 ## Installation
 
@@ -13,21 +13,27 @@ npm install react-native-sqlite-explorer
 ```js
 import SQLiteExplorer from 'react-native-sqlite-explorer';
 
-const DBExplorer = () => {
+const SQLiteExplorerScreen = () => {
   // initial baseName that you used in params or taken from openDatabase success callback:
   // SQLite.openDatabase({ name: baseName, location: 'default' }, DB => { DB.dbname <-- your baseName also here
   const baseName = '<your_base_name_here>';
 
   return <SQLiteExplorer params={{ name: baseName, location: 'default' }} />;
 };
 
-export default DBExplorer;
+export default SQLiteExplorerScreen;
 ```
 
 ## Tips
 
 Temporarily only for Android
 
+![Example 1](/src/assets/example-1.png)
+![Example 2](/src/assets/example-2.png)
+
+![Example 3](/src/assets/example-3.png)
+![Example 4](/src/assets/example-4.png)
+
 ## License
 
 MIT

example/src/App.tsx

@@ -3,6 +3,9 @@ import { Alert, StyleSheet, Text, View } from 'react-native';
 import { getDBPath } from '../../src/utils';
 import DB from './models/DB';
 import SQLiteExplorer from '../../src';
+import Document from './models/Document';
+import Record from './models/Record';
+import Setting from './models/Setting';
 
 const defaultBasePrefix = 'defaultBasePrefix';
 const defaultBasePostfix = '1';
@@ -22,16 +25,19 @@ export default function App() {
       !!pathString ? `Loading from ${pathString}...` : "Error! Can't find path"
     );
 
-    // инициализирую подключение к базе
+    // init database
     try {
       await DB.open(baseName);
       setOpened(true);
     } catch (error: any) {
-      Alert.alert(
-        'Внимание',
-        'Не удалось открыть базу данных: ' + error.message
-      );
+      Alert.alert('Error!', "Can't open database: " + error.message);
+      return;
     }
+
+    // init models
+    await Document.init();
+    await Record.init();
+    await Setting.init();
   };
 
   return (

example/src/models/DB.ts

@@ -1,15 +1,13 @@
-// версия с шифрованием - https://github.com/axsy-dev/react-native-sqlcipher-storage
 import { Alert } from 'react-native';
 import { getDBPath } from '../../../src/utils';
 
-import SQLite from 'react-native-sqlite-storage'; // sselect sqlite_version()    -   "3.22.0"
+import SQLite from 'react-native-sqlite-storage';
 
-// SQLite.DEBUG(process.env.NODE_ENV !== 'production');
 SQLite.DEBUG(false);
 SQLite.enablePromise(true);
 
 /**
- * Коннектор к базе данных
+ * Database connector
  */
 class Database {
   DB: SQLite.SQLiteDatabase | null = null;
@@ -18,11 +16,9 @@ class Database {
   transaction: Function = (callback: () => Promise<void>) =>
     this?.DB?.transaction(callback);
 
-  // сделаю свое логирование ошибок на проде
   executeSql: Function = async (sql: string, arg?: any[]): Promise<any[]> => {
-    // если вдруг подключение пропало, попытаюсь его восстановить
     if (!this.DB) {
-      Alert.alert('executeSql: Не удалось переподключиться к базе');
+      Alert.alert("executeSql: can't re-connect to database");
       return [];
     }
 
@@ -52,7 +48,7 @@ class Database {
         return resolve(this.DB);
       }
 
-      // не обязательно
+      // not necessary
       this.basePath = await getDBPath(baseName);
 
       const params = {
@@ -64,7 +60,6 @@ class Database {
         params,
         (DB) => {
           this.DB = DB;
-          // Нужно включить внешние ключи
           this.executeSql('PRAGMA foreign_keys = ON').then(() => {
             return resolve(DB);
           });
@@ -92,6 +87,13 @@ class Database {
       return resolve();
     });
   };
+
+  isTableExist = async (table: string = ''): Promise<boolean> => {
+    const ifExist = await this.executeSql(
+      `SELECT EXISTS(SELECT name FROM sqlite_master WHERE type='table' AND name='${table}') as exist`
+    );
+    return !!ifExist?.[0]?.rows?.item(0)?.exist ?? false;
+  };
 }
 
 export default new Database();

example/src/models/Document.ts

@@ -0,0 +1,33 @@
+import DB from './DB';
+
+class Document {
+  init: () => Promise<void> = () => {
+    return new Promise<void>(async (resolve): Promise<void> => {
+      DB.isTableExist('Document').then((ifExists): void => {
+        if (ifExists) {
+          resolve();
+        } else {
+          DB.transaction(async (): Promise<void> => {
+            await DB.executeSql(`
+								CREATE TABLE IF NOT EXISTS Document (
+									_id INTEGER PRIMARY KEY AUTOINCREMENT,
+									name VARCHAR(255)
+								)
+							`);
+            resolve();
+          });
+        }
+      });
+    });
+  };
+
+  truncate: () => Promise<void> = () => {
+    return new Promise(async (resolve): Promise<void> => {
+      await DB.executeSql('DROP TABLE IF EXISTS Document');
+      await this.init();
+      resolve();
+    });
+  };
+}
+
+export default new Document();

example/src/models/Record.ts

@@ -0,0 +1,37 @@
+import DB from './DB';
+
+class Record {
+  init: () => Promise<void> = () => {
+    return new Promise<void>(async (resolve): Promise<void> => {
+      DB.isTableExist('Record').then((ifExists): void => {
+        if (ifExists) {
+          resolve();
+        } else {
+          DB.transaction(async (): Promise<void> => {
+            await DB.executeSql(`
+								CREATE TABLE IF NOT EXISTS Record (
+									_id INTEGER PRIMARY KEY AUTOINCREMENT,
+									name VARCHAR(255),
+									description VARCHAR(255),
+									type VARCHAR(100),
+									code INTEGER,
+									json TEXT NOT NULL
+								)
+							`);
+            resolve();
+          });
+        }
+      });
+    });
+  };
+
+  truncate: () => Promise<void> = () => {
+    return new Promise(async (resolve): Promise<void> => {
+      await DB.executeSql('DROP TABLE IF EXISTS Record');
+      await this.init();
+      resolve();
+    });
+  };
+}
+
+export default new Record();

example/src/models/Setting.ts

@@ -0,0 +1,33 @@
+import DB from './DB';
+
+class Setting {
+  init: () => Promise<void> = () => {
+    return new Promise<void>(async (resolve): Promise<void> => {
+      DB.isTableExist('Setting').then((ifExists): void => {
+        if (ifExists) {
+          resolve();
+        } else {
+          DB.transaction(async (): Promise<void> => {
+            await DB.executeSql(`
+								CREATE TABLE IF NOT EXISTS Setting (
+									_id INTEGER PRIMARY KEY AUTOINCREMENT,
+									name VARCHAR(255)
+								)
+							`);
+            resolve();
+          });
+        }
+      });
+    });
+  };
+
+  truncate: () => Promise<void> = () => {
+    return new Promise(async (resolve): Promise<void> => {
+      await DB.executeSql('DROP TABLE IF EXISTS Setting');
+      await this.init();
+      resolve();
+    });
+  };
+}
+
+export default new Setting();