wok-server 0.5.0 → 0.7.0

package/src/mysql/manager/ops/find.ts

@@ -0,0 +1,209 @@
+import { PoolConnection, RowDataPacket } from 'mysql2'
+import { Table } from '../../table-info'
+import { MixCriteria, buildQuery } from './criteria'
+import { promiseQuery } from '../utils'
+import { MysqlConfig } from '../../config'
+import { OrderBy, buildOrderBy } from './order-by'
+
+/**
+ * 按 id 查询
+ * @param connection
+ * @param mapping
+ * @param type
+ * @param id
+ */
+export async function findById<T>(
+  config: MysqlConfig,
+  connection: PoolConnection,
+  table: Table<T>,
+  id: string | number
+): Promise<T | null> {
+  const res = await promiseQuery(config, connection, `select * from ?? where ?? = ?`, [
+    table.tableName,
+    table.id,
+    id
+  ])
+  const rows = res as RowDataPacket[]
+  if (!rows.length) {
+    return null
+  }
+  return rows[0] as T
+}
+
+/**
+ * 查询表中所有数据。需谨慎操作，全表查询有可能会产生大列表问题。
+ * @param connection
+ * @param mapping
+ * @param type
+ * @returns
+ */
+export async function findAll<T>(
+  config: MysqlConfig,
+  connection: PoolConnection,
+  table: Table<T>
+): Promise<T[]> {
+  const res = await promiseQuery(config, connection, `select * from ??`, [table.tableName])
+  return res as RowDataPacket[] as T[]
+}
+
+export interface FindOpts<T> {
+  /**
+   * 表
+   */
+  table: Table<T>
+  /**
+   * 查询条件
+   * @param criteria
+   * @returns
+   */
+  criteria?: MixCriteria<T>
+  /**
+   * 偏移，需要 limit 有值才可以
+   */
+  offset?: number
+  /**
+   * 限制返回的数量
+   */
+  limit?: number
+  /**
+   * 排序规则，按先后顺序放入，每个规则是一个元组，第一个元素是字段名称，第二个元素是顺序
+   */
+  orderBy?: OrderBy<T>
+}
+/**
+ * 条件查询
+ * @param opts
+ * @returns
+ */
+export async function find<T>(
+  config: MysqlConfig,
+  conn: PoolConnection,
+  opts: FindOpts<T>
+): Promise<T[]> {
+  let query = opts.criteria ? buildQuery(opts.criteria) : undefined
+  const values: any[] = []
+  let sql = `select * from ?? `
+  values.push(opts.table.tableName)
+  if (query) {
+    sql += ` where ${query.sql} `
+    values.push(...query.values)
+  }
+  // 排序
+  if (opts.orderBy && opts.orderBy.length) {
+    const ob = buildOrderBy(opts.orderBy)
+    sql += ob.sql
+    values.push(...ob.values)
+  }
+  // 数量限制
+  if (opts.limit) {
+    sql += ` limit ${opts.limit} `
+    if (opts.offset) {
+      sql += ` offset ${opts.offset}`
+    }
+  }
+  const res = await promiseQuery(config, conn, sql, values)
+  return res as RowDataPacket[] as T[]
+}
+
+/**
+ * 指定字段条件查询选项
+ */
+export interface FindSelectOpts<T, K extends keyof T> extends FindOpts<T> {
+  /**
+   * 要查询的字段
+   */
+  select: K[]
+}
+
+/**
+ * 查询指定的字段，返回值类型与选择的字段有关
+ * @param onfig
+ * @param conn
+ * @param opts
+ */
+export async function findSelect<T, K extends keyof T>(
+  config: MysqlConfig,
+  conn: PoolConnection,
+  opts: FindSelectOpts<T, K>
+): Promise<Array<Pick<T, K>>> {
+  let query = opts.criteria ? buildQuery(opts.criteria) : undefined
+  const values: any[] = []
+  let sql = `select ${opts.select.map(() => '??').join(',')} from ?? `
+  values.push(...opts.select, opts.table.tableName)
+  if (query) {
+    sql += ` where ${query.sql} `
+    values.push(...query.values)
+  }
+  // 排序
+  if (opts.orderBy && opts.orderBy.length) {
+    const ob = buildOrderBy(opts.orderBy)
+    sql += ob.sql
+    values.push(...ob.values)
+  }
+  // 数量限制
+  if (opts.limit) {
+    sql += ` limit ${opts.limit} `
+    if (opts.offset) {
+      sql += ` offset ${opts.offset}`
+    }
+  }
+  const res = await promiseQuery(config, conn, sql, values)
+  return res as RowDataPacket[] as Pick<T, K>[]
+}
+/**
+ * 根据 id 列表查询记录
+ * @param connection
+ * @param table
+ * @param ids
+ * @returns
+ */
+export async function findByIdIn<T>(
+  config: MysqlConfig,
+  connection: PoolConnection,
+  table: Table<T>,
+  ids: Array<string | number>
+): Promise<T[]> {
+  if (!ids.length) {
+    return []
+  }
+  return find(config, connection, {
+    table,
+    criteria: c => c.in(table.id, ids)
+  })
+}
+
+/**
+ * 查找符合条件的第一条记录
+ * @param conn
+ * @param table
+ * @param criteria
+ * @returns
+ */
+export async function findFirst<T>(
+  config: MysqlConfig,
+  conn: PoolConnection,
+  table: Table<T>,
+  criteria?: MixCriteria<T>,
+  /**
+   * 排序规则，按先后顺序放入，每个规则是一个元组，第一个元素是字段名称，第二个元素是顺序
+   */
+  orderBy?: OrderBy<T>
+): Promise<T | null> {
+  let query = criteria ? buildQuery(criteria) : undefined
+  let sql = `select * from ?? `
+  const values: any[] = [table.tableName]
+  if (query) {
+    sql += ` where ${query.sql} `
+    values.push(...query.values)
+  }
+  // 排序
+  if (orderBy && orderBy.length) {
+    const ob = buildOrderBy(orderBy)
+    sql += ob.sql
+    values.push(...ob.values)
+  }
+  sql += ' limit 1'
+  const res = await promiseQuery(config, conn, sql, values)
+  const list = res as RowDataPacket[] as T[]
+  return list.length ? list[0] : null
+}

package/src/mysql/manager/ops/index.ts

@@ -0,0 +1,13 @@
+// 各类操作封装
+export * from './count'
+export * from './criteria'
+export * from './delete'
+export * from './exist'
+export * from './find'
+export * from './insert'
+export * from './modify'
+export * from './order-by'
+export * from './upsert'
+export * from './paginate'
+export * from './query'
+export * from './update'

package/src/mysql/manager/ops/insert.ts

@@ -0,0 +1,158 @@
+import { PoolConnection, ResultSetHeader } from 'mysql2'
+import { MysqlException } from '../../exception'
+import { Table } from '../../table-info'
+import { promiseQuery } from '../utils'
+import { MysqlConfig } from '../../config'
+import { processColumnValue } from './utils'
+
+/**
+ * 插入值类型，支持在 INSERT VALUES 中使用表达式
+ */
+export type InsertValue<T> = {
+  [K in keyof T]?:
+    | T[K]
+    | ['now']
+    | ['set', T[K]]
+    | ['expr', string]
+    | ['expr', string, any[]]
+}
+
+/**
+ * 处理 insert value，支持表达式
+ * @returns { frag: SQL 片段, values: 参数值数组 }
+ */
+export function processInsertValue(value: any): { frag: string; values: any[] } {
+  if (Array.isArray(value)) {
+    if (value[0] === 'now') {
+      return { frag: 'NOW()', values: [] }
+    }
+    if (value[0] === 'set') {
+      return { frag: '?', values: [processColumnValue(value[1])] }
+    }
+    if (value[0] === 'expr') {
+      return { frag: value[1], values: value[2] || [] }
+    }
+  }
+  return { frag: '?', values: [processColumnValue(value)] }
+}
+
+/**
+ * 为表插入数据
+ * @param connection
+ * @param table
+ * @param data
+ * @returns
+ */
+export async function insert<T>(
+  config: MysqlConfig,
+  connection: PoolConnection,
+  table: Table<T>,
+  data: InsertValue<T>
+): Promise<T> {
+  // 列信息，使用 set 防止 columns 中重复配置 id 和更新创建时间列
+  let columnsSet: Set<keyof T> = new Set()
+  // 判定下 id ，如果有值，才在 insert 语句中出现 id 列，否则不出现
+  if (data[table.id]) {
+    columnsSet.add(table.id)
+  }
+  table.columns.forEach(col => columnsSet.add(col))
+  if (table.createdDate) {
+    const createdData = table.createdDate.type === 'date' ? new Date() : new Date().getTime()
+    data[table.createdDate.column] = createdData as any
+    columnsSet.add(table.createdDate.column)
+  }
+  if (table.updatedDate) {
+    const updatedDate = table.updatedDate.type === 'date' ? new Date() : new Date().getTime()
+    data[table.updatedDate.column] = updatedDate as any
+    columnsSet.add(table.updatedDate.column)
+  }
+  const columns = Array.from(columnsSet)
+  // 构建 sql，逐列处理以支持表达式
+  const fragList: string[] = []
+  const insertValues: any[] = []
+  for (const col of columns) {
+    const { frag, values: vs } = processInsertValue(data[col])
+    fragList.push(frag)
+    insertValues.push(...vs)
+  }
+  const sql = `insert into ??(${columns.map(() => '??').join(',')}) values(${fragList.join(',')})`
+  const values: any[] = [table.tableName, ...columns, ...insertValues]
+  const res = await promiseQuery(config, connection, sql, values)
+  const packet = res as ResultSetHeader
+  if (packet.affectedRows !== 1) {
+    throw new MysqlException(
+      `Insert failed，table：${table.tableName}，primary key: ${data[table.id]}`
+    )
+  }
+  // 自动生成的id处理
+  if (packet.insertId && (data[table.id] === undefined || data[table.id] === null)) {
+    data[table.id] = packet.insertId as any
+  }
+  return data as unknown as T
+}
+/**
+ * 一次插入多条记录
+ * @param connection 连接
+ * @param table 表
+ * @param list 要插入的记录列表
+ */
+export async function insertMany<T>(
+  config: MysqlConfig,
+  connection: PoolConnection,
+  table: Table<T>,
+  list: InsertValue<T>[]
+): Promise<void> {
+  if (!list.length) {
+    return
+  }
+  // 列信息，使用 set 防止 columns 中重复配置 id 和更新创建时间列
+  let columnsSet: Set<keyof T> = new Set()
+  // 批量插入必须统一使用 id 或不使用 id，以第一条记录为准
+  if (list[0][table.id]) {
+    columnsSet.add(table.id)
+  }
+  table.columns.forEach(col => columnsSet.add(col))
+  let createdData: Date | number | undefined = undefined
+  if (table.createdDate) {
+    createdData = table.createdDate.type === 'date' ? new Date() : new Date().getTime()
+    columnsSet.add(table.createdDate.column)
+  }
+  let updatedDate: Date | number | undefined = undefined
+  if (table.updatedDate) {
+    updatedDate = table.updatedDate.type === 'date' ? new Date() : new Date().getTime()
+    columnsSet.add(table.updatedDate.column)
+  }
+  const columns = Array.from(columnsSet)
+  // 构建 sql
+  let sql = `insert into ??(${columns.map(() => '??').join(',')}) values`
+  const values: any[] = [table.tableName, ...columns]
+  list.forEach((data, idx) => {
+    if (idx > 0) {
+      sql += ','
+    }
+    const fragList: string[] = []
+    const rowValues: any[] = []
+    if (table.createdDate) {
+      data[table.createdDate.column] = createdData as any
+    }
+    if (table.updatedDate) {
+      data[table.updatedDate.column] = updatedDate as any
+    }
+    for (const col of columns) {
+      const { frag, values: vs } = processInsertValue(data[col])
+      fragList.push(frag)
+      rowValues.push(...vs)
+    }
+    sql += `(${fragList.join(',')})`
+    values.push(...rowValues)
+  })
+
+  const res = await promiseQuery(config, connection, sql, values)
+  const rsh = res as ResultSetHeader
+  if (rsh.affectedRows !== list.length) {
+    throw new MysqlException(
+      `Insert many for table ${table.tableName} failed,expected to insert ${list.length} records, actually ${rsh.affectedRows}.`
+    )
+  }
+  // insert 插入多条记录是不会返回生成的 id 的，所以就没有办法自动处理
+}

package/src/mysql/manager/ops/modify.ts

@@ -0,0 +1,14 @@
+import { PoolConnection, ResultSetHeader } from 'mysql2'
+import { promiseQuery } from '../utils'
+import { MysqlConfig } from '../../config'
+
+export async function modify(
+  config: MysqlConfig,
+  connection: PoolConnection,
+  sql: string,
+  values?: any[]
+): Promise<number> {
+  const res = await promiseQuery(config, connection, sql, values || [])
+  const pck = res as ResultSetHeader
+  return pck.affectedRows
+}

package/src/mysql/manager/ops/order-by.ts

@@ -0,0 +1,58 @@
+/**
+ * 排序规则类型.
+ *
+ * T 为表类型.
+ *
+ * 普通列排序：
+ *   [keyof T, 'asc' | 'desc']
+ *   例: ['balance', 'asc']  →  ORDER BY `balance` asc
+ *
+ * 自定义表达式排序：
+ *   ['expr', SQL片段, 参数值数组, 'asc' | 'desc']
+ *   例: ['expr', '?? * ?', ['balance', 2], 'desc']
+ *       →  ORDER BY `balance` * 2 desc
+ *
+ *   例: ['expr', 'CHAR_LENGTH(??)', ['name'], 'desc']
+ *       →  ORDER BY CHAR_LENGTH(`name`) desc
+ *
+ *   例: ['expr', 'VECTOR_DISTANCE(??, STRING_TO_VECTOR(?))', ['content_vec', embedding], 'asc']
+ *       →  ORDER BY VECTOR_DISTANCE(`content_vec`, STRING_TO_VECTOR(?)) asc
+ *
+ * 混合使用：
+ *   [
+ *     ['active', 'asc'],
+ *     ['expr', '?? * ?', ['balance', 2], 'desc']
+ *   ]
+ *   →  ORDER BY `active` asc , `balance` * 2 desc
+ */
+export type OrderBy<T> = Array<
+  | [keyof T, 'asc' | 'desc']
+  | ['expr', string, any[], 'asc' | 'desc']
+>
+
+/**
+ * 构建 ORDER BY 子句.
+ *
+ * @param orderBy 排序规则
+ * @returns { sql: SQL 片段, values: 参数值数组 }
+ */
+export function buildOrderBy<T>(orderBy: OrderBy<T>): { sql: string; values: any[] } {
+  const fragments: string[] = []
+  const values: any[] = []
+
+  orderBy.forEach((item, idx) => {
+    const prefix = idx === 0 ? ' order by ' : ' , '
+
+    if (item.length === 4 && item[0] === 'expr') {
+      const [, exprSql, exprValues, sort] = item as ['expr', string, any[], 'asc' | 'desc']
+      fragments.push(`${prefix}${exprSql} ${sort}`)
+      values.push(...exprValues)
+    } else {
+      const [field, sort] = item as [keyof T, 'asc' | 'desc']
+      fragments.push(`${prefix}?? ${sort}`)
+      values.push(field)
+    }
+  })
+
+  return { sql: fragments.join(''), values }
+}

package/src/mysql/manager/ops/paginate.ts

@@ -0,0 +1,100 @@
+import { PoolConnection } from 'mysql2'
+import { Table } from '../../table-info'
+import { count } from './count'
+import { MixCriteria } from './criteria'
+import { find, findSelect } from './find'
+import { MysqlConfig } from '../../config'
+import { OrderBy } from './order-by'
+
+export interface MysqlPaginateOpts<T> {
+  /**
+   * 表
+   */
+  table: Table<T>
+  /**
+   * 查询条件
+   * @param criteria
+   * @returns
+   */
+  criteria?: MixCriteria<T>
+  /**
+   * 而码,默认1
+   */
+  pn?: number
+  /**
+   * 每页的数据量大小,默认 20, 必须在 1-1000 之间
+   */
+  pz?: number
+  /**
+   * 排序规则，按先后顺序放入，每个规则是一个元组，第一个元素是字段名称，第二个元素是顺序
+   */
+  orderBy?: OrderBy<T>
+}
+/**
+ * mysql 分页查询结果
+ */
+export interface MysqlPage<T> {
+  total: number
+  list: T[]
+}
+
+export async function paginate<T>(
+  config: MysqlConfig,
+  conn: PoolConnection,
+  opts: MysqlPaginateOpts<T>
+): Promise<MysqlPage<T>> {
+  const pn = opts.pn && opts.pn >= 1 ? opts.pn : 1
+  const limit = opts.pz && opts.pz >= 1 && opts.pz <= 1000 ? opts.pz : 20
+  const offset = (pn - 1) * limit
+  const list = await find(config, conn, {
+    table: opts.table,
+    criteria: opts.criteria,
+    offset,
+    limit,
+    orderBy: opts.orderBy
+  })
+  const total = await count(config, conn, opts.table, opts.criteria)
+  return {
+    total,
+    list
+  }
+}
+
+/**
+ * 指定字段分页查询选项
+ */
+export interface MysqlPaginateSelectOpts<T, K extends keyof T> extends MysqlPaginateOpts<T> {
+  /**
+   * 要查询的字段
+   */
+  select: K[]
+}
+
+/**
+ * 指定字段分页查询
+ * @param config
+ * @param conn
+ * @param opts
+ */
+export async function paginateSelect<T, K extends keyof T>(
+  config: MysqlConfig,
+  conn: PoolConnection,
+  opts: MysqlPaginateSelectOpts<T, K>
+): Promise<MysqlPage<Pick<T, K>>> {
+  const pn = opts.pn && opts.pn >= 1 ? opts.pn : 1
+  const limit = opts.pz && opts.pz >= 1 && opts.pz <= 1000 ? opts.pz : 20
+  const offset = (pn - 1) * limit
+  const list = await findSelect(config, conn, {
+    table: opts.table,
+    criteria: opts.criteria,
+    offset,
+    limit,
+    orderBy: opts.orderBy,
+    select: opts.select
+  })
+  const total = await count(config, conn, opts.table, opts.criteria)
+  return {
+    total,
+    list
+  }
+}

package/src/mysql/manager/ops/query.ts

@@ -0,0 +1,13 @@
+import { PoolConnection, RowDataPacket } from 'mysql2'
+import { promiseQuery } from '../utils'
+import { MysqlConfig } from '../../config'
+
+export async function query<T>(
+  config: MysqlConfig,
+  connection: PoolConnection,
+  sql: string,
+  values?: any[]
+): Promise<T[]> {
+  const res = await promiseQuery(config, connection, sql, values || [])
+  return res as RowDataPacket[] as T[]
+}