Knex Scripts

Knex utilities to interact with Postgres database.

npm install knex-scripts

Command Line Usage

 Usage: cli [options] [command]
Options:
-V, --version output the version number
--docker Use docker.
--docker-service [service] Docker service name, default: "postgres".
--knexfile [path] Specify the knexfile path.
--cwd [path] Specify the working directory.
--env [name] environment, default: process.env.NODE_ENV || development
-h, --help output usage information
Commands:
create Create database.
drop Drop database.
dump Dump database.
load Load database.
check-structure Check structure.
truncate Truncate all tables.

Node API Usage

importknexfrom'knex'import{truncate}from'knex-scripts'importconfigfrom'./knexfile'// Truncate all databasetruncate({getKnex: ()=>knex(config)}).then(()=>console.log('Truncated')).catch(console.error)

Configuration

// knexfile.jsconstconfig={knexScripts: {docker: false,structurePath: 'db/structure.sql',},development: {client: 'postgresql',connection: {user: 'postgres',database: 'development',timezone: 'utc',},},}module.exports=config

License

MIT