Unified error API for node.js SQL DB drivers

This project is an attempt to create a unified API for node.js SQL DB driver errors. Each driver throws their own kind of errors and libraries like knex, Bookshelf and objection.js simply pass these errors through. It's usually very difficult to reason with these errors. This library wraps those errors to error classes that are the same for all drivers. The wrapped error classes also expose useful information about the errors.

NOTE: Only MySQL, Sqlite3, MSSQL and PostgreSQL are officially supported (tested).

Contributions and suggestions are most welcome

If you have an idea for an error we should handle, please open an issue and we'll see what we can do to add it.

Usage

const{ wrapError, DBError, UniqueViolationError, NotNullViolationError }=require('db-errors');functionerrorHandler(err){// wrapError function takes any error and returns a DBError subclass instance if// the input was an error thrown by the supported database drivers. Otherwise// the input error is returned.err=wrapError(err);if(errinstanceofUniqueViolationError){console.log(`Unique constraint ${err.constraint} failed for table ${err.table} and columns ${err.columns}`);}elseif(errinstanceofNotNullViolationError){console.log(`Not null constraint failed for table ${err.table} and column ${err.column}`);}elseif(errinstanceofDBError){console.log(`Some unknown DB error ${dbError.nativeError}`);}}

API

DBError

classDBErrorextendsError{// The error thrown by the database client.nativeError: Error;}

Base class for all errors.

ConstraintViolationError

classConstraintViolationErrorextendsDBError{// No own properties.}

A base class for all constraint violation errors

UniqueViolationError

classUniqueViolationErrorextendsConstraintViolationError{// The columns that failed.//// Available for: postgres, sqlitecolumns: string[];// The table that has the columns.//// Available for: postgres, sqlitetable: string;// The constraint that was violated.//// Available for: postgres, mysqlconstraint: string;}

NotNullViolationError

classNotNullViolationErrorextendsConstraintViolationError{// The column that failed.//// Available for: postgres, sqlite, mysqlcolumn: string;// The table that has the columns.//// Available for: postgres, sqlitetable: string;}

ForeignKeyViolationError

classForeignKeyViolationErrorextendsConstraintViolationError{// The table that has the foreign key.//// Available for: postgres, mysqltable: string;// The constraint that was violated.//// Available for: postgres, mysqlconstraint: string;}

CheckViolationError

// This is not available for MySql since MySql doesn't have check constraints.classCheckViolationErrorextendsConstraintViolationError{// The table that has the check constraint.//// Available for: postgrestable: string;// The constraint that was violated.//// Available for: postgresconstraint: string;}

DataError

// Invalid data (string too long, invalid date etc.)//// NOTE: SQLite uses dynamic typing and doesn't throw this error.classDataErrorextendsDBError{// There is no easy way to parse data from these kind// of errors.}

Development setup

Run the following commands in the repo root:

docker-compose up
node setup-test-db.js

Run tests:

npm test