HAPI module that connects to the mongodb.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
src
test
.gitignore
.npmignore
.travis.yml
Gruntfile.coffee
README.md
package.json

README.md

Build Status Coverage Status NPM Version Dependency Status NPM Downloads Issues HAPI 6.0 API Documentation

(C) 2014 Martin Wawrusch

HAPI module to connect to mongodb (using mongoose).

Rational

When creating services with HAPI a working design approach is to split functionality into individual plugins, which can be individually tested and developed. To facilitate this, this plugin provides the functionality to connect and disconnect from a mongodb through mongoose.

To use it you include it into your server configuration like so:

hapiMongooseDbConnector = require 'hapi-mongoose-db-connector'

server = new Hapi.Server 3000, "localhost", {}

pluginConf = [
    plugin: hapiMongooseDbConnector
    options:
      mongodbUrl: "your mongodb url."
    #... more plugins
]

server.pack.register pluginConf, (err) ->
  throw err if err

Now this automatically connects to mongodb when the server starts.

How to access mongoose

There are basically two ways of doing this:

The bad way

You reference this plugin and access the mongoose property exposed by the plugin. This creates some nasty runtime dependencies that you don't want.

# from the server
mongoose = server.pack.plugins['hapi-mongoose-db-connector'].mongoose
# or from a plugin
mongoose = plugin.plugins['hapi-mongoose-db-connector'].mongoose

The good way

You do nothing and just require mongoose in your plugins. As npm requires are singletons (the code is loaded only once this works very well)

See also

and additionally

Contributing

  • Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
  • Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
  • Fork the project
  • Start a feature/bugfix branch
  • Commit and push until you are happy with your contribution
  • Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
  • Please try not to mess with the package.json, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

Copyright

Copyright (c) 2014 Martin Wawrusch