Simon Whatley » user defined function

SQL User-Defined Function: ListToTable

Simon — Mon, 22 Sep 2008 10:58:30 +0000

A common need in SQL is the ability to iterate over a list as if it were an array. In SQL it is not possible to declare arrays, unlike other programming languages such as ColdFusion, ActionScript and Java. Fortunately, there is a way around this problem: use a User-Defined Functions (UDFs) to create a tabular version of the data. Arrays are, after all, essentially tabular data (at their simplest, one dimension level).

A User-Defined Function, is a function provided by the user of a program or environment. In SQL databases, a user-defined function provides a mechanism for extending the functionality of the database server by adding a function that can be evaluated in SQL statements.

The Function Code

Below is the complete function definition:

<|/1/>CREATE <|/1/>FUNCTION dbo.udf_ListToTable
(
	@LIST 		<|/2/>NVARCHAR(<| style="color: #cc66cc;">4000),
	@DELIMITER 	<|/2/>NVARCHAR(<| style="color: #cc66cc;">10) = ','
)
<|/1/>RETURNS @ListTable <|/1/>TABLE
(
	Item <|/2/>NVARCHAR(<| style="color: #cc66cc;">200)
)
<|/1/>AS
<|/1/>BEGIN
	<|/1/>DECLARE @LenDel 	<|/2/>INT
	<|/1/>DECLARE @Pos 		<|/2/>INT
	<|/1/>DECLARE @Item 		<|/2/>NVARCHAR(<| style="color: #cc66cc;">200)
 
	--Get the length of the delimiter, use hack to get around LEN(' ') = 0 issue
	<|/1/>SET @LenDel = LEN(@DELIMITER + '|') - <| style="color: #cc66cc;">1
 
	<|/1/>SET @Pos = CHARINDEX(@DELIMITER, @LIST)
	<|/1/>WHILE @Pos > <| style="color: #cc66cc;">0
	<|/1/>BEGIN
		--Get the item
		<|/1/>SET @Item = SUBSTRING(@LIST, <| style="color: #cc66cc;">1, @Pos-<| style="color: #cc66cc;">1)
		--Add it to the table (if not empty string)
		<|/1/>IF LEN(LTRIM(@Item)) > <| style="color: #cc66cc;">0
			<|/1/>INSERT @ListTable (Item) <|/1/>VALUES (LTRIM(@Item))
		--Remove the item from the list
		<|/1/>SET @LIST = STUFF(@LIST, <| style="color: #cc66cc;">1, @Pos+@LenDel-<| style="color: #cc66cc;">1, '')
		--Get the position of the next delimiter
		<|/1/>SET @Pos = CHARINDEX(@DELIMITER, @LIST)
	<|/1/>END
 
	--Add the last item to the table (if not empty string)
	<|/1/>IF LEN(LTRIM(@LIST)) > <| style="color: #cc66cc;">0
		<|/1/>INSERT @ListTable (Item) <|/1/>VALUES (LTRIM(@LIST))
 
	<|/1/>RETURN
<|/1/>END
<|/1/>GO

The function simply loops over the list passed into the function. Each list item is then inserted into the variable named @ListTable, which is of type TABLE. The @ListTable variable is then returned out of the function and can be handled the same as any other table.

The Function In Use

A simple demonstration is as follows:

<|/1/>INSERT <|/1/>INTO tableName (column1, column2, column3, column4)
<|/1/>SELECT @variable1, @variable2, myTable.item, GETDATE()
<|/1/>FROM dbo.udf_ListToTable(@list,',') <|/1/>AS myTable

In this example, we insert the same information (@variable1, @variable2) for every instance of an item found in myTable.

This is useful, for example, if you want to apply a setting to a group of users. The group of users could be contained in a list that needs to be parsed as a table, whilst the individual setting details are contained in the other variables.

Download the Code

Download the code, rename the file to .sql and run on your database instance. You will then be able to reference the function in your Stored Procedures.

SQL User-Defined Function: ReplaceChars

Simon — Fri, 19 Sep 2008 14:46:13 +0000

The SQL REPLACE function enables us to look for a certain character phrase in a string and replace it with another character phrase. The updated string is then returned by the function.

The syntax for this string function is the same for SQL Server, Oracle and Microsoft Access. The syntax is as follows:

REPLACE(stringToLookIn, stringToMatch, replacementsString)

The syntax is fairly straight forward, the stringToMatch parameter is the character phrase that we want to replace, the replacementsString is the character phrase that will replace any occurence of the stringToMatch parameter. If the stringToMatch phrase occurs more than once in the string, then all instances of the phrase will be replaced with the replacement string. If no matches were found then the string is returned unaltered.

If we want to match multiple items, we need to nest the REPLACE function:

REPLACE(REPLACE(stringToLookIn, stringToMatch, replacementsString), stringToMatch, replacementsString)

or set the replaced string into a new variable multiple times:

stringReturned = REPLACE(stringToLookIn, stringToMatch, replacementsString)
stringReturned = REPLACE(stringReturned, stringToMatch, replacementsString)

This is far from ideal, especially the more strings there are to be matched. This is where User-Defined Functions (UDFs) can provide the answer.

The Function Code

Below is the complete function definition:

<|/1/>CREATE <|/1/>FUNCTION dbo.udf_ReplaceChars
(
@ReplaceList		<|/2/>VARCHAR(<| style="color: #cc66cc;">50),
@String			<|/2/>VARCHAR(<| style="color: #cc66cc;">100)
)
<|/1/>RETURNS <|/2/>VARCHAR(<| style="color: #cc66cc;">100)
<|/1/>AS
<|/1/>BEGIN
	<|/1/>DECLARE	@<|/2/>CHAR		<|/2/>CHAR(<| style="color: #cc66cc;">1),
		@Loop		<|/2/>INT
 
	<|/1/>SET @Loop  = <| style="color: #cc66cc;">0
	<|/1/>WHILE @Loop < = LEN(@ReplaceList)
	<|/1/>BEGIN
		<|/1/>SET	@Loop = @Loop + <| style="color: #cc66cc;">1
		<|/1/>SET	@<|/2/>CHAR = SUBSTRING(@ReplaceList, @Loop, <| style="color: #cc66cc;">1)
		<|/1/>SET	@String = REPLACE(@String, @<|/2/>CHAR, '')
	<|/1/>END
 
	<|/1/>RETURN		@String
 
<|/1/>END
<|/1/>GO

The function simply loops over the replace list, finding each instance of the list item in the string in which we want to replace items. The new string is then returned out of the function.

The Function In Use

A very simple use of the replace function could be as follows:

<|/1/>SELECT dbo.udf_ReplaceChars('=,/,<,>,@,~,#', columnName) <|/1/>AS newColumn, columnName
<|/1/>FROM tableName

The function is not restricted to SELECT statements. Below is an example of an UPDATE statement utilising a variable:

<|/1/>UPDATE tableName
<|/1/>SET columnName = dbo.udf_ReplaceChars('=,/,<,>,@,~,#', @variableName)
<|/1/>WHERE idName = @myId

Download the Code

Download the code, rename the file to .sql and run on your database instance. You will then be able to reference the function in your Stored Procedures.