Leoric

ORM for Node.js heavily influenced by Active Record of Ruby on Rails

cyjake/leoricleoric.js.orgleoric

README

Leoric

Package Quality NPM Downloads NPM Version Build Status codecov

Leoric is an object-relational mapping for Node.js, which is heavily influenced by Active Record of Ruby on Rails. See the documentation for detail.

Usage


Assume the tables of posts, users, and comments were setup already. We may declare the models as classes by extending from the base class Bone of Leoric. After the models are connected to the database, the columns of the tables are mapped as attributes, the associations are setup, feel free to start querying.

  1. ```js
  2. const { Bone, connect } = require('leoric')

  4. // define model
  5. class Post extends Bone {
  6.   static initialize() {
  7.     this.belongsTo('author', { Model: 'User' })
  8.     this.hasMany('comments')
  9.   }
  10. }

  12. async function main() {
  13.   // connect models to database
  14.   await connect({ host: 'example.com', models: [ Post ], /* among other options */ })

  16.   // CRUD
  17.   await Post.create({ title: 'New Post' })
  18.   const post = await Post.findOne({ title: 'New Post' })
  19.   post.title = 'Untitled'
  20.   await post.save()

  22.   // or UPDATE directly
  23.   await Post.update({ title: 'Untitled' }, { title: 'New Post' })

  25.   // find with associations
  26.   const post = await Post.findOne({ title: 'New Post' }).with('comments')
  27.   console.log(post.comments) // => [ Comment { id, content }, ... ]
  28. }
  29. ```

If table structures were intended to be maintained in the models, Leoric can be used as a table migration tool as well. We can just define attributes in the models, and call realm.sync() whenever we are ready.

  1. ```js
  2. const { BIGINT, STRING } = Bone.DataTypes;
  3. class Post extends Bone {
  4.   static attributes = {
  5.     id: { type: BIGINT, primaryKey: true },
  6.     email: { type: STRING, allowNull: false },
  7.     nickname: { type: STRING, allowNull: false },
  8.   }
  9. }

  11. const realm = new Realm({ models: [ Post ] });
  12. await realm.sync();
  13. ```

Syntax Table


JavaScriptSQL
|-----------------------------------------|----------------------------------------------------|
`Post.create({`INSERT
`Post.all``SELECT
`Post.find({`SELECT
`Post.find(42)``SELECT
`Post.order('title')``SELECT
`Post.order('title',`SELECT
`Post.limit(20)``SELECT
`Post.update({`UPDATE
`Post.remove({`DELETE

A more detailed syntax table may be found at the documentation site.

TypeScript charged


  1. ```ts
  2. import { Bone, BelongsTo, Column, DataTypes: { TEXT } } from 'leoric';
  3. import User from './user';

  5. export default class Post extends Bone {
  6.   @Column({ autoIncrement: true })
  7.   id: bigint;

  9.   @Column(TEXT)
  10.   content: string;

  12.   @Column()
  13.   description: string;

  15.   @Column()
  16.   userId: bigint;

  18.   @BelongsTo()
  19.   user: User;
  20. }
  21. ```

More about TypeScript integration examples can be found at the TypeScript support documentation

Contributing


There are many ways in which you can participate in the project, for example:

- Submit bugs and feature requests, and help us verify as they are checked in
- Review source code changes
- Review the documentation and make pull requests for anything from typo to new content

If you are interested in fixing issues and contributing directly to the code base, please see the document How to Contribute, which covers the following:

- The development workflow, including debugging and running tests
- Coding guidelines
- Submitting pull requests
- Contributing to translations

egg-orm


If developing web applications with [egg framework](https://eggjs.org/), it's highly recommended using the [egg-orm](https://github.com/eggjs/egg-orm) plugin. More detailed examples about setting up egg-orm with egg framework in either JavaScript or TypeScript can be found at