Code Monkey home page Code Monkey logo

hapi-plugin-mysql's Introduction

hapi-plugin-mysql Build Status

hapi plugin for MySQL

What

Attaches a MySQL connection from a pool to every request.

How

Via request.app.db. You can also manually get a connection from the server via server.getDb(function (err, connection) {}).

server.register({
    register: require('hapi-plugin-mysql'),
    options: {
        host: "localhost",
        user: "root",
        password: ""
    }
}, function (err) {

    if (err) console.log(err);
    ...
});

server.route({
    method: 'GET',
    path: '/',
    handler: function (request, reply) {

        request.app.db.query(...);
        return reply('ok');
    }
});

The options are the same options you can pass onto the mysql lib for making a connection. See https://www.npmjs.com/package/mysql for more info on the mysql lib itself.

The keyword db is used because connection is used by hapi and might cause confusion/collision.

If you want more manual control or you want to use the same pool outside of the hapi part of your server you can initialize the pool before the plugin registration by calling require('hapi-plugin-mysql').init(options, callback) and then call require('hapi-plugin-mysql').getConnection to get a connection from the pool. If you still want to register the plugin (to get all the goodies) just don't pass any options to the plugin registration and it will use the same pool as first created. To manually stop the pool call require('hapi-plugin-mysql').stop. See the tests for more granular use cases.

Catches

  • The releasing of the connection is handled on the tail event of the server. If you have handlers that reply early, with reply.file() for example, be sure to register a tail event and use that as callback.
  • Transactions are no longer a part of this plugin and should be handled (with care) in your code

Testing

  • 100% code coverage!
  • The tests requires you to have a test db with a table test and {user: root, password: ""}.
  • See .travis.yml and the tests for more info.

Changelog

See the releases page

hapi-plugin-mysql's People

Contributors

adrivanhoudt avatar greenkeeperio-bot avatar greenkeeper[bot] avatar adrianblynch avatar watson avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.