React Hook for capacitor-data-storage-sqlite plugin
react-data-storage-sqlite-hook
CAPACITOR 5
Maintainers
| Maintainer | GitHub | Social |
|---|---|---|
| Quéau Jean Pierre | jepiqueau |
Installation
npm install --save capacitor-data-storage-sqlite
npm install --save-dev react-data-storage-sqlite-hookApplications demonstrating the use of the plugin and the react hook
React
- [react-datastoragesqlite-app] (https://github.com/jepiqueau/react-datastoragesqlite-app)
Ionic/React
- [react-data-storage-sqlite-app-starter] (https://github.com/jepiqueau/react-data-storage-sqlite-app-starter)
Usage
Import the hook from its own path:
import { useStorageSQLite } from 'react-data-storage-sqlite-hook'
import { Dialog } from '@capacitor/dialog';Then use the hook from that namespace in your app:
const [log, setLog] = useState<string[]>([]);
const errMess = useRef("");
const showAlert = async (message: string) => {
await Dialog.alert({
title: 'Error Dialog',
message: message,
});
};
const {echo, getPlatform, openStore, closeStore, isStoreOpen,
isStoreExists, deleteStore, getItem, setItem, getAllKeys,
getAllValues, getFilterValues, getAllKeysValues, isKey,
setTable, removeItem, clear, isTable, getAllTables, deleteTable,
isJsonValid, importFromJson, exportToJson, isAvailable} = useStorageSQLite();
useEffect(() => {
const testSimpleStore= async (): Promise<boolean> => {
setLog((log) => log.concat("* Tab 2 Page Start Test\n"));
try {
await openStore({});
await setItem('name', 'Jeep');
const val = await getItem('name');
await setItem('message', 'Hello World from ');
const mess = await getItem('message');
if( mess && val ) setLog((log) => log.concat(" > " + mess + " " + val + "\n"));
const keys = await getAllKeys();
setLog((log) => log.concat(" > keys : " + keys.length + "\n"));
for(let i: number = 0;i< keys.length;i++) {
setLog((log) => log.concat(' >> key[' + i + "] = " + keys[i] + "\n"));
}
let values: string[] = await getAllValues();
setLog((log) => log.concat(" > values : " + values.length + "\n"));
for(var i in values) {
// eslint-disable-next-line no-loop-func
setLog((log) => log.concat(` >> value[${i}] = ${values[i]} \n`));
}
const keysvalues = await getAllKeysValues();
setLog((log) => log.concat(" > keysvalues : " + keysvalues.length + "\n"));
for(let i: number = 0;i< keysvalues.length;i++) {
setLog((log) => log.concat(' >> key[' + i + "] = " + keysvalues[i].key +
' value[' + i + "] = " + keysvalues[i].value + "\n"));
}
let iskey: boolean = await isKey('name');
setLog((log) => log.concat(` > iskey name ${iskey} \n`));
const iskey1 = await isKey('foo');
setLog((log) => log.concat(` > iskey foo ${iskey1}\n`));
await setTable("testtable");
setLog((log) => log.concat(` > set table "testtable" result \n`));
await setItem('name', 'Jeepq');
await setItem('email', 'Jeepq@example.com');
await setItem('tel', '2255443315');
const name = await getItem('name');
if( name != null ) setLog((log) => log.concat(" > " + name + "\n"));
const email = await getItem('email');
if( email != null ) setLog((log) => log.concat(" > " + email + "\n"));
const tel = await getItem('tel');
if( tel != null ) setLog((log) => log.concat(" > " + tel + "\n"));
await removeItem('tel')
setLog((log) => log.concat(` > remove tel \n`));
iskey = await isKey('tel');
setLog((log) => log.concat(' > iskey tel ' + iskey + "\n"));
await clear();
setLog((log) => log.concat(` > clear table "testtable" \n`));
// store data to test getFilterValues
await setItem("session","Session Lowercase Opened");
const data = {'a':20,'b':'Hello World','c':{'c1':40,'c2':'cool'}};
await setItem("testJson",JSON.stringify(data));
await setItem("Session1","Session Uppercase 1 Opened");
await setItem("MySession2foo","Session Uppercase 2 Opened");
const data1 = 243.567;
await setItem("testNumber",data1.toString());
await setItem("Mylsession2foo","Session Lowercase 2 Opened");
await setItem("EnduSession","Session Uppercase End Opened");
await setItem("Endlsession","Session Lowercase End Opened");
await setItem("SessionReact","Session React Opened");
// Get All Values
values = await getAllValues();
if(values.length !== 9) {
setLog((log) => log.concat(" > getAllValues failed \n"));
} else {
for(let i = 0; i< values.length;i++) {
setLog((log) => log.concat(' key[' + i + "] = " + values[i] + "\n"));
}
setLog((log) => log.concat(" > getAllValues was successful \n"));
}
// Get Filter Values Starting with "session"
const stValues: string[] = await getFilterValues("%session");
if(stValues.length !== 3) {
setLog((log) => log.concat(" > getFilterValues Start failed \n"));
} else {
for(let i = 0; i< stValues.length;i++) {
setLog((log) => log.concat(' >> key[' + i + "] = " + stValues[i] + "\n"));
}
setLog((log) => log.concat(" > getFilterValues Start was successful \n"));
}
// Get Filter Values Ending with "session"
const endValues: string[] = await getFilterValues("session%");
if(endValues.length !== 3) {
setLog((log) => log.concat(" > getFilterValues End failed \n"));
} else {
for(let i = 0; i< endValues.length;i++) {
setLog((log) => log.concat(' >> key[' + i + "] = " + endValues[i] + "\n"));
}
setLog((log) => log.concat(" > getFilterValues End was successful \n"));
}
// Get Filter Values Containing "session"
const contValues: string[] = await getFilterValues("session");
if(contValues.length !== 7) {
setLog((log) => log.concat(" > getFilterValues Contain failed \n"));
setLog((log) => log.concat("* Tab 2 Page End Test failed\n"));
} else {
for(let i = 0; i< contValues.length;i++) {
setLog((log) => log.concat(' >> key[' + i + "] = " + contValues[i] + "\n"));
}
setLog((log) => log.concat(" > getFilterValues Contain was successful \n"));
}
const platform = await getPlatform();
if(platform.platform !== "web") {
let isStore = await isStoreExists({})
setLog((log) => log.concat(` > isStoreExists ${isStore} \n`));
if(!isStore) {
errMess.current = `isStoreExists 1 failed`;
return false;
}
const isOpen = await isStoreOpen({})
setLog((log) => log.concat(` > isStoreOpen ${isOpen} \n`));
if(!isOpen) {
errMess.current = `isStoreOpen failed`;
return false;
}
let isTableExists = await isTable({table: "testtable"})
setLog((log) => log.concat(` > isTableExists ${isTableExists} \n`));
if(!isTableExists) {
errMess.current = `isTable 1 failed`;
return false;
}
const tables: string[] = await getAllTables();
setLog((log) => log.concat(` > getAllTables ${tables.length} \n`));
await deleteTable({table: "testtable"});
isTableExists = await isTable({table: "testtable"})
setLog((log) => log.concat(` > isTableExists ${isTableExists} \n`));
if(isTableExists) {
errMess.current = `isTable 2 failed`;
return false;
}
await closeStore({});
await deleteStore({});
console.log("after deleteStore")
isStore = await isStoreExists({})
console.log("after isStoreExists")
if(isStore) {
errMess.current = `isStoreExists 2 failed`;
return false;
}
}
setLog((log) => log.concat("* Tab 2 Page End Test successful\n"));
return true;
} catch (err) {
errMess.current = `${err.message}`;
return false;
}
}
if (isAvailable) {
testSimpleStore().then(async res => {
if(res) {
setLog((log) => log
.concat("\n* The set of tests was successful *\n"));
} else {
setLog((log) => log
.concat("\n* The set of tests failed *\n"));
await showAlert(errMess.current);
}
});
} else {
getPlatform().then((ret: { platform: string; }) => {
setLog((log) => log.concat("\n* Not available for " +
ret.platform + " platform *\n"));
});
}
}, [ echo, getPlatform, openStore, closeStore, isStoreOpen, isStoreExists,
deleteStore, getItem, setItem, getAllKeys, getAllValues,
getFilterValues, getAllKeysValues, isKey, setTable,
removeItem, clear, isTable, getAllTables, deleteTable,
isJsonValid, importFromJson, exportToJson, isAvailable, errMess]);
Contributors ✨
Thanks goes to these wonderful people (emoji key):
 Jean Pierre Quéau |
This project follows the all-contributors specification. Contributions of any kind welcome!