Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

knex

Package Overview
Dependencies
Maintainers
9
Versions
252
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

knex

A batteries-included SQL query & schema builder for Postgres, MySQL and SQLite3 and the Browser

  • 0.16.5
  • Source
  • npm
  • Socket score

Version published
Maintainers
9
Created

What is knex?

Knex.js is a SQL query builder for JavaScript, which works with multiple database systems like PostgreSQL, MySQL, SQLite3, and Oracle. It allows for building and executing SQL queries in a readable and programmatic way, handling connections and transactions, and seeding and migrating databases for development purposes.

What are knex's main functionalities?

Query Building

Builds a SQL query to select all columns from the 'users' table where the 'id' is 1.

knex.select('*').from('users').where('id', 1)

Schema Building

Creates a new table called 'users' with an auto-incrementing 'id' column, a 'name' column of string type, and timestamp columns for 'created_at' and 'updated_at'.

knex.schema.createTable('users', function(table) { table.increments('id'); table.string('name'); table.timestamps(); })

Transaction Support

Performs a transaction to insert multiple records into the 'books' table. If any part of the transaction fails, all changes are rolled back.

knex.transaction(function(trx) { const books = [{title: 'Canterbury Tales'}, {title: 'Macbeth'}]; return trx.insert(books).into('books'); })

Raw Queries

Executes a raw SQL query, selecting all columns from the 'users' table where the 'id' is 1, with parameter binding.

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

Seeding

Defines a seed file that first clears the 'users' table and then inserts new records into it.

exports.seed = function(knex) { return knex('users').del().then(function() { return knex('users').insert([{name: 'Alice'}, {name: 'Bob'}]); }); }

Migrations

Defines a migration file with an 'up' method to create a new 'users' table and a 'down' method to drop the 'users' table.

exports.up = function(knex) { return knex.schema.createTable('users', function(table) { table.increments(); table.string('name'); table.timestamps(); }); }; exports.down = function(knex) { return knex.schema.dropTable('users'); };

Other packages similar to knex

Keywords

FAQs

Package last updated on 11 Apr 2019

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc