Hoja de referencia de Knex.js

Constructor de consultas SQL para Node.js: consultas, esquemas, migraciones y transacciones.

Instalación y Configuración

Instalar Knex.js y configurar la conexión a la base de datos

# Instalar knex y el controlador de base de datos
npm install knex --save

# Controladores de base de datos (elige uno)
npm install pg          # PostgreSQL
npm install mysql2      # MySQL
npm install sqlite3     # SQLite
npm install tedious     # MSSQL

Instalación del paquete

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 }
});

Configuración básica

// Cadena de conexión
const knex = require('knex')({
  client: 'pg',
  connection: process.env.DATABASE_URL,
  searchPath: ['knex', 'public']
});

// SQLite en memoria
const knex = require('knex')({
  client: 'sqlite3',
  connection: { filename: ':memory:' },
  useNullAsDefault: true
});

Métodos de conexión alternativos

Consultas básicas

Operaciones de selección, inserción, actualización y eliminación

// Seleccionar todo
knex('users').select('*')
// SELECT * FROM users

// Seleccionar columnas específicas
knex('users').select('id', 'name', 'email')
// SELECT id, name, email FROM users

// Seleccionar con alias
knex('users').select('id', 'name as full_name')
// SELECT id, name as full_name FROM users

// Primer resultado
knex('users').first('*')
// SELECT * FROM users LIMIT 1

Consultas SELECT

// Insertar una fila
knex('users').insert({ name: 'John', email: 'john@example.com' })

// Insertar múltiples filas
knex('users').insert([
  { name: 'John', email: 'john@example.com' },
  { name: 'Jane', email: 'jane@example.com' }
])

// Insertar con returning (PostgreSQL)
knex('users')
  .insert({ name: 'John', email: 'john@example.com' })
  .returning('id')

Consultas INSERT

// Actualizar todas las filas
knex('users').update({ status: 'active' })

// Actualizar filas específicas
knex('users')
  .where('id', 1)
  .update({ name: 'John Updated' })

// Actualizar con returning
knex('users')
  .where('id', 1)
  .update({ name: 'John' })
  .returning('*')

Consultas UPDATE

// Eliminar todas las filas
knex('users').del()

// Eliminar filas específicas
knex('users').where('id', 1).del()

// Eliminar con returning
knex('users')
  .where('id', 1)
  .del()
  .returning('*')

Consultas DELETE

Cláusulas WHERE

Filtrar datos con diversas condiciones

// where simple
knex('users').where('id', 1)
knex('users').where({ id: 1, status: 'active' })

// where con operador
knex('users').where('age', '>', 18)
knex('users').where('created_at', '<=', '2024-01-01')

// Múltiples condiciones (AND)
knex('users')
  .where('status', 'active')
  .where('age', '>', 18)

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

WHERE básico

// 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 avanzado

// Condiciones anidadas complejas
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')
  })

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

WHERE complejo

Uniones

Combinar datos de múltiples tablas

// UNIÓN INTERNA
knex('users')
  .join('orders', 'users.id', '=', 'orders.user_id')
  .select('users.name', 'orders.total')

// UNIÓN IZQUIERDA
knex('users')
  .leftJoin('orders', 'users.id', 'orders.user_id')
  .select('users.name', 'orders.total')

// UNIÓN DERECHA
knex('users')
  .rightJoin('orders', 'users.id', 'orders.user_id')

// UNIÓN COMPLETA EXTERNA
knex('users')
  .fullOuterJoin('orders', 'users.id', 'orders.user_id')

Uniones básicas

// Unión con múltiples condiciones
knex('users')
  .join('orders', function() {
    this.on('users.id', '=', 'orders.user_id')
      .andOn('orders.status', '=', knex.raw('?', ['completed']))
  })

// Unión con condición OR
knex('users')
  .join('orders', function() {
    this.on('users.id', '=', 'orders.user_id')
      .orOn('users.email', '=', 'orders.email')
  })

// Unión cruzada
knex('users').crossJoin('roles')

Uniones avanzadas

Agregaciones y Agrupamiento

Funciones de agregación y operaciones GROUP BY

// Contar
knex('users').count('id as total')

// Contar distintos
knex('users').countDistinct('email')

// Sumar
knex('orders').sum('total as revenue')

// Promedio
knex('orders').avg('total as average_order')

// Mínimo y Máximo
knex('orders').min('total as min_order')
knex('orders').max('total as max_order')

Funciones de agregación

// Agrupar por
knex('orders')
  .select('user_id')
  .count('id as order_count')
  .groupBy('user_id')

// Agrupar por múltiples columnas
knex('orders')
  .select('user_id', 'status')
  .sum('total as revenue')
  .groupBy('user_id', 'status')

// Cláusula HAVING
knex('orders')
  .select('user_id')
  .count('id as order_count')
  .groupBy('user_id')
  .having('order_count', '>', 5)

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

GROUP BY y HAVING

Ordenación y Limitación

Ordenar y paginar los resultados de la consulta

// Ordenar ascendente
knex('users').orderBy('name')
knex('users').orderBy('name', 'asc')

// Ordenar descendente
knex('users').orderBy('created_at', 'desc')

// Múltiples columnas de orden
knex('users')
  .orderBy('status', 'asc')
  .orderBy('created_at', 'desc')

// Ordenar por arreglo
knex('users').orderBy([
  { column: 'status', order: 'asc' },
  { column: 'name', order: 'desc' }
])

// Ordenar por raw
knex('users').orderByRaw('age DESC NULLS LAST')

Ordenación

// Limitar
knex('users').limit(10)

// Desplazamiento
knex('users').offset(20)

// Paginación
knex('users')
  .limit(10)
  .offset(20)

// Distinto
knex('users').distinct('email')

// Distinto en múltiples columnas
knex('users').distinct('email', 'status')

Limitación y paginación

Esquema - Creación de Tablas

Definir y crear tablas de base de datos

// Crear tabla
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);
});

// Crear tabla si no existe
knex.schema.createTableIfNotExists('users', function(table) {
  table.increments('id');
  table.string('email').unique();
});

Creación básica de tabla

// Tipos de columna comunes
table.increments('id')              // ID autoincremental
 table.integer('votes')              // Entero
 table.bigInteger('big_votes')       // Entero grande
 table.text('description')           // Texto
 table.string('name', 255)           // Cadena con longitud
 table.float('amount')               // Flotante
 table.decimal('price', 8, 2)        // Decimal(8,2)
 table.boolean('is_admin')           // Booleano
 table.date('birth_date')            // Fecha
 table.datetime('created_at')        // Fecha y hora
 table.time('alarm_time')            // Hora
 table.timestamp('updated_at')       // Marca de tiempo
 table.json('metadata')              // JSON
 table.jsonb('data')                 // JSONB (PostgreSQL)
 table.uuid('id')                    // UUID
 table.enum('status', ['active', 'inactive'])  // Enumerado

Tipos de columna

// Modificadores de columna
table.string('email')
  .notNullable()           // NO NULO
  .unique()                // ÚNICO
  .defaultTo('default')    // Valor POR DEFECTO
  .unsigned()              // SIN SIGNO (para números)
  .index()                 // Añadir índice
  .comment('Email address') // Añadir comentario

// Claves foráneas
table.integer('user_id')
  .unsigned()
  .notNullable()
  .references('id')
  .inTable('users')
  .onDelete('CASCADE')
  .onUpdate('CASCADE');

// Ayudantes de marcas de tiempo
table.timestamps(true, true)  // created_at, updated_at
table.timestamp('created_at').defaultTo(knex.fn.now())

Modificadores de columna y restricciones

Esquema - Alterar Tablas

Modificar estructuras de tabla existentes

// Añadir columna
knex.schema.table('users', function(table) {
  table.string('phone', 20);
});

// Añadir múltiples columnas
knex.schema.table('users', function(table) {
  table.string('phone', 20);
  table.string('address', 255);
  table.integer('zip_code');
});

// Alterar columna
knex.schema.alterTable('users', function(table) {
  table.string('email', 500).alter();
});

// Renombrar columna
knex.schema.table('users', function(table) {
  table.renameColumn('name', 'full_name');
});

Modificando tablas

// Eliminar columna
knex.schema.table('users', function(table) {
  table.dropColumn('phone');
});

// Eliminar múltiples columnas
knex.schema.table('users', function(table) {
  table.dropColumns('phone', 'address');
});

// Eliminar tabla
knex.schema.dropTable('users');

// Eliminar tabla si existe
knex.schema.dropTableIfExists('users');

// Renombrar tabla
knex.schema.renameTable('users', 'customers');

Eliminación y renombrado

// Verificar si la tabla existe
knex.schema.hasTable('users')
  .then(exists => {
    if (!exists) {
      return knex.schema.createTable('users', table => {
        table.increments('id');
      });
    }
  });

// Verificar si la columna existe
knex.schema.hasColumn('users', 'email')
  .then(exists => {
    if (!exists) {
      return knex.schema.table('users', table => {
        table.string('email');
      });
    }
  });

Verificaciones de esquema

Esquema - Índices y Claves Foráneas

Crear y gestionar índices de base de datos y relaciones

// Crear índice
knex.schema.table('users', function(table) {
  table.index('email');
});

// Crear índice con nombre
knex.schema.table('users', function(table) {
  table.index('email', 'idx_users_email');
});

// Índice compuesto
knex.schema.table('users', function(table) {
  table.index(['status', 'created_at'], 'idx_status_created');
});

// Índice único
knex.schema.table('users', function(table) {
  table.unique('email');
});

// Eliminar índice
knex.schema.table('users', function(table) {
  table.dropIndex('email');
  table.dropIndex([], 'idx_users_email'); // por nombre
});

Índices

// Añadir clave foránea
knex.schema.table('orders', function(table) {
  table.foreign('user_id')
    .references('id')
    .inTable('users');
});

// Clave foránea con acciones
knex.schema.table('orders', function(table) {
  table.foreign('user_id')
    .references('id')
    .inTable('users')
    .onDelete('CASCADE')
    .onUpdate('RESTRICT');
});

// Clave foránea con nombre
knex.schema.table('orders', function(table) {
  table.foreign('user_id', 'fk_orders_user')
    .references('users.id');
});

// Eliminar clave foránea
knex.schema.table('orders', function(table) {
  table.dropForeign('user_id');
  table.dropForeign([], 'fk_orders_user'); // por nombre
});

Claves foráneas

Transacciones

Ejecutar múltiples consultas de forma atómica

// Transacción básica
knex.transaction(async (trx) => {
  await trx('users').insert({ name: 'John' });
  await trx('orders').insert({ user_id: 1, total: 100 });
})
.then(() => console.log('Transacción confirmada'))
.catch((err) => console.error('Transacción falló:', err));

// Transacción con valor de retorno
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: 'Hola' });
  
  return id;
});

Transacciones básicas

// Control manual de transacción
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;
}

// Transacción con puntos de guardado
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();
  }
});

Control avanzado de transacciones

Consultas sin procesar

Ejecutar SQL sin procesar cuando sea necesario

// Consulta RAW simple
knex.raw('SELECT * FROM users WHERE id = ?', [1])

// Consulta RAW con enlaces nombrados
knex.raw('SELECT * FROM users WHERE id = :userId', {
  userId: 1
})

// RAW en select
knex('users')
  .select(knex.raw('COUNT(*) as total'))
  .where('status', 'active')

// RAW en where
knex('users')
  .whereRaw('age > ?', [18])
  .orWhereRaw('status = ?', ['admin'])

Consultas RAW básicas

// Actualización RAW
knex('users')
  .update({
    updated_at: knex.raw('NOW()'),
    views: knex.raw('views + 1')
  })
  .where('id', 1)

// Inserción RAW
knex('users').insert({
  name: 'John',
  created_at: knex.raw('CURRENT_TIMESTAMP')
})

// Usando knex.ref para referencias de columnas
knex('users')
  .where('created_at', '>', knex.ref('updated_at'))

RAW en consultas

Migraciones

Control de versiones para el esquema de base de datos

# Crear migración
npx knex migrate:make create_users_table

# Ejecutar migraciones
npx knex migrate:latest

# Revertir último lote
npx knex migrate:rollback

# Revertir todas las migraciones
npx knex migrate:rollback --all

# Verificar estado de migraciones
npx knex migrate:status

# Ejecutar migración específica
npx knex migrate:up 001_create_users.js

Comandos de migración

// Estructura del archivo de migración
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');
};

Ejemplo de archivo de migración

// Migración con múltiples operaciones
exports.up = async function(knex) {
  // Crear tabla users
  await knex.schema.createTable('users', table => {
    table.increments('id');
    table.string('email').unique();
  });
  
  // Crear tabla orders
  await knex.schema.createTable('orders', table => {
    table.increments('id');
    table.integer('user_id').unsigned();
    table.foreign('user_id').references('users.id');
  });
  
  // Poblar datos iniciales
  await knex('users').insert([
    { email: 'admin@example.com' }
  ]);
};

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

Migración compleja

Semillas

Poblar la base de datos con datos de prueba

# Crear archivo de semilla
npx knex seed:make 01_users

# Ejecutar todas las semillas
npx knex seed:run

# Ejecutar semilla específica
npx knex seed:run --specific=01_users.js

Comandos de semillas

// Archivo de semilla básico
exports.seed = async function(knex) {
  // Eliminar entradas existentes
  await knex('users').del();
  
  // Insertar datos de semilla
  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' }
  ]);
};

Semilla básica

// Semilla con relaciones
exports.seed = async function(knex) {
  // Vaciar tablas en el orden correcto
  await knex('orders').del();
  await knex('users').del();
  
  // Insertar usuarios y obtener IDs
  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');
  
  // Insertar pedidos relacionados
  await knex('orders').insert([
    { user_id: userId1, total: 100.50 },
    { user_id: userId1, total: 75.25 },
    { user_id: userId2, total: 200.00 }
  ]);
};

Semilla con relaciones

Soporte TypeScript

Consultas con tipado seguro usando TypeScript

// Definir tipos de tabla
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;
}

Definiciones de tipos

// Ampliar tipos de Knex
import { Knex } from 'knex';

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

// Consultas con tipado seguro
const users = await knex('users').select('*');
// users tiene tipo User[]

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

Ampliación de tipos

// Tipos de consultas genéricos
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;
};

Funciones de consulta tipadas

Funciones avanzadas

Capacidades avanzadas de Knex.js

// Upsert (insertar o actualizar)
knex('users')
  .insert({ id: 1, name: 'John', email: 'john@example.com' })
  .onConflict('id')
  .merge()

// Upsert con columnas específicas
knex('users')
  .insert({ id: 1, name: 'John', email: 'john@example.com' })
  .onConflict('email')
  .merge(['name'])

// Insert ignore (MySQL)
knex('users')
  .insert({ email: 'john@example.com' })
  .onConflict('email')
  .ignore()

Operaciones Upsert

// WITH (Expresiones de tabla comunes)
knex.with('active_users', (qb) => {
  qb.select('*').from('users').where('status', 'active');
})
.select('*')
.from('active_users')
.where('age', '>', 18);

// CTE recursivo
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');

Expresiones de tabla comunes

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

// Subconsulta en select
knex('users')
  .select('name')
  .select(
    knex('orders')
      .count('*')
      .where('orders.user_id', knex.raw('??', ['users.id']))
      .as('order_count')
  )

// Subconsulta en from
knex
  .select('*')
  .from(
    knex('users')
      .where('status', 'active')
      .as('active_users')
  )

Subconsultas

// Funciones de ventana
knex('orders')
  .select('*')
  .select(
    knex.raw('ROW_NUMBER() OVER (PARTITION BY user_id ORDER BY created_at DESC) as row_num')
  )

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

// Operaciones de arreglos (PostgreSQL)
knex('users')
  .whereRaw('? = ANY(tags)', ['javascript'])

Características avanzadas de SQL

Gestión de Conexiones y Pools

Gestionar conexiones de base de datos y pool

// Configurar pool de conexión
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
  }
});

// Destruir pool de conexión
await knex.destroy();

// Re-inicializar
knex.initialize();

Configuración del pool

// Hook afterCreate de conexión
const knex = require('knex')({
  client: 'pg',
  connection: { /* ... */ },
  pool: {
    afterCreate: function(conn, done) {
      conn.query('SET timezone="UTC";', function(err) {
        done(err, conn);
      });
    }
  }
});

// Conexión dinámica
const knex = require('knex')({
  client: 'mysql',
  connection: async () => {
    const token = await getAuthToken();
    return {
      host: 'localhost',
      user: 'user',
      password: token,
      database: 'myapp'
    };
  }
});

Hooks de conexión

// Depuración de consultas
const knex = require('knex')({
  client: 'pg',
  connection: { /* ... */ },
  debug: true  // Registrar todas las consultas
});

// Depurar consulta específica
knex('users')
  .select('*')
  .debug()
  .then(rows => console.log(rows));

// Obtener SQL sin ejecutar
const sql = knex('users')
  .where('id', 1)
  .toSQL();
console.log(sql.sql);      // Cadena SQL
console.log(sql.bindings); // Parámetros

Depuración

Hoja de referencia de Knex.js