BackEnd

Laravelの便利メソッドupsert

投稿日:

はじめに

LaravelでUPSERTを行いたい場合にupdateOrCreateメソッドを使った事があるかと思いますが、Laravel8系から一度で複数レコードのUPSERTを行える便利なupsertメソッドが出ていたので紹介したいと思います。

upsertメソッドとは

1つのクエリで複数レコードのUPSERT(すでに更新対象となるデータが存在すればUPDATEを実行し、無ければINSERTを行う)を簡潔に行う事が出来ます。

今まで同じ事をしようとする時は、数が少なければforeachで updateOrCreate メソッドで1レコードずつ処理したり、自前でSQLを用意してしていたかと思いますが、このメソッドを利用する事でスッキリと書けます。

使い方

例えば、usersテーブル(id、email、nameのカラム構成)でupsertメソッドを使ってみたいと思います。
例えば、id=1の1ユーザーのみ保存されている状態で以下の様にupsertメソッドを実行すると、

id=1のレコードは既に存在しているのでUPDATEされ、id=1以外のレコードはINSERTされます。
UPDATEされるレコードでは、nameカラムのみが更新されます。
引数で渡している値はそれぞれ

  • 第一引数:UPSERT対象となるデータの配列。ここに第二引数と第三引数(省略しない場合)の値が含まれている必要があります。
  • 第二引数:レコードのユニークを識別するカラムの配列。プライマリーキー or ユニークキー(複数もOK)
  • 第三引数:UPDATEされる場合に更新したいカラムの配列。これを省略すると、全カラムが更新対象になるようです。

となっています。

usersテーブルでは、emailカラムにユニーク制約されているので、以下の様に書いても同じ結果が得られます。

タイムスタンプ

Userモデルでタイムスタンプが設定されていれば第三引数にタイムスタンプ用のカラムを含めなくても、
INSERT時には created_atupdated_at に値が入り、UPDATE時には updated_at のみ更新されます。

生成SQL

Mysqlの場合では、ON DUPLICATE KEY UPDATE ステートメントが生成されてました。

さいごに

upsertメソッドを利用すると、簡潔に複数レコードのUPSERTを行う事が出来ます。Laravelは色々便利な機能を追加してくれますね

おすすめ書籍

プロフェッショナルWebプログラミング Laravel 速習 Laravel 改訂2版 速習シリーズ

blog-page_footer_336




blog-page_footer_336




-BackEnd
-,

執筆者:


comment

メールアドレスが公開されることはありません。 が付いている欄は必須項目です

CAPTCHA


関連記事

php logo

PHPでGmail APIを利用してメールデータを取得してみる その2

1 はじめに2 メールの内容取得3 MessagePartオブジェクト3.1 件名3.2 本文4 multipartの場合4.1 本文の取得5 全文6 さいごに7 おすすめ書籍 はじめに 前回は、Gm ...

aws

ALB+EC2な環境でhttpをhttpsにリダイレクトする

1 はじめに1.1 前提条件2 ALBの設定3 Nginxの設定3.1 注意点4 さいごに はじめに httpsに対応済みのWebサイトの場合、httpでアクセスされた時にhttpsでリダイレクトする ...

laravel logo

PHPで画像編集~Intervention Image~

1 はじめに2 やる事3 インストール4 画像読み込み5 文字列の追加6 編集した画像の保存7 実際のコード8 他に使う機会がありそうな編集8.1 モザイク8.2 ぼやけ8.3 リサイズ9 さいご10 ...

rails

Capistrano3でRailsアプリケーションをデプロイする

1 はじめに1.1 前提条件2 Cpistranoについて3 導入3.1 Gemのインストール3.2 設定ファイルの準備4 デプロイ設定4.1 Capfileを修正する4.2 各環境で共通のデプロイ設 ...

laravel logo

Laravel Sail 環境に Laravel Breeze を導入してみた

1 はじめに2 Laravel Sail とは3 Laravel Breeze とは4 Laravel Breeze のインストール4.1 Composer4.2 npm5 マイグレーション6 確認7 ...

フォロー

blog-page_side_responsive

2023年4月
 1
2345678
9101112131415
16171819202122
23242526272829
30  

アプリ情報

私たちは無料アプリもリリースしています、ぜひご覧ください。 下記のアイコンから無料でダウンロードできます。