keyboard_arrow_leftAlierDB asIdentifier()keyboard_arrow_right

AlierDB

概要

AlierDB は単一のデータベースに対する操作を集約したクラスです。

コンストラクタ

構文

new AlierDB({ database, version })
new AlierDB({ database, version, autoConnect })
new AlierDB({ database, databaseType, connectorOptions })
new AlierDB({ database, databaseType, connectorOptions, autoConnect })
new AlierDB({ connector })
new AlierDB({ connector, autoConnect })

引数

単一の、以下のプロパティを持つオブジェクトを引数に取ります。

database: string （省略可）

データベース名です。

connector を指定する場合、この引数は無視されます。

databaseType, vertion を指定する場合、この引数は必須です。
databaseType: string （省略可）

データベースの種別を表す文字列です。

connector を指定する場合、この引数は無視されます。

モバイル版ではこの値は使用されません。

Node.js版では、database を指定する場合、この引数は必須です。
version: number （省略可）

データベースのバージョンを表す正の整数です（version >= 1）。

connector を指定する場合、この引数は無視されます。

モバイル版では、database を指定する場合、この引数は必須です。
connectorOptions: object （省略可）

DBConnector 向けのコンストラクタ引数のオプションです。

connector を指定する場合、この引数は無視されます。

database, databaseType, version が connectorOptions のプロパティとして設定されている場合、それらは無視されます。
connector: DBConnector （省略可）

データベース操作を実装した DBConnector 派生クラスのインスタンスです。

database, databaseType, version を指定しない場合、この引数は必須です。
autoConnect: boolean （省略可）

データベース操作に伴い、自動的にデータベースへ接続を試みるかどうかです。 true なら自動接続が有効になり、false なら無効になります。

このプロパティの指定は任意です。指定がない場合、自動接続は有効（true）となります。

例外

TypeError
- 引数 connector が与えられなかったか、DBConnector のインスタンスでなかった場合
- connector の指定がなく、database が指定されていなかった場合
- connector の指定がなく、version が正の整数でなかった場合
  
  この例外はモバイル版でのみ発生します。
DBError
- connector の指定がなく、引数 databaseType に対応する DBConnector が registerDefaultConnector() で登録されていなかった場合
  
  この例外は Node.js 版でのみ発生します。