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

ユーザー定義集計関数は、一連の 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 を返します。