npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

db-up

v0.3.0

Published

This component allow to migrate a database (schema / data) from a version to the most recent version

Downloads

8

Readme

Build Status dependencies Status devDependencies Status

db-up

This component allow to migrate a database (schema / data) from a version to the most recent version. Using javascript files in a folder, will find those files and execute them in sequencial order.

Usage

var updater = require('db-up');

updater
    .update({  path: './patches', version: 10 })
    .then(function () {
        console.log('update completed.');
    });

Installation

npm install db-up

Put update files in a ./patches folder. Each file should be identified with a number followed by the .js extension.

Example structure

project
    |- patches
        |- 1.js
        |- 2.js
        |- 3.js

update

Updater function takes an options object with the following parameters.

Returns

A promise that is resolved when all patches as been applied. If a patch fail, all subsequent patches are not run and the updater invoke the catch branch of the promise.

Options

  • data:

Optionnal data that can be passed to the patches. Usefull for passing a dbContext or connection string.

  • path:

The path to the folder containing the patches. Default is ./patches

  • version:

The current version of the database. The updater will run the script where the name is greater than this number.

  • onApplyingPatch:

A function called before applying a patch.

  • onAppliedPatch:

A function called after a patch has been applied. If the patch cannot be applied, the event won't be called.

Example of a patch file.

Name the file as 1.js and put it in the ./patches folder.

var Promise = require('bluebird');

module.exports = function () {
    return new Promise(function (resolve) {
        // do something to update
        // resolve the promise once it's done.
        resolve();
    });
}

You can omit the promise as well if you are not required to.

module.exports = function () {
    // do something to update
}

Development and test

Clone the project

#Clone the project
https://github.com/xploratics/db-up.git

#Move into the cloned repo
cd db-up

#Install all dependencies
npm install

#Run the tests
npm test

License

MIT License