@knorm/knorm

@knorm/knorm

A JavaScript ORM written using ES6 classes.

Knorm is a collection of classes that allow creating JavaScript ORM's to make it easier to work with relational databases.

Knorm can be used on any existing database without requiring any changes to the database layer. It does not (yet) create or run any database migrations (creating or altering tables, columns, indexes etc), nor does it generate models from existing database schema (yet). For creating and running migrations, consider a library such as Knex.js.

It can also be used on the browser to create models that do not interact with the database, perhaps for data validation. Please note that it's not secure to generate queries on the browser and send them for processing to a backend server.

Features

• simplicity - easy to extend, configure or override, owing to ES6 classes.
• validation, including validation for JSON fields (similar to Mongoose JS)
• plugin support
• transactions
• relations through SQL joins
• field-name to column-name mapping (e.g. snake-casing)
• virtual fields with support for async getters
• value casting before save and after fetch
• custom error classes for database errors
• extensive test coverage

Supported environments

These environments are currently supported:

Environment	Value	Description
Node.js	Version >= 8	Knorm uses async/await
Databases	PostgreSQL	via the @knorm/postgres plugin

Get started