https://github.com/tswayne/fast-water
Fastify plugin for waterline
https://github.com/tswayne/fast-water
Last synced: 3 months ago
JSON representation
Fastify plugin for waterline
- Host: GitHub
- URL: https://github.com/tswayne/fast-water
- Owner: tswayne
- License: mit
- Created: 2018-04-08T04:23:19.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2022-12-20T17:25:40.000Z (over 2 years ago)
- Last Synced: 2025-01-29T18:48:30.744Z (3 months ago)
- Language: JavaScript
- Homepage:
- Size: 109 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://www.npmjs.com/package/fast-water)
# Fast Water
A fastify plugin for [waterline](https://github.com/balderdashy/waterline). This plugin replicates waterline usage in sails by:
* Allowing you to define waterline models exactly as in sails
* Use any sails waterline adapter
* Gives you access to your models anywhere in the request cycle through the fastify instance
## Usage
```javascript
// Setup
const fastWater = require('fast-water')
const options = {
adapter: require('sails-mysql'),
adapterType: 'mysql',
database: {
name: 'myDb',
user: 'user',
password: 'password',
host: 'localhost'
},
decoratorName: 'models',
modelPath: path.join(__dirname, './models'),
modelDefaults: {
datastore: 'default',
fetchRecordsOnCreate: true,
fetchRecordsOnUpdate: true,
primaryKey: 'id',
attributes: {
createdAt: { type: 'string', autoCreatedAt: true, },
updatedAt: { type: 'string', autoUpdatedAt: true, },
id: { type: 'number', autoMigrations: { autoIncrement: true } },
},
}
}
fastify.register(fastWater, { options })
// Usage in handler
const pets = await this.models.pet.find()
```
#### Model definition
```javascript
// ./model/Pet.js
module.exports = {
identity: 'pet',
attributes: {
name: { type: 'string' },
}
}
```
## Options
* adapter: Any of sail's [available adapters](https://next.sailsjs.com/documentation/concepts/extending-sails/adapters/available-adapters)
* adapterType: The name of adapter, example: 'mysql', 'sails-disk', etc
* database:
* name: The database name
* user: The database user
* password: The database password (optional)
* host: The database host
* port: The database port (optional)
* modelPath: Path to the directory where your models are defined.
* decoratorName: The fastify decorator name (optional - defaults to 'models')
* modelDefaults: Object. Any [model settings](https://sailsjs.com/documentation/concepts/models-and-orm/model-settings) that will apply to all models.
* Great for setting default primaryKey, datastore, fetchRecordsOnUpdate, fetchRecordsOnCreate
* Will be overridden by specific model settings
## Contributing
Pull requests or issues welcome!