https://github.com/sutandojs/sutando

Sutando is a modern Node.js ORM, like Laravel Eloquent.
https://github.com/sutandojs/sutando

cloudflare-d1 javascript mariadb mssql mysql nodejs orm postgresql sql sqlite sutando

Last synced: 3 days ago
JSON representation

Sutando is a modern Node.js ORM, like Laravel Eloquent.

• Host: GitHub
• URL: https://github.com/sutandojs/sutando
• Owner: sutandojs
• License: mit
• Created: 2022-10-22T18:00:19.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-11-16T11:35:49.000Z (about 1 month ago)
• Last Synced: 2024-12-20T14:23:58.059Z (5 days ago)
• Topics: cloudflare-d1, javascript, mariadb, mssql, mysql, nodejs, orm, postgresql, sql, sqlite, sutando
• Language: JavaScript
• Homepage: https://sutando.org
• Size: 214 KB
• Stars: 196
• Watchers: 8
• Forks: 15
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-nodejs - Sutando - ActiveRecord style ORM, based on Knex, supports MySQL, PostgreSQL, SQLite and other databases.  (Repository / Database)

README

        


  

  
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](https://laravel.com/docs/10.x/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](https://sutando.org) | [中文文档](https://sutando.org/zh_CN)

## 🚀 Quick Start

Let’s take mysql as an example.

Install Sutando and mysql database library

```sh

$ npm install sutando mysql2 --save

```

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.

```js

const { sutando, Model } = require('sutando');

// Add SQL Connection Info

sutando.addConnection({

  client: 'mysql2',

  connection: {

    host : '127.0.0.1',

    port : 3306,

    user : 'root',

    password : '',

    database : 'test'

  },

});

const db = sutando.connection();

// Query Builder

const users = await db.table('users').where('age', '>', 35).get();

// ORM

class User extends Model {}

// Query Data

const users = await User.query().where('age', '>', 35).get();

// Insert

const user = new User;

user.name = 'David Bowie';

await user.save();

// Delete

await user.delete();

// Pagination

const users = await User.query().paginate();

// Eager Loading

const users = await User.query().with('posts').get();

// Constraining Eager Loads

const users = await User.query().with({

  posts: q => q.where('likes_count', '>', 100)

}).get();

// Lazy Eager Loading

await user.load('posts');

```

## 💖 Show Your Support

Please ⭐️ this repository if this project helped you