JSPM

knex

3.1.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 1801931
  • Score
    100M100P100Q186404F
  • License MIT

A batteries-included SQL query & schema builder for PostgresSQL, MySQL, CockroachDB, MSSQL and SQLite3

Package Exports

  • knex
  • knex/bin/cli
  • knex/bin/cli.js
  • knex/bin/utils/cli-config-utils
  • knex/bin/utils/cli-config-utils.js
  • knex/knex.js
  • knex/lib/client
  • knex/lib/client.js
  • knex/lib/constants
  • knex/lib/constants.js
  • knex/lib/dialects/better-sqlite3/index.js
  • knex/lib/dialects/mssql
  • knex/lib/dialects/mssql/index.js
  • knex/lib/dialects/mssql/transaction.js
  • knex/lib/dialects/mysql
  • knex/lib/dialects/mysql/index
  • knex/lib/dialects/mysql/index.js
  • knex/lib/dialects/mysql/query/mysql-querycompiler
  • knex/lib/dialects/mysql/query/mysql-querycompiler.js
  • knex/lib/dialects/mysql/schema/mysql-columncompiler
  • knex/lib/dialects/mysql/schema/mysql-columncompiler.js
  • knex/lib/dialects/mysql/schema/mysql-compiler
  • knex/lib/dialects/mysql/schema/mysql-compiler.js
  • knex/lib/dialects/mysql/schema/mysql-tablecompiler
  • knex/lib/dialects/mysql/schema/mysql-tablecompiler.js
  • knex/lib/dialects/mysql2
  • knex/lib/dialects/mysql2/index.js
  • knex/lib/dialects/oracle
  • knex/lib/dialects/oracle/index.js
  • knex/lib/dialects/oracle/schema/oracle-compiler
  • knex/lib/dialects/oracle/schema/oracle-compiler.js
  • knex/lib/dialects/oracledb
  • knex/lib/dialects/oracledb/index.js
  • knex/lib/dialects/oracledb/query/oracledb-querycompiler
  • knex/lib/dialects/oracledb/query/oracledb-querycompiler.js
  • knex/lib/dialects/oracledb/schema/oracledb-columncompiler
  • knex/lib/dialects/oracledb/schema/oracledb-columncompiler.js
  • knex/lib/dialects/oracledb/utils
  • knex/lib/dialects/oracledb/utils.js
  • knex/lib/dialects/postgres
  • knex/lib/dialects/postgres/index.js
  • knex/lib/dialects/postgres/query/pg-querybuilder
  • knex/lib/dialects/postgres/query/pg-querybuilder.js
  • knex/lib/dialects/postgres/query/pg-querycompiler
  • knex/lib/dialects/postgres/query/pg-querycompiler.js
  • knex/lib/dialects/postgres/schema/pg-tablecompiler
  • knex/lib/dialects/postgres/schema/pg-tablecompiler.js
  • knex/lib/dialects/sqlite3
  • knex/lib/dialects/sqlite3/index
  • knex/lib/dialects/sqlite3/index.js
  • knex/lib/dialects/sqlite3/query/sqlite-querycompiler
  • knex/lib/dialects/sqlite3/query/sqlite-querycompiler.js
  • knex/lib/dialects/sqlite3/schema/ddl
  • knex/lib/dialects/sqlite3/schema/ddl.js
  • knex/lib/dialects/sqlite3/schema/sqlite-columncompiler
  • knex/lib/dialects/sqlite3/schema/sqlite-columncompiler.js
  • knex/lib/dialects/sqlite3/schema/sqlite-compiler
  • knex/lib/dialects/sqlite3/schema/sqlite-compiler.js
  • knex/lib/dialects/sqlite3/schema/sqlite-tablecompiler
  • knex/lib/dialects/sqlite3/schema/sqlite-tablecompiler.js
  • knex/lib/execution/internal/query-executioner
  • knex/lib/execution/internal/query-executioner.js
  • knex/lib/execution/runner
  • knex/lib/execution/runner.js
  • knex/lib/execution/transaction
  • knex/lib/execution/transaction.js
  • knex/lib/formatter
  • knex/lib/formatter.js
  • knex/lib/formatter/formatterUtils
  • knex/lib/formatter/formatterUtils.js
  • knex/lib/formatter/wrappingFormatter
  • knex/lib/formatter/wrappingFormatter.js
  • knex/lib/index
  • knex/lib/index.js
  • knex/lib/knex-builder/make-knex
  • knex/lib/knex-builder/make-knex.js
  • knex/lib/migrations/migrate/migration-list-resolver
  • knex/lib/migrations/migrate/migration-list-resolver.js
  • knex/lib/migrations/migrate/sources/fs-migrations
  • knex/lib/migrations/migrate/sources/fs-migrations.js
  • knex/lib/migrations/util/import-file.js
  • knex/lib/query/joinclause
  • knex/lib/query/joinclause.js
  • knex/lib/query/querybuilder
  • knex/lib/query/querybuilder.js
  • knex/lib/query/querycompiler
  • knex/lib/query/querycompiler.js
  • knex/lib/raw
  • knex/lib/raw.js
  • knex/lib/schema/builder
  • knex/lib/schema/builder.js
  • knex/lib/schema/columnbuilder
  • knex/lib/schema/columnbuilder.js
  • knex/lib/schema/columncompiler
  • knex/lib/schema/columncompiler.js
  • knex/lib/schema/compiler
  • knex/lib/schema/compiler.js
  • knex/lib/schema/tablebuilder
  • knex/lib/schema/tablebuilder.js
  • knex/lib/schema/tablecompiler
  • knex/lib/schema/tablecompiler.js
  • knex/lib/schema/viewcompiler.js
  • knex/lib/util/helpers
  • knex/lib/util/helpers.js
  • knex/lib/util/is
  • knex/lib/util/is.js
  • knex/lib/util/nanoid
  • knex/lib/util/nanoid.js
  • knex/lib/util/noop
  • knex/lib/util/noop.js
  • knex/lib/util/security
  • knex/lib/util/security.js
  • knex/lib/util/string
  • knex/lib/util/string.js
  • knex/lib/util/timeout
  • knex/lib/util/timeout.js
  • knex/package
  • knex/package.json

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (knex) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

knex.js

npm version npm downloads Coverage Status Dependencies Status Gitter chat

A SQL query builder that is flexible, portable, and fun to use!

A batteries-included, multi-dialect (PostgreSQL, MySQL, CockroachDB, MSSQL, SQLite3, Oracle (including Oracle Wallet Authentication)) query builder for Node.js, featuring:

Node.js versions 12+ are supported.

You can report bugs and discuss features on the GitHub issues page or send tweets to @kibertoad.

For support and questions, join our Gitter channel.

For knex-based Object Relational Mapper, see:

To see the SQL that Knex will generate for a given query, you can use Knex Query Lab

Examples

We have several examples on the website. Here is the first one to get you started:

const knex = require('knex')({
  client: 'sqlite3',
  connection: {
    filename: './data.db',
  },
});

try {
  // Create a table
  await knex.schema
    .createTable('users', (table) => {
      table.increments('id');
      table.string('user_name');
    })
    // ...and another
    .createTable('accounts', (table) => {
      table.increments('id');
      table.string('account_name');
      table.integer('user_id').unsigned().references('users.id');
    });

  // Then query the table...
  const insertedRows = await knex('users').insert({ user_name: 'Tim' });

  // ...and using the insert id, insert into the other table.
  await knex('accounts').insert({
    account_name: 'knex',
    user_id: insertedRows[0],
  });

  // Query both of the rows.
  const selectedRows = await knex('users')
    .join('accounts', 'users.id', 'accounts.user_id')
    .select('users.user_name as user', 'accounts.account_name as account');

  // map over the results
  const enrichedRows = selectedRows.map((row) => ({ ...row, active: true }));

  // Finally, add a catch statement
} catch (e) {
  console.error(e);
}

TypeScript example

import { Knex, knex } from 'knex';

interface User {
  id: number;
  age: number;
  name: string;
  active: boolean;
  departmentId: number;
}

const config: Knex.Config = {
  client: 'sqlite3',
  connection: {
    filename: './data.db',
  },
};

const knexInstance = knex(config);

try {
  const users = await knex<User>('users').select('id', 'age');
} catch (err) {
  // error handling
}

Usage as ESM module

If you are launching your Node application with --experimental-modules, knex.mjs should be picked up automatically and named ESM import should work out-of-the-box. Otherwise, if you want to use named imports, you'll have to import knex like this:

import { knex } from 'knex/knex.mjs';

You can also just do the default import:

import knex from 'knex';

If you are not using TypeScript and would like the IntelliSense of your IDE to work correctly, it is recommended to set the type explicitly:

/**
 * @type {Knex}
 */
const database = knex({
  client: 'mysql',
  connection: {
    host: '127.0.0.1',
    user: 'your_database_user',
    password: 'your_database_password',
    database: 'myapp_test',
  },
});
database.migrate.latest();