robertkowalski / bfx-facs-db-sqlite-1

bfx-facs-db-sqlite

API

fac.upsert

Returns { lastID: } in the result cb

Example:

fac.upsert({
  table: 'Employees',
  selectKey: 'id',
  selectValue: '1',
  data: { id: 1, name: 'paolo', surname: 'ardoino' }
}, cb)

// runs:
d.run(
  "INSERT OR REPLACE INTO Employees (id, name, surname) VALUES ((SELECT id FROM Employees WHERE id = $id),  $name,  $surname)",
  { '$id': '1', '$name': 'peter', '$surname': 'bitcoin' }
)

fac.cupsert

Provides a simple way to check and process data before an upsert.

Example:

fac.cupsert({
  table: 'Employees',
  selectKey: 'id',
  selectValue: '1',
  process: (data, cb) => {
    data[0].surname = 'diaz'
    cb(null, data[0])
  }
}, cb)

fac.runMigrations

• migrations: <Array>
  • inex 0..x: <Function>
• cb: <Function>

Runs an array of functions (migrations).

Each function in the migrations array is passed the faculty instance and a callback.

Assumptions:

1. PRAGMA user_version will be used to track migrations. It is assumed to unused and will increment as an id for the index of the migrations array
2. New migrations will always be added to the end of the migrations array and old migrations shall never be deleted from the array. The PRAGMA user_version will track which migrations in the migration array which have run and only run new migrations.
3. Each migration is automatically wrapped in a TRANSACTION. Migrations will stop running on any error.

Example Migrations

# api.my.wrk.js
...
    this.conf.init.facilities.push(
      ['fac', 'bfx-facs-db-sqlite', 'main', 'main', {
        name: this.prefix,
        presist: true,
        runSqlAtStart: this.getDbSqliteInit()
      }]
    )
  }

  _start (cb) {
    async.series([
      next => { super._start(next) },
      next => { this.dbSqlite_main.runMigrations(migrations, next) }
    ], cb)
  }

  getDbSqliteInit () {
    return [
      // eslint-disable-next-line no-multi-str
      'CREATE TABLE IF NOT EXISTS token_sales ( \
    # ...
}

const migrations = [
  (dsm, cb) => {
    dsm.db.run('ALTER TABLE token_sales ADD COLUMN listed INTEGER;', cb)
  },
  (dsm, cb) => {
    dsm.db.run('ALTER TABLE token_sales ADD COLUMN trading INTEGER;', cb)
  },
  (dsm, cb) => {
    dsm.db.run('ALTER TABLE token_sales ADD COLUMN contribute_url TEXT;', cb)
  },
  (dsm, cb) => {
    dsm.db.run('ALTER TABLE token_sales RENAME TO token_listing;', cb)
  }
]

Config

name

Used to construct the database name: sqlite_$NAME_$LABEL.db

label

Used to construct the database name: sqlite_$NAME_$LABEL.db

runSqlAtStart

Runs SQLite commands at start of the service. Useful to create a table if it does not exist. Takes an array commands to run.

Example fields:

{
  "runSqlAtStart": [
    'CREATE TABLE IF NOT EXISTS vegetables (id INTEGER PRIMARY KEY ASC, sold, price)',
    'CREATE TABLE IF NOT EXISTS meat (id INTEGER PRIMARY KEY ASC, sold, price)'
  ]
}

Example

db-sqlite.config.json

{
  "sqlite": {
    "name": "foo",
    "label": "bar",
    "runSqlAtStart": [
      "CREATE TABLE IF NOT EXISTS vegetables (id INTEGER PRIMARY KEY ASC, sold, price)",
      "CREATE TABLE IF NOT EXISTS meat (id INTEGER PRIMARY KEY ASC, sold, price)"
    ]
  }
}

git clone [e-mail]:bitfinexcom/REPO.git REPO git remote -v git remote add upstream [e-mail]:bitfinexcom/PARENT.git git remote -v git push origin master