oracle / oracle/node-oracledb

Category of Error codes

Open
#1,440 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
JavaScript
Stars
2.4k
Forks
1.1k
PR merge metrics
No merged PRs in 30d

Description

  1. What is the link to the documentation section that needs improving?
    Errors

  2. Describe the confusion
    I'm currently building an API that uses node-oracledb. In my app, I'd like to know whether the error is caused by the data (ex: ORA-12899: value too large for column) or by a connectivity issue during runtime. I know there's a lot of error codes available, I found the documentation: https://docs.oracle.com/en/database/oracle/oracle-database/12.2/errmg/index.html

However, I can't find any documentation that tells which range of codes covers what type of error. Do I need to filter through the long list of error codes to identify which ones are for data error and connectivity error, or is there existing documentation or tool to achieve this?

  1. Suggest changes that would help
    It would be great if the documentation categorizes error codes or an additional field in the Error object that will identify the type of error.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the Errors section linked in the issue and compare it with Oracle's error message documentation. Determine whether the requested outcome is categorized documentation or a new Error object field, then define the data and connectivity categories and update the relevant documentation or API specification. Done means the requested error classification is documented and consistently understandable.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, node.js
Domain
api, database, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.