1. 28 Apr, 2019 1 commit
  2. 27 Apr, 2019 1 commit
  3. 21 Feb, 2019 1 commit
    • add backup api that can be run incrementally (#1116) · 2bd051da
      This exposes the sqlite3 backup api as described at https://sqlite.org/backup.html.
      
      This implementation draws on https://github.com/mapbox/node-sqlite3/pull/883,
      extending it to create a backup object that can be used in the background,
      without leaving the database locked for an extended period of time.  This is
      crucial for making backups of large live databases in a non-disruptive manner.
      Example usage:
      
      ```
      var db = new sqlite3.Database('live.db');
      var backup = db.backup('backup.db');
      ...
      // in event loop, move backup forward when we have time.
      if (backup.idle) { backup.step(NPAGES); }
      if (backup.completed) { /* success! backup made */  }
      if (backup.failed)    { /* sadness! backup broke */ }
      // do other work in event loop - fine to modify live.db
      ...
      ```
      
      Here is how sqlite's backup api is exposed:
      
       * `sqlite3_backup_init`: This is implemented as `db.backup(filename, [callback])`
         or `db.backup(filename, destDbName, sourceDbName, filenameIsDest, [callback])`.
       * `sqlite3_backup_step`: This is implemented as `backup.step(pages, [callback])`.
       * `sqlite3_backup_finish`: This is implemented as `backup.finish([callback])`.
       * `sqlite3_backup_remaining`: This is implemented as a `backup.remaining` getter.
       * `sqlite3_backup_pagecount`: This is implemented as a `backup.pageCount` getter.
      
      Some conveniences are added in the node api.
      
      There are the following read-only properties:
       * `backup.completed` is set to `true` when the backup succeeeds.
       * `backup.failed` is set to `true` when the backup has a fatal error.
       * `backup.idle` is set to `true` when no operation is currently in progress or
         queued for the backup.
       * `backup.remaining` is an integer with the remaining number of pages after the
         last call to `backup.step` (-1 if `step` not yet called).
       * `backup.pageCount` is an integer with the total number of pages measured during
         the last call to `backup.step` (-1 if `step` not yet called).
      
      There is the following writable property:
       * `backup.retryErrors`: an array of sqlite3 error codes that are treated as
         non-fatal - meaning, if they occur, backup.failed is not set, and the backup
         may continue.  By default, this is `[sqlite3.BUSY, sqlite3.LOCKED]`.
      
      The `db.backup(filename, [callback])` shorthand is sufficient for making a
      backup of a database opened by node-sqlite3.  If using attached or temporary
      databases, or moving data in the opposite direction, the more complete
      (but daunting) `db.backup(filename, destDbName, sourceDbName, filenameIsDest, [callback])`
      signature is provided.
      
      A backup will finish automatically when it succeeds or a fatal error
      occurs, meaning it is not necessary to call `db.finish()`.
      By default, SQLITE_LOCKED and SQLITE_BUSY errors are not treated as
      failures, and the backup will continue if they occur.  The set of errors
      that are tolerated can be controlled by setting `backup.retryErrors`.
      To disable automatic finishing and stick strictly to sqlite's raw api,
      set `backup.retryErrors` to `[]`.  In that case, it is necessary to call
      `backup.finish()`.
      
      In the same way as node-sqlite3 databases and statements, backup methods
      can be called safely without callbacks, due to an internal call queue.  So
      for example this naive code will correctly back up a db, if there are
      no errors:
      ```
      var backup = db.backup('backup.db');
      backup.step(-1);
      backup.finish();
      ```
      Paul Fitzpatrick authored
  4. 08 Feb, 2019 1 commit
  5. 04 Feb, 2019 1 commit
  6. 28 Jan, 2019 1 commit
  7. 19 Jan, 2019 1 commit
  8. 12 Jan, 2019 1 commit
  9. 11 Jan, 2019 1 commit
  10. 04 Jan, 2019 1 commit
  11. 13 Dec, 2018 1 commit
  12. 10 Dec, 2018 1 commit
  13. 09 Dec, 2018 2 commits
  14. 05 Dec, 2018 3 commits
  15. 04 Dec, 2018 4 commits
  16. 03 Dec, 2018 2 commits
  17. 02 Dec, 2018 1 commit
  18. 17 Nov, 2018 2 commits
  19. 10 Nov, 2018 2 commits
  20. 09 Nov, 2018 6 commits
  21. 08 Nov, 2018 1 commit
  22. 30 Oct, 2018 3 commits
  23. 24 Oct, 2018 1 commit
  24. 22 Oct, 2018 1 commit