$sum()

指定した条件を満たすレコードの値の合計を与える集計用オブジェクトを生成します。

構文

$sum({ column }) => object
$sum({ column, group }) => object
$sum({ column, having }) => object
$sum({ column, group, having }) => object
$sum({ column, distinct }) => object
$sum({ column, distinct, group }) => object
$sum({ column, distinct, having }) => object
$sum({ column, distinct, group, having }) => object

引数

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

• column: string

  集計するカラムの名前です。

• group: string | string[] | undefined （省略可）

  GROUP BY 句に指定するカラム名のリストです。

  カラム名のリストとして、カラム名の配列またはカンマ区切り文字列を指定できます。

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

• having: string | undefined （省略可）

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

• distinct: boolean | undefined （省略可）

  DISTINCT キーワードを使用するかどうかです。 DISTINCT を使う場合、集計対象から重複レコードを除いた上で集計されます。

  true かつ column に "*" 以外の値が設定されている場合、DISTINCT キーワードが使われます。 このプロパティの指定は任意です。指定がない場合、false が使われます（DISTINCT を使用しません）。

返値: object | null

集計用オブジェクトまたは null です。集計用オブジェクトは以下のプロパティを持ちます。

• aggregate: string
  • 組み込みの集計関数 SUM の呼び出しを表す文字列です。
• group: string[] | undefined
  • GROUP BY 句に指定するカラム名の配列です。
• having: string | undefined
  • HAVING 句に指定する条件式です。

集計用オブジェクトとして aggregate に設定するべき文字列が存在しない場合、代わりに null を返します。

解説

指定した条件を満たすレコードの値の合計を与える集計用オブジェクトを生成します。

このオブジェクトは AlierTable.get() の引数のプロパティ aggregate の値として使用できます。