@teqed/interact-ibmi
Version:
Menus for interacting with IBMi AS400 using node-odbc.
145 lines (144 loc) • 8.2 kB
JavaScript
import chalk from 'chalk';
export const qualifyObject = (QualifiedObject) => {
// TODO: Test the special object parameters.
if (QualifiedObject.object === `*SAME` ||
QualifiedObject.object === `*NONE` ||
QualifiedObject.object === `*SIGNOFF` ||
QualifiedObject.object === `*USRPRF` ||
QualifiedObject.object === `*WRKSTN` ||
QualifiedObject.object === `*DEV` ||
QualifiedObject.object === `*SYSVAL` ||
QualifiedObject.object === `*ASSIST` ||
QualifiedObject.object === `*HEX` ||
QualifiedObject.object === `*LANGIDSHR` ||
QualifiedObject.object === `*LANGIDUNQ`)
return QualifiedObject.object;
const innerLibrary = QualifiedObject.library ?? `*LIBL`;
// return a string in the format 'library/object'.
return `${innerLibrary}/${QualifiedObject.object}`;
};
/* Parse the input into an object with two properties: 'errorIdentifier' and 'messageText'. */
/* Remove the prefix '[IBM][System i Access ODBC Driver][DB2 for i5/OS]' from the error message. */
/* Separate the error number from the error message where the first space hyphen space is. */
export const parseErrorMessage = async (error) => {
// https://www.ibm.com/docs/en/i/7.2?topic=odbc-i-access-error-messages
// [vendor][ODBC-component][data-source] error-message
let { message } = error.odbcErrors[0];
/* Remove the prefix '[IBM][System i Access ODBC Driver][DB2 for i5/OS]' from the error message. */
message = message.replace(/^\[IBM\]\[System i Access ODBC Driver\]\[DB2 for i5\/OS\] /u, ``);
const errorIdentifier = message.split(` - `)[0];
const messageText = message.split(` - `)[1];
return { errorIdentifier, messageText };
};
export const parseODBCErrorMessage = async (error) => {
/* https://www.ibm.com/docs/en/i/7.2?topic=odbc-i-access-error-messages
Error messages have the following format:
[vendor][ODBC-component][data-source] error-message
The prefixes in brackets ([]) identify the source of the error.
When the error occurs in the data source, the [vendor] and [ODBC-component] prefixes identify
the vendor and name of the ODBC component that received the error from the data source.
The following table shows the values of these prefixes returned by the IBM i Access ODBC driver.
Error source - Value
Driver Manager - [Microsoft] [ODBC driver Manager] [N/A]
IBM i Access ODBC driver - [IBM(R)] [IBM i Access ODBC driver] N/A
NLS messages - [IBM] [IBM i Access ODBC driver] Column #: NLS error message number NLS error message text
Communication layer - [IBM] [IBM i Access ODBC driver] Communications link failure.
Comm RC=xxxx (message text) Where xxxx is the error number in decimal, not hexadecimal, format.
Message text describing the nature of your error appears with the error number.
Db2 for i - [IBM] [IBM i Access ODBC driver] [DB2] Server error message
Viewing Db2 for i error message text:
For errors that begin with: Use this CL command
SQL: DSPMSGD RANGE(SQLxxxx) MSGF(QSQLMSG)
IWS or PWS: DSPMSGD RANGE(ZZZxxxx) MSGF(QIWS/QIWSMSG) where ZZZ is IWS or PWS
Refer to Common ODBC errors for help with other ODBC error messages.
You can search and view NLS or communication error messages in the Service,
Error and Trace message help topic in the IBM i Access Client Solutions online User's Guide.
For more information about error message ids, see IBM i Access return codes
or the IBM i Access Client Solutions online User's Guide. */
// https://www.ibm.com/docs/en/i/7.2?topic=errors-sql
// List of common SQL IBM® i Access ODBC errors that are encountered by applications.
/* SQL0104 - Token &1 was not valid. Valid tokens: &2
Invalid IBM i Access ODBC SQL Syntax message
SQL0113 - Name &1 not allowed.
Update the IBM i Access ODBC Relational Database Directory
SQL0114 - Relational database &1 not the same as current &2 server
Update the IBM i Access ODBC Relational Database Directory Entry.
SQL0204 - MYSYSCONF not found
For IBM i Access ODBC: Optional table on the server.
SQL0208 - ORDER BY column not in result table
For IBM i Access ODBC: Problem with ORDER BY clause
SQL0900 - Application process not in a connected state
Update the IBM i Access ODBC Relational Database Directory Entry.
SQL0901 - SQL System Error
For IBM i Access ODBC: Server machine (function) check error
SQL5001 - Column qualifier or table &2 undefined.
Change your naming convention in your IBM i Access ODBC DSN.
SQL5016 - Object name &1 not valid for naming convention
Change your naming convention in your IBM i Access ODBC DSN.
SQL7008 - &1 in &2 not valid for operation. The reason code is 3
For IBM i Access ODBC: Error related to files not journaled */
// https://www.ibm.com/docs/en/i/7.2?topic=codes-listing-sql-messages
// These tables list SQL messages.
// Use these tables to find message text, cause text, recovery text, and corresponding SQLCODEs and SQLSTATEs.
/* You can use the following tables with both positive and negative SQLCODEs.
Take the absolute value of the SQLCODE, then append it to the letters SQL (for SQLCODEs less than 10 000)
or the letters SQ (for SQLCODEs greater than or equal to 10 000) to determine the message identifier.
Each SQLCODE corresponds to one or more SQLSTATEs. */
// Make sure we only received one error. Otherwise, throw a new error.
if (error.odbcErrors.length !== 1) {
throw new Error(`Expected 1 error, but received ${error.odbcErrors.length} errors.`);
}
let { message } = error.odbcErrors[0];
/* Place the [vendor], [ODBC-component], and [data-source] prefixes into their own properties. */
/* Remove them from the error message. */
/* If null, then set to an empty string. */
const vendor = /\[.*?\]/u.exec(message)?.[0] ?? ``;
message = message.replace(vendor, ``);
const ODBCComponent = /\[.*?\]/u.exec(message)?.[0] ?? ``;
message = message.replace(ODBCComponent, ``);
const dataSource = /\[.*?\]/u.exec(message)?.[0] ?? ``;
message = message.replace(dataSource, ``);
// Remove any leading or trailing whitespace.
message = message.trim();
// Remove any brackets from vendor, ODBCComponent, and dataSource.
vendor.replace(`[`, ``).replace(`]`, ``);
ODBCComponent.replace(`[`, ``).replace(`]`, ``);
dataSource.replace(`[`, ``).replace(`]`, ``);
// Find the error identifier and the message.
// The error identifier is usually the first 7 characters. It doesn't always exist.
// If it does, the delimiter between it and the message is ` - `.
// We'll call the error identifier the `errorIdentifier` and the message the `messageText`.
let messageIdentifier = ``;
let messageText = message;
const dashIndex = message.indexOf(` - `);
if (dashIndex !== -1) {
messageIdentifier = message.slice(0, dashIndex);
messageText = message.slice(dashIndex + 3);
}
// Remove any leading or trailing whitespace.
messageIdentifier = messageIdentifier.trim();
messageText = messageText.trim();
// ODBC top level error information
const errorName = error.name;
const errorMessage = error.message;
// Return the error number and the error message.
return {
dataSource,
errorMessage,
errorName,
messageIdentifier,
messageText,
ODBCComponent,
vendor,
};
};
export const printODBCError = async (error) => {
const { errorMessage, messageIdentifier, messageText } = await parseODBCErrorMessage(error);
// Log the message identifier and the message text.
// Use chalk to color the message identifier red.
// Use chalk to color the message text yellow.
// Use console.table to display the error information.
console.log(chalk.red(`Error . . . . . : ${errorMessage}`));
console.log(chalk.red(`Message ID . . : ${messageIdentifier}`));
console.log(chalk.yellow(`Message . . . . : ${messageText}`));
};