17.00 - 17.05 - UDTBaseInfoメソッド - 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
日本語 (日本)

getArrayInfo()

public ArrayTypeInfo getArrayInfo()

Array型関連情報をすべて取得し、それをArrayTypeInfoオブジェクトで返します。ArrayTypeInfoクラスは、C FNC関数によって使用されるarray_info_eon_t構造に対応します。この構造には、配列の次元に関する情報、要素の数、および各要素に関する情報が含まれています。array_info_eon_t構造の詳細については、sqltypes_td.hヘッダー ファイルを参照してください。

getArrayNumDimension()

int getArrayNumDimension()
                       throws SQLException

Array/Varray型の次元の数を取得します。このメソッドは他のUDTまたは複合型には適用されません。

メソッドは、このArray/Varray型の次元数を含む型intの定数を返します。

次元情報にアクセスしようとしたときにエラーが発生する場合、メソッドはSQLExceptionをスローします。データベース固有コード"9744 (ERRUDFJAVUDT) < Number of dimensions for Array/Varray could not be accessed>"が返されます。

getBaseCharset()

int getBaseCharset()
                       throws SQLException

UDTまたは複合型の文字セットを取得します(その基本型に該当する場合)。

メソッドは、charset値を含む型intの定数を返します。

charset値にアクセスしようとしたときにエラーが発生する場合、メソッドはSQLExceptionをスローします。データベース固有コード"9744 (ERRUDFJAVUDT) <UDT charset could not be accessed>"が返されます。

getBaseDataType()

TeradataType getBaseDataType()
                        throws SQLException

UDTまたは複合型の基本データ型情報を取得します。有効な値にはJava enum TeradataTypeに含まれる値があります。

メソッドは、このUDTの基本型または複合型に一致するenum TeradataTypeのメンバーを返します。

基本データ型にアクセスしようとしたときにエラーが発生する場合、メソッドはSQLExceptionをスローします。データベース固有コード"9744 (ERRUDFJAVUDT) <UDT base type could not be accessed>"が返されます。

getBaseMaxLength()

int getBaseMaxLength()
                       throws SQLException

UDTまたは複合型の基本型の最大長を取得します。

メソッドは、UDTまたは複合型の基本最大長値を含む型intの定数を返します。

基本最大長にアクセスしようとしたときにエラーが発生する場合、メソッドはSQLExceptionをスローします。データベース固有コード"9744 (ERRUDFJAVUDT) <UDT base max length could not be accessed >"が返されます。

getBaseNumFractionalDigits()

short getBaseNumFractionalDigits()
                       throws SQLException

UDTの基本型または複合型の小数桁数値を取得します。この値はDECIMAL(m,n)基本型の値nに対応します。その他の場合はゼロに設定されます。

メソッドは、小数桁数値を含む型shortの定数を返します。

合計間隔桁数値にアクセスしようとしたときにエラーが発生する場合、メソッドはSQLExceptionをスローします。データベース固有コード"9744 (ERRUDFJAVUDT) <UDT base fractional digits could not be accessed >"が返されます。

getBasePrecision()

int getBasePrecision()
                       throws SQLException

UDTの基本型、または複合型の精度を取得します。この値はTIME型またはTIMESTAMP型の精度に対応します。例えば、TIME(4)やTIMESTAMP(6)です。その他の場合はゼロに設定されます。

メソッドは、精度値を含む型intの定数を返します。

精度値にアクセスしようとしたときにエラーが発生する場合、メソッドはSQLExceptionをスローします。データベース固有コード"9744 (ERRUDFJAVUDT) <UDT base precision could not be accessed>"が返されます。

getBaseTotalIntervalDigits()

short getBaseTotalIntervalDigits()
                       throws SQLException

UDTの基本型、または複合型の合計間隔桁数を取得します。この値はDECIMAL(m,n)基本型の値mに対応しています。その他の場合はゼロに設定されます。

メソッドは、合計間隔桁数値を含む型shortの定数を返します。

合計間隔桁数値にアクセスしようとしたときにエラーが発生する場合、メソッドはSQLExceptionをスローします。データベース固有コード"9744 (ERRUDFJAVUDT) <UDT base total interval digits could not be accessed>"が返されます。

getJSONStorageFormat()

short getJSONStorageFormat()
                       throws SQLException

JSON列のJSON格納形式を取得します。有効な値はC構造json_storage_enに使用される値に一致します。この構造の詳細については、テーブル演算子のデータ構造を参照してください。

メソッドは、このJSON列に対応するJSON格納形式値を含む型shortの定数を返します。

JSON格納形式値にアクセスしようとしたときにエラーが発生する場合、メソッドはSQLExceptionをスローします。データベース固有コード"9744 (ERRUDFJAVUDT) <JSON Storage format could not be accessed>"が返されます。

getStructNumAttributes()

int getStructNumAttributes()
                       throws SQLException

STRUCTURED型UDTの合計属性数を取得します。このメソッドは他のUDTまたは複合型には適用されません。

メソッドは、このSTRUCTURED型UDTの属性数を含む型intの定数を返します。

STRUCTURED型UDTの属性数にアクセスしようとしたときにエラーが発生する場合、メソッドはSQLExceptionをスローします。データベース固有コード"9744 (ERRUDFJAVUDT) <Structured UDT number of attributes could not be accessed>"が返されます。

getTransformメソッド

UDTの変換型に関する情報は次のメソッドを使用して取得できます:
  • int getTransformCharset()
  • int getTransformFractionalDigits()
  • int getTransformIntervalRange()
  • int getTransformMaxLength()
  • int getTransformPrecision()
  • int getTransformTotalDigits()
  • TeradataType getTransformType()

これらのメソッドはgetBase型のメソッドに似ていますが、UDTのデフォルトの変換型を参照します。

getUdtIndicator()

short getUdtIndicator()
                       throws SQLException

UDTまたはCDTのUDT標識属性を取得します。

有効な値は、C構造UDT_BaseInfo_tのudt_indicator属性に使用される値に一致します。この構造の詳細については、テーブル演算子のデータ構造を参照してください。

メソッドは、このUDTまたはCDTに対応する標識値を含む型shortの定数を返します。

標識値にアクセスしようとしたときにエラーが発生する場合、メソッドはSQLExceptionをスローします。データベース固有コード"9744 (ERRUDFJAVUDT) <UDT indicator could not be accessed>"が返されます。

getUdtName()

java.lang.String getUdtName()
                  throws SQLException

UDTまたは複合型の名前を取得します。

メソッドは、UDTの名前を含む型java.lang.Stringの定数を返します。

udtNameにアクセスしようとしたときにエラーが発生する場合、メソッドはSQLExceptionをスローします。データベース固有コード"9744 (ERRUDFJAVUDT) <UDT name could not be accessed>"が返されます。

setArrayInfo(ArrayTypeInfo)

public void setArrayInfo(ArrayTypeInfo  a)

列の配列メタデータ情報を設定します。設定される情報には、配列の次元、要素数、各要素の関する情報が含まれます。

setArrayNumDimension(int)

void setArrayNumDimension(int  num)
                       throws SQLException

Array/Varray型の次元の数を設定します。このメソッドは他のUDTまたは複合型には適用されません。

Array/Varray型の次元数を設定しようとしたときにエラーが発生する場合、メソッドはSQLExceptionをスローします。データベース固有コード"9744 (ERRUDFJAVUDT) <Number of dimensions for Array/Varray could not be set>"が返されます。

setBaseCharset(int)

void setBaseCharset(int  charset)
                       throws SQLException

UDTまたは複合型の文字セットを設定します(その基本型に該当する場合)。

charsetを設定しようとしたときにエラーが発生する場合、メソッドはSQLExceptionをスローします。データベース固有コード"9744 (ERRUDFJAVUDT) <UDT Charset could not be set>"が返されます。

setBaseDataType(TeradataType)

void setBaseDataType(TeradataType  baseDataType)
                       throws SQLException

UDTまたは複合型の基本データ型情報を設定します。有効な値にはJava enum TeradataTypeに含まれる値があります。

基本データ型を設定しようとしたときにエラーが発生する場合、メソッドはSQLExceptionをスローします。データベース固有コード"9744 (ERRUDFJAVUDT) <UDT base type could not be set>"が返されます。

setBaseMaxLength(int)

void setBaseMaxLength(int  maxLength)
                       throws SQLException

UDTまたは複合型の基本型の最大長を設定します。

基本最大長を設定しようとしたときにエラーが発生する場合、メソッドはSQLExceptionをスローします。データベース固有コード"9744 (ERRUDFJAVUDT) <UDT base max length could not be set>"が返されます。

setBaseNumFractionalDigits(short)

void setBaseNumFractionalDigits(short  numFractionalDigits)
                       throws SQLException

UDTの基本型、または複合型の小数桁数値を設定します。この値はDECIMAL(m,n)基本型の値nに対応します。その他の場合はゼロに設定されます。

小数桁数値を設定しようとしたときにエラーが発生する場合、メソッドはSQLExceptionをスローします。データベース固有コード"9744 (ERRUDFJAVUDT) <UDT base fractional digits could not be set>"が返されます。

setBasePrecision(int)

void setBasePrecision(int  precision)
                       throws SQLException

UDTの基本型、または複合型の精度を設定します。この値はTIME型またはTIMESTAMP型の精度に対応します。例えば、TIME(4)やTIMESTAMP(6)です。その他の場合はゼロに設定されます。

精度値を設定しようとしたときにエラーが発生する場合、メソッドはSQLExceptionをスローします。データベース固有コード"9744 (ERRUDFJAVUDT) <UDT base precision could not be set>"が返されます。

setBaseTotalIntervalDigits(short)

void setBaseTotalIntervalDigits(short  totalIntervalDigits)
                       throws SQLException

UDTの基本型、または複合型の合計間隔桁数を設定します。この値はDECIMAL(m,n)基本型の値mに対応します。その他の場合はゼロに設定されます。

合計間隔桁数値を設定しようとしたときにエラーが発生する場合、メソッドはSQLExceptionをスローします。データベース固有コード"9744 (ERRUDFJAVUDT) <UDT base total interval digits could not be set>"が返されます。

setJSONStorageFormat(short)

void setJSONStorageFormat(short  indicator)
                            throws SQLException

JSON列のJSON格納形式を設定します。有効な値はC構造json_storage_enに使用される値に一致します。この構造の詳細については、テーブル演算子のデータ構造を参照してください。

JSON格納形式値を設定しようとしたときにエラーが発生する場合、メソッドはSQLExceptionをスローします。データベース固有コード"9744 (ERRUDFJAVUDT) <JSON Storage Format could not be set>"が返されます。

setStructNumAttributes(int)

void setStructNumAttributes(int  structNumAttributes)
                       throws SQLException

STRUCTURED型UDTの合計属性数を設定します。このメソッドは他のUDTまたは複合型には適用されません。

STRUCTURED型UDTの属性数を設定しようとしたときにエラーが発生する場合、メソッドはSQLExceptionをスローします。データベース固有コード"9744 (ERRUDFJAVUDT) <Structured UDT number of attributes could not be set>"が返されます。

setTransformメソッド

UDTの変換型に関する情報は次のメソッドを使用して設定できます:
  • void setTransformCharset(int c)
  • void setTransformFractionalDigits(int d)
  • void setTransformIntervalRange(int d)
  • void setTransformMaxLength(int len)
  • void setTransformPrecision(int p)
  • void setTransformTotalDigits(int d)
  • void setTransformType(TeradataType type)

これらのメソッドはsetBase型のメソッドに似ていますが、UDTのデフォルトの変換型プを参照します。

setUdtIndicator(short)

void setUdtIndicator(short  indicator)
                     throws SQLException

UDTまたはCDTのUDT標識属性を設定します。

有効な値は、C構造UDT_BaseInfo_tのudt_indicator属性に使用される値に一致します。この構造の詳細については、テーブル演算子のデータ構造を参照してください。

標識値を設定しようとしたときにエラーが発生する場合、メソッドはSQLExceptionをスローします。データベース固有コード"9744 (ERRUDFJAVUDT) <UDT indicator could not be set>"が返されます。

setUdtName(java.lang.String)

void setUdtName(java.lang.String  udtName)
                    throws SQLException

UDTまたは複合型の名前を設定します。

udtNameを設定しようとしたときにエラーが発生する場合、メソッドはSQLExceptionをスローします。データベース固有コード"9744 (ERRUDFJAVUDT) <UDT name could not be set>"が返されます。