Sutando

A modern Node.js ORM, like Laravel Eloquent.

ORMSQL
sutandojs/sutandosutando.orgsutando

README

Sutando logo

Sutando


Sutando is an object-relational mapper (ORM) that makes it enjoyable to interact with your database. When using Sutando, each database table has a corresponding "Model" that is used to interact with that table. In addition to retrieving records from the database table, Sutando models allow you to insert, update, and delete records from the table as well.

Heavily inspired by Laravel's ORM Eloquent.


✨ Features


- Supports MySQL, PostgreSQL, SQLite and other databases
- Concise syntax and intuitive operations
- Model relationships for handling complex data queries and operations
- Powerful query builder
- Customized data type conversion for model attributes
- Easy-to-use transaction
- Support for hooks to execute custom logic at different stages of model operations
- Simple plugin mechanism for easy expansion

📖 Documentation


Check the full documentation on https://sutando.org | 中文文档

🚀 Quick Start


Let’s take mysql as an example.

Install Sutando and mysql database library

  1. ```sh
  2. $ npm install sutando mysql2 --save
  3. ```

The easiest way to make SQL queries is to use the Database query builder. It allows you to construct simple and complex SQL queries using JavaScript methods.

  1. ```js
  2. const { sutando, Model } = require('sutando');

  4. // Add SQL Connection Info
  5. sutando.addConnection({
  6.   client: 'mysql2',
  7.   connection: {
  8.     host : '127.0.0.1',
  9.     port : 3306,
  10.     user : 'root',
  11.     password : '',
  12.     database : 'test'
  13.   },
  14. });

  16. const db = sutando.connection();

  18. // Query Builder
  19. const users = await db.table('users').where('age', '>', 35).get();

  21. // ORM
  22. class User extends Model {}

  24. // Query Data
  25. const users = await User.query().where('age', '>', 35).get();

  27. // Insert
  28. const user = new User;
  29. user.name = 'David Bowie';
  30. await user.save();

  32. // Delete
  33. await user.delete();

  35. // Pagination
  36. const users = await User.query().paginate();

  38. // Eager Loading
  39. const users = await User.query().with('posts').get();

  41. // Constraining Eager Loads
  42. const users = await User.query().with({
  43.   posts: q => q.where('likes_count', '>', 100)
  44. }).get();

  46. // Lazy Eager Loading
  47. await user.load('posts');
  48. ```

💖 Show Your Support


Please ⭐️ this repository if this project helped you