Git Product home page Git Product logo

db-error's Introduction

Unified error API for node.js SQL DB drivers

Build Status Dependabot Status

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');

function errorHandler(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 (err instanceof UniqueViolationError) {
    console.log(`Unique constraint ${err.constraint} failed for table ${err.table} and columns ${err.columns}`);
  } else if (err instanceof NotNullViolationError) {
    console.log(`Not null constraint failed for table ${err.table} and column ${err.column}`);
  } else if (err instanceof DBError) {
    console.log(`Some unknown DB error ${dbError.nativeError}`);
  }
}


API



DBError

class DBError extends Error {
  // The error thrown by the database client.
  nativeError: Error
}

Base class for all errors.



ConstraintViolationError

class ConstraintViolationError extends DBError {
  // No own properties.
}

A base class for all constraint violation errors



UniqueViolationError

class UniqueViolationError extends ConstraintViolationError {
  // The columns that failed.
  //
  // Available for: postgres, sqlite
  columns: string[]

  // The table that has the columns.
  //
  // Available for: postgres, sqlite
  table: string

  // The constraint that was violated.
  //
  // Available for: postgres, mysql
  constraint: string
}


NotNullViolationError

class NotNullViolationError extends ConstraintViolationError {
  // The column that failed.
  //
  // Available for: postgres, sqlite, mysql
  column: string

  // The table that has the columns.
  //
  // Available for: postgres, sqlite
  table: string
}


ForeignKeyViolationError

class ForeignKeyViolationError extends ConstraintViolationError {
  // The table that has the foreign key.
  //
  // Available for: postgres, mysql
  table: string

  // The constraint that was violated.
  //
  // Available for: postgres, mysql
  constraint: string
}


CheckViolationError

// This is not available for MySql since MySql doesn't have check constraints.
class CheckViolationError extends ConstraintViolationError {
  // The table that has the check constraint.
  //
  // Available for: postgres
  table: string

  // The constraint that was violated.
  //
  // Available for: postgres
  constraint: string
}


DataError

// Invalid data (string too long, invalid date etc.)
//
// NOTE: SQLite uses dynamic typing and doesn't throw this error.
class DataError extends DBError {
  // 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

db-error's People

Contributors

cliedeman avatar dependabot-preview[bot] avatar janejeon avatar koskimas avatar petrhanak avatar restjohn avatar wswoodruff avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.