Summary: in this tutorial, you will learn how to create stored functions using the
CREATE FUNCTION statement.
A stored function is a special kind stored program that returns a single value. You use stored functions to encapsulate common formulas or business rules that are reusable among SQL statements or stored programs.
Different from a stored procedure, you can use a stored function in SQL statements wherever an expression is used. This helps improve the readability and maintainability of the procedural code.
MySQL stored function syntax
The following illustrates the simplest syntax for creating a new stored function:
CREATE FUNCTION function_name(param1,param2,…)
First, you specify the name of the stored function after
CREATE FUNCTION clause.
Second, you list all parameters of the stored function inside the parentheses. By default, all parameters are the
IN parameters. You cannot specify
INOUT modifiers to the parameters.
Third, you must specify the data type of the return value in the
RETURNS statement. It can be any valid MySQL data types.
Fourth, for the same input parameters, if the stored function returns the same result, it is considered deterministic; otherwise, the stored function is not deterministic. You have to decide whether a stored function is deterministic or not. If you declare it incorrectly, the stored function may produce an unexpected result, or the available optimization is not used which degrades the performance.
Fifth, you write the code in the body of the stored function. It can be a single statement or a compound statement. Inside the body section, you have to specify at least one
RETURN statement. The
RETURN statement returns a value to the caller. Whenever the
RETURN statement is reached, the stored function’s execution is terminated immediately.
MySQL stored function example
Let’s take a look at an example of using the stored function. We will use the
customers table in the sample database for the demonstration.
The following example is a function that returns the level of a customer based on credit limit. We use the IF statement to determine the credit limit.
CREATE FUNCTION CustomerLevel(p_creditLimit double) RETURNS VARCHAR(10)
DECLARE lvl varchar(10);
IF p_creditLimit > 50000 THEN
SET lvl = 'PLATINUM';
ELSEIF (p_creditLimit <= 50000 AND p_creditLimit >= 10000) THEN
SET lvl = 'GOLD';
ELSEIF p_creditLimit < 10000 THEN
SET lvl = 'SILVER';
Now, we can call the
CustomerLevel() in a
SELECT statement as follows:
We also rewrite the
GetCustomerLevel() stored procedure that we developed in the MySQL IF statement tutorial as follows:
CREATE PROCEDURE GetCustomerLevel(
IN p_customerNumber INT(11),
OUT p_customerLevel varchar(10)
DECLARE creditlim DOUBLE;
SELECT creditlimit INTO creditlim
WHERE customerNumber = p_customerNumber;
As you can see, the
GetCustomerLevel() stored procedure is much more readable when using the
CustomerLevel() stored function.
Notice that a stored function returns a single value only. If you include a
SELECT statement without the
INTO clause, you will get an error.
In addition, if a stored function contains SQL statements, you should not use it inside other SQL statements; otherwise, the stored function will slow down the speed of the query.
In this tutorial, you have learned how to create a stored function to encapsulate the common formula or business rules.