Rasmus/docs.sheetjs.com
1
Fork 0
forked from sheetjs/docs.sheetjs.com
Code Pull Requests Activity
b8269a2871
docs.sheetjs.com/docz/docs/03-demos/27-local/09-indexeddb.md

246 lines
6.9 KiB
Markdown
Raw Normal View History

alasql
2023-02-24 07:46:48 +00:00
---
title: IndexedDB API
react
2023-02-28 11:40:44 +00:00
pagination_prev: demos/desktop/index
pagination_next: demos/local/index
alasql
2023-02-24 07:46:48 +00:00
sidebar_custom_props:
gsheet-api
2023-09-18 06:44:33 +00:00
summary: Reading and writing data in an in-browser NoSQL database
alasql
2023-02-24 07:46:48 +00:00
---
idb
2023-02-27 00:33:01 +00:00
<head>
<script type="text/javascript" src="https://unpkg.com/localforage@1.10.0/dist/localforage.min.js"></script>
idb
2023-06-01 08:25:44 +00:00
<script type="text/javascript" src="https://unpkg.com/dexie@3.2.4/dist/dexie.js"></script>
idb
2023-02-27 00:33:01 +00:00
</head>
win-arm
2023-09-19 19:08:29 +00:00
:::warning pass
alasql
2023-02-24 07:46:48 +00:00
idb
2023-02-27 00:33:01 +00:00
IndexedDB is a very low-level API.
server
2023-10-16 09:12:56 +00:00
Browser vendors recommend using [WebSQL](/docs/demos/local/websql) or wrapper
libraries in production applications.
idb
2023-02-27 00:33:01 +00:00
:::
idb
2023-06-01 08:25:44 +00:00
The IndexedDB API provides an in-browser sandboxed local data store for JSON
objects. Like the [Local Storage API](/docs/demos/data/storageapi), IndexedDB is
a popular choice for offline storage.
idb
2023-02-27 00:33:01 +00:00
## Wrapper Libraries
A number of popular wrapper libraries seek to simplify IndexedDB operations.
knex
2023-09-24 03:59:48 +00:00
:::note pass
idb
2023-02-27 00:33:01 +00:00
The wrapper libraries in this section have been used by SheetJS users in
production sites.
:::
### localForage
dbox
2023-11-30 07:10:37 +00:00
:::note Tested Deployments
idb
2023-02-27 00:33:01 +00:00
darwin-arm
2023-10-19 05:23:55 +00:00
This demo was last tested in the following environments:
| Browser | Date | `localForage` |
|:------------|:-----------|:--------------|
linux-x64 refresh
2024-03-22 04:45:40 +00:00
| Chrome 122 | 2024-03-21 | 1.10.0 |
dbox
2023-11-30 07:10:37 +00:00
| Safari 17.0 | 2023-11-30 | 1.10.0 |
alasql
2023-02-24 07:46:48 +00:00
:::
`localForage` is a IndexedDB wrapper that presents an async Storage interface.
idb
2023-02-27 00:33:01 +00:00
Arrays of objects can be stored using `setItem` using row index as key:
alasql
2023-02-24 07:46:48 +00:00
```js
const aoo = XLSX.utils.sheet_to_json(ws);
idb
2023-02-27 00:33:01 +00:00
for(var i = 0; i < aoo.length; ++i) await localForage.setItem(i, aoo[i]);
alasql
2023-02-24 07:46:48 +00:00
```
idb
2023-02-27 00:33:01 +00:00
Recovering the array of objects involves an iteration over the storage:
alasql
2023-02-24 07:46:48 +00:00
```js
const aoo = [];
idb
2023-02-27 00:33:01 +00:00
await localforage.iterate((v, k) => { aoa[+k] = v; });
const ws = XLSX.utils.json_to_sheet(aoo);
alasql
2023-02-24 07:46:48 +00:00
```
idb
2023-02-27 00:33:01 +00:00
#### Demo
This demo prepares a small IndexedDB database with some sample data.
After saving the exported file, the IndexedDB database can be inspected in the
"IndexedDB" section of the "Application" Tab of Developer Tools:
![IndexedDB view in Developer Tools](pathname:///storageapi/lforage.png)
```jsx live
function SheetJSLocalForage() {
const data = [
{ Name: "Barack Obama", Index: 44 },
{ Name: "Donald Trump", Index: 45 },
{ Name: "Joseph Biden", Index: 46 }
];
const xport = React.useCallback(async() => {
/* force use of IndexedDB and connect to DB */
localforage.config({
driver: [ localforage.INDEXEDDB ],
name: "SheetQL",
size: 2097152
});
/* create sample data */
await localforage.clear();
for(var i = 0; i < data.length; ++i) await localforage.setItem(i, data[i]);
/* pull data and generate aoa */
const aoo = [];
await localforage.iterate((v, k) => { aoo[+k] = v; });
/* export */
const ws = XLSX.utils.json_to_sheet(aoo);
const wb = XLSX.utils.book_new();
XLSX.utils.book_append_sheet(wb, ws, "Presidents");
XLSX.writeFile(wb, "SheetJSLocalForage.xlsx");
});
return ( <pre><button onClick={xport}><b>Do it!</b></button></pre> );
}
```
### DexieJS
dbox
2023-11-30 07:10:37 +00:00
:::note Tested Deployments
idb
2023-02-27 00:33:01 +00:00
darwin-arm
2023-10-19 05:23:55 +00:00
This demo was last tested in the following environments:
| Browser | Date | DexieJS |
|:------------|:-----------|:--------|
linux-x64 refresh
2024-03-22 04:45:40 +00:00
| Chrome 122 | 2024-03-21 | 3.2.4 |
idb
2023-02-27 00:33:01 +00:00
:::
DexieJS is a minimalistic wrapper for IndexedDB. It provides a convenient
interface for creating multiple logical tables, well-suited for workbooks.
#### Importing Data
When configuring tables, DexieJS needs a schema. The schema definition supports
primary keys and other properties, but they are not required:
```js
/* assuming `wb` is a workbook from XLSX.read */
var db = new Dexie("SheetJSDexie");
db.version(1).stores(Object.fromEntries(wb.SheetNames.map(n => ([n, "++"]))));
```
After the database is configured, `bulkPut` can insert arrays of objects:
```js
/* loop over worksheet names */
for(let i = 0; i <= wb.SheetNames.length; ++i) {
/* get the worksheet for the specified index */
const wsname = wb.SheetNames[i];
const ws = wb.Sheets[wsname];
if(!ws) continue;
/* generate an array of objects */
const aoo = XLSX.utils.sheet_to_json(ws);
/* push to idb */
await db[wsname].bulkPut(aoo);
}
```
This demo inserts all data from a selected worksheet into a database, then
linux-x64 refresh
2024-03-22 04:45:40 +00:00
fetches the data from the first worksheet in reverse.
After saving the exported file, the "IndexedDB" section of the "Application" Tab
of Developer Tools will include a database named "SheetJSDexie".
idb
2023-02-27 00:33:01 +00:00
```jsx live
/* The live editor requires this function wrapper */
function SheetJSDexieImport(props) {
const [__html, setHTML] = React.useState("Select a spreadsheet");
react
2023-02-28 11:40:44 +00:00
return ( <>
idb
2023-02-27 00:33:01 +00:00
<input type="file" onChange={async(e) => { try {
/* get data as an ArrayBuffer */
const file = e.target.files[0];
const data = await file.arrayBuffer();
/* parse worksheet */
const wb = XLSX.read(data);
/* load into indexeddb */
await Dexie.delete("SheetJSDexie");
const db = new Dexie("SheetJSDexie");
const wsnames = wb.SheetNames.map(n => ([n, "++"]));
db.version(1).stores(Object.fromEntries(wsnames));
/* loop over worksheet names */
for(let i = 0; i <= wb.SheetNames.length; ++i) {
/* get the worksheet for the specified index */
const wsname = wb.SheetNames[i];
const ws = wb.Sheets[wsname];
if(!ws) continue;
/* generate an array of objects */
const aoo = XLSX.utils.sheet_to_json(ws);
/* push to idb */
await db[wsname].bulkPut(aoo);
}
/* fetch the first table in reverse order */
const rev = await db[wb.SheetNames[0]].reverse().toArray();
setHTML(rev.map(r => JSON.stringify(r)).join("\n"));
} catch(e) { setHTML(e && e.message || e); }}}/>
<pre dangerouslySetInnerHTML={{ __html }}/>
react
2023-02-28 11:40:44 +00:00
</> );
idb
2023-02-27 00:33:01 +00:00
}
```
#### Exporting Data
`db.tables` is a plain array of table objects. `toArray` fetches data:
```js
/* create blank workbook */
const wb = XLSX.utils.book_new();
/* loop tables */
for(const table of db.tables) {
/* get data */
const aoo = await table.toArray();
/* create worksheet */
const ws = XLSX.utils.json_to_sheet(aoo);
/* add to workbook */
XLSX.utils.book_append_sheet(wb, ws, table.name);
}
```
This demo prepares a small database with some sample data.
```jsx live
function SheetJSDexieExport() {
const data = [
{ Name: "Barack Obama", Index: 44 },
{ Name: "Donald Trump", Index: 45 },
{ Name: "Joseph Biden", Index: 46 }
];
const xport = React.useCallback(async() => {
/* prepare db */
await Dexie.delete("SheetJSDexie");
var db = new Dexie("SheetJSDexie");
db.version(1).stores({ Presidents: "++" });
db.Presidents.bulkPut(data);
/* pull data and generate workbook */
const wb = XLSX.utils.book_new();
for(const table of db.tables) {
const aoo = await table.toArray();
const ws = XLSX.utils.json_to_sheet(aoo);
XLSX.utils.book_append_sheet(wb, ws, table.name);
}
XLSX.writeFile(wb, "SheetJSDexie.xlsx");
});
return ( <pre><button onClick={xport}><b>Do it!</b></button></pre> );
}
```
Copy Permalink