23
Sat, Nov
1 New Articles

TechTip: Speed Up Your UDF Performance

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

Are you aware of the fenced and deterministic attributes?

SQL user-defined functions (UDFs) have been available since OS/400 V4R4. UDFs provide a great tool for allowing you to easily perform a business calculation as an SQL query, processing a set of rows in your database. If you want an explanation of how to implement UDFs, take a look at the IBM Redbook Stored Procedures, Triggers, and User-Defined Functions on DB2 UDB for iSeries.

For those of you already familiar with UDFs, you need to be aware that two attributes can be used to improve UDF performance. Knowledge of these two attributes is particularly important because these attributes default to the slower-performing values if they are not specified as part of your function definition.

Fenced

The first is the fenced or not fenced attribute. Fenced is the default attribute and is primarily supported because DB2 products other than those for iSeries need the option to control their memory usage during UDF execution. (This aspect does not apply to DB2 UDB for iSeries since the database engine is part of the operating system.)

The fenced attribute causes the UDF to perform more slowly because it causes DB2 to perform UDF calls in a different thread. Starting with V5R2, the not fenced attribute allows DB2 to execute the UDF call within the same thread as the invoking SQL statement. This ability to call the UDF within the same thread is supported only when the SQL Query Engine (SQE) processes the invoking SQL statement.

Here's a simple example of a UDF, getCelsius, which converts Fahrenheit temperatures to Celsius. It specifies the not fenced attribute to improve performance:

CREATE FUNCTION getCelsius( fahrenheit_temp INT)
  RETURNS DECIMAL(4,0)
LANGUAGE SQL
DETERMINISTIC
NOT FENCED
BEGIN
  RETURN( CEILING( (5*(fahrenheit_temp-32) )/9) );
END;

 

Deterministic

Deterministic is the other setting on the getCelsius function definition that can help improve performance. The deterministic setting says that the UDF will always return the same result value when called with the exact same input parameters. For example, this getCelsius function is deterministic because each time it's invoked with an input parameter value of 32, it will output a Celsius temperature value of 0. Every time this deterministic getCelsius UDF is given a value of 50, it will return a value of 10 to the invoker.

Contrast that with the GetLocalTemp UDF below, which is a non-deterministic function. This function receives a ZIP code value as input and then passes this value on a call to an external stored procedure. The AccessLocalTemp reads an XML file to find the current temperature for the specified ZIP code and returns that temperature value to the UDF. This XML file is updated every five minutes via RSS or an FTP process. The GetLocalTemp UDF is declared as non-deterministic because passing in the same ZIP code on successive calls is not guaranteed to return the same output value. The temperature value for a ZIP code value of 51106 could return 35 on the first invocation and 36 on the next invocation.

CREATE FUNCTION GetLocalTemp(zipcode VARCHAR(5)) 

  RETURNS INTEGER
NOT DETERMINISTIC

NOT FENCED

LANGUAGE SQL

BEGIN

   DECLARE localTemp INT;

   
   CALL AccessLocalTemp(zipcode,localTemp);

   RETURN localTemp;

END;
 

You should now have a firm understanding of deterministic functions, but it may be unclear how this setting can improve performance. The main performance benefit of deterministic functions is that they allow DB2 UDB to cache the input parameter values and the return value for a UDF call. On successive calls to that UDF with the same input parameters, DB2 UDB can just return the cached returned value without ever invoking the UDF. Performance is gained by eliminating the overhead involved with calling the UDF. Remember that when DB2 UDB invokes a UDF, it's equivalent to the performance of executing an unbound, external program call; thus, avoiding the call can produce noticeable performance gains.

The following query provides a very common example of how UDFs perform some user-defined calculation. Just consider how many low temperature values over 365 days share the same value, which can allow DB2 UDB to skip calling the function and use its cache instead.

   SELECT DATERECORDED, GETCELSIUS(LOWTEMP) FROM TEMPERATURE_HISTORY WHERE YEAR(DATERECORDED)=2005

This caching of deterministic function calls was first added in V5R3 and is again only possible when SQE processes the invoking SQL statement.

Kent Milligan is a DB2 UDB Technology Specialist on IBM's eServer Solutions Enablement team. He spent the first seven years at IBM as a member of the DB2 development team in Rochester. He can be reached at This email address is being protected from spambots. You need JavaScript enabled to view it..

Kent Milligan
Kent Milligan is a Senior Db2 for i Consultant in the IBM Lab Services Power Systems Delivery Practice.  Kent has over 25 years of experience as a Db2 for IBM i consultant and developer working out of the IBM Rochester lab. Prior to re-joining the DB2 for i Lab Services practice in 2020, Kent spent 5 years working on healthcare solutions powered by IBM Watson technologies. Kent is a sought-after speaker and author on Db2 for i & SQL topics.
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: