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

upsertMany()

特定の条件に合致した全ての行を指定した値に更新するが、条件に合致した行がない場合指定したデータを新規に追加したい場合に利用します。

使用できるキー

キー名内容省略
where取得条件の指定不可
update取得列の表示設定不可
create取得列の表示設定不可

説明例用のシート

説明用シート

説明

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

  • age => 44 を 45 にする
  • ない場合は以下のデータを追加する
    • name => fukuzawa
    • age => 45
    • pref => yamaguchi
    • postNumber => 753-8650

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

const gassma = new Gassma.GassmaClient();

// gassma.sheets.{{TARGET_SHEET_NAME}}.upsertMany
const result = gassma.sheets.sheet1.upsertMany({
where: {
age: 44,
},
update: {
age: 45,
},
create: {
name: "fukuzawa",
age: 45,
pref: "yamaguchi",
postNumber: "753-8650",
},
});

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

{
count: 1;
}

追加された行の数が返されます。

またwhereの仕様はfindMany()の記事の記事に準拠します。