README.md

sqlite-to-json

Dump data from sqlite databases to JSON files easily.

API

constructor(opts)

Create an instance of SqliteToJson.

Example:

const SqliteToJson = require('sqlite-to-json');
const sqlite3 = require('sqlite3');
const exporter = new SqliteToJson({
  client: new sqlite3.Database('./mydb.sqlite3')
});

opts.client

A sqlite3 client instance.

Type: sqlite3.Database
Default: null

tables(cb)

List all tables in the current database.

Example:

const SqliteToJson = require('sqlite-to-json');
const sqlite3 = require('sqlite3');
const exporter = new SqliteToJson({
  client: new sqlite3.Database('./mydb.sqlite3')
});
exporter.tables(function (err, tables) {
  // all your table names here
});

save(table, dest, cb)

Save the contents of a table to the specified output directory.

Example:

const SqliteToJson = require('sqlite-to-json');
const sqlite3 = require('sqlite3');
const exporter = new SqliteToJson({
  client: new sqlite3.Database('./mydb.sqlite3')
});
exporter.save('table_name', './data/table_name.json', function (err) {
  // no error and you're good.
});

all(cb)

Returns the entire database and all tables as a single object.

Example:

const SqliteToJson = require('sqlite-to-json');
const sqlite3 = require('sqlite3');
const exporter = new SqliteToJson({
  client: new sqlite3.Database('./mydb.sqlite3')
});
exporter.all(function (err, all) {
  // all your data here
});