polarisation / indexeddb-export-import Goto Github PK

Export/import an IndexedDB database to/from JSON. Can be used to backup and restore.

License: MIT License

JavaScript 100.00%

indexeddb-export-import's Introduction

indexeddb-export-import - JSON export/import for IndexedDB

IndexedDB is a client-side database API available in modern browsers and https://electron.atom.io/. During development and testing of an web / desktop app which uses IndexedDB, it can be helpful to save, load, or clear the contents of an IndexedDB database - this package provides that capability.

You can use indexeddb-export-import in a Node.js environment imported as a module (eg. for use with an Electron app). You may also use it in a browser environment by simply including via a <script> tag.

Usage

You will need an open IDBDatabase connection.

The following example exports a database, clears all object stores, then re-imports the database. It uses Dexie.js to initiate the database, but this is not required.

    const Dexie = require('dexie');
    const IDBExportImport = require('indexeddb-export-import');
    
    const db = new Dexie('MyDB');
    db.version(1).stores({
      things: 'id++, thing_name, thing_description',
    });
    db.open().then(function() {
      const idbDatabase = db.backendDB(); // get native IDBDatabase object from Dexie wrapper
    
      // export to JSON, clear database, and import from JSON
      IDBExportImport.exportToJsonString(idbDatabase, function(err, jsonString) {
        if (err) {
          console.error(err);
        } else {
          console.log('Exported as JSON: ' + jsonString);
          IDBExportImport.clearDatabase(idbDatabase, function(err) {
            if (!err) { // cleared data successfully
              IDBExportImport.importFromJsonString(idbDatabase, jsonString, function(err) {
                if (!err) {
                  console.log('Imported data successfully');
                }
              });
            }
          });
        }
      });
    }).catch(function(e) {
      console.error('Could not connect. ' + e);
    });

API

exportToJsonString(idbDatabase, cb)

Export all data from an IndexedDB database

Param	Type	Description
idbDatabase	`IDBDatabase`
cb	`function`	callback with signature (error, jsonString)

importFromJsonString(idbDatabase, jsonString, cb)

Import data from JSON into an IndexedDB database. This does not delete any existing data from the database, so keys could clash

Param	Type	Description
idbDatabase	`IDBDatabase`
jsonString	`string`	data to import, one key per object store
cb	`function`	callback with signature (error), where error is null on success

clearDatabase(idbDatabase, cb)

Clears a database of all data

Param	Type	Description
idbDatabase	`IDBDatabase`
cb	`function`	callback with signature (error), where error is null on success

Installation

$ npm install indexeddb-export-import

License

MIT

indexeddb-export-import's People

Contributors

Stargazers

Watchers

indexeddb-export-import's Issues

Failed to execute 'transaction' on 'IDBDatabase': The storeNames parameter was empty.

When importing a backup into a browser that didn't have an existing database I get the following error:

Uncaught DOMException: Failed to execute 'transaction' on 'IDBDatabase': The storeNames parameter was empty.

This is due to idbDatabase.objectStoreNames being an empty list in

  const transaction = idbDatabase.transaction(
      idbDatabase.objectStoreNames,
      'readwrite'
  );

Any help would be appreciated!

Looking for suggestion around how to use in browser execution js

I have a requirement to take a backup of indexed database from the browser. Can you please point me to a place that explains this or give me some pointers of how to use this library to run the backup from a browser.

Add handling for ArrayBuffer data

ArrayBuffer should be exported via some tricky way instead of JSON.stringify.

re-run npm install FAILS

if this module is already installed in the project, running the npm insatll fails with the message

`npm install
npm ERR! code EISGIT
npm ERR! path **\node_modules\indexeddb-export-import
npm ERR! git **\node_modules\indexeddb-export-import: Appears to be a git
repo or submodule.
npm ERR! git **\node_modules\indexeddb-export-import
npm ERR! git Refusing to remove it. Update manually,
npm ERR! git or move it out of the way first.

npm ERR! A complete log of this run can be found in:
npm ERR! **\AppData\Roaming\npm-cache_logs\2020-06-01T13_10_57_546Z-debug.log`

This error is caused because tar.gz in version 2.0.2 has a directory **. git ** inside, the solution is to remove and resend. The package **. zip ** is OK

Can it be used for saving a third-party site's indexedDB?

I'm trying to save a copy (whether JSON or some other format) of a third-party's site's indexedDB. Is that something that this library could help with? If so, what's a rough sketch of how to do that?

UglifyJs: ERROR - Unexpected token: name (count)

Hi,

When trying to bundling my project with webpack and UglifyJs I get the following error:

ERROR in static/js/vendor.a27e424093e8687946a1.js from UglifyJs
Unexpected token: name (count) [./node_modules/indexeddb-export-import/index.js:50,0][static/js/vendor.a27e424093e8687946a1.js:51531,6]
...
ERROR in static/js/vendor.c242818493dd22375921.js from UglifyJs
Unexpected token: name (count) [./node_modules/indexeddb-export-import/index.js:76,0][static/js/vendor.c242818493dd22375921.js:51557,5]

Question: is this supposed to export/import indexes?

This may be a very naive question but index creation is very slow for me and I have a large (400k+) table with a few indexes. Following the examples I am still getting the browser creating indexes internally (which use a lot of CPU and take several minutes, so it is very visible), so it appears this project doesn't do that. I would have been very surprised if it could do this but if you don't ask you will never know!

Hi, is this possible to use this project to backup data inside indexedDB in Electron APP?

We are trying to converting our Web App into an Electron APP.
We use DexieJS in our Web App, so we prefer to use it as well in our Electron APP.

However, we are worried about the data safety, since there are maybe some scenarios, the data inside indexedDB MIGHT be deleted. Such as reinstall the App, auto update the App etc. We are not sure about it. But we can not risk it.

I found this project while searching around the internet. I am wondering maybe this could be used to backup the indexedDB.

Is this possible?
Thanks.

Sets exported as empty objects

I'm saving sets to my database, eg new Set() and while they show as a Set in the indexeddb inspector, they appear as empty objects {} in the exported JSON.

Something like this in the Chrome inspector:

{
  items: Set(12)
}

becomes:

{
  "items": {}
}

Example needs to be updated

Example provided uses exportToJson but the method inside the package is exportToJsonString
applicable for importFromJson as well