Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hapipal/schwifty
A model layer for hapi integrating Objection ORM
https://github.com/hapipal/schwifty
hapi knex-connections objection-orm orm
Last synced: about 2 months ago
JSON representation
A model layer for hapi integrating Objection ORM
- Host: GitHub
- URL: https://github.com/hapipal/schwifty
- Owner: hapipal
- License: mit
- Created: 2016-12-02T19:21:18.000Z (almost 8 years ago)
- Default Branch: main
- Last Pushed: 2023-02-27T15:02:09.000Z (over 1 year ago)
- Last Synced: 2024-04-16T00:57:51.566Z (5 months ago)
- Topics: hapi, knex-connections, objection-orm, orm
- Language: JavaScript
- Homepage:
- Size: 384 KB
- Stars: 73
- Watchers: 16
- Forks: 10
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# schwifty
A model layer for [hapi](https://hapi.dev) integrating [Objection ORM](https://vincit.github.io/objection.js/)
[](https://app.travis-ci.com/hapipal/schwifty) [](https://coveralls.io/github/hapipal/schwifty?branch=main)
Lead Maintainer - [Devin Ivy](https://github.com/devinivy)
## Installation
```sh
npm install @hapipal/schwifty
```
## Usage
> See also the [API Reference](API.md)
>
> Schwifty is intended for use with hapi v19+, nodejs v12+, Joi v17+, Objection v1 through v3, and knex v0.16+ (_see v5 for lower support_).
Schwifty is used to define [Joi](https://joi.dev/)-compatible models and knex connections for use with Objection ORM. Those models then become available within your hapi server where it is most convenient. It has been tailored to multi-plugin deployments, where each plugin may set clear boundaries in defining its own models, knex database connections, and migrations. It's safe to register schwifty multiple times, wherever you'd like to use it, as it protects against model name collisions and other ambiguous configurations.
```js
// First, ensure your project includes knex, objection, and sqlite3
// To get started you might run,
// npm install --save @hapipal/schwifty @hapi/hapi joi knex objection sqlite3
'use strict';
const Hapi = require('@hapi/hapi');
const Schwifty = require('@hapipal/schwifty');
const Joi = require('joi');
(async () => {
const server = Hapi.server({ port: 3000 });
server.route({
method: 'get',
path: '/dogs/{id}',
handler: async (request) => {
const { Dog } = request.models();
return await Dog.query().findById(request.params.id);
}
});
await server.register({
plugin: Schwifty,
options: {
knex: {
client: 'sqlite3',
useNullAsDefault: true,
connection: {
filename: ':memory:'
}
}
}
});
// Register a model with schwifty...
server.registerModel(
class Dog extends Schwifty.Model {
static tableName = 'Dog';
static joiSchema = Joi.object({
id: Joi.number(),
name: Joi.string()
});
}
);
await server.initialize();
// ... then make a table ...
const knex = server.knex();
await knex.schema.createTable('Dog', (table) => {
table.increments('id').primary();
table.string('name');
});
// ... then add some records ...
const { Dog } = server.models();
await Promise.all([
Dog.query().insert({ name: 'Guinness' }),
Dog.query().insert({ name: 'Sully' }),
Dog.query().insert({ name: 'Ren' })
]);
// ... then start the server!
await server.start();
console.log(`Now, go find some dogs at ${server.info.uri}`);
})();
```
## Extras
- Compatible with [haute-couture](https://github.com/hapipal/haute-couture)
- [Objection docs](http://vincit.github.io/objection.js/)
- [Knex docs](https://knexjs.org/)