Out of date, to be updated

The following NPM packages may be included in this product:

...

• Export of IndexedDB Database to JSON Blob.

• Import from Blob back to IndexedDB Database.

• An import Blob can be retrieved from an URL (using fetch()) or from a user-input file (dropped or browsed to).

• An export Blob can be either given end-user to be stored in Downloaded Files, or be send to a server over HTTP(S) using fetch().

• Chunk-wise / Streaming - does not read the entire DB into RAM

• Progress callback (typically for showing progress bar)

• Optional filter allows to import/export subset of data

• Support for all structured clonable exotic types (Date, ArrayBuffer, Blob, etc) except CryptoKeys (which by design cannot be exported)

• Atomic - import / export within one database transaction (optional)

• Export speed: Using getAll() in chunks rather than openCursor().

• Import speed: Using bulkPut() in chunks rather than put().

• Can well be run from a Web Worker (better speed + doesn't lock GUI).

• Can also export IndexedDB databases that was not created with Dexie.

Compatibility

Similar Libraries

indexeddb-export-import

...

function export(db) {
    return db.transaction('r', db.tables, ()=>{
        return Promise.all(
            db.tables.map(table => table.toArray()
                .then(rows => ({table: table.name, rows: rows})));
    });
}

function import(data, db) {
    return db.transaction('rw', db.tables, () => {
        return Promise.all(data.map (t =>
            db.table(t.table).clear()
              .then(()=>db.table(t.table).bulkAdd(t.rows)));
    });
}

Looks simple!

But:

1. The whole database has to fit in RAM. Can be issue on small devices.

2. If using JSON.stringify() / JSON.parse() on the data, we won't support exotic types (Dates, Blobs, ArrayBuffers, etc)

3. Not possible to show a progress while importing.

This addon solves these issues, and some more, with the help of some libraries.

...

I use two different solutions for this:

1. If we are in a Worker, I use new FileReaderSync() instead of new FileReader().

2. If in the main thread, I use Dexie.waitFor() to while reading this short elapsed chunk, keeping the transaction alive still.

Ok, fine, but how do we parse the chunk then? Cannot use JSON.parse(firstPart) because it will most defenitely be incomplete.

...

Blobs can be constructeed from an array of other Blobs. This is the key.

1. Let's say we generate 1000 Blobs of 1MB each on a device with 512 MB RAM. If the browser does its job well, it will allow the first 200 blobs or so to reside in RAM. But then, it should start putting the remanding blobs onto temporary files.

2. We put all these 1000 blobs into an array and generate a final Blob from that array.

And that's pretty much it.

...

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

   "License" shall mean the terms and conditions for use, reproduction,

   and distribution as defined by Sections 1 through 9 of this document.

   "Licensor" shall mean the copyright owner or entity authorized by

   the copyright owner that is granting the License.

   "Legal Entity" shall mean the union of the acting entity and all

   other entities that control, are controlled by, or are under common

   control with that entity. For the purposes of this definition,

   "control" means (i) the power, direct or indirect, to cause the

   direction or management of such entity, whether by contract or

   otherwise, or (ii) ownership of fifty percent (50%) or more of the

   outstanding shares, or (iii) beneficial ownership of such entity.

   "You" (or "Your") shall mean an individual or Legal Entity

   exercising permissions granted by this License.

   "Source" form shall mean the preferred form for making modifications,

   including but not limited to software source code, documentation

   source, and configuration files.

   "Object" form shall mean any form resulting from mechanical

   transformation or translation of a Source form, including but

   not limited to compiled object code, generated documentation,

   and conversions to other media types.

   "Work" shall mean the work of authorship, whether in Source or

   Object form, made available under the License, as indicated by a

   copyright notice that is included in or attached to the work

   (an example is provided in the Appendix below).

   "Derivative Works" shall mean any work, whether in Source or Object

   form, that is based on (or derived from) the Work and for which the

   editorial revisions, annotations, elaborations, or other modifications

   represent, as a whole, an original work of authorship. For the purposes

   of this License, Derivative Works shall not include works that remain

   separable from, or merely link (or bind by name) to the interfaces of,

   the Work and Derivative Works thereof.

   "Contribution" shall mean any work of authorship, including

   the original version of the Work and any modifications or additions

   to that Work or Derivative Works thereof, that is intentionally

   submitted to Licensor for inclusion in the Work by the copyright owner

   or by an individual or Legal Entity authorized to submit on behalf of

   the copyright owner. For the purposes of this definition, "submitted"

   means any form of electronic, verbal, or written communication sent

   to the Licensor or its representatives, including but not limited to

   communication on electronic mailing lists, source code control systems,

   and issue tracking systems that are managed by, or on behalf of, the

   Licensor for the purpose of discussing and improving the Work, but

   excluding communication that is conspicuously marked or otherwise

   designated in writing by the copyright owner as "Not a Contribution."

   "Contributor" shall mean Licensor and any individual or Legal Entity

   on behalf of whom a Contribution has been received by Licensor and

   subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of

   this License, each Contributor hereby grants to You a perpetual,

   worldwide, non-exclusive, no-charge, royalty-free, irrevocable

   copyright license to reproduce, prepare Derivative Works of,

   publicly display, publicly perform, sublicense, and distribute the

   Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of

   this License, each Contributor hereby grants to You a perpetual,

   worldwide, non-exclusive, no-charge, royalty-free, irrevocable

   (except as stated in this section) patent license to make, have made,

   use, offer to sell, sell, import, and otherwise transfer the Work,

   where such license applies only to those patent claims licensable

   by such Contributor that are necessarily infringed by their

   Contribution(s) alone or by combination of their Contribution(s)

   with the Work to which such Contribution(s) was submitted. If You

   institute patent litigation against any entity (including a

   cross-claim or counterclaim in a lawsuit) alleging that the Work

   or a Contribution incorporated within the Work constitutes direct

   or contributory patent infringement, then any patent licenses

   granted to You under this License for that Work shall terminate

   as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the

   Work or Derivative Works thereof in any medium, with or without

   modifications, and in Source or Object form, provided that You

   meet the following conditions:

   (a) You must give any other recipients of the Work or

   Code Block
   Derivative Works a copy of this License; and

   (b) You must cause any modified files to carry prominent notices

   Code Block
   stating that You changed the files; and

   (c) You must retain, in the Source form of any Derivative Works

   Code Block
   that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and

   (d) If the Work includes a "NOTICE" text file as part of its

   Code Block

   distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.

   You may add Your own copyright statement to Your modifications and

   may provide additional or different license terms and conditions

   for use, reproduction, or distribution of Your modifications, or

   for any such Derivative Works as a whole, provided Your use,

   reproduction, and distribution of the Work otherwise complies with

   the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,

   any Contribution intentionally submitted for inclusion in the Work

   by You to the Licensor shall be under the terms and conditions of

   this License, without any additional terms or conditions.

   Notwithstanding the above, nothing herein shall supersede or modify

   the terms of any separate license agreement you may have executed

   with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade

   names, trademarks, service marks, or product names of the Licensor,

   except as required for reasonable and customary use in describing the

   origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or

   agreed to in writing, Licensor provides the Work (and each

   Contributor provides its Contributions) on an "AS IS" BASIS,

   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or

   implied, including, without limitation, any warranties or conditions

   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A

   PARTICULAR PURPOSE. You are solely responsible for determining the

   appropriateness of using or redistributing the Work and assume any

   risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,

   whether in tort (including negligence), contract, or otherwise,

   unless required by applicable law (such as deliberate and grossly

   negligent acts) or agreed to in writing, shall any Contributor be

   liable to You for damages, including any direct, indirect, special,

   incidental, or consequential damages of any character arising as a

   result of this License or out of the use or inability to use the

   Work (including but not limited to damages for loss of goodwill,

   work stoppage, computer failure or malfunction, or any and all

   other commercial damages or losses), even if such Contributor

   has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing

   the Work or Derivative Works thereof, You may choose to offer,

   and charge a fee for, acceptance of support, warranty, indemnity,

   or other liability obligations and/or rights consistent with this

   License. However, in accepting such obligations, You may act only

   on Your own behalf and on Your sole responsibility, not on behalf

   of any other Contributor, and only if You agree to indemnify,

   defend, and hold each Contributor harmless for any liability

   incurred by, or claims asserted against, such Contributor by reason

   of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

...

Mozilla Public License, version 2.0

1. Definitions

1.1. “Contributor”

 means each individual or legal entity that creates, contributes to the
 creation of, or owns Covered Software.

...

  means an individual or a legal entity exercising rights under this
  License. For legal entities, “You” includes any entity that controls, is
  controlled by, or is under common control with You. For purposes of this
  definition, “control” means (a) the power, direct or indirect, to cause
  the direction or management of such entity, whether by contract or
  otherwise, or (b) ownership of more than fifty percent (50%) of the
  outstanding shares or beneficial ownership of such entity.

1. License Grants and Conditions

2.1. Grants

 Each Contributor hereby grants You a world-wide, royalty-free,
 non-exclusive license:

 a. under intellectual property rights (other than patent or trademark)
    Licensable by such Contributor to use, reproduce, make available,
    modify, display, perform, distribute, and otherwise exploit its
    Contributions, either on an unmodified basis, with Modifications, or as
    part of a Larger Work; and

 b. under Patent Claims of such Contributor to make, use, sell, offer for
    sale, have made, import, and otherwise transfer either its Contributions
    or its Contributor Version.

...

 Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted in
 Section 2.1.

1. Responsibilities

3.1. Distribution of Source Form

...

 You may choose to offer, and to charge a fee for, warranty, support,
 indemnity or liability obligations to one or more recipients of Covered
 Software. However, You may do so only on Your own behalf, and not on behalf
 of any Contributor. You must make it absolutely clear that any such
 warranty, support, indemnity, or liability obligation is offered by You
 alone, and You hereby agree to indemnify every Contributor for any
 liability incurred by such Contributor as a result of warranty, support,
 indemnity or liability terms You offer. You may include additional
 disclaimers of warranty and limitations of liability specific to any
 jurisdiction.

1. Inability to Comply Due to Statute or Regulation

   If it is impossible for You to comply with any of the terms of this License

   with respect to some or all of the Covered Software due to statute, judicial

   order, or regulation then You must: (a) comply with the terms of this License

   to the maximum extent possible; and (b) describe the limitations and the code

   they affect. Such description must be placed in a text file included with all

   distributions of the Covered Software under this License. Except to the

   extent prohibited by statute or regulation, such description must be

   sufficiently detailed for a recipient of ordinary skill to be able to

   understand it.

2. Termination

5.1. The rights granted under this License will terminate automatically if You

...

 license agreements (excluding distributors and resellers) which have been
 validly granted by You or Your distributors under this License prior to
 termination shall survive termination.

1. Disclaimer of Warranty

   Covered Software is provided under this License on an “as is” basis, without

   warranty of any kind, either expressed, implied, or statutory, including,

   without limitation, warranties that the Covered Software is free of defects,

   merchantable, fit for a particular purpose or non-infringing. The entire

   risk as to the quality and performance of the Covered Software is with You.

   Should any Covered Software prove defective in any respect, You (not any

   Contributor) assume the cost of any necessary servicing, repair, or

   correction. This disclaimer of warranty constitutes an essential part of this

   License. No use of any Covered Software is authorized under this License

   except under this disclaimer.

2. Limitation of Liability

   Under no circumstances and under no legal theory, whether tort (including

   negligence), contract, or otherwise, shall any Contributor, or anyone who

   distributes Covered Software as permitted above, be liable to You for any

   direct, indirect, special, incidental, or consequential damages of any

   character including, without limitation, damages for lost profits, loss of

   goodwill, work stoppage, computer failure or malfunction, or any and all

   other commercial damages or losses, even if such party shall have been

   informed of the possibility of such damages. This limitation of liability

   shall not apply to liability for death or personal injury resulting from such

   party’s negligence to the extent applicable law prohibits such limitation.

   Some jurisdictions do not allow the exclusion or limitation of incidental or

   consequential damages, so this exclusion and limitation may not apply to You.

3. Litigation

   Any litigation relating to this License may be brought only in the courts of

   a jurisdiction where the defendant maintains its principal place of business

   and such litigation shall be governed by laws of that jurisdiction, without

   reference to its conflict-of-law provisions. Nothing in this Section shall

   prevent a party’s ability to bring cross-claims or counter-claims.

4. Miscellaneous

   This License represents the complete agreement concerning the subject matter

   hereof. If any provision of this License is held to be unenforceable, such

   provision shall be reformed only to the extent necessary to make it

   enforceable. Any law or regulation which provides that the language of a

   contract shall be construed against the drafter shall not be used to construe

   this License against a Contributor.

1. Versions of the License

10.1. New Versions

  Mozilla Foundation is the license steward. Except as provided in Section
  10.3, no one other than the license steward has the right to modify or
  publish new versions of this License. Each version will be given a
  distinguishing version number.

...

modification, are permitted provided that the following conditions

are met:

1. Redistributions of source code must retain the above copyright

notice, this list of conditions and the following disclaimer.

1. Redistributions in binary form must reproduce the above copyright

notice, this list of conditions and the following disclaimer in the

documentation and/or other materials provided with the distribution.

1. Neither the name of the copyright holder nor the names of its

contributors may be used to endorse or promote products derived from

...

modification, are permitted provided that the following conditions

are met:

1. Redistributions of source code must retain the above copyright

notice, this list of conditions and the following disclaimer.

1. Redistributions in binary form must reproduce the above copyright

notice, this list of conditions and the following disclaimer in the

documentation and/or other materials provided with the distribution.

1. Neither the name of the copyright holder nor the names of its

contributors may be used to endorse or promote products derived from

...