PolarDB:ユーザー定義関数

関数プッシュダウン

PolarDB-X は、UDF の SQL DATA ACCESS フィールドをチェックして、データノードに登録するかどうかを決定します。SQL DATA ACCESS が NO SQL に設定されている UDF のみがデータノードに登録され、プッシュダウンできます。

MySQL互換性を維持するため、PolarDB-X はプッシュダウン可能な UDF をデータノード上の MySQLライブラリに登録します。

UDF のプッシュダウンロジックが関係しているため、SQL DATA ACCESS フィールドは変更できません。

スケーリング後のプッシュダウン

スケーリング後、pushdown udf を実行して、プッシュダウン可能な UDF を新しいデータノード (DN) に登録します。

UDFの作成

CREATE
    [DEFINER = user]
    FUNCTION sp_name ([func_parameter[,...]])
    RETURNS type
    [characteristic ...] routine_body

func_parameter:
    param_name type

characteristic:
    COMMENT 'string'
  | LANGUAGE SQL
  | [NOT] DETERMINISTIC
  | { CONTAINS SQL | NO SQL | READS SQL DATA | MODIFIES SQL DATA }
  | SQL SECURITY { DEFINER | INVOKER }

routine_body:
    Valid SQL routine statement

主な特性：

例：

CREATE FUNCTION my_mul(x int, y int)
RETURNS int
LANGUAGE SQL
DETERMINISTIC
COMMENT 'my multiply function'
RETURN x*y*31;

UDFの呼び出し

UDF はビルトイン関数と同じ方法で呼び出します。

SELECT my_mul(2, 2);
+--------------+
| my_mul(2, 2) |
+--------------+
|          124 |
+--------------+

UDFの変更

ALTER FUNCTION は COMMENT、LANGUAGE SQL、および SQL SECURITY の変更をサポートします。SQL DATA ACCESS の変更はサポートしていません。

ALTER FUNCTION func_name [characteristic ...]

characteristic: {
    COMMENT 'string'
  | LANGUAGE SQL
  | SQL SECURITY { DEFINER | INVOKER }
}

UDFの削除

DROP FUNCTION [IF EXISTS] FUNCTION_NAME;

UDFの表示

すべての UDF の表示：

SELECT * FROM information_schema.Routines WHERE ROUTINE_TYPE = 'FUNCTION';

特定の UDF の表示：

SHOW FUNCTION STATUS [LIKE 'pattern' | WHERE expr]

SHOW CREATE FUNCTION function_name;

SELECT * FROM information_schema.Routines WHERE ROUTINE_NAME = 'function_name';

プッシュダウンされた UDF の表示：

SELECT * FROM information_schema.pushed_function;

実行中の UDF のキャンセル

UDF を実行しているクエリを終了するには、KILL 文を実行します。

KILL {QUERY | CONNECTION} connection_id;

キャッシュコマンド

キャッシュライフサイクルの例

次の例は、my_mul の完全なキャッシュライフサイクルを説明します。

-- Create the UDF.
CREATE FUNCTION my_mul(x int, y int)
     RETURNS int
     LANGUAGE SQL
     DETERMINISTIC
     COMMENT 'my multiply function'
     RETURN x*y*31;

-- The function exists in cache, but the body is not loaded yet (SIZE = 0).
SELECT * FROM information_schema.function_cache;
+--------------------+--------------+------+
| ID                 | FUNCTION     | SIZE |
+--------------------+--------------+------+
| xx.xx.xx.xx:3000   | mysql.my_mul |    0 |
| yy.yy.yy.yy:3100   | mysql.my_mul |    0 |
+--------------------+--------------+------+

-- Call the UDF. This triggers the function body to load on one node.
SELECT my_mul(2, 2);
+--------------+
| my_mul(2, 2) |
+--------------+
|          124 |
+--------------+

-- The body is now loaded on the node that executed the call (SIZE = 79).
SELECT * FROM information_schema.function_cache;
+--------------------+--------------+------+
| ID                 | FUNCTION     | SIZE |
+--------------------+--------------+------+
| xx.xx.xx.xx:3000   | mysql.my_mul |    0 |
| yy.yy.yy.yy:3100   | mysql.my_mul |   79 |
+--------------------+--------------+------+

SELECT * FROM information_schema.function_cache_capacity;
+--------------------+-----------+-------------+
| ID                 | USED_SIZE | TOTAL_SIZE  |
+--------------------+-----------+-------------+
| xx.xx.xx.xx:3000   |         0 | 15139759718 |
| yy.yy.yy.yy:3100   |        79 | 15139759718 |
+--------------------+-----------+-------------+

-- Reload the UDF to reset the cache on all nodes.
RELOAD FUNCTIONS;

-- All nodes show SIZE = 0 again.
SELECT * FROM information_schema.function_cache;
+--------------------+--------------+------+
| ID                 | FUNCTION     | SIZE |
+--------------------+--------------+------+
| xx.xx.xx.xx:3000   | mysql.my_mul |    0 |
| yy.yy.yy.yy:3100   | mysql.my_mul |    0 |
+--------------------+--------------+------+

メモリ制限

UDF 実行中、メモリは主にカーソルによって使用されます。メモリ制限を設定するには、次のパラメーターを使用します。

UDF を呼び出すクエリ全体のメモリも制限されます。

呼び出し深度制限

MAX_PL_DEPTH パラメーターを使用して UDF 呼び出し深度を制限します。深い呼び出しスタックはデバッグが困難であり、かなりのリソースを消費します。