5.7 pgxa_create

機能

カラムナテーブルにインデックスを作成します。

書式

pgxa_create_index(indexname, tablename, columns, type, unique)

引数

引数	データ型	意味
indexname	text	インデックス名
tablename	text	テーブル名（外部テーブル名）
columns	text	列名リスト
type	text	インデックスの形式を以下のどれかで指定します。 'HG' 'DATE' 'TIME' 'DTTM' 'CMP'
unique	boolean	ユニーク属性か否か TRUE：ユニーク属性である FALSE：ユニーク属性ではない

戻り値

戻り値	意味
TRUE	正常終了
FALSE	異常終了

実行例

> psql postgres
psql (x.y.z)
Type "help" for help.

postgres=# select pgxa_create_index('tbl1_ix1', 'scm.tbl1', 'col1', 'HG', true);
 pgxa_create_index
-------------------
 t
(1 row)

x.y.z : PostgreSQLのバージョンが表示されます。

説明

インデックス名は、テーブル内で一意の名前を指定してください。
テーブル名は、事前に定義した外部テーブル名を指定してください。

指定できるインデックス形式と用途は以下のとおりです。
用途外の指定を実施した場合、本関数実行時にエラーになります。

インデックス形式	用途
HG	CHAR/VARCHAR型の場合は5300バイト以内で指定してください。ジョインキーやGROUP BY、集合関数、大小比較など。
DATE	ユニーク属性は利用できません。 DATE型専用です。 DATE型の列に対して有効です。
TIME	ユニーク属性は利用できません。 TIME型専用です。 TIME型の列に対して有効です。
DTTM	ユニーク属性は利用できません。 TIMESTAMP型専用です。 DTTM型の列に対して有効です。
CMP	ユニーク属性は利用できません。 2つのカラムのデータ型・精度・位取りが同じである必要があります。 FLOAT,DOUBLE,REAL型では使用できません。同じデータ型の列同士の比較。

未定義の外部テーブル名を指定した場合はエラーとなります。
指定した外部テーブルに既に同じ形式のインデックスが定義されている場合はエラーとなります。
typeに'HG'を指定して列名リストに指定する列名の型がCHARおよびVARCHARである場合、5300バイト以内の長さにしてください。5301バイト以上の長さの列名を指定すると、エラーになります。

注意

CREATE FOREIGN TABLE文で外部テーブルを作成するときに指定するスキーマ名、外部テーブル名、カラム名などには、半角英数字だけを使用してください。

また、外部テーブルに対するビュー名、インデックス名などには半角英数字だけを使用してください。

なお、使用可能文字の詳細は、“利用ガイド”の“定量制限”を参照してください。

5.7 pgxa_create_index