no versions found for ApplicationFrameworkReferences / Utility/Database/DBConnector/dbconnector_getschema / en

DBConnector: getSchema()

データベースの定義情報を取得します。

この関数は非同期関数です。

note
  • この関数は基底クラスでは実装されていません。派生クラスでは以下に示す仕様を満たすようにこの関数を実装する必要があります。

構文

dbConnector.getSchema() => Promise<object>

返値: Promise<object>

データベースの定義情報を取得した際に履行される Promise です。

履行した際、データベース定義情報を表す object を与えます。 このオブジェクトは以下のプロパティを持ちます。

  • tables: Array<object>

    テーブルの定義情報を表すオブジェクトの配列です。

例外

以下の例外は返値の Promise が棄却された際に発生します。

  • DBInternalError
    • この関数が未実装だった場合
warning

  • DBInternalError を try-catch 文の中で catch した場合、何もせず再び throw してください。この例外はアプリケーション実行時に発生するべきではありません。

    その他のアプリケーションエラーと区別するため、この関数で発生した例外は必ず instanceof で型を検査してください。

解説

データベースの定義情報を取得します。