TechTip: Create an SQL Function to Split a Delimited List PDF Print E-mail
Tips & Techniques - SQL
Written by Michael Sansoterra   
Friday, 22 February 2013 00:00

Support MC Press - Visit Our Sponsors

Forums Sponsor

POPULAR FORUMS

 

Forums

 

Search Sponsor

 

 

Search

Bookstore Sidebar Header

With the aid of a recursive query, add a SPLIT function (common to many programming languages) to your DB2 for i toolbox.

 

Many programming languages, such as Visual Basic, C#, Java, JavaScript, and others, have a "split" function. Split allows a developer to take a single string containing a delimited list of items and separate the individual items into a dynamically sized array. Every so often, I find myself longing for a similar function in DB2 for i's SQL. While DB2 for i doesn't have a SPLIT function, it is very easy to create one by embedding the power of recursion within a table function. But instead of splitting the list into an array, the table function will split each item into a separate row within a result set. The technique shown in this tip requires DB2 for i V5R4 or higher.

 

Before delving into code, let's look at an example of why a SPLIT function is useful within SQL. Say a Web or GUI client is designed to let users inquire against the database based on various filter criteria. Further, say some of the filter selections can allow for multiple values. For example, the quarter selection list shown in Figure 1 will let the user select multiple quarters:

 

022213SansoterraFigure1                       

Figure 1: The list box will allow a user to select from zero to many quarters.

 

When the user selects multiple quarters, how should the client pass those multiple values to the database for processing? In this case, one approach is to let the user pick a maximum of 10 quarters and then create a stored procedure that defines 10 quarter parameters.

 

A better alternative is to have the client join the selected values in a delimited string (e.g., "2010-Q1,2011-Q1") and pass it as a single parameter to a stored procedure. The stored procedure will use the SPLIT function to break apart the list of values and return results accordingly. The advantage of this solution is that it isn't bound to a specific number of parameterized values.

 

Here's a little more detail on how the solution would be implemented. Assume that a SPLIT User-Defined Table Function (UDTF) is installed on your system and it accepts two parameters: the data (or delimited string) and the delimiter.

 

When passed multiple values, the SPLIT table function will convert the delimited list (in this case assuming a pipe character (|) delimiter) to a set of rows.

 

SELECT *

FROM TABLE(QGPL.SPLIT('2010-Q1|2011-Q1|2012-Q1|2013-Q1','|')) LIST;


The results of the table function include two columns: ID and VALUE. The ID is an incremental row number that can be useful in circumstances when the position or order of the element within the list is important. The VALUE column is just an item that was extracted from the list. In the case where the delimiter is placed at the beginning or end of the input, or where two delimiters are sandwiched together, the VALUE column will hold an empty string. The maximum size of an element to split (although it can be modified) is 256 characters.

 

The result of the above query is shown in Figure 2:

 

ID

VALUE

1

2010-Q1

2

2011-Q1

3

2012-Q1

4

2013-Q1

Figure 2: Here's a sample result set from the SPLIT UDTF.

 

So SPLIT converts a list into rows and columns, which is something SQL is good at manipulating. A sample query that takes advantage of the SPLIT UDTF might look like this:

 

SELECT *

FROM ORDER_HEADER

WHERE QTR_ID IN (

SELECT CAST(VALUE AS CHAR(7))

FROM TABLE(SPLIT('2010-Q1|2011-Q1|2012-Q1|2013-Q1','|')) LIST);


Of course, if this query were embedded in a stored procedure, the list of values would be a parameter or variable name instead of a literal.

 

Marching on, let's discuss the code involved with the SPLIT function. The DB2 for i code shown below is used to create a User-Defined Table Function (UDTF) called SPLIT. As for the code, I must give credit where credit is due. I filched this idea from a website that specializes in SQL Server tips.

 

In this tip, the author Mickey Stuewe discussed the very same multi-select problem when using SQL Server Reporting Services (which can be configured to allow users to select multiple values for a report, similar to the scenario described above). Stuewe published a brilliant T-SQL table function to parse a delimited string. I converted the function to DB2 for i (with a few minor changes), which is shown here:

 

CREATE FUNCTION QGPL.SPLIT (

@Data     VARCHAR(32000),

@Delimiter VARCHAR(5))

 

RETURNS TABLE (

ID   INT,

VALUE VARCHAR(256))

 

LANGUAGE SQL

DISALLOW PARALLEL

DETERMINISTIC

NOT FENCED

 

RETURN

WITH CTE_Items (ID,StartString,StopString) AS

(

   SELECT

       1 AS ID

       ,1 AS StartString

       ,LOCATE(@Delimiter, @Data) AS StopString

   FROM SYSIBM.SYSDUMMY1

   WHERE LENGTH(@Delimiter)>0

     AND LENGTH(@Data)>0


UNION ALL


   SELECT

       ID + 1

       ,StopString + LENGTH(@Delimiter)

       ,LOCATE(@Delimiter, @Data, StopString + LENGTH(@Delimiter))

   FROM

       CTE_Items

   WHERE

       StopString > 0

)

SELECT ID, SUBSTRING(@Data,StartString,

       CASE WHEN StopString=0

           THEN LENGTH(@Data)

           ELSE StopString-StartString END)

FROM CTE_Items;

There's not much to this function. A recursive common table expression (RCTE) is used to find the starting and ending character positions of all the items in the data string. The delimiter, of course, identifies the end of a data item and the start of the next. The "prime" query in the RCTE identifies the first and last positions of the first data item. The "recursive" portion of the query in the RCTE identifies all the starting and ending positions of the remaining items contained in the list. If you're not familiar with RCTEs, please review the references at the end of this tip.

 

A few additional notes to consider:

  • When on i7.1, the code can be changed to use the "CREATE OR REPLACE" syntax. Also, the DISALLOW PARALLEL option is not required.
  • For table functions, the default cardinality is assumed to be 1000 rows. This means, when creating an execution plan for the query, DB2 will assume the table function will return 1000 rows on average, and that will be a major consideration for where the table function is placed in the join order. If, on average, you expect the cardinality to be much smaller than 1000 rows, you can specify the estimated number of rows using the CARDINALITY keyword on the CREATE FUNCTION statement. (e.g., CARDINALITY 50).
  • Perhaps you're wondering whether the recursive query against a long string will hit a nesting limit and cause a query to fail. The answer is yes, but for reasonable strings it shouldn't be a problem. On a V5R4 system, the function successfully parsed a string of over 1000 delimited values without a hiccup.
  • IBM i 7.1 supports an ARRAY data type that can be converted to a result set using the UNNEST table function. Also, XML can be used to pass multiple values in a single parameter that can be parsed with the XMLTABLE table function. When possible, I usually encourage the use of arrays or XML to pass related data in a single parameter (as opposed to an unstructured string). However, a limitation of using arrays is that they're currently supported only from a Java client or another SQL routine. Parsing XML can also be a resource-intensive operation, so passing delimited strings is still in some cases an acceptable option.

 

Having a SPLIT function in your database can be useful in a vast number of situations. For instance, filter criteria selections are often combined into a single parameter to avoid the pain of defining multiple parameters of an unknown quantity. Or, in a client/server scenario, multiple data elements may be consolidated so that only a single call is made to the database server from the client (instead of passing small amounts of data using successive database calls), etc. When these types of solutions are architected, SPLIT is a key to allowing the database to handle them.

References

Practical SQL: Don't Be Afraid of Recursion

TechTip: DB2's CONNECT BY Simplifies Recursive Processing

Recursive query optimization (IBM DB2 i 7.1 documentation)

Last Updated on Friday, 22 February 2013 00:00
 
User Rating: / 2
PoorBest 
   MC-STORE.COM