fernandocagale / k7 Goto Github PK

hapi database connector

K7 is the simplest way to connect Hapi.js with your favorite Database Mapper, you can use any of ours available connectors for the most populars Databases.

For example:

const Hapi = require('hapi');
const Server = new Hapi.Server();

Server.connection({host: 'localhost'});

let options = {
    adapter: require('k7-mongoose'),
    connectionString: 'mongodb://localhost:27017/K7Mongoose'
};

Server.register({
    register: require('k7'),
    options: options
}, (err) => {
    if (err) {
        throw err;
    }
    
    Server.start((err) => {
        if (err) {
            throw err;
        }
        
        Server.log('info', 'Server running at: ' + Server.info.uri);
    });
});

This example does:

1. Setting the k7-mongoose adapter
2. Setting the connectionString for mongoose connect
3. Register the k7 to Hapi.js

k7 have minimal options, and the major options are specified in ours Adapters.

• connectionString: Is a common option, specified a connectionString to connecto in your database.
• connectionOptions: Is a common option, where you will specify the options passed for the connector.
• models: Is a common option, where you will specify how we can find your models. Default: models/*.js In this option you can pass a String or an Array of files or glob patterns like: **/model.js

Your models will be available in server.database all of your databases will be there. In server.database have the instance of the Database Mapper used too.

If your model are in a file called models/user.js, the model will be avaiblable as server.database.User.

• k7-bookshelf (WIP)
• k7-mongoose
• k7-sequelize

The K7 API is very simple, your adapter just need be a Class and export a function load and return an Object with all models and the Database Mapper instance for k7 decorate the database in Hapi.js. For more examples, please see the source code in the k7-sequelize plugin.

For testing you just need clone this repo and run npm install && npm test inside root folder of this project.;