17.00 - 17.05 - FNC_TblOpGetUDTMetadata - Advanced SQL Engine - Teradata Database

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

Product
Advanced SQL Engine
Teradata Database
Release Number
17.00
17.05
Published
2020年6月
Content Type
プログラミング リファレンス
Publication ID
B035-1147-170K-JPN
Language
日本語 (日本)

目的

入力または出力ストリームの1つまたは複数のUDT列に関するメタデータ情報を返します。

構文規則

void
FNC_TblOpGetUDTMetadata(int                   streamno,
                        Stream_Direction_en   direction,
                        int                   columnno,
                        int                   bufSize,
                        UDT_BaseInfo_t      *udtbaseInfo);
int streamno
入力ストリーム番号。
Stream_Direction_en direction
入力または出力。
int columnno
UDTメタデータが要求される列番号。columnnoが-1の場合、UDTメタデータがすべての列に対して返されます。
int bufSize
この関数に渡されるudtbaseInfoバッファのサイズ。
UDT_BaseInfo_t *udtbaseInfo
この関数によって返されるメタデータ情報を含むUDT_BaseInfo_t構造の配列へのポインタ。すべての入力列に対しメタデータを要求する場合、すべての列に十分なメモリを割り当てる必要があります。

使用上の注意

FNC_TblOpGetUDTMetadataは、入力ストリームの1つ以上の入力または出力UDT列に関するUDTメタデータ情報を含むUDT_BaseInfo_t構造の配列を返します。非UDT列の場合、udt_indicatorは0に設定されます。

このルーチンはテーブル演算子でのみサポートされています。関数はコントラクト関数と演算子で呼び出すことができます。コントラクト関数で呼び出されると、入力ストリームでのみ使用できます。演算子で呼び出されると、入力ストリームまたは出力ストリームで使用できます。

UDT_BaseInfo_t構造とudt_indicatorの詳細については、テーブル演算子のデータ構造を参照してください。