AlierDB: get()

AlierTable のインスタンスを取得します。

構文

alierDb.get({ table }) => AlierTable
alierDb.get({ table, alias }) => AlierTable
alierDb.get({ table, alias, columns }) => AlierTable
alierDb.get({ table, columns }) => AlierTable

引数

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

• table: string

  取得するテーブルの名前です。

• alias: string | undefined （省略可）

  テーブル名の別名です。 主にテーブルを結合した際に使用します。

  このプロパティの指定は任意です。指定しなかった場合、別名は設定されません。

• columns: Array<string> | string | undefined （省略可）

  取得するカラム名のリストです。

  カラム名のリストとして、配列またはカンマ区切りの文字列を指定できます。 それぞれのカラム名は自動的に識別子としてエスケープされます。

  このプロパティの指定は任意です。指定しなかった場合、すべてのカラムを取得の対象とします。

  テーブルに alias の指定がある場合は別名での記述が可能です。

返値: AlierTable

取得したテーブルです。

引数に columns の指定がある場合、VirtualAlierTable のインスタンスが返ります。

例外

• TypeError
  • 引数オブジェクトのプロパティ table が指定されていない場合

解説

AlierTable のインスタンスを取得します。

このメソッドの呼び出しではデータベースへのアクセスは発生しません。 データベースへのアクセスは取得した AlierTable から AlierTable.get() などのデータの取得および変更を行った際に発生します。