Guia rápido do Knex.js

Construtor de consultas SQL para Node.js – consultas, esquema, migrações e transações.

Instalação e Configuração

Instale o Knex.js e configure a conexão do banco de dados

# Instale o knex e seu driver de banco de dados
npm install knex --save

# Drivers de banco de dados (escolha um)
npm install pg          # PostgreSQL
npm install mysql2      # MySQL
npm install sqlite3     # SQLite
npm install tedious     # MSSQL

Instalação de pacotes

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

Configuração básica

// String de conexão
const knex = require('knex')({
  client: 'pg',
  connection: process.env.DATABASE_URL,
  searchPath: ['knex', 'public']
});

// SQLite em memória
const knex = require('knex')({
  client: 'sqlite3',
  connection: { filename: ':memory:' },
  useNullAsDefault: true
});

Métodos alternativos de conexão

Consultas Básicas

Operações de seleção, inserção, atualização e exclusão

// Selecionar tudo
knex('users').select('*')
// SELECT * FROM users

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

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

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

Consultas SELECT

// Inserir linha única
knex('users').insert({ name: 'John', email: 'john@example.com' })

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

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

Consultas INSERT

// Atualizar todas as linhas
knex('users').update({ status: 'active' })

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

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

Consultas UPDATE

// Excluir todas as linhas
knex('users').del()

// Excluir linhas específicas
knex('users').where('id', 1).del()

// Excluir com returning
knex('users')
  .where('id', 1)
  .del()
  .returning('*')

Consultas DELETE

Cláusulas WHERE

Filtrando dados com várias condições

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

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

// Múltiplas condições (AND)
knex('users')
  .where('status', 'active')
  .where('age', '>', 18)

// Condições 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 Avançado

// Condições aninhadas complexas
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 bruto
knex('users').whereRaw('age > ?', [18])

WHERE Complexo

Junções

Combinando dados de várias tabelas

// INNER JOIN
knex('users')
  .join('orders', 'users.id', '=', 'orders.user_id')
  .select('users.name', 'orders.total')

// LEFT JOIN
knex('users')
  .leftJoin('orders', 'users.id', 'orders.user_id')
  .select('users.name', 'orders.total')

// RIGHT JOIN
knex('users')
  .rightJoin('orders', 'users.id', 'orders.user_id')

// FULL OUTER JOIN
knex('users')
  .fullOuterJoin('orders', 'users.id', 'orders.user_id')

Junções básicas

// Junção com múltiplas condições
knex('users')
  .join('orders', function() {
    this.on('users.id', '=', 'orders.user_id')
      .andOn('orders.status', '=', knex.raw('?', ['completed']))
  })

// Junção com condição OR
knex('users')
  .join('orders', function() {
    this.on('users.id', '=', 'orders.user_id')
      .orOn('users.email', '=', 'orders.email')
  })

// Cross join
knex('users').crossJoin('roles')

Junções avançadas

Agregações e Agrupamento

Funções de agregação e operações GROUP BY

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

// Contagem distinta
knex('users').countDistinct('email')

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

// Média
knex('orders').avg('total as average_order')

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

Funções de agregação

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

// Agrupar por múltiplas colunas
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 com raw
knex('orders')
  .select('user_id')
  .sum('total as revenue')
  .groupBy('user_id')
  .havingRaw('SUM(total) > ?', [1000])

GROUP BY e HAVING

Ordenação e Limitação

Ordenar e paginar resultados de consultas

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

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

// Múltiplas colunas de ordenação
knex('users')
  .orderBy('status', 'asc')
  .orderBy('created_at', 'desc')

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

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

Ordenação

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

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

// Paginação
knex('users')
  .limit(10)
  .offset(20)

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

// Distinto em múltiplas colunas
knex('users').distinct('email', 'status')

Limitação e paginação

Esquema - Criação de Tabelas

Definir e criar tabelas de banco de dados

// Criar tabela
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);
});

// Criar tabela se não existir
knex.schema.createTableIfNotExists('users', function(table) {
  table.increments('id');
  table.string('email').unique();
});

Criação básica de tabela

// Tipos de coluna comuns
table.increments('id')              // ID auto-incrementado
table.integer('votes')              // Inteiro
table.bigInteger('big_votes')       // Inteiro grande
table.text('description')           // Texto
table.string('name', 255)           // String com comprimento
table.float('amount')               // Float
table.decimal('price', 8, 2)        // Decimal(8,2)
table.boolean('is_admin')           // Booleano
table.date('birth_date')            // Data
table.datetime('created_at')        // Data e hora
table.time('alarm_time')            // Hora
table.timestamp('updated_at')       // Timestamp
table.json('metadata')              // JSON
table.jsonb('data')                 // JSONB (PostgreSQL)
table.uuid('id')                    // UUID
table.enum('status', ['active', 'inactive'])  // Enum

Tipos de coluna

// Modificadores de coluna
table.string('email')
  .notNullable()           // NÃO NULO
  .unique()                // ÚNICO
  .defaultTo('default')    // valor PADRÃO
  .unsigned()              // NÃO ASSINADO (para números)
  .index()                 // Adicionar índice
  .comment('Email address') // Adicionar comentário

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

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

Modificadores de coluna e restrições

Esquema - Alterando Tabelas

Modificar estruturas de tabelas existentes

// Adicionar coluna
knex.schema.table('users', function(table) {
  table.string('phone', 20);
});

// Adicionar múltiplas colunas
knex.schema.table('users', function(table) {
  table.string('phone', 20);
  table.string('address', 255);
  table.integer('zip_code');
});

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

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

Modificando tabelas

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

// Remover múltiplas colunas
knex.schema.table('users', function(table) {
  table.dropColumns('phone', 'address');
});

// Remover tabela
knex.schema.dropTable('users');

// Remover tabela se existir
knex.schema.dropTableIfExists('users');

// Renomear tabela
knex.schema.renameTable('users', 'customers');

Removendo e renomeando

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

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

Verificações de esquema

Esquema - Índices e Chaves Estrangeiras

Criar e gerenciar índices de banco de dados e relacionamentos

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

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

// Índice composto
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');
});

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

Índices

// Adicionar chave estrangeira
knex.schema.table('orders', function(table) {
  table.foreign('user_id')
    .references('id')
    .inTable('users');
});

// Chave estrangeira com ações
knex.schema.table('orders', function(table) {
  table.foreign('user_id')
    .references('id')
    .inTable('users')
    .onDelete('CASCADE')
    .onUpdate('RESTRICT');
});

// Chave estrangeira nomeada
knex.schema.table('orders', function(table) {
  table.foreign('user_id', 'fk_orders_user')
    .references('users.id');
});

// Remover chave estrangeira
knex.schema.table('orders', function(table) {
  table.dropForeign('user_id');
  table.dropForeign([], 'fk_orders_user'); // por nome
});

Chaves estrangeiras

Transações

Executar múltiplas consultas de forma atômica

// Transação básica
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));

// Transação com 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: 'Hello' });
  
  return id;
});

Transações básicas

// Controle manual de transação
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;
}

// Transação com pontos de salvamento
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();
  }
});

Controle avançado de transações

Consultas Raw

Executar SQL raw quando necessário

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

// Consulta raw com ligações nomeadas
knex.raw('SELECT * FROM users WHERE id = :userId', {
  userId: 1
})

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

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

Consultas raw básicas

// Atualização raw
knex('users')
  .update({
    updated_at: knex.raw('NOW()'),
    views: knex.raw('views + 1')
  })
  .where('id', 1)

// Inserção raw
knex('users').insert({
  name: 'John',
  created_at: knex.raw('CURRENT_TIMESTAMP')
})

// Usando knex.ref para referências de colunas
knex('users')
  .where('created_at', '>', knex.ref('updated_at'))

Raw em consultas

Migrações

Controle de versão para o esquema do banco de dados

# Criar migração
npx knex migrate:make create_users_table

# Executar migrações
npx knex migrate:latest

# Reverter último lote
npx knex migrate:rollback

# Reverter todas as migrações
npx knex migrate:rollback --all

# Verificar status das migrações
npx knex migrate:status

# Executar migração específica
npx knex migrate:up 001_create_users.js

Comandos de migração

// Estrutura do arquivo de migração
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');
};

Exemplo de arquivo de migração

// Migração com múltiplas operações
exports.up = async function(knex) {
  // Criar tabela de usuários
  await knex.schema.createTable('users', table => {
    table.increments('id');
    table.string('email').unique();
  });
  
  // Criar tabela de pedidos
  await knex.schema.createTable('orders', table => {
    table.increments('id');
    table.integer('user_id').unsigned();
    table.foreign('user_id').references('users.id');
  });
  
  // Inserir dados iniciais
  await knex('users').insert([
    { email: 'admin@example.com' }
  ]);
};

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

Migração complexa

Seeds

Popular o banco de dados com dados de teste

# Criar arquivo seed
npx knex seed:make 01_users

# Executar todos os seeds
npx knex seed:run

# Executar seed específico
npx knex seed:run --specific=01_users.js

Comandos de seed

// Arquivo seed básico
exports.seed = async function(knex) {
  // Excluir entradas existentes
  await knex('users').del();
  
  // Inserir dados seed
  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' }
  ]);
};

Seed básico

// Seed com relações
exports.seed = async function(knex) {
  // Limpar tabelas na ordem correta
  await knex('orders').del();
  await knex('users').del();
  
  // Inserir usuários e obter 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');
  
  // Inserir pedidos relacionados
  await knex('orders').insert([
    { user_id: userId1, total: 100.50 },
    { user_id: userId1, total: 75.25 },
    { user_id: userId2, total: 200.00 }
  ]);
};

Seed com relacionamentos

Suporte a TypeScript

Consultas tipadas com TypeScript

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

Definições de tipos

// Aumentar tipos do Knex
import { Knex } from 'knex';

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

// Consultas tipadas
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('*');

Aumento de tipos

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

Funções de consulta tipadas

Recursos avançados

Recursos avançados do Knex.js

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

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

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

Operações de upsert

// WITH (Expressões de Tabela Comuns)
knex.with('active_users', (qb) => {
  qb.select('*').from('users').where('status', 'active');
})
.select('*')
.from('active_users')
.where('age', '>', 18);

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

Expressões de Tabela Comuns

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

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

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

Subconsultas

// Funções de janela
knex('orders')
  .select('*')
  .select(
    knex.raw('ROW_NUMBER() OVER (PARTITION BY user_id ORDER BY created_at DESC) as row_num')
  )

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

// Operações de array (PostgreSQL)
knex('users')
  .whereRaw('? = ANY(tags)', ['javascript'])

Recursos avançados de SQL

Gerenciamento de Conexão e Pool

Gerencie conexões de banco de dados e pool

// Configurar pool de conexão
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 conexão
await knex.destroy();

// Re-inicializar
knex.initialize();

Configuração do pool

// Gancho afterCreate da conexão
const knex = require('knex')({
  client: 'pg',
  connection: { /* ... */ },
  pool: {
    afterCreate: function(conn, done) {
      conn.query('SET timezone="UTC";', function(err) {
        done(err, conn);
      });
    }
  }
});

// Conexão dinâmica
const knex = require('knex')({
  client: 'mysql',
  connection: async () => {
    const token = await getAuthToken();
    return {
      host: 'localhost',
      user: 'user',
      password: token,
      database: 'myapp'
    };
  }
});

Ganchos de conexão

// Depurando consultas
const knex = require('knex')({
  client: 'pg',
  connection: { /* ... */ },
  debug: true  // Registrar todas as consultas
});

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

// Obter SQL sem executar
const sql = knex('users')
  .where('id', 1)
  .toSQL();
console.log(sql.sql);      // String SQL
console.log(sql.bindings); // Parâmetros

Depuração

Guia rápido do Knex.js