パッケージ org.opengion.hayabusa.db

# クラス DBMetaData

java.lang.Object
org.opengion.hayabusa.db.DBMetaData

public class DBMetaData extends Object
【検索】DatabaseMetaData の情報を検索するタグです。 データベースに関する包括的な情報を提供する、DatabaseMetaData の内容を 表示する、タグです。テスト的に使用します。

機能分類
  テーブル管理
形式ｻﾝﾌﾟﾙ:
  ●形式： ・<og:databaseMetaData /> ●body：なし ●使用例 <og:databaseMetaData />
導入されたバージョン:
  JDK5.0,

- ## コンストラクタの概要

  コンストラクタ
  コンストラクタ
  説明
  `DBMetaData()`
  デフォルトコンストラクター

- ## メソッドの概要

  修飾子とタイプ
  メソッド
  説明
  `DBTableModel`
  `getColumns(String catalog, String schema, String tableName, String columnName)`
  指定されたカタログで使用可能なテーブル列の記述を取得します。
  `DBTableModel`
  `getIndexInfo(String catalog, String schema, String tableName, boolean unique, boolean approximate)`
  指定されたテーブルのインデックスと統計情報に関する記述を取得します。
  `DBTableModel`
  `getProcedures(String catalog, String schema, String procName)`
  指定されたカタログで使用可能なストアドプロシージャに関する記述を取得します。
  `DBTableModel`
  `getSchemas()`
  このデータベースで使用可能なスキーマ名を取得します。
  `DBTableModel`
  `getTables(String catalog, String schema, String tableName)`
  指定されたカタログで使用可能なテーブルに関する記述を取得します。
  `void`
  `setApplicationInfo(ApplicationInfo appInfo)`
  アクセスログ取得の為,ApplicationInfoオブジェクトを設定します。
  `void`
  `setDbid(String id)`
  DatabaseMetaData を作成する時のDB接続IDを指定します。
  `void`
  `setResourceManager(ResourceManager resource)`
  リソースマネージャーをセットします。

  ### クラスから継承されたメソッド java.lang.Object

  `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- ## コンストラクタの詳細

  - ### DBMetaData

    public DBMetaData()
    デフォルトコンストラクター
    変更履歴:
      6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor.

- ## メソッドの詳細

  - ### setDbid

    public void setDbid(String id)
    DatabaseMetaData を作成する時のDB接続IDを指定します。
    パラメータ:
      `id` - データベース接続ID

  - ### setResourceManager

    public void setResourceManager(ResourceManager resource)
    リソースマネージャーをセットします。 リソースマネージャーが設定されていない、または、所定のキーの DBColumn が リソースに存在しない場合は、デフォルトの DBColumn オブジェクトを作成します。
    パラメータ:
      `resource` - リソースマネージャー

  - ### setApplicationInfo

    public void setApplicationInfo(ApplicationInfo appInfo)
    アクセスログ取得の為,ApplicationInfoオブジェクトを設定します。
    パラメータ:
      `appInfo` - アプリ情報オブジェクト
    変更履歴:
      3.8.7.0 (2006/12/15) 新規追加

  - ### getSchemas

    public DBTableModel getSchemas()
    このデータベースで使用可能なスキーマ名を取得します。 結果はスキーマ名で順序付けられます。 スキーマ列は次のようになります。 ・TABLE_SCHEM String ⇒ スキーマ名 ・TABLE_CATALOG String ⇒ カタログ名 (null の可能性がある)
    戻り値:
      スキーマ名をDBTableModelオブジェクトにラップ
    関連項目:
      - `DatabaseMetaData.getSchemas()`
    変更履歴:
      3.8.7.0 (2006/12/15) アクセスログ取得の為,ApplicationInfoオブジェクトを設定

  - ### getTables

    public DBTableModel getTables(String catalog, String schema, String tableName)
    指定されたカタログで使用可能なテーブルに関する記述を取得します。 カタログ、スキーマ、テーブル名および型の条件に一致するテーブルの記述だけが返されます。 それらは、TABLE_TYPE、TABLE_SCHEM、TABLE_NAME によって順序付けられます。 各テーブルの記述には次の列があります。 ・TABLE_CAT String ⇒ テーブルカタログ (null の可能性がある) ・TABLE_SCHEM String ⇒ テーブルスキーマ (null の可能性がある) ・TABLE_NAME String ⇒ テーブル名 ・TABLE_TYPE String ⇒ テーブルの型。典型的な型は、"TABLE"、"VIEW"、"SYSTEM TABLE"、"GLOBAL TEMPORARY"、"LOCAL TEMPORARY"、"ALIAS"、"SYNONYM" である ・REMARKS String ⇒ テーブルに関する説明 ・TYPE_CAT String ⇒ の型のカタログ (null の可能性がある) ・TYPE_SCHEM String ⇒ の型のスキーマ (null の可能性がある) ・TYPE_NAME String ⇒ の型名 (null の可能性がある) ・SELF_REFERENCING_COL_NAME String ⇒ 型付きテーブルの指定された「識別子」列の名前 (null の可能性がある) ・REF_GENERATION String ⇒ SELF_REFERENCING_COL_NAME の値の作成方法を指定する。値は、"SYSTEM"、"USER"、"DERIVED" (null の可能性がある)
    パラメータ:
      `catalog` - カタログ名。(カタログ名と一致、"" はカタログなし、null は、カタログ名無条件)
      `schema` - スキーマ名パターン。(スキーマ名と一致、"" はスキーマなし、null は、スキーマ名無条件)
      `tableName` - テーブル名パターン。
    戻り値:
      テーブルに関する記述をDBTableModelオブジェクトにラップ
    関連項目:
      - `DatabaseMetaData.getSchemas()`
    変更履歴:
      3.8.7.0 (2006/12/15) アクセスログ取得の為,ApplicationInfoオブジェクトを設定

  - ### getColumns

    public DBTableModel getColumns(String catalog, String schema, String tableName, String columnName)
    指定されたカタログで使用可能なテーブル列の記述を取得します。 カタログ、スキーマ、テーブル名、および列名の条件に一致する列の 記述だけが返されます。 それらは、TABLE_SCHEM、TABLE_NAME、ORDINAL_POSITION によって順序付けられます。 各列の説明を次にします ・TABLE_CAT String ⇒ テーブルカタログ (null の可能性がある) ・TABLE_SCHEM String ⇒ テーブルスキーマ (null の可能性がある) ・TABLE_NAME String ⇒ テーブル名 ・COLUMN_NAME String ⇒ 列名 ・DATA_TYPE short ⇒ java.sql.Types からの SQL の型 ・TYPE_NAME String ⇒ データソース依存の型名。UDT の場合、型名は完全指定 ・COLUMN_SIZE int ⇒ 列サイズ。char や date の型については最大文字数、numeric や decimal の型については精度 ・BUFFER_LENGTH - 未使用 ・DECIMAL_DIGITS int ⇒ 小数点以下の桁数 ・NUM_PREC_RADIX int ⇒ 基数 (通常は、10 または 2 のどちらか) ・NULLABLE int ⇒ NULL は許されるか ・columnNoNulls - NULL 値を許さない可能性がある ・columnNullable - 必ず NULL 値を許す ・columnNullableUnknown - NULL 値を許すかどうかは不明 ・REMARKS String ⇒ コメント記述列 (null の可能性がある) ・COLUMN_DEF String ⇒ デフォルト値 (null の可能性がある) ・SQL_DATA_TYPE int ⇒ 未使用 ・SQL_DATETIME_SUB int ⇒ 未使用 ・CHAR_OCTET_LENGTH int ⇒ char の型については列の最大バイト数 ・ORDINAL_POSITION int ⇒ テーブル中の列のインデックス (1 から始まる) ・IS_NULLABLE String ⇒ "NO" は、列は決して NULL 値を許さないことを意味する。"YES" は NULL 値を許す可能性があることを意味する。空の文字列は不明であることを意味する ・SCOPE_CATLOG String ⇒ 参照属性のスコープであるテーブルのカタログ (DATA_TYPE が REF でない場合は null) ・SCOPE_SCHEMA String ⇒ 参照属性のスコープであるテーブルのスキーマ (DATA_TYPE が REF でない場合は null) ・SCOPE_TABLE String ⇒ 参照属性のスコープであるテーブル名 (DATA_TYPE が REF でない場合は null) ・SOURCE_DATA_TYPE short ⇒ 個別の型またはユーザ生成 Ref 型、java.sql.Types の SQL 型のソースの型 (DATA_TYPE が DISTINCT またはユーザ生成 REF でない場合は null)
    パラメータ:
      `catalog` - カタログ名。(カタログ名と一致、"" はカタログなし、null は、カタログ名無条件)
      `schema` - スキーマ名パターン。(スキーマ名と一致、"" はスキーマなし、null は、スキーマ名無条件)
      `tableName` - テーブル名パターン。
      `columnName` - 列名パターン
    戻り値:
      テーブル列の記述をDBTableModelオブジェクトにラップ
    関連項目:
      - `DatabaseMetaData.getSchemas()`
    変更履歴:
      3.8.7.0 (2006/12/15) アクセスログ取得の為,ApplicationInfoオブジェクトを設定

  - ### getIndexInfo

    public DBTableModel getIndexInfo(String catalog, String schema, String tableName, boolean unique, boolean approximate)
    指定されたテーブルのインデックスと統計情報に関する記述を取得します。 それらは、NON_UNIQUE、TYPE、INDEX_NAME、ORDINAL_POSITION によって順序付けされます。 各インデックス列の記述には次の列があります ・TABLE_CAT String ⇒ テーブルカタログ (null の可能性がある) ・TABLE_SCHEM String ⇒ テーブルスキーマ (null の可能性がある) ・TABLE_NAME String ⇒ テーブル名 ・NON_UNIQUE boolean ⇒ インデックス値は一意でない値にできるか。TYPE が tableIndexStatistic の場合は false ・INDEX_QUALIFIER String ⇒ インデックスカタログ (null の可能性がある)。TYPE が tableIndexStatistic の場合は null ・INDEX_NAME String ⇒ インデックス名。TYPE が tableIndexStatistic の場合は null ・TYPE short ⇒ インデックスの型 ・tableIndexStatistic - テーブルのインデックスの記述に連動して返されるテーブルの統計情報を識別する ・tableIndexClustered - クラスタ化されたインデックス ・tableIndexHashed - ハッシュ化されたインデックス ・tableIndexOther - インデックスのその他のスタイル ・ORDINAL_POSITION short ⇒ インデックス中の列シーケンス。TYPE が tableIndexStatistic の場合は 0 ・COLUMN_NAME String ⇒ 列名。TYPE が tableIndexStatistic の場合は null ・ASC_OR_DESC String ⇒ 列ソートシーケンス、"A" ⇒ 昇順、"D" ⇒ 降順、 ソートシーケンスがサポートされていない場合は、null の可能性がある。TYPE が tableIndexStatistic の場合は null ・CARDINALITY int ⇒ TYPE が tableIndexStatistic の場合、テーブル中の列数。そうでない場合は、インデックス中の一意の値の数 ・PAGES int ⇒ TYPE が tableIndexStatistic の場合、テーブルで使用されるページ数。そうでない場合は、現在のインデックスで使用されるページ数 ・FILTER_CONDITION String ⇒ もしあれば、フィルタ条件 (null の可能性がある)
    パラメータ:
      `catalog` - カタログ名。(カタログ名と一致、"" はカタログなし、null は、カタログ名無条件)
      `schema` - スキーマ名パターン。(スキーマ名と一致、"" はスキーマなし、null は、スキーマ名無条件)
      `tableName` - テーブル名。このデータベースに格納されたテーブル名と一致しなければならない
      `unique` - true の場合は、一意の値のインデックスだけを返す。false の場合は、一意であるかどうかにかかわらずインデックスを返す
      `approximate` - true の場合は、結果は概数またはデータ値から外れることもある。false の場合は、正確であることが要求される
    戻り値:
      インデックスと統計情報に関する記述をDBTableModelオブジェクトにラップ
    関連項目:
      - `DatabaseMetaData.getSchemas()`
    変更履歴:
      3.8.7.0 (2006/12/15) アクセスログ取得の為,ApplicationInfoオブジェクトを設定

  - ### getProcedures

    public DBTableModel getProcedures(String catalog, String schema, String procName)
    指定されたカタログで使用可能なストアドプロシージャに関する記述を取得します。 スキーマとプロシージャ名の条件に一致するプロシージャの記述だけが返されます。 それらは、PROCEDURE_SCHEM と PROCEDURE_NAME によって順序付けられます。 各プロシージャの記述には次の列があります。 ・PROCEDURE_CAT String ⇒ プロシージャカタログ (null の可能性がある) ・PROCEDURE_SCHEM String ⇒ プロシージャスキーマ (null の可能性がある) ・PROCEDURE_NAME String ⇒ プロシージャ名 ・将来使用するための予約 ・将来使用するための予約 ・将来使用するための予約 ・REMARKS String ⇒ プロシージャの説明文 ・PROCEDURE_TYPE short ⇒ プロシージャの種類 ・procedureResultUnknown - 結果を返す可能性がある ・procedureNoResult - 結果を返さない ・procedureReturnsResult - 結果を返す
    パラメータ:
      `catalog` - カタログ名。(カタログ名と一致、"" はカタログなし、null は、カタログ名無条件)
      `schema` - スキーマ名パターン。(スキーマ名と一致、"" はスキーマなし、null は、スキーマ名無条件)
      `procName` - プロシージャ名パターン。データベースに格納されたプロシージャ名と一致しなければならない
    戻り値:
      ストアドプロシージャに関する記述をDBTableModelオブジェクトにラップ
    関連項目:
      - `DatabaseMetaData.getSchemas()`
    変更履歴:
      3.8.7.0 (2006/12/15) アクセスログ取得の為,ApplicationInfoオブジェクトを設定