機能
カラムナデータベース上に、指定の値を持つ変数を定義します。
書式
pgxa_register_variable(var_name, data_type, value)
引数
詳細は以下のとおりです。
引数 | データ型 | 意味 |
---|---|---|
var_name | text | 変数名 |
data_type | Text | データ型 |
value | Anyelement | 変数に設定するデータ |
戻り値
戻り値 | 意味 |
---|---|
TRUE | 正常終了 |
FALSE | 異常終了 |
説明
var_nameに指定できる変数名は、127バイトまでです。
var_nameには半角英字(A-Z、a-z)、半角数字(0-9)、半角アンダースコア(_)のみを使用してください。
valueには、data_typeで指定したデータ型の値を指定してください。
valueに文字列リテラルを指定する場合は、data_typeで指定したデータ型と同一の型でCASTしてください。
定義した変数はログインユーザーの同一コネクション上のみ有効となります
同一コネクション、または、ユーザー定義関数内で、同じ変数名(var_name)を複数回定義しないでください。
data_typeには以下のデータ型を文字列形式で指定可能です。
カテゴリ | データ型 | data_type指定形式 | 格納サイズ | 精度・範囲 |
---|---|---|---|---|
数値型 | smallint | ‘smallint’ | 2Byte | -32768から32767 |
integer | ‘integer’ | 4Byte | -2147483648から2147483647 | |
bigint | ‘bigint’ | 8Byte | -9223372036854775808から9223372036854775807 | |
decimal | ‘decimal’ | 可変長 | 精度、位取り共126桁 | |
numeric | ‘numeric’ | 可変長 | 精度、位取り共126桁 | |
float | ‘float’ | 4 または 8Byte | 15桁精度 | |
real | ‘real’ | 4Byte | 6桁精度 | |
double precision | ‘double’ | 8Byte | 15桁精度 | |
文字型 | character varying(n) | ‘varchar(n)’ | 32KB - 1 | |
varchar(n) | ||||
character(n) | ‘char(n)’ | 32KB - 1 | ||
char(n) | ||||
日付/時刻型 | date | ‘date’ | 4Byte | 日付 |
time | ‘time’ | 8Byte | 時刻 | |
timestamp | ‘timestamp’ | 8Byte | 日付と時刻(時刻帯なし) |