テストシステムは、テスト言語インタープリタ（mysqltest）、すべてのテストを実行するシェルスクリプト（mysql-test-run）、テスト専用言語で記述された実際のテストケース、および予想されるテスト結果から構成されます。ビルドしてからシステムでテストスイートを実行するには、ソースルートから make test または mysql-test/mysql-test-run と入力します。バイナリディストリビューションをインストールした場合は、cd でインストールルートディレクトリ（/usr/local/mysql など）に移動し、scripts/mysql-test-run を実行します。すべてのテストが正常終了する必要があります。正常終了しないケースがある場合、その原因を調べ、それが MySQL のバグであれば問題点を報告してください。 See 項13.1.2.3. 「MySQL テストスイートのバグの報告」。

テストスイートを実行しようとするマシン上で mysqld が動作している場合、それが 9306 および 9307 のポートをどちらも使用していないのであれば、それを停止する必要はありません。どちらかのポートが使用されている場合は、mysql-test-run を編集してマスタポートまたはスレーブポート、あるいはその両方を、使用できるポートに変更する必要があります。

mysql-test/mysql-test-run test_name を使用して、個々のテストケースを 1 件ずつ実行できます。

あるテストが失敗した場合、--force オプションを指定して mysql-test-run を実行し、ほかにも失敗するテストがあるかどうかを調べる必要があります。

mysqltest 言語を使用して独自にテストケースを作成できます。残念ながら、その完全なマニュアルはまだ作成されていません。ただ、現在のテストケースを参考にすることができます。独自にテストケースを作成する際の注意点を以下に示します。

お使いの MySQL バージョンがテストスイートを正常終了できない場合、以下の処理を実行する必要があります。

関数は以下に示すように宣言する必要があります。注意: 戻り値の型およびパラメータは、CREATE FUNCTION ステートメントで SQL 関数 XXX() の戻り値を STRING、INTEGER、または REAL のどの型で返すと宣言するかによって異なります。

STRING 関数の場合は以下のように宣言します。

char *xxx(UDF_INIT *initid, UDF_ARGS *args,
          char *result, unsigned long *length,
          char *is_null, char *error);

INTEGER 関数の場合は以下のように宣言します。

long long xxx(UDF_INIT *initid, UDF_ARGS *args,
              char *is_null, char *error);

REAL 関数の場合は以下のように宣言します。

double xxx(UDF_INIT *initid, UDF_ARGS *args,
              char *is_null, char *error);

初期化関数および終了関数は以下のように宣言します。

my_bool xxx_init(UDF_INIT *initid, UDF_ARGS *args, char *message);

void xxx_deinit(UDF_INIT *initid);

initid パラメータは、上記の 3 つの関数すべてに渡されます。UDF_INIT 構造体を参照しており、関数間のデータの受け渡しに使用されます。UDF_INIT 構造体のメンバを以下に示します。初期化関数では、必要に応じてメンバの値を変更します（メンバのデフォルト値を使用する場合はそのままにしておきます）。

ここでは、集計 UDF 関数を作成する際に定義する必要があるさまざまな関数について説明します。

注意: 以下に示す関数は MySQL 4.1.1 では必要ありません。また使用されることもありません。MySQL 4.0 および MySQL 4.1.1 の両方で動作するようなコードを作成する場合にこれらの関数を定義します。

char *xxx_reset(UDF_INIT *initid, UDF_ARGS *args,
                char *is_null, char *error);

この関数は、MySQL が新しいグループの最初の行を見つけたときに呼び出されます。この関数では、内部の集計変数をリセットし、渡された引数をグループの最初の引数として設定する必要があります。

多くの場合、この処理はすべての変数をリセットすることで内部的に実装します（たとえば、xxx_clear() を呼び出してから xxx_add() を呼び出します）。

次の関数は、MySQL 4.1.1 以降でのみ必要です。

char *xxx_clear(UDF_INIT *initid, char *is_null, char *error);

この関数は、MySQL が集計結果をリセットする必要があるときに呼び出されます。この関数は新しいグループが始まるたびに呼び出されますが、一致するレコードがなかったクエリの値をリセットするために呼び出される場合もあります。is_null は、xxx_clear() を呼び出す前に CHAR(0) を参照するように設定されます。

何らかの異常が発生した場合、error の参照先に 1 バイトを保存できます。

char *xxx_add(UDF_INIT *initid, UDF_ARGS *args,
              char *is_null, char *error);

この関数は、同じグループに属する 2 番目以降のすべてのレコードについて呼び出されます。この関数では、UDF_ARGS の値を内部集計変数に加算する必要があります。

xxx() 関数は、単純 UDF 関数を定義するときと同じように宣言する必要があります。 See 項13.2.2.1. 「単純関数の場合の UDF の呼び出し手順」。

この関数は、グループのすべてのレコードが処理されたときに呼び出されます。通常はこの関数で args 変数にアクセスする必要はまったくなく、内部集計変数に基づいて値を返します。

xxx_reset() および xxx_add() では、引数の処理はすべて、通常の UDF と同じように実行する必要があります。 See 項13.2.2.3. 「引数の処理」。

xxx() では、戻り値の処理を、通常の UDF と同じように実行する必要があります。 See 項13.2.2.4. 「戻り値およびエラー処理」。

is_null および error へのポインタ引数は、xxx_reset()、xxx_clear()、xxx_add()、および xxx() への呼び出しですべて同じです。この引数を使用して、エラーが発生したこと、または xxx() 関数が NULL を返す必要があるかどうかを記憶できます。注意: *error には文字列は格納できません。これは 1 バイトフラグです。

is_null は、グループごとにリセットされます（xxx_clear() を呼び出す前でも）。error はリセットされることはありません。

isnull または error が xxx() の後に設定された場合、MySQL はグループ関数の結果として NULL を返します。

args パラメータは、UDF_ARGS 構造体を参照します。そのメンバを以下に示します。

初期化関数は、エラーがない場合は 0、エラーが発生した場合は 1 を返す必要があります。エラーが発生した場合、xxx_init() は message パラメータにヌルで終端されたエラーメッセージを格納する必要があります。このメッセージがクライアントに返されます。メッセージバッファの長さは MYSQL_ERRMSG_SIZE 文字ですが、標準の端末画面の幅に合わせて、80 文字未満でメッセージを作成するように努力する必要があります。

long long 関数および double 関数の場合、関数 xxx() の戻り値が関数値になります。文字列関数の場合、結果を参照するポインタを返し、その文字列長を length 引数に格納する必要があります。

戻り値の内容と長さは、以下のように設定します。

memcpy(result, "result string", 13);
*length = 13;

calc 関数には、255 バイトの result バッファが渡されます。返す値がこの大きさに収まる場合は、そのメモリ割り当てについて心配する必要はありません。

文字列関数が 255 バイトより長い文字列を返す必要がある場合、xxx_init() 関数または xxx() 関数で malloc() を使用してそのための領域を割り当て、xxx_deinit() 関数でそれを解放する必要があります。割り当てたメモリを UDF_INIT 構造体の ptr スロットに保存しておけば、将来 xxx() が呼び出されたときにそのメモリを再利用できます。 See 項13.2.2.1. 「単純関数の場合の UDF の呼び出し手順」。

関数で戻り値が NULL であることを示すには、is_null に 1 を設定します。

*is_null = 1;

関数がエラーを返すことを示すには、error に 1 を設定します。

*error = 1;

xxx() が、いずれかのレコードの処理で *error に 1 を設定した場合、カレントレコードおよび XXX() を呼び出したステートメントが処理するそれ以降のレコードについて、関数値が NULL になります(それ以降のレコードでは xxx() の呼び出しも行われません）。注意:MySQL 3.22.10 より古いバージョンでは、*error および *is_null の両方に値を設定する必要があります。

*error = 1;
*is_null = 1;

UDF を実装するファイルは、サーバが動作するホスト上でコンパイルし、インストールする必要があります。ここでは、MySQL ソースディストリビューションに含まれるサンプル UDF ファイル udf_example.cc を使用して、その手順について説明します。このファイルには以下の関数が定義されています。

ダイナミックにロード可能なファイルは、以下のようなコマンドを使用して、共有オブジェクトファイルとしてコンパイルする必要があります。

shell> gcc -shared -o udf_example.so myfunc.cc

MySQL ソースツリーの sql ディレクトリで以下のコマンドを実行するだけで、システムに合った適切なコンパイラオプションを知ることができます。

shell> make udf_example.o

make が表示するコンパイルコマンドをほとんどそのまま使用できます。ただし、行末付近にある -c オプションは指定しないでください。また、行末に -o udf_example.so を追加してください（一部のシステムでは、-c オプションをコマンドに残す必要があります）。

UDF を含む共有オブジェクトをコンパイルしたら、それをインストールして、MySQL に通知する必要があります。udf_example.cc をコンパイルして共有オブジェクトを作成すると、udf_example.so のような名前のファイルが生成されます（正確な名前はプラットフォームによって異なる可能性があります）。このファイルを /usr/lib などのダイナミックリンカ ld の検索対象パスにコピーするか、または共有オブジェクトを置いたディレクトリをリンカ設定ファイル（たとえば /etc/ld.so.conf）に追加します。

多くのシステムでは、UDF 関数ファイルを置いたディレクトリを参照するように環境変数 LD_LIBRARY または LD_LIBRARY_PATH を設定することもできます。システムで使用する必要がある変数については、dlopen のマニュアルページを参照してください。それらの変数を mysql.server または mysqld_safe の起動スクリプトで設定し、mysqld を再起動する必要があります。

ライブラリをインストールしたら、以下のコマンドを使用して、新しく追加した関数について mysqld に通知します。

mysql> CREATE FUNCTION metaphon RETURNS STRING SONAME "udf_example.so";
mysql> CREATE FUNCTION myfunc_double RETURNS REAL SONAME "udf_example.so";
mysql> CREATE FUNCTION myfunc_int RETURNS INTEGER SONAME "udf_example.so";
mysql> CREATE FUNCTION lookup RETURNS STRING SONAME "udf_example.so";
mysql> CREATE FUNCTION reverse_lookup
    ->        RETURNS STRING SONAME "udf_example.so";
mysql> CREATE AGGREGATE FUNCTION avgcost
    ->        RETURNS REAL SONAME "udf_example.so";

関数を削除するには、DROP FUNCTION を使用します。

mysql> DROP FUNCTION metaphon;
mysql> DROP FUNCTION myfunc_double;
mysql> DROP FUNCTION myfunc_int;
mysql> DROP FUNCTION lookup;
mysql> DROP FUNCTION reverse_lookup;
mysql> DROP FUNCTION avgcost;

CREATE FUNCTION および DROP FUNCTION の各ステートメントは、mysql データベースのシステムテーブル func を更新します。関数の名前、型、および共有ライブラリ名はこのテーブルに保存されます。関数を作成および削除するには、mysql データベースに対する INSERT 特権および DELETE 特権を持っている必要があります。

すでに作成されている関数を CREATE FUNCTION を使用して追加してはいけません。関数を再インストールする必要がある場合は、まず DROP FUNCTION で関数を削除してから CREATE FUNCTION で再インストールします。たとえば新しいバージョンの関数を再コンパイルした場合に、この手順で再インストールして mysqld に新しいバージョンの関数を追加します。再インストールしなければ、サーバは古いバージョンの関数を使い続けます。

mysqld を起動する際に --skip-grant-tables オプションが指定されていなかった場合、アクティブな関数はサーバが起動するたびに再ロードされます。オプションが指定されていた場合、UDF の初期化は行われず、それを使用することはできません（アクティブな関数とは CREATE FUNCTION でロードされたが DROP FUNCTION による削除は行われていない関数）。