Knex.js-Spickzettel

SQL-Abfrage-Builder für Node.js – Abfragen, Schema, Migrationen und Transaktionen.

Installation & Einrichtung

Knex.js installieren und Datenbankverbindung konfigurieren

# Knex und Ihren Datenbanktreiber installieren
npm install knex --save

# Datenbanktreiber (auswählen)
npm install pg          # PostgreSQL
npm install mysql2      # MySQL
npm install sqlite3     # SQLite
npm install tedious     # MSSQL

Paketinstallation

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

Grundkonfiguration

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

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

Alternative Verbindungsarten

Grundlegende Abfragen

Auswahl-, Einfüge-, Aktualisierungs- und Löschoperationen

// Alle auswählen
knex('users').select('*')
// SELECT * FROM users

// Bestimmte Spalten auswählen
knex('users').select('id', 'name', 'email')
// SELECT id, name, email FROM users

// Auswahl mit Alias
knex('users').select('id', 'name as full_name')
// SELECT id, name as full_name FROM users

// Erstes Ergebnis
knex('users').first('*')
// SELECT * FROM users LIMIT 1

SELECT-Abfragen

// Einzelne Zeile einfügen
knex('users').insert({ name: 'John', email: 'john@example.com' })

// Mehrere Zeilen einfügen
knex('users').insert([
  { name: 'John', email: 'john@example.com' },
  { name: 'Jane', email: 'jane@example.com' }
])

// Einfügen mit Rückgabe (PostgreSQL)
knex('users')
  .insert({ name: 'John', email: 'john@example.com' })
  .returning('id')

INSERT-Abfragen

// Alle Zeilen aktualisieren
knex('users').update({ status: 'active' })

// Bestimmte Zeilen aktualisieren
knex('users')
  .where('id', 1)
  .update({ name: 'John Updated' })

// Aktualisieren mit Rückgabe
knex('users')
  .where('id', 1)
  .update({ name: 'John' })
  .returning('*')

UPDATE-Abfragen

// Alle Zeilen löschen
knex('users').del()

// Bestimmte Zeilen löschen
knex('users').where('id', 1).del()

// Löschen mit Rückgabe
knex('users')
  .where('id', 1)
  .del()
  .returning('*')

DELETE-Abfragen

WHERE-Klauseln

Daten filtern mit verschiedenen Bedingungen

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

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

// Mehrere Bedingungen (UND)
knex('users')
  .where('status', 'active')
  .where('age', '>', 18)

// ODER-Bedingungen
knex('users')
  .where('status', 'active')
  .orWhere('role', 'admin')

Grundlegendes 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])

Erweitertes WHERE

// Komplexe verschachtelte Bedingungen
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])

Komplexes WHERE

Joins

Daten aus mehreren Tabellen kombinieren

// 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')

Grundlegende Joins

// Join mit mehreren Bedingungen
knex('users')
  .join('orders', function() {
    this.on('users.id', '=', 'orders.user_id')
      .andOn('orders.status', '=', knex.raw('?', ['completed']))
  })

// Join mit ODER-Bedingung
knex('users')
  .join('orders', function() {
    this.on('users.id', '=', 'orders.user_id')
      .orOn('users.email', '=', 'orders.email')
  })

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

Erweiterte Joins

Aggregation & Gruppierung

Aggregatfunktionen und GROUP BY-Operationen

// Zählen
knex('users').count('id as total')

// Distinct zählen
knex('users').countDistinct('email')

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

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

// Minimum und Maximum
knex('orders').min('total as min_order')
knex('orders').max('total as max_order')

Aggregatfunktionen

// Gruppieren nach
knex('orders')
  .select('user_id')
  .count('id as order_count')
  .groupBy('user_id')

// Gruppieren nach mehreren Spalten
knex('orders')
  .select('user_id', 'status')
  .sum('total as revenue')
  .groupBy('user_id', 'status')

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

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

GROUP BY und HAVING

Sortierung & Begrenzung

Ergebnisse sortieren und paginieren

// Aufsteigend sortieren
knex('users').orderBy('name')
knex('users').orderBy('name', 'asc')

// Absteigend sortieren
knex('users').orderBy('created_at', 'desc')

// Mehrere Sortierspalten
knex('users')
  .orderBy('status', 'asc')
  .orderBy('created_at', 'desc')

// Sortieren nach Array
knex('users').orderBy([
  { column: 'status', order: 'asc' },
  { column: 'name', order: 'desc' }
])

// Sortieren per raw
knex('users').orderByRaw('age DESC NULLS LAST')

Sortierung

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

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

// Paginierung
knex('users')
  .limit(10)
  .offset(20)

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

// Distinct für mehrere Spalten
knex('users').distinct('email', 'status')

Begrenzung und Paginierung

Schema – Tabellen erstellen

Datenbanktabellen definieren und erstellen

// Tabelle erstellen
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);
});

// Tabelle erstellen, falls nicht vorhanden
knex.schema.createTableIfNotExists('users', function(table) {
  table.increments('id');
  table.string('email').unique();
});

Grundlegende Tabellenerstellung

// Häufige Spaltentypen
table.increments('id')              // Auto-incrementing ID
table.integer('votes')              // Integer
table.bigInteger('big_votes')       // Big integer
table.text('description')           // Text
table.string('name', 255)           // String with length
table.float('amount')               // Float
table.decimal('price', 8, 2)        // Decimal(8,2)
table.boolean('is_admin')           // Boolean
table.date('birth_date')            // Date
table.datetime('created_at')        // Datetime
table.time('alarm_time')            // Time
table.timestamp('updated_at')       // Timestamp
table.json('metadata')              // JSON
table.jsonb('data')                 // JSONB (PostgreSQL)
table.uuid('id')                    // UUID
table.enum('status', ['active', 'inactive'])  // Enum

Spaltentypen

// Spaltenmodifikatoren
table.string('email')
  .notNullable()           // NICHT NULL
  .unique()                // EINDEUTIG
  .defaultTo('default')    // STANDARDwert
  .unsigned()              // UNSIGNED (für Zahlen)
  .index()                 // Index hinzufügen
  .comment('Email address') // Kommentar hinzufügen

// Fremdschlüssel
table.integer('user_id')
  .unsigned()
  .notNullable()
  .references('id')
  .inTable('users')
  .onDelete('CASCADE')
  .onUpdate('CASCADE');

// Hilfsfunktionen für Zeitstempel
table.timestamps(true, true)  // created_at, updated_at
table.timestamp('created_at').defaultTo(knex.fn.now())

Spaltenmodifikatoren und Einschränkungen

Schema - Tabellen ändern

Vorhandene Tabellenstrukturen ändern

// Spalte hinzufügen
knex.schema.table('users', function(table) {
  table.string('phone', 20);
});

// Mehrere Spalten hinzufügen
knex.schema.table('users', function(table) {
  table.string('phone', 20);
  table.string('address', 255);
  table.integer('zip_code');
});

// Spalte ändern
knex.schema.alterTable('users', function(table) {
  table.string('email', 500).alter();
});

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

Tabellen ändern

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

// Mehrere Spalten entfernen
knex.schema.table('users', function(table) {
  table.dropColumns('phone', 'address');
});

// Tabelle entfernen
knex.schema.dropTable('users');

// Tabelle entfernen, falls vorhanden
knex.schema.dropTableIfExists('users');

// Tabelle umbenennen
knex.schema.renameTable('users', 'customers');

Entfernen und Umbenennen

// Prüfen, ob Tabelle existiert
knex.schema.hasTable('users')
  .then(exists => {
    if (!exists) {
      return knex.schema.createTable('users', table => {
        table.increments('id');
      });
    }
  });

// Prüfen, ob Spalte existiert
knex.schema.hasColumn('users', 'email')
  .then(exists => {
    if (!exists) {
      return knex.schema.table('users', table => {
        table.string('email');
      });
    }
  });

Schema‑Prüfungen

Schema – Indizes & Fremdschlüssel

Datenbankindizes und Beziehungen erstellen und verwalten

// Index erstellen
knex.schema.table('users', function(table) {
  table.index('email');
});

// Benannten Index erstellen
knex.schema.table('users', function(table) {
  table.index('email', 'idx_users_email');
});

// Zusammengesetzten Index erstellen
knex.schema.table('users', function(table) {
  table.index(['status', 'created_at'], 'idx_status_created');
});

// Eindeutigen Index erstellen
knex.schema.table('users', function(table) {
  table.unique('email');
});

// Index entfernen
knex.schema.table('users', function(table) {
  table.dropIndex('email');
  table.dropIndex([], 'idx_users_email'); // nach Name
});

Indizes

// Fremdschlüssel hinzufügen
knex.schema.table('orders', function(table) {
  table.foreign('user_id')
    .references('id')
    .inTable('users');
});

// Fremdschlüssel mit Aktionen
knex.schema.table('orders', function(table) {
  table.foreign('user_id')
    .references('id')
    .inTable('users')
    .onDelete('CASCADE')
    .onUpdate('RESTRICT');
});

// Benannten Fremdschlüssel
knex.schema.table('orders', function(table) {
  table.foreign('user_id', 'fk_orders_user')
    .references('users.id');
});

// Fremdschlüssel entfernen
knex.schema.table('orders', function(table) {
  table.dropForeign('user_id');
  table.dropForeign([], 'fk_orders_user'); // nach Name
});

Fremdschlüssel

Transaktionen

Mehrere Abfragen atomar ausführen

// Grundlegende Transaktion
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));

// Transaktion mit Rückgabewert
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;
});

Grundlegende Transaktionen

// Manuelle Transaktionssteuerung
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;
}

// Transaktion mit Speicherpunkten
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();
  }
});

Erweiterte Transaktionssteuerung

Rohabfragen

Roh‑SQL bei Bedarf ausführen

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

// Rohabfrage mit benannten Bindungen
knex.raw('SELECT * FROM users WHERE id = :userId', {
  userId: 1
})

// Roh in SELECT
knex('users')
  .select(knex.raw('COUNT(*) as total'))
  .where('status', 'active')

// Roh in WHERE
knex('users')
  .whereRaw('age > ?', [18])
  .orWhereRaw('status = ?', ['admin'])

Einfache Rohabfragen

// Roh‑Update
knex('users')
  .update({
    updated_at: knex.raw('NOW()'),
    views: knex.raw('views + 1')
  })
  .where('id', 1)

// Roh‑Einfügen
knex('users').insert({
  name: 'John',
  created_at: knex.raw('CURRENT_TIMESTAMP')
})

// Verwendung von knex.ref für Spaltenreferenzen
knex('users')
  .where('created_at', '>', knex.ref('updated_at'))

Roh in Abfragen

Migrationen

Versionskontrolle für Datenbankschema

# Migration erstellen
npx knex migrate:make create_users_table

# Migrationen ausführen
npx knex migrate:latest

# Letztes Batch zurückrollen
npx knex migrate:rollback

# Alle Migrationen zurückrollen
npx knex migrate:rollback --all

# Migrationsstatus prüfen
npx knex migrate:status

# Spezifische Migration ausführen
npx knex migrate:up 001_create_users.js

Migrationsbefehle

// Struktur der Migrationsdatei
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');
};

Beispiel für Migrationsdatei

// Migration mit mehreren Vorgängen
exports.up = async function(knex) {
  // Tabelle users erstellen
  await knex.schema.createTable('users', table => {
    table.increments('id');
    table.string('email').unique();
  });
  
  // Tabelle orders erstellen
  await knex.schema.createTable('orders', table => {
    table.increments('id');
    table.integer('user_id').unsigned();
    table.foreign('user_id').references('users.id');
  });
  
  // Anfangsdaten einfügen
  await knex('users').insert([
    { email: 'admin@example.com' }
  ]);
};

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

Komplexe Migration

Seed-Daten

Datenbank mit Testdaten füllen

# Seed-Datei erstellen
npx knex seed:make 01_users

# Alle Seeds ausführen
npx knex seed:run

# Spezifischen Seed ausführen
npx knex seed:run --specific=01_users.js

Seed-Befehle

// Grundlegende Seed-Datei
exports.seed = async function(knex) {
  // Vorhandene Einträge löschen
  await knex('users').del();
  
  // Seed-Daten einfügen
  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' }
  ]);
};

Grundlegender Seed

// Seed mit Beziehungen
exports.seed = async function(knex) {
  // Tabellen in richtiger Reihenfolge leeren
  await knex('orders').del();
  await knex('users').del();
  
  // Benutzer einfügen und IDs erhalten
  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');
  
  // Zugehörige Bestellungen einfügen
  await knex('orders').insert([
    { user_id: userId1, total: 100.50 },
    { user_id: userId1, total: 75.25 },
    { user_id: userId2, total: 200.00 }
  ]);
};

Seed mit Beziehungen

TypeScript-Unterstützung

Typensichere Abfragen mit TypeScript

// Define table types
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;
}

Typdefinitionen

// Knex-Typen erweitern
import { Knex } from 'knex';

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

// Typensichere Abfragen
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('*');

Typ-Erweiterung

// Generische Abfragetypen
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;
};

Typisierte Abfragefunktionen

Erweiterte Funktionen

Erweiterte Knex.js-Funktionen

// Upsert (Einfügen oder Aktualisieren)
knex('users')
  .insert({ id: 1, name: 'John', email: 'john@example.com' })
  .onConflict('id')
  .merge()

// Upsert mit spezifischen Spalten
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()

Upsert-Operationen

// WITH (Gemeinsame Tabellenausdrücke)
knex.with('active_users', (qb) => {
  qb.select('*').from('users').where('status', 'active');
})
.select('*')
.from('active_users')
.where('age', '>', 18);

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

Gemeinsame Tabellenausdrücke

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

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

// Unterabfrage im FROM
knex
  .select('*')
  .from(
    knex('users')
      .where('status', 'active')
      .as('active_users')
  )

Unterabfragen

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

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

// Array-Operationen (PostgreSQL)
knex('users')
  .whereRaw('? = ANY(tags)', ['javascript'])

Erweiterte SQL-Funktionen

Verbindungs- und Poolverwaltung

Verwalte Datenbankverbindungen und den Pool

// Verbindungspool konfigurieren
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
  }
});

// Verbindungspool zerstören
await knex.destroy();

// Neu initialisieren
knex.initialize();

Pool-Konfiguration

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

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

Verbindungs-Hooks

// Abfragen debuggen
const knex = require('knex')({
  client: 'pg',
  connection: { /* ... */ },
  debug: true  // Alle Abfragen protokollieren
});

// Spezifische Abfrage debuggen
knex('users')
  .select('*')
  .debug()
  .then(rows => console.log(rows));

// SQL ohne Ausführung erhalten
const sql = knex('users')
  .where('id', 1)
  .toSQL();
console.log(sql.sql);      // SQL-String
console.log(sql.bindings); // Parameter

Debugging

Knex.js-Spickzettel