8.7.35 getIndexInfo(String catalog, String schema, String table, boolean unique, boolean approximate)
- 〈この項の構成〉
(1) 機能
インデクスに関する情報を取得します。
このメソッドを実行したHADBユーザが持っている権限によって,取得できるインデクス情報が変わります。権限と取得できるインデクス情報については,マニュアルHADB システム構築・運用ガイドのHADBユーザが参照できるディクショナリ表とシステム表の範囲を参照してください。
(2) 形式
public synchronized ResultSet getIndexInfo(String catalog, String schema, String table, boolean unique, boolean approximate) throws SQLException
(3) 引数
- String catalog:
-
カタログ名を指定します。ただし,指定しても無視されます。
- String schema:
-
スキーマ名パターン※を指定します。大文字と小文字を区別します。
- String table:
-
表名パターン※を指定します。大文字と小文字を区別します。
- boolean unique:
-
ユニーク属性を指定します。次に示すどちらかの値を指定してください。
true:ユニークインデクスの情報だけを取得します。
false:すべてのインデクスの情報を取得します。
- boolean approximate:
-
指定する必要はありません。指定しても無視されます。
- 注※
-
各パターンに指定できる特殊文字については,「8.7.1 DatabaseMetaDataインタフェースのメソッド一覧」の「(4) パターン文字列中に指定できる特殊文字」を参照してください。
(4) 戻り値
ResultSetオブジェクトが返却されます。
返却されるResultSetオブジェクトの形式を次の表に示します。
列番号 |
型 |
列名 |
列の意味 |
---|---|---|---|
1 |
String |
TABLE_CAT |
カタログ名 常に空の文字列を返します。 |
2 |
String |
TABLE_SCHEM |
スキーマ名 |
3 |
String |
TABLE_NAME |
表名 |
4 |
boolean |
NON_UNIQUE |
インデクスを定義するキー値(インデクスとして定義する1つまたは複数の列全体の値)が,すべての行で異なっている場合にfalse,そうでない場合にtrueを返します。 |
5 |
String |
INDEX_QUALIFIER |
インデクスのカタログ名 常に空の文字列を返します。 |
6 |
String |
INDEX_NAME |
インデクス識別子 |
7 |
short |
TYPE |
インデクス種別を返します。 常にDatabaseMetaData.tableIndexOtherを返します。 |
8 |
short |
ORDINAL_POSITION |
インデクスを構成する列の順序(インデクスを構成する列名順を識別する番号で,1から始まる整数)を返します。 |
9 |
String |
COLUMN_NAME |
列名を返します。 |
10 |
String |
ASC_OR_DESC |
B-treeインデクスのキー値の並び順を返します。
B-treeインデクス以外のインデクスの場合は,ナル値を返します。 |
11 |
int |
CARDINALITY |
インデクス内のユニークな値の数 常にナル値を返します。 |
12 |
int |
PAGES |
インデクスで使用しているページ数 常にナル値を返します。 |
13 |
String |
FILTER_CONDITION |
フィルタ条件 常に空の文字列を返します。 |
(5) 発生する例外
このメソッドを実行する前に,Connectionオブジェクトがクローズされている場合,SQLExceptionが投入されます。