AlierDB: get()

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

構文

alierDb.get({ table }) => AlierDBTable
alierDb.get({ table, alias }) => AlierDBTable
alierDb.get({ table, alias, columns }) => AlierDBTable
alierDb.get({ table, alias, column, columnAliases }) => AlierDBTable
alierDb.get({ table, columns }) => AlierDBTable
alierDb.get({ table, columns, columnAliases }) => AlierDBTable

引数

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

• table: string

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

• alias: string | undefined （省略可）

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

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

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

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

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

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

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

• columnAliases: object | undefined （省略可）

  取得するカラム名とカラム名の別名の組のオブジェクトです。

  各プロパティ名がカラム名を表し、プロパティの値がそのカラムに対する別名を表す文字列です。 プロパティ名であるカラム名がcolumnsのリストに含まれていない場合、カラムの別名は無視されます。

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

返値: AlierDBTable

取得したテーブルです。

例外

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

解説

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

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