feathers-knex
A Knex.js service adapter for FeathersJS
Installation
npm install feathers-knex --save
Documentation
Please refer to the Feathers database adapter documentation for more details or directly at:
- KnexJS - The detailed documentation for this adapter
- Extending - How to extend a database adapter
- Pagination - How to use pagination
- Querying and Sorting - The common adapter querying mechanism and sorting for the database adapter
Complete Example
Here's a complete example of a Feathers server with a todos
SQLite service. We are using the Knex schema builder
import feathers from 'feathers';
import rest from 'feathers-rest';
import bodyParser from 'body-parser';
import knexService from 'feathers-knex';
const knex = require('knex')({
client: 'sqlite3',
connection: {
filename: './db.sqlite'
}
});
var todos = knexService({
Model: knex,
name: 'todos',
paginate: {
default: 2,
max: 4
}
});
const app = feathers()
.configure(rest())
.use(bodyParser.json())
.use(bodyParser.urlencoded({ extended: true }));
todos
.init({}, function(table) {
console.log(`created ${table._tableName} table`);
table.increments('id');
table.string('text');
table.boolean('complete');
}).then(() => {
app.use('/todos', todos);
app.use(function(error, req, res, next){
res.json(error);
});
const port = 8080;
app.listen(port, function() {
console.log(`Feathers server listening on port ${port}`);
});
});
You can run this example by using node server
and going to localhost:8080/todos. You should see an empty array. That's because you don't have any Todos yet but you now have full CRUD for your new todos service!
License
Copyright (c) 2016
Licensed under the MIT license.