Skip to content

简介

🛠️ @aicblock/esql 基于 mysql2/pg 基础二次封装,追求打造简单、好用的 SQL-ORM 库。支持 MySQL 和 PostgreSQL。

安装

sh
npm i @aicblock/esql@latest -S
# OR
yarn add @aicblock/esql@latest -S

MySQL 使用

ts
import esql, { DefineTable } from '@aicblock/esql'
const mysql = new esql({
  connConfig: {
    host: 'localhost',
    port: 3306,
    user: 'root',
    password: 'password',
    database: 'my_db'
  }
})
await mysql.init()

PostgreSQL 使用

ts
import esql, { DefineTable } from '@aicblock/esql'
const pg = new esql({
  connConfig: {
    host: 'localhost',
    port: 5432,
    user: 'postgres',
    password: 'password+',
    database: 'my_db'
  },
  dialect: 'postgresql'
})
await pg.init()

向后兼容

emysql 作为 esql 的别名导出,现有代码无需修改:

ts
import emysql from '@aicblock/esql' // 仍然可用,默认 dialect 为 mysql