keyboard_arrow_leftisPhysical()post()keyboard_arrow_right

AlierDBTable: join()

対象のテーブルを与えられたテーブルと結合します。

構文

alierDBTable.join({ table }) => AlierDBTable
alierDBTable.join({ table, joinType }) => AlierDBTable
alierDBTable.join({ table, on }) => AlierDBTable
alierDBTable.join({ table, using }) => AlierDBTable
alierDBTable.join({ table, columns }) => AlierDBTable
alierDBTable.join({ table, columns, on }) => AlierDBTable
alierDBTable.join({ table, columns, using }) => AlierDBTable
alierDBTable.join({ table, columns, columnAliases }) => AlierDBTable
alierDBTable.join({ table, columns, columnAliases, on }) => AlierDBTable
alierDBTable.join({ table, columns, columnAliases, using }) => AlierDBTable
alierDBTable.join({ table, joinType, on }) => AlierDBTable
alierDBTable.join({ table, joinType, using }) => AlierDBTable
alierDBTable.join({ table, joinType, columns }) => AlierDBTable
alierDBTable.join({ table, joinType, columns, on }) => AlierDBTable
alierDBTable.join({ table, joinType, columns, using }) => AlierDBTable
alierDBTable.join({ table, joinType, columns, columnAliases }) => AlierDBTable
alierDBTable.join({ table, joinType, columns, columnAliases, on }) => AlierDBTable
alierDBTable.join({ table, joinType, columns, columnAliases, using }) => AlierDBTable

引数

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

table: AlierDBTable

結合するテーブルです。JOIN 演算の右項として使われます。
columns: string | Array<string> | undefined （省略可）

結合テーブルから取得するカラム名のリストです。

カラム名を表す文字列の配列、またはカンマ区切り文字列を指定できます。

このプロパティの指定は任意です。指定がない場合、すべてのカラムが取得されます。
columnAliases: object | undefined （省略可）

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

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

このプロパティの指定は任意です。指定しなかった場合、カラムに別名は設定されません。
joinType: DBJoinType | undefined （省略可）

結合する方法を指定します。指定できる値は DBJoinType のプロパティとして定義された下記の定数のみです。
このプロパティの指定は任意です。指定がない場合、テーブルは内部結合（INNER JOIN）されます（DBJoinType.INNER_JOIN）。
on: string | undefined （省略可）

JOIN 演算の ON 句に与える結合条件を表す条件式です。条件式の記法についてはSQL 式のスクリプト上での表現を参照してください。

このプロパティは joinType の値を以下のいずれかに指定した場合のみ指定できます：
以下の値を joinType に指定した場合、このプロパティは指定できません：
また、on プロパティと using プロパティの両方を指定することはできません。

このプロパティの指定は条件付きで任意です。指定がない場合、ON 句は使われません。
using: string | Array<string> | undefined （省略可）

JOIN 演算の USING 句に与えるカラム名、またはカラム名のリストです。単一のカラム名を指定する場合は文字列を使用し、リストを指定する場合は文字列の配列を使用します。

このプロパティは joinType の値を以下のいずれかに指定した場合のみ指定できます：
以下の値を joinType に指定した場合、このプロパティは指定できません：
また、on プロパティと using プロパティの両方を指定することはできません。

このプロパティの指定は条件付きで任意です。指定がない場合、USING 句は使われません。

SQLiteのUSING

SQLite 3.39.0 以降と3.38.x 以前で USING まわりの挙動が変更されています。

```js

// これは 3.38.x 以前では構文エラーになります（no such column: C.x）
const BC = B.join({table:C, using:"x"});
const ABC = A.join({table:BC, on:"A.x = C.x"})

// これは 3.38.x 以前でも実行可能です。
const BC = B.join({table:C, using:"x"});
const ABC =　BC.join({table:A, on:"A.x = C.x"})

```

対策として JOIN の右項に USING が使われているなら左項と入れ替え、LEFT_OUTER_JOIN を RIGHT_OUTER_JOIN, RIGHT_OUTER_JOIN を LEFT_OUTER_JOIN に変更してください。
NATURAL に関しても USING を使う場合と同様に変更してください。

返値: `AlierDBTable`

結合結果の AlierDBTable が返ります。

例外

DBError
- 引数にプロパティ table が指定されなかった場合
- 引数のプロパティ table の値が AlierDBTable のインスタンスでなかった場合
- 引数のプロパティ table に指定された AlierDBTable と join() の対象の AlierDBTable が互いに異なるデータベースのテーブルを指している場合
- 引数にプロパティ on と using の両方が指定されていた場合
- 引数のプロパティ joinType の値が以下のいずれかで、かつプロパティ on と using のいずれも指定されていない場合：
- 引数のプロパティ joinType の値が以下のいずれかで、かつプロパティ on と using のいずれかが指定されていた場合：
TypeError
- 引数のプロパティon に null または undefined でない値が設定されていて、それが文字列でない場合
- 引数のプロパティ using に null または undefined でない値が設定されていて、それが文字列でも文字列の配列でもない場合

解説

対象のテーブルを与えられたテーブルと結合します。

結合時に同名のカラムを別々に扱いたい場合は、結合したいテーブルのcolumnAliasesでカラムに別名を付けてください。

別名を付けずに結合すると、同名のカラムが複数あった場合の結果は、DBごとに異なります。

keyboard_arrow_leftisPhysical()post()keyboard_arrow_right

AlierDBTable: join()

構文

引数

返値: AlierDBTable

例外

解説

返値: `AlierDBTable`