メインコンテンツまでスキップ

groupBy()

データをグループ化したい場合に利用します。

使用できるキー​

キー名内容省略備考
where取得条件の指定可書かない場合は全ての行を取得します
orderByソート設定可指定する列が 1 つの場合、配列の省略が可能です
take取得数の設定可
skipスキップ数の設定可
_avg平均表示の設定可
_countヒット数表示の設定可_all や true 省略形も指定可能です。詳細は _count を参照
_max最大値表示の設定可
_min最小値表示の設定可
_sum合計表示の設定可
byグループ化条件の指定不可
havingグループ化した後の取得条件指定可書かない場合は全てのデータを取得します
注記

by は必須です。省略すると GassmaMissingArgumentError（メッセージ: Argument by is missing.）がスローされます。

ヒント

where ではリレーションフィルタ（some / every / none / is / isNot）も利用可能です。

説明例用のシート​

説明用シート

説明​

上記例から以下の処理を行いたいとします。

  • pref でグループ化

この場合以下のコードとなります。

// gassma.{{TARGET_SHEET_NAME}}.groupBy
const result = gassma.sheet1.groupBy({
  by: "pref",
});

戻り値は以下の形式です。

[
  { pref: "Ibaraki" },
  { pref: "Tokyo" },
  { pref: "Osaka" },
  { pref: "Aichi" },
  { pref: "Shiga" },
  { pref: "Kyoto" },
  { pref: "Tottori" },
  { pref: "Fukuoka" },
];

また、複数指定することもでき、以下の処理を行いたいとします。

  • pref でグループ化
  • さらに age でグループ化

この場合以下のコードとなります。

// gassma.{{TARGET_SHEET_NAME}}.groupBy
const result = gassma.sheet1.groupBy({
  by: ["pref", "age"],
});

戻り値は以下の形式です。

[
  { pref: "Ibaraki", age: 22 },
  { pref: "Tokyo", age: 31 },
  { pref: "Tokyo", age: 55 },
  { pref: "Osaka", age: 20 },
  { pref: "Aichi", age: 40 },
  { pref: "Shiga", age: 25 },
  { pref: "Kyoto", age: 45 },
  { pref: "Tottori", age: 29 },
  { pref: "Fukuoka", age: 33 },
];

グループ化キーの欠損値（null / NaN / Invalid Date）​

by に指定した列の値が null / NaN / 不正な Date（Invalid Date）の行も、落とされずにグループ化されます。

  • NaN の行同士は 1 つのグループにまとまります。
  • Invalid Date の行同士も、別インスタンスであっても 1 つのグループにまとまります。
  • NaN・null・Invalid Date は互いに別のグループです。

having​

グループ化されたデータの中で、特定の条件を満たすデータを抽出したい場合に利用します。

例えば以下の条件でデータを抽出したいとします。

  • pref でグループ化
  • (グループ化した後)age => 平均が 30 以下

この場合以下のコードとなります。

// gassma.{{TARGET_SHEET_NAME}}.groupBy
const result = gassma.sheet1.groupBy({
  by: ["pref"],
  having: {
    age: {
      _avg: {
        lte: 30,
      },
    },
  },
});

戻り値は以下の形式です。

[
  { pref: "Ibaraki" },
  { pref: "Osaka" },
  { pref: "Shiga" },
  { pref: "Tottori" },
];

having の AND, OR, NOT​

AND, OR, NOT を利用することも可能です。

例えば以下の処理を行いたいとします。

  • pref でグループ化
  • (グループ化した後)age => 平均が 30 以下ではない

この場合以下のコードとなります。

// gassma.{{TARGET_SHEET_NAME}}.groupBy
const result = gassma.sheet1.groupBy({
  by: ["pref"],
  having: {
    NOT: {
      age: {
        _avg: {
          lte: 30,
        },
      },
    },
  },
});

戻り値は以下のようになります。

[{ pref: "Tokyo" }, { pref: "Aichi" }, { pref: "Kyoto" }, { pref: "Fukuoka" }];

また、whereと同様 NOT の下に AND を入れたりネストすることが可能です。

注意

having の値に NaN や不正な Date（Invalid Date）などの比較できない値を渡すと GassmaInvalidValueError がスローされます（where と同様です）。

統計の表示​

aggregate のように平均などを表示することもできます。

例えば以下の処理を行いたいとします。

  • pref でグループ化
  • age の平均を表示

この場合以下のコードとなります。

// gassma.{{TARGET_SHEET_NAME}}.groupBy
const result = gassma.sheet1.groupBy({
  by: ["pref"],
  _avg: { age: true },
});

戻り値は以下の形式です。

[
  { pref: "Ibaraki", _avg: { age: 22 } },
  { pref: "Tokyo", _avg: { age: 43 } },
  { pref: "Osaka", _avg: { age: 20 } },
  { pref: "Aichi", _avg: { age: 40 } },
  { pref: "Shiga", _avg: { age: 25 } },
  { pref: "Kyoto", _avg: { age: 45 } },
  { pref: "Tottori", _avg: { age: 29 } },
  { pref: "Fukuoka", _avg: { age: 33 } },
];
注記

_avg / _sum / _max / _min および列名指定の _count では、null に加えて NaN / 不正な Date（Invalid Date）も欠損値として集計から除外されます。集計対象の値がすべて欠損値の場合、結果は null になります。_count: { _all: true } はこれらの行も数えます。

_count​

_count では各グループの行数を数えられます。列名を指定するとその列の値が null（空のセル）や NaN / 不正な Date（Invalid Date）などの欠損値ではない行のみを、_all: true を指定すると欠損値を含む全ての行数を数えます。

例えば以下の処理を行いたいとします。

  • pref でグループ化
  • 各グループの行数を表示

この場合以下のコードとなります。

// gassma.{{TARGET_SHEET_NAME}}.groupBy
const result = gassma.sheet1.groupBy({
  by: ["pref"],
  _count: { _all: true },
});

戻り値は以下の形式です。

[
  { pref: "Ibaraki", _count: { _all: 1 } },
  { pref: "Tokyo", _count: { _all: 2 } },
  { pref: "Osaka", _count: { _all: 1 } },
  { pref: "Aichi", _count: { _all: 1 } },
  { pref: "Shiga", _count: { _all: 1 } },
  { pref: "Kyoto", _count: { _all: 1 } },
  { pref: "Tottori", _count: { _all: 1 } },
  { pref: "Fukuoka", _count: { _all: 1 } },
];

_count: true と省略すると、行数が数値としてそのまま返されます。

// gassma.{{TARGET_SHEET_NAME}}.groupBy
const result = gassma.sheet1.groupBy({
  by: ["pref"],
  _count: true,
});

戻り値は以下の形式です。

[
  { pref: "Ibaraki", _count: 1 },
  { pref: "Tokyo", _count: 2 },
  { pref: "Osaka", _count: 1 },
  { pref: "Aichi", _count: 1 },
  { pref: "Shiga", _count: 1 },
  { pref: "Kyoto", _count: 1 },
  { pref: "Tottori", _count: 1 },
  { pref: "Fukuoka", _count: 1 },
];
注記

_all と true 省略形は _count 専用で、_avg / _max / _min / _sum では利用できません。詳細は aggregate の _count を参照してください。