DBConnector: getDBConnector()

登録済みの DBConnector クラスの実装から、DBConnector のインスタンスを取得します。

info

構文

getDefaultConnector({ database, version }) => DBConnector
getDefaultConnector({ database, databaseType }) => DBConnector
getDefaultConnector({ database, databaseType, user, host, port, password }) => DBConnector

引数

単一の、以下のプロパティを持つオブジェクトです。 以下に示すプロパティ以外に、使用する DBConnector クラスの実装に依存した設定項目が存在します。詳細は各実装のリファレンスを参照してください。

  • database: string

    使用するデータベース名です。

  • version: number

    使用するデータベースのバージョンです。

    このプロパティはモバイル版でのみ使用されます。Node.js版では省略可能です。

  • databaseType: string

    使用するデータベースの種別です。

    指定できる値は関数 registerDefaultConnector() で登録したデータベース種別を表す文字列に限られます。 Node.js版において、以下のデータベース種別は登録済みです：

    このプロパティはNode.js版でのみ使用されます。モバイル版では省略可能です。

  • user: string | undefined （省略可）

    データベースに接続するユーザ名です。

    このプロパティの指定は任意です。指定がない場合、利用する DBConnector 派生クラスの実装および実行環境に依存した既定値が使われます。

    このプロパティはNode.js版でのみ使用されます。モバイル版では省略可能です。

  • host: string | undefined （省略可）

    データベースサーバのホスト名またはIPアドレスです。

    このプロパティの指定は任意です。指定がない場合、利用する DBConnector 派生クラスの実装および実行環境に依存した既定値が使われます。

    このプロパティはNode.js版でのみ使用されます。モバイル版では省略可能です。

  • port: number | undefined （省略可）

    データベースサーバが使用するポート番号です。

    ポート番号としては 0 以上の整数値を指定します（0, 1, 2, ...）。

    このプロパティの指定は任意です。指定がない場合、利用する DBConnector 派生クラスの実装および実行環境に依存した既定値が使われます。

    このプロパティはNode.js版でのみ使用されます。モバイル版では省略可能です。

  • password: string | undefined （省略可）

    データベースのパスワードです。

    このプロパティの指定は任意です。指定がない場合、利用する DBConnector 派生クラスの実装および実行環境に依存した既定値が使われます。

    このプロパティはNode.js版でのみ使用されます。モバイル版では省略可能です。

返値: DBConnector

モバイル版では常に SQLiteConnector のインスタンスが返ります。

Node.js版では registerDefaultConnector() で登録した、DBConnector 派生クラスのインスタンスが返されます。どのクラスのインスタンスが返されるかは、引数のプロパティ databaseType に依存し、registerDefaultConnector で登録されたデータベース種別に一致するクラスのインスタンスが返ります。

例外

解説

登録済みの DBConnector クラスの実装から、DBConnector のインスタンスを取得します。

Node.js版において、フレームワーク側で定義されている派生クラスを利用する場合、引数のプロパティ databaseType として以下のいずれかの値を指定できます：

独自に定義した DBConnector 派生クラスを使用するには、事前に関数 registerDefaultConnector() で DBConnector 派生クラスの定義されたモジュールのパスを登録する必要があります。