thenanyu / objection.js

An SQL-friendly ORM for Node.js

About this fork

Objection does not work with ES5 classes, and the author has expressly noted that he does not wish to support this in the root version of the lib. All I have done and plan to do here is compile to ES2015 in Babel.

Objection.js

Objection.js is an ORM for Node.js that aims to stay out of your way and make it as easy as possible to use the full power of SQL and the underlying database engine while keeping magic to a minimum.

Objection.js is built on an SQL query builder called knex. All databases supported by knex are supported by objection.js. SQLite3, Postgres and MySQL are thoroughly tested.

What objection.js gives you:

• An easy declarative way of defining models and relationships between them
• Simple and fun way to fetch, insert, update and delete objects using the full power of SQL
• Powerful mechanisms for eager loading, inserting and upserting object graphs
• A way to store complex documents as single rows
• Completely Promise based API
• Easy to use transactions
• Optional JSON schema validation

What objection.js doesn't give you:

• A custom query DSL. SQL is used as a query language. This doesn't mean you have to write SQL strings though. A query builder based on knex is used to build the SQL. However, if the query builder fails you for some reason, raw SQL strings can be easily written using the raw helper function.
• Automatic database schema creation and migration from model definitions. For simple things it is useful that the database schema is automatically generated from the model definitions, but usually just gets in your way when doing anything non-trivial. Objection.js leaves the schema related things to you. knex has a great migration tool that we recommend for this job. Check out the example project.

Objection.js uses Promises and coding practices that make it ready for the future. We use Well known OOP techniques and ES2015 classes and inheritance in the codebase. You can use things like async/await using node ">=7.6.0" or alternatively with a transpiler such as Babel. Check out our ES2015 and ESNext example projects.

Shortcuts:

• API reference
• Changelog
• Contribution guide
• Plugins