Knex.js 速查表

Node.js 的 SQL 查询构建器——查询、模式、迁移和事务。

安装与设置

安装 Knex.js 并配置数据库连接

# 安装 knex 和你的数据库驱动
npm install knex --save

# 数据库驱动（选择一个）
npm install pg          # PostgreSQL
npm install mysql2      # MySQL
npm install sqlite3     # SQLite
npm install tedious     # MSSQL

软件包安装

const knex = require('knex')({
  client: 'mysql2',
  connection: {
    host: '127.0.0.1',
    port: 3306,
    user: 'your_database_user',
    password: 'your_database_password',
    database: 'myapp_test'
  },
  pool: { min: 0, max: 7 }
});

基本配置

// 连接字符串
const knex = require('knex')({
  client: 'pg',
  connection: process.env.DATABASE_URL,
  searchPath: ['knex', 'public']
});

// SQLite 内存数据库
const knex = require('knex')({
  client: 'sqlite3',
  connection: { filename: ':memory:' },
  useNullAsDefault: true
});

可选的连接方式

基本查询

SELECT、INSERT、UPDATE 和 DELETE 操作

// 查询所有
knex('users').select('*')
// SELECT * FROM users

// 查询特定列
knex('users').select('id', 'name', 'email')
// SELECT id, name, email FROM users

// 带别名的查询
knex('users').select('id', 'name as full_name')
// SELECT id, name as full_name FROM users

// 首条结果
knex('users').first('*')
// SELECT * FROM users LIMIT 1

SELECT 查询

// 插入单行
knex('users').insert({ name: 'John', email: 'john@example.com' })

// 插入多行
knex('users').insert([
  { name: 'John', email: 'john@example.com' },
  { name: 'Jane', email: 'jane@example.com' }
])

// 插入并返回 (PostgreSQL)
knex('users')
  .insert({ name: 'John', email: 'john@example.com' })
  .returning('id')

INSERT 查询

// 更新所有行
knex('users').update({ status: 'active' })

// 更新特定行
knex('users')
  .where('id', 1)
  .update({ name: 'John Updated' })

// 更新并返回
knex('users')
  .where('id', 1)
  .update({ name: 'John' })
  .returning('*')

UPDATE 查询

// 删除所有行
knex('users').del()

// 删除特定行
knex('users').where('id', 1).del()

// 删除并返回
knex('users')
  .where('id', 1)
  .del()
  .returning('*')

DELETE 查询

WHERE 子句

使用各种条件过滤数据

// 简易条件
knex('users').where('id', 1)
knex('users').where({ id: 1, status: 'active' })

// 带运算符的 where
knex('users').where('age', '>', 18)
knex('users').where('created_at', '<=', '2024-01-01')

// 多个条件 (AND)
knex('users')
  .where('status', 'active')
  .where('age', '>', 18)

// OR 条件
knex('users')
  .where('status', 'active')
  .orWhere('role', 'admin')

基础 WHERE

// Where IN
knex('users').whereIn('id', [1, 2, 3])

// Where NOT IN
knex('users').whereNotIn('status', ['banned', 'deleted'])

// Where NULL
knex('users').whereNull('deleted_at')

// Where NOT NULL
knex('users').whereNotNull('email')

// Where BETWEEN
knex('users').whereBetween('age', [18, 65])

// Where NOT BETWEEN
knex('users').whereNotBetween('age', [0, 18])

高级 WHERE

// 复杂的嵌套条件
knex('users')
  .where('status', 'active')
  .where(function() {
    this.where('role', 'admin')
      .orWhere('role', 'moderator')
  })
// WHERE status = 'active' AND (role = 'admin' OR role = 'moderator')

// WHERE EXISTS
knex('users')
  .whereExists(function() {
    this.select('*')
      .from('orders')
      .whereRaw('orders.user_id = users.id')
  })

// Raw WHERE
knex('users').whereRaw('age > ?', [18])

复杂 WHERE

连接

从多个表合并数据

// 内连接
knex('users')
  .join('orders', 'users.id', '=', 'orders.user_id')
  .select('users.name', 'orders.total')

// 左连接
knex('users')
  .leftJoin('orders', 'users.id', 'orders.user_id')
  .select('users.name', 'orders.total')

// 右连接
knex('users')
  .rightJoin('orders', 'users.id', 'orders.user_id')

// 全外连接
knex('users')
  .fullOuterJoin('orders', 'users.id', 'orders.user_id')

基础连接

// 多条件连接
knex('users')
  .join('orders', function() {
    this.on('users.id', '=', 'orders.user_id')
      .andOn('orders.status', '=', knex.raw('?', ['completed']))
  })

// 带 OR 条件的连接
knex('users')
  .join('orders', function() {
    this.on('users.id', '=', 'orders.user_id')
      .orOn('users.email', '=', 'orders.email')
  })

// 交叉连接
knex('users').crossJoin('roles')

高级连接

聚合与分组

聚合函数和 GROUP BY 操作

// 计数
knex('users').count('id as total')

// 计数去重
knex('users').countDistinct('email')

// 求和
knex('orders').sum('total as revenue')

// 平均值
knex('orders').avg('total as average_order')

// 最小值和最大值
knex('orders').min('total as min_order')
knex('orders').max('total as max_order')

聚合函数

// 分组
knex('orders')
  .select('user_id')
  .count('id as order_count')
  .groupBy('user_id')

// 多列分组
knex('orders')
  .select('user_id', 'status')
  .sum('total as revenue')
  .groupBy('user_id', 'status')

// HAVING 子句
knex('orders')
  .select('user_id')
  .count('id as order_count')
  .groupBy('user_id')
  .having('order_count', '>', 5)

// 原始 HAVING
knex('orders')
  .select('user_id')
  .sum('total as revenue')
  .groupBy('user_id')
  .havingRaw('SUM(total) > ?', [1000])

GROUP BY 与 HAVING

排序与限制

对查询结果进行排序和分页

// 升序排序
knex('users').orderBy('name')
knex('users').orderBy('name', 'asc')

// 降序排序
knex('users').orderBy('created_at', 'desc')

// 多列排序
knex('users')
  .orderBy('status', 'asc')
  .orderBy('created_at', 'desc')

// 数组排序
knex('users').orderBy([
  { column: 'status', order: 'asc' },
  { column: 'name', order: 'desc' }
])

// 原始排序
knex('users').orderByRaw('age DESC NULLS LAST')

排序

// 限制
knex('users').limit(10)

// 偏移
knex('users').offset(20)

// 分页
knex('users')
  .limit(10)
  .offset(20)

// 去重
knex('users').distinct('email')

// 多列去重
knex('users').distinct('email', 'status')

限制与分页

模式 - 创建表

定义并创建数据库表

// 创建表
knex.schema.createTable('users', function(table) {
  table.increments('id').primary();
  table.string('name', 100).notNullable();
  table.string('email', 255).unique().notNullable();
  table.integer('age');
  table.boolean('is_active').defaultTo(true);
  table.timestamps(true, true);
});

// 若不存在则创建表
knex.schema.createTableIfNotExists('users', function(table) {
  table.increments('id');
  table.string('email').unique();
});

基础表创建

// 常用列类型
table.increments('id')              // 自动递增 ID
table.integer('votes')              // 整数
table.bigInteger('big_votes')       // 大整数
table.text('description')           // 文本
table.string('name', 255)           // 带长度的字符串
table.float('amount')               // 浮点数
table.decimal('price', 8, 2)        // 小数(8,2)
table.boolean('is_admin')           // 布尔值
table.date('birth_date')            // 日期
table.datetime('created_at')        // 日期时间
table.time('alarm_time')            // 时间
table.timestamp('updated_at')       // 时间戳
table.json('metadata')              // JSON
table.jsonb('data')                 // JSONB（PostgreSQL）
table.uuid('id')                    // UUID
table.enum('status', ['active', 'inactive'])  // 枚举

列类型

// 列修饰符
table.string('email')
  .notNullable()           // 非空
  .unique()                // 唯一
  .defaultTo('default')    // 默认值
  .unsigned()              // 无符号（用于数字）
  .index()                 // 添加索引
  .comment('Email address') // 添加注释

// 外键
table.integer('user_id')
  .unsigned()
  .notNullable()
  .references('id')
  .inTable('users')
  .onDelete('CASCADE')
  .onUpdate('CASCADE');

// 时间戳辅助
table.timestamps(true, true)  // created_at, updated_at
table.timestamp('created_at').defaultTo(knex.fn.now())

列修饰符和约束

模式 - 修改表

修改现有表结构

// 添加列
knex.schema.table('users', function(table) {
  table.string('phone', 20);
});

// 添加多个列
knex.schema.table('users', function(table) {
  table.string('phone', 20);
  table.string('address', 255);
  table.integer('zip_code');
});

// 修改列
knex.schema.alterTable('users', function(table) {
  table.string('email', 500).alter();
});

// 重命名列
knex.schema.table('users', function(table) {
  table.renameColumn('name', 'full_name');
});

修改表

// 删除列
knex.schema.table('users', function(table) {
  table.dropColumn('phone');
});

// 删除多个列
knex.schema.table('users', function(table) {
  table.dropColumns('phone', 'address');
});

// 删除表
knex.schema.dropTable('users');

// 删除表（如果存在）
knex.schema.dropTableIfExists('users');

// 重命名表
knex.schema.renameTable('users', 'customers');

删除和重命名

// 检查表是否存在
knex.schema.hasTable('users')
  .then(exists => {
    if (!exists) {
      return knex.schema.createTable('users', table => {
        table.increments('id');
      });
    }
  });

// 检查列是否存在
knex.schema.hasColumn('users', 'email')
  .then(exists => {
    if (!exists) {
      return knex.schema.table('users', table => {
        table.string('email');
      });
    }
  });

模式检查

模式 - 索引与外键

创建和管理数据库索引及关系

// 创建索引
knex.schema.table('users', function(table) {
  table.index('email');
});

// 创建命名索引
knex.schema.table('users', function(table) {
  table.index('email', 'idx_users_email');
});

// 复合索引
knex.schema.table('users', function(table) {
  table.index(['status', 'created_at'], 'idx_status_created');
});

// 唯一索引
knex.schema.table('users', function(table) {
  table.unique('email');
});

// 删除索引
knex.schema.table('users', function(table) {
  table.dropIndex('email');
  table.dropIndex([], 'idx_users_email'); // 按名称
});

索引

// 添加外键
knex.schema.table('orders', function(table) {
  table.foreign('user_id')
    .references('id')
    .inTable('users');
});

// 带操作的外键
knex.schema.table('orders', function(table) {
  table.foreign('user_id')
    .references('id')
    .inTable('users')
    .onDelete('CASCADE')
    .onUpdate('RESTRICT');
});

// 命名外键
knex.schema.table('orders', function(table) {
  table.foreign('user_id', 'fk_orders_user')
    .references('users.id');
});

// 删除外键
knex.schema.table('orders', function(table) {
  table.dropForeign('user_id');
  table.dropForeign([], 'fk_orders_user'); // 按名称
});

外键

事务

原子执行多个查询

// 基本事务
knex.transaction(async (trx) => {
  await trx('users').insert({ name: 'John' });
  await trx('orders').insert({ user_id: 1, total: 100 });
})
.then(() => console.log('Transaction committed'))
.catch((err) => console.error('Transaction failed:', err));

// 带返回值的事务
const userId = await knex.transaction(async (trx) => {
  const [id] = await trx('users')
    .insert({ name: 'John' })
    .returning('id');
  
  await trx('profiles')
    .insert({ user_id: id, bio: 'Hello' });
  
  return id;
});

基本事务

// 手动事务控制
const trx = await knex.transaction();

try {
  await trx('users').insert({ name: 'John' });
  await trx('orders').insert({ user_id: 1, total: 100 });
  await trx.commit();
} catch (err) {
  await trx.rollback();
  throw err;
}

// 带保存点的事务
knex.transaction(async (trx) => {
  await trx('users').insert({ name: 'John' });
  
  const savepoint = await trx.savepoint();
  try {
    await trx('orders').insert({ user_id: 1, total: 100 });
    await savepoint.release();
  } catch (err) {
    await savepoint.rollback();
  }
});

高级事务控制

原始查询

在需要时执行原始 SQL

// 简单原始查询
knex.raw('SELECT * FROM users WHERE id = ?', [1])

// 带命名绑定的原始查询
knex.raw('SELECT * FROM users WHERE id = :userId', {
  userId: 1
})

// select 中的原始查询
knex('users')
  .select(knex.raw('COUNT(*) as total'))
  .where('status', 'active')

// where 中的原始查询
knex('users')
  .whereRaw('age > ?', [18])
  .orWhereRaw('status = ?', ['admin'])

基本原始查询

// 原始更新
knex('users')
  .update({
    updated_at: knex.raw('NOW()'),
    views: knex.raw('views + 1')
  })
  .where('id', 1)

// 原始插入
knex('users').insert({
  name: 'John',
  created_at: knex.raw('CURRENT_TIMESTAMP')
})

// 使用 knex.ref 引用列
knex('users')
  .where('created_at', '>', knex.ref('updated_at'))

查询中的原始操作

迁移

数据库模式的版本控制

# 创建迁移
npx knex migrate:make create_users_table

# 运行迁移
npx knex migrate:latest

# 回滚最近一次批次
npx knex migrate:rollback

# 回滚所有迁移
npx knex migrate:rollback --all

# 检查迁移状态
npx knex migrate:status

# 运行特定迁移
npx knex migrate:up 001_create_users.js

迁移命令

// 迁移文件结构
exports.up = function(knex) {
  return knex.schema.createTable('users', function(table) {
    table.increments('id').primary();
    table.string('name', 100).notNullable();
    table.string('email', 255).unique().notNullable();
    table.timestamp('created_at').defaultTo(knex.fn.now());
  });
};

exports.down = function(knex) {
  return knex.schema.dropTable('users');
};

迁移文件示例

// 包含多个操作的迁移
exports.up = async function(knex) {
  // 创建 users 表
  await knex.schema.createTable('users', table => {
    table.increments('id');
    table.string('email').unique();
  });
  
  // 创建 orders 表
  await knex.schema.createTable('orders', table => {
    table.increments('id');
    table.integer('user_id').unsigned();
    table.foreign('user_id').references('users.id');
  });
  
  // 插入初始数据
  await knex('users').insert([
    { email: 'admin@example.com' }
  ]);
};

exports.down = async function(knex) {
  await knex.schema.dropTable('orders');
  await knex.schema.dropTable('users');
};

复杂迁移

种子数据

使用测试数据填充数据库

# 创建种子文件
npx knex seed:make 01_users

# 运行所有种子
npx knex seed:run

# 运行特定种子
npx knex seed:run --specific=01_users.js

种子命令

// 基础种子文件
exports.seed = async function(knex) {
  // 删除已有记录
  await knex('users').del();
  
  // 插入种子数据
  await knex('users').insert([
    { name: 'John Doe', email: 'john@example.com' },
    { name: 'Jane Smith', email: 'jane@example.com' },
    { name: 'Bob Johnson', email: 'bob@example.com' }
  ]);
};

基础种子

// 带关系的种子
exports.seed = async function(knex) {
  // 按正确顺序清空表
  await knex('orders').del();
  await knex('users').del();
  
  // 插入用户并获取 ID
  const [userId1] = await knex('users')
    .insert({ name: 'John', email: 'john@example.com' })
    .returning('id');
  
  const [userId2] = await knex('users')
    .insert({ name: 'Jane', email: 'jane@example.com' })
    .returning('id');
  
  // 插入关联订单
  await knex('orders').insert([
    { user_id: userId1, total: 100.50 },
    { user_id: userId1, total: 75.25 },
    { user_id: userId2, total: 200.00 }
  ]);
};

带关系的种子

TypeScript 支持

使用 TypeScript 的类型安全查询

// 定义表类型
interface User {
  id: number;
  name: string;
  email: string;
  created_at: string;
  updated_at: string;
}

interface UserInsert {
  name: string;
  email: string;
}

interface UserUpdate {
  name?: string;
  email?: string;
  updated_at?: string;
}

类型定义

// 扩展 Knex 类型
import { Knex } from 'knex';

declare module 'knex/types/tables' {
  interface Tables {
    users: User;
    users_composite: Knex.CompositeTableType<
      User,
      UserInsert,
      UserUpdate
    >;
  }
}

// 类型安全查询
const users = await knex('users').select('*');
// users is typed as User[]

const newUser = await knex('users_composite')
  .insert({ name: 'John', email: 'john@example.com' })
  .returning('*');

类型扩展

// 通用查询类型
const getUserById = async (id: number): Promise<User | undefined> => {
  return knex<User>('users')
    .where({ id })
    .first();
};

const createUser = async (data: UserInsert): Promise<User> => {
  const [user] = await knex<User>('users')
    .insert(data)
    .returning('*');
  return user;
};

const updateUser = async (
  id: number,
  data: UserUpdate
): Promise<User | undefined> => {
  const [user] = await knex<User>('users')
    .where({ id })
    .update(data)
    .returning('*');
  return user;
};

带类型的查询函数

高级功能

Knex.js 高级功能

// Upsert（插入或更新）
knex('users')
  .insert({ id: 1, name: 'John', email: 'john@example.com' })
  .onConflict('id')
  .merge()

// 使用特定列的 Upsert
knex('users')
  .insert({ id: 1, name: 'John', email: 'john@example.com' })
  .onConflict('email')
  .merge(['name'])

// 插入忽略（MySQL）
knex('users')
  .insert({ email: 'john@example.com' })
  .onConflict('email')
  .ignore()

Upsert 操作

// WITH（公共表表达式）
knex.with('active_users', (qb) => {
  qb.select('*').from('users').where('status', 'active');
})
.select('*')
.from('active_users')
.where('age', '>', 18);

// 递归 CTE
knex.withRecursive('tree', (qb) => {
  qb.select('*').from('categories').where('parent_id', null)
    .union((qb2) => {
      qb2.select('c.*')
        .from('categories as c')
        .join('tree as t', 'c.parent_id', 't.id');
    });
})
.select('*').from('tree');

公共表表达式

// 子查询
knex('users')
  .whereIn('id', function() {
    this.select('user_id').from('orders').where('total', '>', 100);
  })

// SELECT 中的子查询
knex('users')
  .select('name')
  .select(
    knex('orders')
      .count('*')
      .where('orders.user_id', knex.raw('??', ['users.id']))
      .as('order_count')
  )

// FROM 中的子查询
knex
  .select('*')
  .from(
    knex('users')
      .where('status', 'active')
      .as('active_users')
  )

子查询

// 窗口函数
knex('orders')
  .select('*')
  .select(
    knex.raw('ROW_NUMBER() OVER (PARTITION BY user_id ORDER BY created_at DESC) as row_num')
  )

// JSON 操作（PostgreSQL）
knex('users')
  .select('name')
  .select(knex.raw("metadata->>'age' as age"))
  .where(knex.raw("metadata->>'city'"), 'New York')

// 数组操作（PostgreSQL）
knex('users')
  .whereRaw('? = ANY(tags)', ['javascript'])

高级 SQL 功能

连接与池管理

管理数据库连接和连接池

// 配置连接池
const knex = require('knex')({
  client: 'pg',
  connection: {
    host: '127.0.0.1',
    user: 'user',
    password: 'password',
    database: 'myapp'
  },
  pool: {
    min: 2,
    max: 10,
    acquireTimeoutMillis: 30000,
    idleTimeoutMillis: 30000
  }
});

// 销毁连接池
await knex.destroy();

// 重新初始化
knex.initialize();

连接池配置

// 连接 afterCreate 钩子
const knex = require('knex')({
  client: 'pg',
  connection: { /* ... */ },
  pool: {
    afterCreate: function(conn, done) {
      conn.query('SET timezone="UTC";', function(err) {
        done(err, conn);
      });
    }
  }
});

// 动态连接
const knex = require('knex')({
  client: 'mysql',
  connection: async () => {
    const token = await getAuthToken();
    return {
      host: 'localhost',
      user: 'user',
      password: token,
      database: 'myapp'
    };
  }
});

连接钩子

// 调试查询
const knex = require('knex')({
  client: 'pg',
  connection: { /* ... */ },
  debug: true  // 记录所有查询
});

// 调试特定查询
knex('users')
  .select('*')
  .debug()
  .then(rows => console.log(rows));

// 获取未执行的 SQL
const sql = knex('users')
  .where('id', 1)
  .toSQL();
console.log(sql.sql);      // SQL 字符串
console.log(sql.bindings); // 参数

调试

Knex.js 速查表