「Eloquent」の記事 - Crieit

MySQL8.0 の再帰クエリを単独の Eloquent で使ってみる

2022-07-12T23:45:36+09:00

ちょうどやりたいことができそうだったので、 MySQL8.0 で新しく追加された再帰クエリを使ってみました。なお、単独インストールした Eloquent での使用を想定しているので、リレーションの機能をそのまま使うのは難しそうなケースでした。

経緯

内容としてはありがちな部署マスタのようなもので、親子関係まで見たいと考えたためでした。

id	parent	name
1	0	営業部
2	1	営業1課
3	1	営業2課
4	0	システム部
5	4	開発課
6	4	運用保守課
7	5	フロントエンドグループ
8	5	バックエンドグループ

イメージとしてはこんなイメージのテーブルがあったとして、例えば「システム部」と指定した場合、「開発課」「運用保守課」「フロントエンドグループ」「バックエンドグループ」のIDを子部署として参照したい、というようなケースです。

コード

$hogeObjectsArray = $this->dbConnect->connection('hogera')
                                ->select("
                                    WITH recursive child(
                                        depth,
                                        id,
                                        parent,
                                        name
                                      ) AS (
                                        SELECT 0,
                                               id,
                                               parent,
                                               name
                                          FROM hoge
                                         WHERE id = {$foo}
                                         UNION ALL
                                        SELECT child.depth + 1,
                                               hoge.id,
                                               hoge.parent,
                                               hoge.name
                                          FROM hoge, child
                                         WHERE hoge.parent = child.id
                                      )
                                      SELECT depth,
                                             id,
                                             parent,
                                             name
                                        FROM child
                                       ORDER BY
                                             depth
                                ");

最終的には上述の形で取得できました。

->table($this->table) 等でテーブルを指定せず、いきなり ->select() しているのがミソです。

参考

with recursive

単独の Eloquent 内で with recursive を使用したい

メソッド確認

Illuminate\Database\Capsule\Manager | Laravel API
query(): Illuminate\Database\Connection | Laravel API
Builder: Illuminate\Database\Query\Builder | Laravel API
selectRaw(): Illuminate\Database\Query\Builder | Laravel API
select(): Illuminate\Database\Query\Builder | Laravel API
raw(): Illuminate\Database\Connection | Laravel API

unionAll

Eloquent 単独で COUNT(*) を使用したいが DB:raw() を使用すると A facade root has not been set. エラーになる

2022-06-09T23:58:40+09:00

経緯

Eloquent 単独利用しているプログラムの中で COUNT(*) を使用したくなったのでその方法をメモ。

単純に件数をカウントしてその数値を使いたいだけであれば

$data_count = $dbConnect->table('hoge')
              ->count();

で済ませることができます。が、今回はサブクエリとして使用した方がコード的にすっきりしそうな状況でした。

先の方法ではコード上は関連性のない別のクエリをもう1つ記述しなければならないので如何なものかと思い……。

調査

LaravelのEloquentで集計関数Count()などを使うとき - バックエンドとフロントエンドを行き来するWEBプログラマ―のメモ帳

検索したところ、 SQL で COUNT(*) を使用する場合は DB:raw() を使うとのこと。

ただし、 Laravel の中ならばいざ知らず今回は Eloquent 単独使用なので、 DB なるクラスはどこから来るのか……となってしまいました。しかも ::raw() は static メソッドですし。

データベース：クエリビルダ 8.x Laravel

引き続き検索すると、 DB はファサードでした。

しかし、 Laravel 公式のサンプルのように

use Illuminate\Support\Facades\DB;

を追加すると、

A facade root has not been set.

というエラーが発生して怒られてしまいます。

通常の Laravel 内で使用する場合はインスタンスとの紐付けが上手く行われますが、今回は Eloquent のみの単体使用なのでこのパターンではできそうにないように見受けられました (できたとしても素直に Laravel を使った方が早そう)。

最終的には

Eloquentを単体で導入している時にDBファサードを使用する方法 - Qiita

この記事の方法で

use \Illuminate\Database\Capsule\Manager as DB;

を DB::raw() を使うクラスのファイルの中で再度読み込ませる (別のファイルでDB接続用のインスタンスを生成していて、それを DI していたので今回は「再度読み込ませる」という表現) ことで乗り越えることができました。

参考

count()

DB::raw()

A facade root has not been set. エラー

LaravelのFacade(ファサード)とは? 何気なく使用していた裏側の仕組みを解説! | RE:ENGINES
Laravel｜DBデータ操作(DBファサード, クエリビルダ, Eloquent) - わくわくBank (バージョン古い)
エンジニアブログ (バージョン古い)
php - How can I query raw via Eloquent? - Stack Overflow (バージョン古い)
Eloquentを単体で導入している時にDBファサードを使用する方法 - Qiita

Illuminate\Support\Collection を配列に変換する

2022-05-31T23:48:56+09:00

経緯

Eloquent で取得したデータはそのままだと Object の Collection になっているのですが、配列として扱いたいケースが出てきました。そこで先の Collection を配列に変換するメモを残しておきます。

コード

$employeesCollectionObject = $dbConnect->table($this->table)
                    ->where(
                        [
                            ['id', '=', $id],
                        ]
                    )
                    ->select(
                        'employee_id',
                        'depart',
                    )
                    ->get();
$employeesCollectionArray = $employeesCollectionObject->map(function ($item, $key) {
    return [
        'tori_id' => $item->employee_id,
        'domain' => $item->depart,
    ];
});

例えばこうすることで、

object(Illuminate\Support\Collection)[xxx]
  protected 'items' => 
    array (size=10)
      0 => 
        object(stdClass)[yyy]
          public 'employee_id' => string '001' (length=3)
          public 'depart' => string 'sales' (length=5)
      1 => 
        object(stdClass)[zzz]
          public 'employee_id' => string '002' (length=3)
          public 'depart' => string 'accounting' (length=10)
      2 => 
      ...

このようなコレクション→オブジェクトの配列が

object(Illuminate\Support\Collection)[xxx]
  protected 'items' => 
    array (size=10)
      0 => 
        array (size=2)
          'employee_id' => string '001' (length=3)
          'depart' => string 'sales' (length=5)
      1 => 
        array (size=2)
          'employee_id' => string '002' (length=3)
          'depart' => string 'accounting' (length=10)
      ...

このようなコレクション→連想配列の配列になります。各プロパティへのアクセス等が犠牲になりますが、今回は織り込み済み。

さらに ->toArray() を使って

$employeesCollectionArray = $employeesCollectionObject->map(function ($item, $key) {
    return [
        'tori_id' => $item->employee_id,
        'domain' => $item->depart,
    ];
});
$customersArray = $employeesCollectionArray->toArray();

こうすることで

array (size=10)
  0 => 
    array (size=2)
      'employee_id' => string '001' (length=3)
      'depart' => string 'sales' (length=5)
  1 => 
    array (size=2)
      'employee_id' => string '002' (length=3)
      'depart' => string 'accounting' (length=10)
  ...

配列→連想配列にできました。

今回はこれで対応。

参考

Eloquent で複数DBに接続する

2022-05-19T23:50:29+09:00

単独の Eloquent を利用して異なるデータソースにアクセスしてみたのでメモしておきます。

コード

db = new Manager;
        // default
        $this->db->addConnection([
            'driver'    => 'mysql',
            'host'      => $_ENV['MYSQL1_HOST'],
            'database'  => $_ENV['MYSQL1_DBNAME'],
            'username'  => $_ENV['MYSQL1_USER'],
            'password'  => $_ENV['MYSQL1_PASSWORD'],
            'charset'   => 'utf8',
        ]);
        // second
        $this->db->addConnection([
            'driver'    => 'mysql',
            'host'      => $_ENV['MYSQL2_HOST'],
            'database'  => $_ENV['MYSQL2_DBNAME'],
            'username'  => $_ENV['MYSQL2_USER'],
            'password'  => $_ENV['MYSQL2_PASSWORD'],
            'charset'   => 'utf8',
        ],
        'second'); // addConnection() メソッドの第二引数に接続名を指定する (1つ目はなしだと default になる)
        $this->db->setAsGlobal();
        $this->db->bootEloquent();
    }
    // 略
}

肝はコメントにも記した通り Managerクラスの addConnection()メソッドについて、第二引数に接続名を指定することです (1つ目はなしだと default になり、後で使用する分にも指定は不要) 。

あ、しれっと書いていますが dotenv を使用した想定です。


$db = new DBConnection();

$secondDBrows = $db->connection('second')->table('hoge_db')
                   ->where( /* 略 */ )
                   ->select( /* 略 */ )
                   ->get();

こちらもしれっと書いていますがイメージとしては先程のDB接続用クラス DBConnection をインスタンス化して、その中から connection()メソッドで引数に先程指定した接続名を記述することで二つ目の接続を利用してDBにアクセスできる、ということです。

これで意図したことを実装することができました。

参考

Eloquent で複合条件の抽出をする

2022-05-18T00:03:50+09:00

Eloquent を実践的に使い始めたばかりなので初歩的なところですが、複合条件を組み立てるところについてメモ。

コード

やりたいこととしては、 WHERE A AND B AND (C OR D) という条件。

$departName = [
    '総務部',
    '営業部',
];
$dataRows = $dbConnect->table('hoge_db')
                      ->where(
                          [
                              ['user_id', '>', 23],
                              ['age', '<', 42],
                          ]
                      )
                      ->where(function($query) use ($departName) {
                          $query->orWhere('depart_name', '=', $departName[0])
                                ->orWhere('depart_name', '=', $departName[1]);
                      })
                      ->select(
                          'fuga_db.name',
                          'fuga_db.attribute',
                          'fuga_db.parameter'
                      )
                      ->join('fuga_db', 'hoge_db.user_id', '=', 'fuga_db.employee_id')
                      ->get();

$dbConnect にDB接続情報が入ったインスタンスがあるという前提ですが、イメージとしてこのようなコードです。

肝は以下。

OR 条件の括弧の中身を where()メソッドの中にクロージャとして無名関数で記述する。
関数の引数はクエリ。そこに orWhere()メソッドを足していく。
クロージャの外部の変数はスコープの関係で Undefined Variable になってしまうので use句でクロージャ内に持ち込む

これで意図した挙動になることを確認しました。