快捷導(dǎo)航

MySQL中的自定義函數(shù)(CREATE FUNCTION)

更新時(shí)間：2024年06月01日 10:46:52 作者：Dkui

這篇文章主要介紹了MySQL中的自定義函數(shù)(CREATE FUNCTION),具有很好的參考價(jià)值,希望對(duì)大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教

介紹

在使用 MySQL 的過程中，MySQL 自帶的函數(shù)可能完成不了我們的業(yè)務(wù)需求，這時(shí)候就需要自定義函數(shù)。

自定義函數(shù)是一種與存儲(chǔ)過程十分相似的過程式數(shù)據(jù)庫(kù)對(duì)象。它與存儲(chǔ)過程一樣，都是由 SQL 語(yǔ)句和過程式語(yǔ)句組成的代碼片段，并且可以被應(yīng)用程序和其他 SQL 語(yǔ)句調(diào)用。

自定義函數(shù)與存儲(chǔ)過程之間存在幾點(diǎn)區(qū)別：

自定義函數(shù)不能擁有輸出參數(shù)，這是因?yàn)樽远x函數(shù)自身就是輸出參數(shù)；而存儲(chǔ)過程可以擁有輸出參數(shù)。
自定義函數(shù)中必須包含一條 RETURN 語(yǔ)句，而這條特殊的 SQL 語(yǔ)句不允許包含于存儲(chǔ)過程中。
可以直接對(duì)自定義函數(shù)進(jìn)行調(diào)用而不需要使用 CALL 語(yǔ)句，而對(duì)存儲(chǔ)過程的調(diào)用需要使用 CALL 語(yǔ)句。

創(chuàng)建并使用自定義函數(shù)

可以使用 CREATE FUNCTION 語(yǔ)句創(chuàng)建自定義函數(shù)。

語(yǔ)法格式

如下：

CREATE FUNCTION <函數(shù)名> ( [ <參數(shù)1> <類型1> [ , <參數(shù)2> <類型2>] ] … )
  RETURNS <類型>
  <函數(shù)主體>

語(yǔ)法說明如下：

<函數(shù)名>：指定自定義函數(shù)的名稱。注意，自定義函數(shù)不能與存儲(chǔ)過程具有相同的名稱。
<參數(shù)><類型>：用于指定自定義函數(shù)的參數(shù)。這里的參數(shù)只有名稱和類型，不能指定關(guān)鍵字 IN、OUT 和 INOUT。
RETURNS<類型>：用于聲明自定義函數(shù)返回值的數(shù)據(jù)類型。其中，<類型>用于指定返回值的數(shù)據(jù)類型。
<函數(shù)主體>：自定義函數(shù)的主體部分，也稱函數(shù)體。所有在存儲(chǔ)過程中使用的 SQL 語(yǔ)句在自定義函數(shù)中同樣適用，包括前面所介紹的局部變量、SET 語(yǔ)句、流程控制語(yǔ)句、游標(biāo)等。除此之外，自定義函數(shù)體還必須包含一個(gè) RETURN<值> 語(yǔ)句，其中<值>用于指定自定義函數(shù)的返回值。

在 RETURN VALUE 語(yǔ)句中包含 SELECT 語(yǔ)句時(shí)，SELECT 語(yǔ)句的返回結(jié)果只能是一行且只能有一列值。

若要查看數(shù)據(jù)庫(kù)中存在哪些自定義函數(shù)，可以使用 SHOW FUNCTION STATUS 語(yǔ)句；若要查看數(shù)據(jù)庫(kù)中某個(gè)具體的自定義函數(shù)，可以使用 SHOW CREATE FUNCTION<函數(shù)名> 語(yǔ)句，其中<函數(shù)名>用于指定該自定義函數(shù)的名稱。

【實(shí)例 1】

創(chuàng)建存儲(chǔ)函數(shù)，名稱為 StuNameById，該函數(shù)返回 SELECT 語(yǔ)句的查詢結(jié)果，數(shù)值類型為字符串類型，輸入的 SQL 語(yǔ)句和執(zhí)行結(jié)果如下所示。

mysql> CREATE FUNCTION StuNameById()
    -> RETURNS VARCHAR(45)
    -> RETURN
    -> (SELECT name FROM tb_students_info
    -> WHERE id=1);
Query OK， 0 rows affected (0.09 sec)

注意：當(dāng)使用 DELIMITER 命令時(shí)，應(yīng)該避免使用反斜杠“\”字符，因?yàn)榉葱备苁?MySQL 的轉(zhuǎn)義字符。

成功創(chuàng)建自定義函數(shù)后，就可以如同調(diào)用系統(tǒng)內(nèi)置函數(shù)一樣，使用關(guān)鍵字 SELECT 調(diào)用用戶自定義的函數(shù)，語(yǔ)法格式為：

SELECT <自定義函數(shù)名> ([<參數(shù)> [,...]])

【實(shí)例 2】

調(diào)用自定義函數(shù) StuNameById，查看函數(shù)的運(yùn)行結(jié)果，如下所示。

mysql> SELECT StuNameById();
±--------------+
| StuNameById() |
±--------------+
| Dany |
±--------------+
1 row in set (0.24 sec)

修改自定義函數(shù)

可以使用 ALTER FUNCTION 語(yǔ)句來修改自定義函數(shù)的某些相關(guān)特征。
若要修改自定義函數(shù)的內(nèi)容，則需要先刪除該自定義函數(shù)，然后重新創(chuàng)建。

刪除自定義函數(shù)

自定義函數(shù)被創(chuàng)建后，一直保存在數(shù)據(jù)庫(kù)服務(wù)器上以供使用，直至被刪除。
刪除自定義函數(shù)的方法與刪除存儲(chǔ)過程的方法基本一樣，可以使用 DROP FUNCTION 語(yǔ)句來實(shí)現(xiàn)。

語(yǔ)法格式如下：

DROP FUNCTION [ IF EXISTS ] <自定義函數(shù)名>

語(yǔ)法說明如下：

<自定義函數(shù)名>：指定要?jiǎng)h除的自定義函數(shù)的名稱。
IF EXISTS：指定關(guān)鍵字，用于防止因誤刪除不存在的自定義函數(shù)而引發(fā)錯(cuò)誤。

【實(shí)例 3】

刪除自定義函數(shù) StuNameById，查看函數(shù)的運(yùn)行結(jié)果，如下所示。

mysql> DROP FUNCTION StuNameById;
Query OK, 0 rows affected (0.09 sec)
mysql> SELECT StuNameById();
ERROR 1305 (42000): FUNCTION test_db.StuNameById does not exist