02
Sat, Nov
2 New Articles

TechTip: SQL Communications Area

SQL
Typography
  • Smaller Small Medium Big Bigger
  • Default Helvetica Segoe Georgia Times

When RPG programmers begin to use SQL, one of the more difficult things for them to adjust to is that the SQL statements do not issue escape messages if an error occurs. They simply set a few status codes and return control to the next line of code in the program. Combating this problem requires a new methodology for handling SQL errors within our RPG programs. This article explores using the Communications Area to get more information about how the previous SQL statement performed.

The SQL Communications Area, or SQL CA, is automatically inserted into a program containing embedded SQL during the compile process. It consists of a number of fields and arrays:

D SQLCA  DS                       
D SQLAID    1   8A               
D SQLABC      9  12B 0            
D SQLCOD     13  16B 0            
D SQLERL   17  18B 0            
D SQLERM   19  88A              
D SQLERP      89  96A              
D SQLERRD   97 120B 0 DIM(6)            
D SQLERR    97 120A              
D SQLER1     97 100B 0           
D SQLER2  101 104B 0          
D SQLER3 105 108B 0         
D SQLER4 109 112B 0            
D SQLER5  113 116B 0           
D SQLER6  117 120B 0         
D SQLWRN  121 131A           
D SQLWN0  121 121A           
D SQLWN1  122 122A           
D SQLWN2  123 123A           
D SQLWN3  124 124A           
D SQLWN4  125 125A           
D SQLWN5  126 126A           
D SQLWN6  127 127A           
D SQLWN7  128 128A           
D SQLWN8  129 129A              
D SQLWN9  130 130A           
D SQLWNA  131 131A            
D SQLSTT  132 136A 


Rather than try to explain every field in the SQL CA, I'll just review some of the more useful ones:

SQLERM contains message data text for the SQLCOD value.

SQLERP contains the name of the product and module returning an error.

SQLERRD is an array containing six diagnostic codes:
   (1) The last four digits of the CPF message if SQLCOD is negative.
   (2) The last four digits of the CPD message if SQLCOD is negative.
   (3) For INSERT, UPDATE, DELETE, and FETCH, the number of rows affected. For PREPARE, the estimated number of rows returned.
   (4) For PREPARE, the estimated cost of execution. For CALL, the message key of the error that caused the call to fail. For trigger errors during INSERT, UPDATE, or DELETE, the message key of the error. For FETCH, the length of the row.
   (5) For DELETE, the number of rows affected by referential constraints. For PREPARE or EXECUTE IMMEDIATE, the position of a syntax error. For multi-row FETCH, +100 if the last record was read. For CONNECT and SET CONNECTION, -1 if not connected, 0 if local, 1 if remote. For PREPARE, the number of parameter markers.
   (6) SQL completion code when SQLCOD is 0.

SQLWN4 is loaded with "W" if an UPDATE or DELETE statement does not contain a WHERE clause.

SQLWN6 is loaded with "W" if arithmetic caused an end-of-month adjustment.

SQLCOD contains the SQL Return Code. As of V5R3, this field may also be spelled SQLCODE.

SQLSTT contains the SQL Status Code. As of V5R3, this field may also be spelled SQLSTATE.

IBM provides a PDF document on SQL messages and codes.

The simplest rule of thumb is that you should check the value of SQLCOD after every SQL statement. If it is zero, the statement completed normally. If it's negative, a serious error occurred. If it's equal to 100, the previous FETCH reached end-of-file. Any other positive value indicates a warning of some sort. Below are two examples of error-handling with SQL embedded inside RPG IV. The first is prior to V5R4:

C/EXEC SQL                                          
C+         PREPARE SQLSTMT FROM :W_SQL              
C/END-EXEC                                          
 /FREE                                              
  IF SQLCOD <> *zero;                               
    ErrCod = 'SQL' + %SUBST(%EDITC(SQLCOD:'X'):6:4);
    SendMsg(ErrCod:SQLERM:'QSQLMSG');               
  ENDIF;                                            
 /END-FREE                                          

The second is V5R4 or later:

 /FREE                                              
  EXEC SQL PREPARE SQLSTMT FROM :W_SQL;              
  IF SQLCOD <> *zero;                               
    ErrCod = 'SQL' + %SUBST(%EDITC(SQLCOD:'X'):6:4);
    SendMsg(ErrCod:SQLERM:'QSQLMSG');               
  ENDIF;                                            
 /END-FREE                                          

Both examples perform identically, but you can see that the new EXEC SQL syntax available in V5R4 leads to much more readable code when mixing with free-format RPG. In this example, if any error occurs, SQLCOD is set to a non-zero value. The appropriate error message ID is assembled by taking the last four digits from SQLCOD, prefixing them with SQL, and then using SENDMSG to send that error message to the calling program. SENDMSG is a procedure I wrote that simplifies access to IBM's message-sending APIs. You can replace my SENDMSG with any message-handling technique you like.

The most important thing to remember is that you must test SQLCOD after each statement. If a statement fails, the program continues to run, which could lead to serious errors in your database. More documentation on embedded SQL, the Communications Area, and error handling is available at IBM's embedded SQL programming Web page.

Kevin Forsythe has worked on IBM midrange systems for more than 20 years. With many years of experience in programming, analysis, consulting, and instruction, he is uniquely skilled at making difficult material more easily understood. As the lead instructor for DMC Consulting’s AS/Credentials training classes, Kevin is responsible for developing up-to-date courseware as well as providing instruction on a wide range of topics. This comprehensive background includes practical application, education, and research and provides a perspective that allows him to help others steer their way through the technical maze that surrounds them.

Kevin speaks regularly at conferences and user group meetings, volunteers as a Subject Matter Expert for COMMON, has written numerous articles on a variety of iSeries topics, and authored the bestselling book SQL for eServer i5 and iSeries.





BLOG COMMENTS POWERED BY DISQUS

LATEST COMMENTS

Support MC Press Online

$

Book Reviews

Resource Center

  • SB Profound WC 5536 Have you been wondering about Node.js? Our free Node.js Webinar Series takes you from total beginner to creating a fully-functional IBM i Node.js business application. You can find Part 1 here. In Part 2 of our free Node.js Webinar Series, Brian May teaches you the different tooling options available for writing code, debugging, and using Git for version control. Brian will briefly discuss the different tools available, and demonstrate his preferred setup for Node development on IBM i or any platform. Attend this webinar to learn:

  • SB Profound WP 5539More than ever, there is a demand for IT to deliver innovation. Your IBM i has been an essential part of your business operations for years. However, your organization may struggle to maintain the current system and implement new projects. The thousands of customers we've worked with and surveyed state that expectations regarding the digital footprint and vision of the company are not aligned with the current IT environment.

  • SB HelpSystems ROBOT Generic IBM announced the E1080 servers using the latest Power10 processor in September 2021. The most powerful processor from IBM to date, Power10 is designed to handle the demands of doing business in today’s high-tech atmosphere, including running cloud applications, supporting big data, and managing AI workloads. But what does Power10 mean for your data center? In this recorded webinar, IBMers Dan Sundt and Dylan Boday join IBM Power Champion Tom Huntington for a discussion on why Power10 technology is the right strategic investment if you run IBM i, AIX, or Linux. In this action-packed hour, Tom will share trends from the IBM i and AIX user communities while Dan and Dylan dive into the tech specs for key hardware, including:

  • Magic MarkTRY the one package that solves all your document design and printing challenges on all your platforms. Produce bar code labels, electronic forms, ad hoc reports, and RFID tags – without programming! MarkMagic is the only document design and print solution that combines report writing, WYSIWYG label and forms design, and conditional printing in one integrated product. Make sure your data survives when catastrophe hits. Request your trial now!  Request Now.

  • SB HelpSystems ROBOT GenericForms of ransomware has been around for over 30 years, and with more and more organizations suffering attacks each year, it continues to endure. What has made ransomware such a durable threat and what is the best way to combat it? In order to prevent ransomware, organizations must first understand how it works.

  • SB HelpSystems ROBOT GenericIT security is a top priority for businesses around the world, but most IBM i pros don’t know where to begin—and most cybersecurity experts don’t know IBM i. In this session, Robin Tatam explores the business impact of lax IBM i security, the top vulnerabilities putting IBM i at risk, and the steps you can take to protect your organization. If you’re looking to avoid unexpected downtime or corrupted data, you don’t want to miss this session.

  • SB HelpSystems ROBOT GenericCan you trust all of your users all of the time? A typical end user receives 16 malicious emails each month, but only 17 percent of these phishing campaigns are reported to IT. Once an attack is underway, most organizations won’t discover the breach until six months later. A staggering amount of damage can occur in that time. Despite these risks, 93 percent of organizations are leaving their IBM i systems vulnerable to cybercrime. In this on-demand webinar, IBM i security experts Robin Tatam and Sandi Moore will reveal:

  • FORTRA Disaster protection is vital to every business. Yet, it often consists of patched together procedures that are prone to error. From automatic backups to data encryption to media management, Robot automates the routine (yet often complex) tasks of iSeries backup and recovery, saving you time and money and making the process safer and more reliable. Automate your backups with the Robot Backup and Recovery Solution. Key features include:

  • FORTRAManaging messages on your IBM i can be more than a full-time job if you have to do it manually. Messages need a response and resources must be monitored—often over multiple systems and across platforms. How can you be sure you won’t miss important system events? Automate your message center with the Robot Message Management Solution. Key features include:

  • FORTRAThe thought of printing, distributing, and storing iSeries reports manually may reduce you to tears. Paper and labor costs associated with report generation can spiral out of control. Mountains of paper threaten to swamp your files. Robot automates report bursting, distribution, bundling, and archiving, and offers secure, selective online report viewing. Manage your reports with the Robot Report Management Solution. Key features include:

  • FORTRAFor over 30 years, Robot has been a leader in systems management for IBM i. With batch job creation and scheduling at its core, the Robot Job Scheduling Solution reduces the opportunity for human error and helps you maintain service levels, automating even the biggest, most complex runbooks. Manage your job schedule with the Robot Job Scheduling Solution. Key features include:

  • LANSA Business users want new applications now. Market and regulatory pressures require faster application updates and delivery into production. Your IBM i developers may be approaching retirement, and you see no sure way to fill their positions with experienced developers. In addition, you may be caught between maintaining your existing applications and the uncertainty of moving to something new.

  • LANSAWhen it comes to creating your business applications, there are hundreds of coding platforms and programming languages to choose from. These options range from very complex traditional programming languages to Low-Code platforms where sometimes no traditional coding experience is needed. Download our whitepaper, The Power of Writing Code in a Low-Code Solution, and:

  • LANSASupply Chain is becoming increasingly complex and unpredictable. From raw materials for manufacturing to food supply chains, the journey from source to production to delivery to consumers is marred with inefficiencies, manual processes, shortages, recalls, counterfeits, and scandals. In this webinar, we discuss how:

  • The MC Resource Centers bring you the widest selection of white papers, trial software, and on-demand webcasts for you to choose from. >> Review the list of White Papers, Trial Software or On-Demand Webcast at the MC Press Resource Center. >> Add the items to yru Cart and complet he checkout process and submit

  • Profound Logic Have you been wondering about Node.js? Our free Node.js Webinar Series takes you from total beginner to creating a fully-functional IBM i Node.js business application.

  • SB Profound WC 5536Join us for this hour-long webcast that will explore:

  • Fortra IT managers hoping to find new IBM i talent are discovering that the pool of experienced RPG programmers and operators or administrators with intimate knowledge of the operating system and the applications that run on it is small. This begs the question: How will you manage the platform that supports such a big part of your business? This guide offers strategies and software suggestions to help you plan IT staffing and resources and smooth the transition after your AS/400 talent retires. Read on to learn: