カスタム関数:
ユーザー定義関数 (UDF) は MySQL を拡張する方法であり、その使用法は組み込み関数と同じです。
カスタム関数には 2 つの必要な条件があります:
1. パラメーター
2. 戻り値
関数は任意のタイプの値を返すことができ、これらのタイプのパラメーターも受け取ることができます。
関数のパラメータと戻り値の間には必要な内部接続はありません。
例 1:
現在の時刻、年、月、日、時、分、秒を返すパラメーターなしの関数を作成します。
例:
mysql> SELECT NOW(); +---------------------+ | NOW() | +---------------------+ | 2016-09-08 21:17:17 | +---------------------+ 1 row in set (0.00 sec) mysql> SELECT DATE_FORMAT(NOW(),'%Y年%m月%d日 %H点:%i分:%s秒'); +--------------------------------------------------+ | DATE_FORMAT(NOW(),'%Y年%m月%d日 %H点:%i分:%s秒') | +--------------------------------------------------+ | 2016年09月08日 21点:19分:54秒 | +--------------------------------------------------+ 1 row in set (0.01 sec)
上記のプロセスをカプセル化します:
mysql> CREATE FUNCTION f1() RETURNS VARCHAR(30) -> RETURN DATE_FORMAT(NOW(),'%Y年%m月%d日 %H点:%i分:%s秒');Query OK, 0 rows affected (0.08 sec) mysql> SELECT f1(); +-------------------------------+ | f1() | +-------------------------------+ | 2016年09月08日 21点:21分:25秒 | +-------------------------------+ 1 row in set (0.02 sec)
注: returns の後に続くものは戻り値の型であり、return の後に続くものは戻り値です。
例 2:
2 つの数値の平均を求めるなど、パラメーターを含む関数を作成します。
mysql> CREATE FUNCTION f2(num1 SMALLINT UNSIGNED, num2 SMALLINT UNSIGNED) -> RETURNS FLOAT(10,2) UNSIGNED -> RETURN (num1+num2)/2;Query OK, 0 rows affected (0.00 sec)
呼び出し:
mysql> SELECT f2(4,6); +---------+ | f2(4,6) | +---------+ | 5.00 | +---------+ 1 row in set (0.02 sec)
上記で作成した 2 つのカスタム関数を削除する場合:
mysql> DROP FUNCTION f2;Query OK, 0 rows affected (0.11 sec) mysql> DROP FUNCTION f1;Query OK, 0 rows affected (0.00 sec)
複合構造関数本体を持つカスタム関数を作成します
例: テーブルにデータを挿入し、挿入されたデータの ID。
mysql> DESC tdb_test; +------------+------------------+------+-----+---------+----------------+ | Field | Type | Null | Key | Default | Extra | +------------+------------------+------+-----+---------+----------------+ | id | int(10) unsigned | NO | PRI | NULL | auto_increment | | first_name | varchar(20) | NO | | NULL | | | last_name | varchar(20) | NO | | NULL | | +------------+------------------+------+-----+---------+----------------+ 3 rows in set (0.00 sec) mysql> CREATE FUNCTION adduser(first_name VARCHAR(20),last_name VARCHAR(20)) -> RETURNS INT UNSIGNED -> RETURN -> INSERT tdb_test(first_name,last_name) VALUES(first_name,last_name); ERROR 1064 (42000): You have an error in your SQL syntax; check the manual that corresponds to your MySQL server version for the right syntax to use near 'tdb_test(first_name,last_name) VALUES(first_name,last_name)' at line 4
この時点で、実行する SQL ステートメントを入力した後、次のセミコロンが現在のデフォルトの区切り文字であるため、関数が入力を続行できなくなることがわかりました。したがって、デフォルトの区切り文字を変更する必要があります。
mysql> DELIMITER //
は // で終わることを意味します。
mysql> CREATE FUNCTION adduser(first_name VARCHAR(20),last_name VARCHAR(20)) -> RETURNS INT UNSIGNED -> RETURN -> INSERT tdb_test(first_name,last_name) VALUES(first_name,last_name); -> LAST_INSERT_ID(); -> // ERROR 1064 (42000): You have an error in your SQL syntax; check the manual that corresponds to your MySQL server version for the right syntax to use near 'tdb_test(first_name,last_name) VALUES(first_name,last_name); LAST_INSERT_ID()' at line 4
もエラーを返します。これは、実行するステートメントが 2 つあり、集計を形成するために begin と end を入れる必要があるためです。 正しいアプローチを見てみましょう。
mysql> CREATE FUNCTION adduser(first_name VARCHAR(20),last_name VARCHAR(20)) -> RETURNS INT UNSIGNED -> BEGIN -> INSERT tdb_test(first_name,last_name) VALUES(first_name,last_name); -> RETURN LAST_INSERT_ID(); -> END -> // Query OK, 0 rows affected (0.00 sec)
区切り文字を元に戻す
mysql> DELIMITER ;
テスト結果は次のとおりです:
mysql> SELECT adduser("ttt","ddd"); +----------------------+ | adduser("ttt","ddd") | +----------------------+ | 5 | +----------------------+ 1 row in set (0.11 sec) mysql> SELECT * FROM tdb_test; +----+------------+-----------+ | id | first_name | last_name | +----+------------+-----------+ | 1 | A | B | | 2 | Jack | Bob | | 3 | tom% | 123 | | 4 | 11 | 22 | | 5 | ttt | ddd | +----+------------+-----------+ 5 rows in set (0.00 sec)
関数本体について
関数本体は正当な SQL ステートメントで構成されます
関数本体は単純な SELECT にすることができます。または INSERT ステートメント; 関数本体が複合構造体の場合は、BEGIN...END ステートメントを使用します。
複合構造体には宣言、ループ、および制御構造を含めることができます。
DROP FUNCTION [IF EXISTS] function_name
カスタム関数には 2 つの必要な条件があります:
1. パラメーター2. 戻り値
関数は任意のタイプの値を返すことができ、これらのタイプのパラメーターも受け取ることができます。 関数のパラメーターと戻り値の間に必要な内部接続はありません。
例 1:
現在の時刻、年、月、日、時、分、秒を返すパラメーターなしの関数を作成します。
例:
mysql> SELECT NOW(); +---------------------+ | NOW() | +---------------------+ | 2016-09-08 21:17:17 | +---------------------+ 1 row in set (0.00 sec) mysql> SELECT DATE_FORMAT(NOW(),'%Y年%m月%d日 %H点:%i分:%s秒'); +--------------------------------------------------+ | DATE_FORMAT(NOW(),'%Y年%m月%d日 %H点:%i分:%s秒') | +--------------------------------------------------+ | 2016年09月08日 21点:19分:54秒 | +--------------------------------------------------+ 1 row in set (0.01 sec)
上記のプロセスをカプセル化します:
mysql> CREATE FUNCTION f1() RETURNS VARCHAR(30) -> RETURN DATE_FORMAT(NOW(),'%Y年%m月%d日 %H点:%i分:%s秒');Query OK, 0 rows affected (0.08 sec) mysql> SELECT f1();+-------------------------------+| f1() | +-------------------------------+| 2016年09月08日 21点:21分:25秒 | +-------------------------------+1 row in set (0.02 sec)
注: returns の後に続くものは戻り値の型であり、return の後に続くものは戻り値です。
例 2:
2 つの数値の平均を求めるなど、パラメーターを含む関数を作成します。
mysql> CREATE FUNCTION f2(num1 SMALLINT UNSIGNED, num2 SMALLINT UNSIGNED) -> RETURNS FLOAT(10,2) UNSIGNED -> RETURN (num1+num2)/2;Query OK, 0 rows affected (0.00 sec)
mysql> SELECT f2(4,6);+---------+| f2(4,6) | +---------+| 5.00 | +---------+1 row in set (0.02 sec)
mysql> DROP FUNCTION f2;Query OK, 0 rows affected (0.11 sec) mysql> DROP FUNCTION f1;Query OK, 0 rows affected (0.00 sec)
例: テーブルにデータを挿入し、挿入されたデータの ID。
mysql> DESC tdb_test; +------------+------------------+------+-----+---------+----------------+ | Field | Type | Null | Key | Default | Extra | +------------+------------------+------+-----+---------+----------------+ | id | int(10) unsigned | NO | PRI | NULL | auto_increment | | first_name | varchar(20) | NO | | NULL | | | last_name | varchar(20) | NO | | NULL | | +------------+------------------+------+-----+---------+----------------+ 3 rows in set (0.00 sec) mysql> CREATE FUNCTION adduser(first_name VARCHAR(20),last_name VARCHAR(20)) -> RETURNS INT UNSIGNED -> RETURN -> INSERT tdb_test(first_name,last_name) VALUES(first_name,last_name); ERROR 1064 (42000): You have an error in your SQL syntax; check the manual that corresponds to your MySQL server version for the right syntax to use near 'tdb_test(first_name,last_name) VALUES(first_name,last_name)' at line 4
この時点で、実行する SQL ステートメントを入力した後、次のセミコロンが現在のデフォルトの区切り文字であることがわかり、関数は入力を続行できなくなりました。したがって、デフォルトの区切り文字を変更する必要があります。
mysql> DELIMITER //
は // で終わることを意味します。
mysql> CREATE FUNCTION adduser(first_name VARCHAR(20),last_name VARCHAR(20)) -> RETURNS INT UNSIGNED -> RETURN -> INSERT tdb_test(first_name,last_name) VALUES(first_name,last_name); -> LAST_INSERT_ID(); -> // ERROR 1064 (42000): You have an error in your SQL syntax; check the manual that corresponds to your MySQL server version for the right syntax to use near 'tdb_test(first_name,last_name) VALUES(first_name,last_name); LAST_INSERT_ID()' at line 4
もエラーを返します。これは、実行するステートメントが 2 つあり、集計を形成するために begin と end を入れる必要があるためです。 正しいアプローチを見てみましょう。
mysql> CREATE FUNCTION adduser(first_name VARCHAR(20),last_name VARCHAR(20)) -> RETURNS INT UNSIGNED -> BEGIN -> INSERT tdb_test(first_name,last_name) VALUES(first_name,last_name); -> RETURN LAST_INSERT_ID(); -> END -> // Query OK, 0 rows affected (0.00 sec)
次に区切り文字を元に戻します
mysql> DELIMITER ;
テスト結果は次のとおりです:
mysql> SELECT adduser("ttt","ddd"); +----------------------+ | adduser("ttt","ddd") | +----------------------+ | 5 | +----------------------+ 1 row in set (0.11 sec) mysql> SELECT * FROM tdb_test; +----+------------+-----------+ | id | first_name | last_name | +----+------------+-----------+ | 1 | A | B | | 2 | Jack | Bob | | 3 | tom% | 123 | | 4 | 11 | 22 | | 5 | ttt | ddd | +----+------------+-----------+ 5 rows in set (0.00 sec)
関数本体について
関数本体は正当な SQL ステートメントで構成されます
関数本体は単純なものにすることができます。 SELECT または INSERT ステートメント; 関数本体が複合構造体の場合は、BEGIN...END ステートメントを使用します。
複合構造体には宣言、ループ、および制御構造を含めることができます。 :
DROP FUNCTION [IF EXISTS] function_name