Windows関数パラメータの構文要素 - Advanced SQL Engine - Teradata Database

Teradata Vantage™ - SQL外部ルーチン プログラミング

Product
Advanced SQL Engine
Teradata Database
Release Number
17.10
Published
2021年7月
Language
日本語
Last Update
2021-09-23
dita:mapPath
ja-JP/rin1593638965306.ditamap
dita:ditavalPath
ja-JP/wrg1590696035526.ditaval
dita:id
B035-1147
Product Category
Software
Teradata Vantage
function_name
値がCREATE FUNCTION定義の関数名であるC文字列へのポインタ。
関数の中では、この名前を使用してエラー メッセージを作成できます。
aggregation_phase
集約関数での入力データの処理方法を決定する現在の集約句。
集約句の定義は次のとおりです。
typedef enum {
  AGR_INIT        = 1,
  AGR_DETAIL      = 2,
  AGR_COMBINE     = 3,
  AGR_FINAL       = 4,
  AGR_NODATA      = 5
  AGR_MOVINGTRAIL = 6
} FNC_Phase;
集約フェーズの詳細について、ウィンドウ集約関数の基本アルゴリズムを参照してください。
function_context
集約関数操作の対象となるグループの中間集約記憶域である関数文脈構造へのポインタ。
関数文脈構造の定義は次のとおりです。
typedef struct FNC_Context_t {
  int         version;
  FNC_flags_t flags;
  void        *interim1;
  int         intrm1_length;
  void        *interim2;
  int         intrm2_length;
  long        group_count;
  long        window_size;
  long        pre_window;
  long        post_window;
} FNC_Context_t;
Vantageは、関数を呼び出す前に次のフィールドを設定します。
  • window_size
  • pre_window
  • post_window
この関数はこれらのフィールドを使用して、関数が操作する行のウィンドウを定義します。

ウィンドウ集約関数に適用できるFNC_Context_tフィールドの詳細について、FNC_Context_tフィールドを参照してください。

input_parameter_specification
[オプショ] CREATE FUNCTION定義内の入力パラメータのタイプと名前。定義内の各入力パラメータには、対応するinput_parameter_specificationが必要です。入力パラメータの最大数は128です。
typeは、input_parameterのSQLデータ型に対応するsqltypes_td.h内のC型です。
result
関数が戻す結果を保持する十分な大きさのデータ領域のポインタです。このデータ領域は、対応するCREATE FUNCTION文のRETURNS句で定義されます。
indicator_parameter_specification
[オプショ]入力パラメータに対応する標識パラメータ。各input_parameter_specificationには、対応するindicator_parameter_specificationが必要です。入力パラメータと標識パラメータは同じ順序である必要があります。
indicator_parameterの値が-1の場合、対応するinput_parameterの値はNULLです。
indicator_parameterの値が0の場合、対応するinput_parameterの値は非NULL値です。
indicator_result
結果に対応する結果標識パラメータ。
sqlstate
SQLSTATE値(成功、例外、または警告)を示す6文字のC文字列へのポインタ。最初の5文字はASCII文字、6文字目はC NULL文字です。文字列は成功を示す「00000」に初期化されています。
SQLSTATE値の詳細は、SQLSTATEの値を戻すを参照してください。
m
CREATE FUNCTION定義の関数名の文字数。ANSI SQL標準では、mの最大値は128と定義されています。Vantageでは、関数名に最大30文字を使用できます。
specific_function_name
値が呼び出されている外部関数の名前であるC文字列へのポインタ。
CREATE FUNCTION文にSPECIFIC句が含まれている場合、specific_function_nameはSPECIFIC句の名前です。それ以外の場合、specific_function_namefunction_nameと同じです。
関数の中では、この名前を使用してエラー メッセージを作成できます。
l
外部関数名の文字数。ANSI SQL標準では、mの最大値は128と定義されています。Vantageでは、関数名に最大30文字を使用できます。
error_message
値がエラー メッセージ テキストであるC文字列へのポインタ。
p
エラー メッセージ テキストの文字数。最大値は256です。