knex-tablecleaner
TypeScript icon, indicating that this package has built-in type declarations

5.0.0 • Public • Published

knex-tablecleaner

npm version npm downloads Coverage Status

Simple library for deleting all rows from a given list of DB tables. Tables are cleaned sequentially in a given order, to avoid foreign key constraint violations.

Example usage:

const tableCleaner = require('knex-tablecleaner');
const knex = require('../db'); // pre-initialized instance of knex

const defaultTablesToClean = [
  'orders',
  'users'
];

function cleanDb(tablesToClean = defaultTablesToClean) {
  return tableCleaner.cleanTables(knex, tablesToClean);
}

module.exports = {
  cleanDb,
};

Parameters

function cleanTables(knex, tableNames, verboseLog = false) accepts following parameters:

  • knex - pre-initialized knex instance that will be used for accessing the database;
  • tableNames - either a string with a table name, or an array of strings with table names;
  • verboseLog - if set to true, will log a list of tables being cleaned and the completion log messages.

Package Sidebar

Install

npm i knex-tablecleaner

Weekly Downloads

53

Version

5.0.0

License

MIT

Unpacked Size

6.32 kB

Total Files

6

Last publish

Collaborators

  • kibertoad