# sqlite-orm

**Repository Path**: Ann-yang/sqlite-orm

## Basic Information

- **Project Name**: sqlite-orm
- **Description**: 一个简单的 sqlite orm
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-09-19
- **Last Updated**: 2025-01-22

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 一个简单的 sqlite orm

## 安装

```sh
npm install @anlib/sqlite-orm
yarn install @anlib/sqlite-orm
pnpm install @anlib/sqlite-orm
```

## 测试

```sh
npm run test
yarn test
pnpm test
```

## 基本使用
```ts
import SqliteOrm from "@anlib/sqlite-orm";

const sqliteOrm = new SqliteOrm({ tableName: "my_table.db", isFillValue: true });

type Persion = {
  name: string;
  age: number;
  gex: "男" | "女";
};

const datas: Persion[] = [
  { name: "张三", age: 18, gex: "男" },
  { name: "李四", age: 16, gex: "男" },
  { name: "王五", age: 18, gex: "女" },
  { name: "小明", age: 30, gex: "男" },
  { name: "小张", age: 22, gex: "男" }
];

const sql0 = sqliteOrm.buildCreate(
  [
    { field: "id", type: "INTEGER", isKey: true },
    { field: "name", type: "TEXT", isNotNull: true },
    { field: "age", type: "INTEGER", isNotNull: true },
    { field: "height", type: "FLOAT" },
    { field: "weight", type: "FLOAT" }
  ],
  "test.db"
);
console.log("sql0: ", sql0);
// sql0:  [
//   'CREATE TABLE IF NOT EXISTS "test.db" (id INTEGER PRIMARY KEY AUTOINCREMENT, name TEXT NOT NULL, age INTEGER NOT NULL, height FLOAT, weight FLOAT);',
//   []
// ]

const sql1 = sqliteOrm
  .select()
  .where("name", "=", "张三")
  .and("age", "!=", "18")
  .or("name", "IN", ["张三", "李四", "王五"])
  .or("gex", "IS NOT", "男")
  .getSqlRaw();

console.log("sql1: ", sql1);
// sql1:  [
//   'SELECT * FROM "my_table.db" WHERE name=? AND age!=? OR name IN (?, ?, ?) OR gex IS NOT ?',
//   [ '张三', '18', '张三', '李四', '王五', '男' ]
// ]

const sql2 = sqliteOrm
  .setTableName("my_table.db") // -> 只会改变本次调用的 tableName, 可以在任意时刻调用
  .fillValue(false) // -> 只会改变本次调用的值填充模式, 可以在任意时刻调用
  .select("name,age")
  .and("name", ">", "张三") // -> 注意: 丢失 AND 等价于 where()
  .groupBy("name")
  .orderBy("DESC", "name,age")
  .limit(10, 15)
  .or("gex", "=", "男")
  .andArray("ids", "IN", [1, 2, 3])
  .and("uuids", "IN", [1, 2, 3])
  .getSqlRaw();

console.log("sql2: ", sql2);
// sql2:  SELECT name,age FROM "my_table" WHERE name>"张三" OR gex="男" AND ( ids IN 1 AND ids IN 2 AND ids IN 3 ) AND uuids IN (1, 2, 3) GROUP BY name ORDER BY DESC name,age LIMIT 10,15

const sql3 = sqliteOrm.select().where("name", "IN", [1, 2, "hello"]).or("age", "=", 18).getSqlRaw();

console.log("sql3: ", sql3);
// sql3:  [
//   'SELECT * FROM "my_table" WHERE name IN (?, ?, ?) OR age=?',
//   [ 1, 2, 'hello', 18 ]
// ]

const sql4 = sqliteOrm
  .select()
  .whereArray("name", "=", [1, 2, "hello"], "AND")
  .or("age", "=", 18)
  .and("gex", "IN", [1, 2, 3])
  .andArray("gex", "!=", [1, "2", false])
  .getSqlRaw();

console.log("sql4: ", sql4);
// sql4:  [
//   'SELECT * FROM "my_table" WHERE ( name=? AND name=? AND name=? ) OR age=? AND gex IN (?, ?, ?) AND ( gex!=? AND gex!=? AND gex!=false )',
//   [ 1, 2, 'hello', 18, 1, 2, 3, 1, '2' ]
// ]

const sql5 = sqliteOrm.count("id").where("age", ">", 18).and("gex", "=", "男").groupBy("name").getSqlRaw();

console.log("sql5: ", sql5);
// sql5:  [
//   'SELECT count(id) FROM "my_table" WHERE age>? AND gex=? GROUP BY ?',
//   [ 18, '男', 'name' ]
// ]

const sql6 = sqliteOrm.insert<Persion>({
  name: "张三",
  age: 18,
  gex: "男"
});

console.log("sql6: ", sql6);
// sql6:  [
//   'INSERT or REPLACE INTO "my_table" (name, age, gex, isFlag) VALUES (?, ?, ?)',
//   [ '张三', 18, '男' ]
// ]

const sql7 = sqliteOrm.insers<Persion[]>(datas, 6); // 一个语句最多6个变量

console.log("sql7: ", sql7);
// sql7:  [
//   [
//     'INSERT or REPLACE INTO "my_table" (name, age, gex) VALUES (?, ?, ?), (?, ?, ?)',
//     [ '张三', 18, '男', '李四', 16, '男' ]
//   ],
//   [
//     'INSERT or REPLACE INTO "my_table" (name, age, gex) VALUES (?, ?, ?), (?, ?, ?)',
//     [ '王五', 18, '女', '小明', 30, '男' ]
//   ],
//   [
//     'INSERT or REPLACE INTO "my_table" (name, age, gex) VALUES (?, ?, ?)',
//     [ '小张', 22, '男' ]
//   ]
// ]

const sql8 = sqliteOrm.addColumn("new_name", "TEXT");
console.log("sql8: ", sql8);
// sql8:  [ 'ALTER TABLE "my_table" ADD new_name TEXT;', [] ]

const sql9 = sqliteOrm.tableInfo();
console.log("sql9: ", sql9);
// sql9:  [
//   'SELECT * FROM "sqlite_master" WHERE type=? AND name=?',
//   [ 'table', 'my_table' ]
// ]

/**
 * 姓名修改为 name-age-gex 格式
 * 年龄增大10倍
 */
const sql10 = sqliteOrm.buildUpdateByWhen({
  datas,
  onceMaxUpdateDataLength: 2, // 一个语句最多更新2条数据
  fieldOpts: [
    {
      setField: "name",
      getWhenField() {
        return "name";
      },
      getWhenValue(row) {
        return row.name;
      },
      getThenValue(row) {
        return `${row.name}-${row.age}-${row.gex}`;
      }
    },
    {
      setField: "age",
      getWhenField() {
        return "age";
      },
      getWhenValue(row) {
        return row.age;
      },
      getThenValue(row) {
        return row.age * 10;
      }
    }
  ]
});
console.log("sql10: ", sql10);
// sql10:  [
//   [
//     'UPDATE "my_table" SET name = CASE WHEN name=? THEN ? WHEN name=? THEN ? END, age = CASE WHEN age=? THEN ? WHEN age=? THEN ? END',
//     [ '张三', '张三-18-男', '李四', '李四-16-男', 18, 180, 16, 160 ]
//   ],
//   [
//     'UPDATE "my_table" SET name = CASE WHEN name=? THEN ? WHEN name=? THEN ? END, age = CASE WHEN age=? THEN ? WHEN age=? THEN ? END',
//     [ '王五', '王五-18-女', '小明', '小明-30-男', 18, 180, 30, 300 ]
//   ],
//   [
//     'UPDATE "my_table" SET name = CASE WHEN name=? THEN ? END, age = CASE WHEN age=? THEN ? END',
//     [ '小张', '小张-22-男', 22, 220 ]
//   ]
// ]

const sql11 = sqliteOrm.update(datas[0]).where("id", "=", 1).getSqlRaw();
console.log("sql11: ", sql11);
// sql11:  [ 'UPDATE "my_table" SET name="张三", age="18", gex="男" WHERE id=1', [] ]

const sql12 = sqliteOrm.setVersion(2);
console.log("sql12: ", sql12);
// sql12:  [ 'PRAGMA user_version = ?', 2 ]

const sql13 = sqliteOrm.findById(1);
console.log("sql13: ", sql13);
// sql13:  [ 'SELECT * FROM "my_table" WHERE id=?', [ 1 ] ]

const sql14 = sqliteOrm.selectAll();
console.log("sql14: ", sql14);
// sql14:  [ 'SELECT * FROM "my_table"', [] ]

const sql15 = sqliteOrm.deleteById(1);
console.log("sql15: ", sql15);
// sql15:  [ 'DELETE FROM "my_table" WHERE id=?', [ 1 ] ]

const sql16 = sqliteOrm.deleteAll("hello.db");
console.log("sql16: ", sql16);
// sql16:  [ 'DELETE FROM "hello.db" WHERE 1=?', [ 1 ] ]

const sql17 = sqliteOrm.deleteTable("hello.db");
console.log("sql17: ", sql17);
// sql17:  [ 'DROP TABLE IF EXISTS "hello.db"', [] ]

```