ユーザー定義集計関数のインターフェース

ユーザー定義集計関数は、一連の ODCIAggregate ルーチンによって実装されます。これらのルーチンはオブジェクト型のメソッドとして利用でき、CREATE FUNCTION ステートメントを使用して集計関数を作成できます。

OceanBaseデータベースの現行バージョンがサポートする ODCIAggregate ルーチンは以下のとおりです：

• ODCIAggregateInitialize()

• ODCIAggregateIterate()

• ODCIAggregateMerge()

• ODCIAggregateTerminate()

ODCIAggregateInitialize()

ODCIAggregateInitialize()は、集計コンテキストとオブジェクト型のインスタンスを初期化し、OUTパラメータとして返すために使用されます。これは静的メソッドです。

構文

STATIC FUNCTION ODCIAggregateInitialize(
   actx IN OUT <impltype>)
RETURN NUMBER

パラメータの説明

戻り値

成功した場合はODCIConst.Success、エラー発生時はODCIConst.Errorを返します。

ODCIAggregateIterate()

ODCIAggregateIterate()は、入力行をイテレーションして入力値を処理および更新し、集計コンテキストを返すために使用されます。これは強制ルーチンであり、メンバーメソッドとして実装されています。

構文

MEMBER FUNCTION ODCIAggregateIterate(
   self IN OUT <impltype>,
   val <inputdatatype>)
RETURN NUMBER

パラメータの説明

戻り値

成功した場合はODCIConst.Success、エラー発生時はODCIConst.Errorを返します。

ODCIAggregateMerge()

ユーザー定義の集計のシリアルまたはパラレル計算中に、ODCIAggregateMerge()は2つの集計コンテキストを単一のオブジェクトインスタンスにマージするために使用されます。これは強制ルーチンであり、メンバーメソッドとして実装されています。

構文

MEMBER FUNCTION ODCIAggregateMerge(
   self IN OUT <impltype>,
   ctx2 IN <impltype>)
RETURN NUMBER

パラメータの説明

戻り値

成功した場合はODCIConst.Success、エラー発生時はODCIConst.Errorを返します。

ODCIAggregateTerminate()

ODCIAggregateTerminate()は、集計結果を計算し、メモリ解放などの必要なクリーンアップを実行するために使用されます。これは強制ルーチンであり、メンバーメソッドとして実装されています。

構文

MEMBER FUNCTION ODCIAggregateTerminate(
   self IN <impltype>,
   ReturnValue OUT <return_type>,
   flags IN number)
RETURN NUMBER

パラメータの説明

戻り値

成功した場合はODCIConst.Success、エラー発生時はODCIConst.Errorを返します。