Laravel – エラーメッセージの日本語化

2021-08-24 / tau / コメントする

日本語化ファイルのダウンロードとインストール

ユーザー認証やバリデーションなどに関するエラーメッセージの日本語化はロケールファイルを編集する方法で可能だが、言語ファイルをダウンロード・インストールする方法がReadDoubleで紹介されている。

以下、プロジェクトのルートディレクトリーで操作。

インストールファイルのダウンロード

$ php -r "copy('https://readouble.com/laravel/6.x/ja/install-ja-lang-files.php', 'install-ja-lang.php');"

1	$ php -r "copy('https://readouble.com/laravel/6.x/ja/install-ja-lang-files.php', 'install-ja-lang.php');"

インストールファイルの実行

$ php -f install-ja-lang.php

1	$ php -f install-ja-lang.php

インストールファイルの削除

$ php -r "unlink('install-ja-lang.php');"

1	$ php -r "unlink('install-ja-lang.php');"

これによりresources/lang/jaディレクトリーにauth.php、passwords.php、pagination.php、validation.phpの4つのファイルが生成される。

[vagrant@localhost laravel_tutorial]$ ls -Al resources/lang/ja/
合計 24
-rw-rw-r--. 1 vagrant vagrant   658  8月 24 23:09 auth.php
-rw-rw-r--. 1 vagrant vagrant   564  8月 24 23:09 pagination.php
-rw-rw-r--. 1 vagrant vagrant   844  8月 24 23:09 passwords.php
-rw-rw-r--. 1 vagrant vagrant 10490  8月 24 23:09 validation.php

[vagrant@localhost laravel_tutorial]$ ls -Al resources/lang/ja/

合計 24

-rw-rw-r--. 1 vagrant vagrant 658 8月 24 23:09 auth.php

-rw-rw-r--. 1 vagrant vagrant 564 8月 24 23:09 pagination.php

-rw-rw-r--. 1 vagrant vagrant 844 8月 24 23:09 passwords.php

-rw-rw-r--. 1 vagrant vagrant 10490 8月 24 23:09 validation.php

これでメッセージは日本語化されるが、まだ属性名は以下のようにソースコードで記述したまま。

nameは必ず指定してください。

handlenameは、10文字以下で指定してください。

emailに正しい形式を指定してください。

nameは必ず指定してください。

handlenameは、10文字以下で指定してください。

emailに正しい形式を指定してください。

属性名の日本語化

バリデーションエラーの属性名を日本語化するには、resources/lang/ja/validation.phpを編集する。

<?php

return [
    .....

    /*
    |--------------------------------------------------------------------------
    | カスタムバリデーション属性名
    |--------------------------------------------------------------------------
    |
    | 以下の言語行は、例えば"email"の代わりに「メールアドレス」のように、
    | 読み手にフレンドリーな表現でプレースホルダーを置き換えるために指定する
    | 言語行です。これはメッセージをよりきれいに表示するために役に立ちます。
    |
    */

    'attributes' => [],

];

<?php

return [

.....

|--------------------------------------------------------------------------

| カスタムバリデーション属性名

|--------------------------------------------------------------------------

| 以下の言語行は、例えば"email"の代わりに「メールアドレス」のように、

| 読み手にフレンドリーな表現でプレースホルダーを置き換えるために指定する

| 言語行です。これはメッセージをよりきれいに表示するために役に立ちます。

'attributes' => [],

];

たとえばname、handlename、emailを日本語化するには以下のように編集。

<?php

return [
    .....

    /*
    |--------------------------------------------------------------------------
    | カスタムバリデーション属性名
    |--------------------------------------------------------------------------
    |
    | 以下の言語行は、例えば"email"の代わりに「メールアドレス」のように、
    | 読み手にフレンドリーな表現でプレースホルダーを置き換えるために指定する
    | 言語行です。これはメッセージをよりきれいに表示するために役に立ちます。
    |
    */

    'attributes' => [
        'name' => '名前',
        'handlename' => 'ハンドルネーム',
        'email' => 'メールアドレス',
     ],

];

<?php

return [

.....

|--------------------------------------------------------------------------

| カスタムバリデーション属性名

|--------------------------------------------------------------------------

| 以下の言語行は、例えば"email"の代わりに「メールアドレス」のように、

| 読み手にフレンドリーな表現でプレースホルダーを置き換えるために指定する

| 言語行です。これはメッセージをよりきれいに表示するために役に立ちます。

'attributes' => [

'name' => '名前',

'handlename' => 'ハンドルネーム',

'email' => 'メールアドレス',

];

これにより、メッセージ表示は以下のように日本語化される。

名前は必ず指定してください。

ハンドルネームは、10文字以下で指定してください。

メールアドレスに正しい形式を指定してください。

名前は必ず指定してください。

ハンドルネームは、10文字以下で指定してください。

メールアドレスに正しい形式を指定してください。

Laravel – フォームリクエスト

2021-08-24 / tau / コメントする

概要

FormRequestクラスは、ユーザー権限の認証と入力のバリデーションを専用に扱う
実装は、artisanでFormRequestクラスを継承したクラスを生成し、認証やバリデーションの内容を記述
コントローラーのインジェクションをRequestからFormRequestの継承クラスに変更することで、チェック機能をコントローラーから分離することができる

準備

バリデーションで使ったアプリケーションを利用する。

ビュー

    <h1>{{ $title }}</h1>

    <form method="post">
      @csrf
      <p><input type="text" name="name" placeholder="ユーザー名"></p>
      <p><input type="text" name="handlename" placeholder="ハンドルネーム"></p>
      <p><input type="text" name="email" placeholder="メールアドレス"></p>
      <input type="submit" value="送信">
    </form>
    <hr>

    @foreach ($errors->all() as $error)
      <p>{{ $error }}</p>
    @endforeach

    @if (isset($user))
      <p>ユーザーネーム：{{ $user['name'] }}</p>
      <p>ハンドルネーム：{{ $user['handlename'] }}</p>
      <p>メールアドレス：{{ $user['email'] }}</p>
    @endif

<h1>{{ $title }}</h1>

@csrf

</form>

<hr>

@foreach ($errors->all() as $error)

<p>{{ $error }}</p>

@endforeach

@if (isset($user))

<p>ユーザーネーム：{{ $user['name'] }}</p>

<p>ハンドルネーム：{{ $user['handlename'] }}</p>

<p>メールアドレス：{{ $user['email'] }}</p>

@endif

コントローラーのアクション

  public function showValidation(Request $request) {
    $request->validate([
      'name' => ['required'],
      'handlename' => ['required', 'max:10'],
      'email' => ['required', 'regex:/^\w+@\w+$/'],
    ]);

    $user = [
      'name' => $request->input('name'),
      'handlename' => $request->input('handlename'),
      'email' => $request->input('email'),
    ];

    return view('samples.validation_example_form', [
      'title' => 'バリデーションサンプル結果',
      'user' => $user,
    ]);
  }

public function showValidation(Request $request) {

$request->validate([

'name' => ['required'],

'handlename' => ['required', 'max:10'],

'email' => ['required', 'regex:/^\w+@\w+$/'],

]);

$user = [

'name' => $request->input('name'),

'handlename' => $request->input('handlename'),

'email' => $request->input('email'),

];

return view('samples.validation_example_form', [

'title' => 'バリデーションサンプル結果',

'user' => $user,

]);

}

フォームリクエストクラスの生成

以下のコマンドでFormRequestを継承したクラスを作成する。

php artisan make:request リクエストクラス名

[vagrant@localhost laravel_tutorial]$ php artisan make:request RegistrationRequest
Request created successfully.

1 2	[vagrant@localhost laravel_tutorial]$ php artisan make:request RegistrationRequest Request created successfully.

リクエストクラスは、app/Http/Requestsディレクトリー下に作成される。

[vagrant@localhost laravel_tutorial]$ ls app/Http/Requests/
RegistrationRequest.php

1 2	[vagrant@localhost laravel_tutorial]$ ls app/Http/Requests/ RegistrationRequest.php

リクエストクラスの内容。ユーザー認証のためのauthorize()メソッドと、バリデーションのためのrules()メソッドが定義されている。

<?php

namespace App\Http\Requests;

use Illuminate\Foundation\Http\FormRequest;

class RegistrationRequest extends FormRequest
{
    /**
     * Determine if the user is authorized to make this request.
     *
     * @return bool
     */
    public function authorize()
    {
        return false;
    }

    /**
     * Get the validation rules that apply to the request.
     *
     * @return array
     */
    public function rules()
    {
        return [
            //
        ];
    }
}

<?php

namespace App\Http\Requests;

use Illuminate\Foundation\Http\FormRequest;

class RegistrationRequest extends FormRequest

{

/**

* Determine if the user is authorized to make this request.

* @return bool

public function authorize()

{

return false;

}

/**

* Get the validation rules that apply to the request.

* @return array

public function rules()

{

return [

];

}

アクションの引数の変更

コントローラーの先頭でリクエストクラスをuseでインポート
コントローラーのアクションのメソッドインジェクションをRequestからリクエストクラスに変更
validate()メソッドはアクションには書かない

今回の例の場合。

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;

// リクエストクラスのインポート
use App\Http\Requests\RegistrationRequest;

class ValidationExampleController extends Controller
{
  .....
  public function showValidation(RegistrationRequest $request) {
    // バリデーションの記述は不要

    $user = [
      'name' => $request->input('name'),
      'handlename' => $request->input('handlename'),
      'email' => $request->input('email'),
    ];

    return view('samples.validation_example_form', [
      'title' => 'バリデーションの結果',
      'user' => $user,
    ]);
  }
}

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;

// リクエストクラスのインポート

use App\Http\Requests\RegistrationRequest;

class ValidationExampleController extends Controller

{

.....

public function showValidation(RegistrationRequest $request) {

// バリデーションの記述は不要

$user = [

'name' => $request->input('name'),

'handlename' => $request->input('handlename'),

'email' => $request->input('email'),

];

return view('samples.validation_example_form', [

'title' => 'バリデーションの結果',

'user' => $user,

]);

}

ユーザー認証の記述

準備中。認証された場合はauthorize()メソッドの戻り値がtrue。

バリデーションルールの記述

rules()メソッドの戻り値の配列に、バリデーションルールを書く。

準備したコントローラーのバリデーション部分をリクエストクラスに記述。

<?php

namespace App\Http\Requests;

use Illuminate\Foundation\Http\FormRequest;

class RegistrationRequest extends FormRequest
{
    public function authorize()
    .....

    public function rules()
    {
        return [
          'name' => ['required'],
          'handlename' => ['required', 'max:10'],
          'email' => ['required', 'regex:/^\w+@\w+$/'],
        ];
    }
}

<?php

namespace App\Http\Requests;

use Illuminate\Foundation\Http\FormRequest;

class RegistrationRequest extends FormRequest

{

public function authorize()

.....

public function rules()

{

return [

'name' => ['required'],

'handlename' => ['required', 'max:10'],

'email' => ['required', 'regex:/^\w+@\w+$/'],

];

}

エラーメッセージのカスタマイズ

フォームリクエストのmessages()メソッドをオーバーライドすることで、メッセージのカスタマイズができる。

参考：Laravel 6.x バリデーション～エラーメッセージのカスタマイズ

Laravel – マスアサインメント

2021-08-24 / tau / コメントする

概要

マスアサインメントによって、フォームからPOSTされたパラメーターを一括してモデルの属性にセットして、データベースに書き込める
ただしセットできる属性をモデルの$fillable配列に限定列挙する必要がある
モデルのインスタンス生成時に、セットできるパラメーターをonlyメソッドで限定列挙できる
$fillableのほかに$guarded配列も指定できて、こちらは指定した属性をモデルのセットの際に排除する

準備

以下のようなフォームがあって、nameとcommentをPOSTする。

  <form method="post">
    @csrf
    <div><label>名前: <input type="text" name="name"></label></div>
    <div><label>コメント: <input type="text" name = "comment"></label></div>
    <input type="submit" value="投稿">
  </form>

@csrf

</form>

POSTはコントローラーのstore()メソッドにルーティングされる。

Route::post('/messages', 'MessageController@store');

1	Route::post('/messages', 'MessageController@store');

ルーティング先のコントローラーでは、モデルのインスタンスを生成し、その属性にPOSTされたパラメーターをセットしてデータベースに書き込む。

class MessageController extends Controller
{
  .....
  public function store(Request $request) {
    $message = new Message();
    $messsage->name = $request->name;
    $messsage->comment = $request->comment;
    $message->save();
    .....
  }
}

class MessageController extends Controller

{

.....

public function store(Request $request) {

$message = new Message();

$messsage->name = $request->name;

$messsage->comment = $request->comment;

$message->save();

.....

}

マスアサインメント

Requestのall()メソッド

Request引数のall()メソッドで得られる内容を確認。

class MessageController extends Controller
{
  .....
  public function store(Request $request) {
    dd($request->all());
    .....
  }
}

class MessageController extends Controller

{

.....

public function store(Request $request) {

dd($request->all());

.....

}

CSRF対策のトークンを含んだパラメーターの配列が得られる。

array:3 [▼
  "_token" => "DPci3aVibUshjdv5xGhllPZHvGgfdIUNh5iMniO9"
  "name" => "test"
  "comment" => "test comment"
]

array:3 [▼

"_token" => "DPci3aVibUshjdv5xGhllPZHvGgfdIUNh5iMniO9"

"name" => "test"

"comment" => "test comment"

]

$request->all()の結果を、モデルインスタンスのfill()メソッドによって属性にセット。dd()で内容を確認してみる。

class MessageController extends Controller
{
  .....
  public function store(Request $request) {
    $message = new Message();
    $message->fill($request->all());
    dd($message);
    .....
  }
}

class MessageController extends Controller

{

.....

public function store(Request $request) {

$message = new Message();

$message->fill($request->all());

dd($message);

.....

}

エラー。

マスアサインメントのためにはfillable属性に加えなければならないと言われる。

Illuminate\Database\Eloquent\MassAssignmentException
Add [_token] to fillable property to allow mass assignment on [App\Message].

1 2	Illuminate\Database\Eloquent\MassAssignmentException Add [_token] to fillable property to allow mass assignment on [App\Message].

モデルの$fillableプロパティー

モデルの定義で、$fillable配列に取得したいプロパティーを列挙する。

class Message extends Model
{
  protected $fillable = ['name', 'comment'];
}

class Message extends Model

{

protected $fillable = ['name', 'comment'];

}

先ほどのコードの実行結果。エラーがなくなる。dd()でプロパティーがセットされたインスタンスの内容を確認。

fillableプロパティーに2つのパラメーター名がセットされている
attributesに属性とその内容が配列としてセットされている
guardedは指定しておらず、サイズ1、内容'*'の配列となっている

App\Message {#323 ▼
  +fillable: array:2 [▼
    0 => "name"
    1 => "comment"
  ]
  .....
  #attributes: array:2 [▼
    "name" => "test"
    "comment" => "test comment"
  ]
  .....
  #guarded: array:1 [▼
    0 => "*"
  ]
}

App\Message {#323 ▼

+fillable: array:2 [▼

0 => "name"

1 => "comment"

]

.....

#attributes: array:2 [▼

"name" => "test"

"comment" => "test comment"

]

.....

#guarded: array:1 [▼

0 => "*"

]

}

以上を踏まえて、fillableがセットされたモデルのマスアサインメントとデータベース登録を以下に例示。

class MessageController extends Controller
{
  .....
  public function store(Request $request) {
    $message = new Message();
    $message->fill($request->all());
    $message->save();
    .....
  }
}

class MessageController extends Controller

{

.....

public function store(Request $request) {

$message = new Message();

$message->fill($request->all());

$message->save();

.....

}

マスアサインメントの記述方法

マスアサインメントの書き方には複数あって、同じ結果が得られる。create()スタティックメソッドは、インスタンスの生成とデータベースの書き込みを一つのメソッドで行う。

    $message = new Message();
    $message->fill($request->all());
    $message->save();
      または
    $message = new Message($request->all());
    $message->save();
      または
    $message = Message::create($request->all());

$message = new Message();

$message->fill($request->all());

$message->save();

または

$message = new Message($request->all());

$message->save();

または

$message = Message::create($request->all());

Requestのonly()メソッドによる限定

意図しないパラメーターの追加を避けるため、all()メソッドではなくonly()メソッドでパラメーターを限定列挙できる。

    $message = Message::create($request->only(['name', 'comment']));

1	$message = Message::create($request->only(['name', 'comment']));

Git/GitHub

2021-08-23 / tau / コメントする

Git

基本

コミット

ブランチ

リモート

GitHub

スタートアップ

操作

Laravel – tinker – モデルの操作

2021-08-23 / tau / コメントする

tinkerの起動

php artisan tinkerでtinkerを起動。

[vagrant@localhost laravel_tutorial]$ php artisan tinker
Psy Shell v0.10.8 (PHP 7.3.29 — cli) by Justin Hileman
>>>

[vagrant@localhost laravel_tutorial]$ php artisan tinker

Psy Shell v0.10.8 (PHP 7.3.29 — cli) by Justin Hileman

>>>

helpでコマンドが確認できる。

>>> help
  help             Show a list of commands. Type `help [foo]` for information about [foo].      Aliases: ?
  ls               List local, instance or class variables, methods and constants.              Aliases: dir
  dump             Dump an object or primitive.
  doc              Read the documentation for an object, class, constant, method or property.   Aliases: rtfm, man
  show             Show the code for an object, class, constant, method or property.
  wtf              Show the backtrace of the most recent exception.                             Aliases: last-exception,
  whereami         Show where you are in the code.
  throw-up         Throw an exception or error out of the Psy Shell.
  timeit           Profiles with a timer.
  trace            Show the current call stack.
  buffer           Show (or clear) the contents of the code input buffer.                       Aliases: buf
  clear            Clear the Psy Shell screen.
  edit             Open an external editor. Afterwards, get produced code in input buffer.
  sudo             Evaluate PHP code, bypassing visibility restrictions.
  history          Show the Psy Shell history.                                                  Aliases: hist
  exit             End the current session and return to caller.                                Aliases: quit, q
  clear-compiled   Remove the compiled class file
  down             Put the application into maintenance mode
  env              Display the current framework environment
  optimize         Cache the framework bootstrap files
  up               Bring the application out of maintenance mode
  migrate          Run the database migrations
  inspire          Display an inspiring quote

>>> help

help Show a list of commands. Type `help [foo]` for information about [foo]. Aliases: ?

ls List local, instance or class variables, methods and constants. Aliases: dir

dump Dump an object or primitive.

doc Read the documentation for an object, class, constant, method or property. Aliases: rtfm, man

show Show the code for an object, class, constant, method or property.

wtf Show the backtrace of the most recent exception. Aliases: last-exception,

whereami Show where you are in the code.

throw-up Throw an exception or error out of the Psy Shell.

timeit Profiles with a timer.

trace Show the current call stack.

buffer Show (or clear) the contents of the code input buffer. Aliases: buf

clear Clear the Psy Shell screen.

edit Open an external editor. Afterwards, get produced code in input buffer.

sudo Evaluate PHP code, bypassing visibility restrictions.

history Show the Psy Shell history. Aliases: hist

exit End the current session and return to caller. Aliases: quit, q

clear-compiled Remove the compiled class file

down Put the application into maintenance mode

env Display the current framework environment

optimize Cache the framework bootstrap files

up Bring the application out of maintenance mode

migrate Run the database migrations

inspire Display an inspiring quote

モデル・データベースの操作

データの登録

モデルとマイグレーションで作成したモデルを使う。

まずshowコマンドでモデルクラスを見てみる。

>>> show TestModel
[!] Aliasing 'TestModel' to 'App\TestModel' for this Tinker session.
 7: class TestModel extends Model
 8: {
 9:     //
10: }

>>> show TestModel

[!] Aliasing 'TestModel' to 'App\TestModel' for this Tinker session.

7: class TestModel extends Model

8: {

9: //

10: }

変数$modelにTestModelクラスのインスタンスを生成。

>>> $model = new App\TestModel();
=> App\TestModel {#3370}

1 2	>>> $model = new App\TestModel(); => App\TestModel {#3370}

マイグレーションファイルで定義したフィールド(product_name、amount)に値を代入。

>>> $model->product_name = 'wire';
=> "wire"
>>> $model->amount = 100;
=> 10

>>> $model->product_name = 'wire';

=> "wire"

>>> $model->amount = 100;

=> 10

変数を入力すると、その内容が確認できる。

>>> $model;
=> App\TestModel {#3370
     product_name: "wire",
     amount: 100,
   }

>>> $model;

=> App\TestModel {#3370

product_name: "wire",

amount: 100,

}

lsで定義された変数を、ls -lでそれらを少し詳しく見ることができる。

>>> ls
Variables: $model
>>> ls -l

Variables:
  $model   App\TestModel {#3370 …5}

>>> ls

Variables: $model

>>> ls -l

Variables:

$model App\TestModel {#3370 …5}

変数の内容をデータベースに保存するステートメントを実行。

>>> $model->save();
=> true

1 2	>>> $model->save(); => true

データベース側で確認すると、日付もちゃんと登録されている。

mysql> SELECT * FROM test_models;
+----+--------------+--------+---------------------+---------------------+
| id | product_name | amount | created_at          | updated_at          |
+----+--------------+--------+---------------------+---------------------+
|  1 | wire         |    100 | 2021-08-23 14:33:27 | 2021-08-23 14:33:27 |
+----+--------------+--------+---------------------+---------------------+
1 row in set (0.00 sec)

mysql> SELECT * FROM test_models;

+----+--------------+--------+---------------------+---------------------+

+----+--------------+--------+---------------------+---------------------+

| 1 | wire | 100 | 2021-08-23 14:33:27 | 2021-08-23 14:33:27 |

+----+--------------+--------+---------------------+---------------------+

1 row in set (0.00 sec)

さらに2つのデータを登録。

>>> $model->product_name = 'steel plate';
=> "steel plate"
>>> $model->amount = 50;
=> 50
>>> $model->save();
=> true
>>> $model = new App\TestModel();
=> App\TestModel {#4110}
>>> $model->product_name = 'screws';
=> "screws"
>>> $model->amount = 150;
=> 150
>>> $model->save();
=> true

>>> $model->product_name = 'steel plate';

=> "steel plate"

>>> $model->amount = 50;

=> 50

>>> $model->save();

=> true

>>> $model = new App\TestModel();

=> App\TestModel {#4110}

>>> $model->product_name = 'screws';

=> "screws"

>>> $model->amount = 150;

=> 150

>>> $model->save();

=> true

データベース側でも登録されているのが確認できる。

mysql> SELECT * FROM test_models;
+----+--------------+--------+---------------------+---------------------+
| id | product_name | amount | created_at          | updated_at          |
+----+--------------+--------+---------------------+---------------------+
|  1 | wire         |    100 | 2021-08-23 14:33:27 | 2021-08-23 14:33:27 |
|  2 | steel plate  |     50 | 2021-08-23 14:51:02 | 2021-08-23 14:51:02 |
|  3 | screws       |    150 | 2021-08-23 14:53:44 | 2021-08-23 14:53:44 |
+----+--------------+--------+---------------------+---------------------+
3 rows in set (0.00 sec)

mysql> SELECT * FROM test_models;

+----+--------------+--------+---------------------+---------------------+

+----+--------------+--------+---------------------+---------------------+

| 1 | wire | 100 | 2021-08-23 14:33:27 | 2021-08-23 14:33:27 |

| 2 | steel plate | 50 | 2021-08-23 14:51:02 | 2021-08-23 14:51:02 |

| 3 | screws | 150 | 2021-08-23 14:53:44 | 2021-08-23 14:53:44 |

+----+--------------+--------+---------------------+---------------------+

3 rows in set (0.00 sec)

全データ取得

tinkerで変数$modelsにデータベースの全データを取得。

>>> $models = App\TestModel::all();
=> Illuminate\Database\Eloquent\Collection {#4327
     all: [
       App\TestModel {#4328
         id: 1,
         product_name: "wire",
         amount: 100,
         created_at: "2021-08-23 14:33:27",
         updated_at: "2021-08-23 14:33:27",
       },
       App\TestModel {#4329
         id: 2,
         product_name: "steel plate",
         amount: 50,
         created_at: "2021-08-23 14:51:02",
         updated_at: "2021-08-23 14:52:53",
       },
       App\TestModel {#4330
         id: 3,
         product_name: "screws",
         amount: 150,
         created_at: "2021-08-23 14:53:44",
         updated_at: "2021-08-23 14:53:44",
       },
     ],
   }

>>> $models = App\TestModel::all();

=> Illuminate\Database\Eloquent\Collection {#4327

all: [

App\TestModel {#4328

id: 1,

product_name: "wire",

amount: 100,

created_at: "2021-08-23 14:33:27",

updated_at: "2021-08-23 14:33:27",

App\TestModel {#4329

id: 2,

product_name: "steel plate",

amount: 50,

created_at: "2021-08-23 14:51:02",

updated_at: "2021-08-23 14:52:53",

App\TestModel {#4330

id: 3,

product_name: "screws",

amount: 150,

created_at: "2021-08-23 14:53:44",

updated_at: "2021-08-23 14:53:44",

}

$modelsは配列で要素はゼロから始まるので、$models[1]は2番目のデータ。

>>> $models[1];
=> App\TestModel {#4329
     id: 2,
     product_name: "steel plate",
     amount: 50,
     created_at: "2021-08-23 14:51:02",
     updated_at: "2021-08-23 14:51:02",
   }

>>> $models[1];

=> App\TestModel {#4329

id: 2,

product_name: "steel plate",

amount: 50,

created_at: "2021-08-23 14:51:02",

updated_at: "2021-08-23 14:51:02",

}

データの更新

スタティック関数find()でid=2のデータを$modelに取得。

>>> $model = App\TestModel::find(2);
=> App\TestModel {#4073
     id: 2,
     product_name: "steel plate",
     amount: 50,
     created_at: "2021-08-23 14:51:02",
     updated_at: "2021-08-23 14:52:53",
   }

>>> $model = App\TestModel::find(2);

=> App\TestModel {#4073

id: 2,

product_name: "steel plate",

amount: 50,

created_at: "2021-08-23 14:51:02",

updated_at: "2021-08-23 14:52:53",

}

取得したid=2のデータのamountを0に変更して保存。

>>> $model->amount = 0;
=> 0
>>> $model->save();
=> true

>>> $model->amount = 0;

=> 0

>>> $model->save();

=> true

データが更新されているのを確認。

>>> App\TestModel::find(2);
=> App\TestModel {#4332
     id: 2,
     product_name: "steel plate",
     amount: 0,
     created_at: "2021-08-23 14:51:02",
     updated_at: "2021-08-23 15:01:36",
   }

>>> App\TestModel::find(2);

=> App\TestModel {#4332

id: 2,

product_name: "steel plate",

amount: 0,

created_at: "2021-08-23 14:51:02",

updated_at: "2021-08-23 15:01:36",

}

データベースでも確認できる。

mysql> SELECT * FROM test_models;
+----+--------------+--------+---------------------+---------------------+
| id | product_name | amount | created_at          | updated_at          |
+----+--------------+--------+---------------------+---------------------+
|  1 | wire         |    100 | 2021-08-23 14:33:27 | 2021-08-23 14:33:27 |
|  2 | steel plate  |      0 | 2021-08-23 14:51:02 | 2021-08-23 15:01:36 |
|  3 | screws       |    150 | 2021-08-23 14:53:44 | 2021-08-23 14:53:44 |
+----+--------------+--------+---------------------+---------------------+
3 rows in set (0.00 sec)

mysql> SELECT * FROM test_models;

+----+--------------+--------+---------------------+---------------------+

+----+--------------+--------+---------------------+---------------------+

| 1 | wire | 100 | 2021-08-23 14:33:27 | 2021-08-23 14:33:27 |

| 2 | steel plate | 0 | 2021-08-23 14:51:02 | 2021-08-23 15:01:36 |

| 3 | screws | 150 | 2021-08-23 14:53:44 | 2021-08-23 14:53:44 |

+----+--------------+--------+---------------------+---------------------+

3 rows in set (0.00 sec)

データの削除

id=2のデータを取得。

>>> $model = App\TestModel::find(2);
=> App\TestModel {#4267
     id: 2,
     product_name: "steel plate",
     amount: 0,
     created_at: "2021-08-23 14:51:02",
     updated_at: "2021-08-23 15:01:36",
   }

>>> $model = App\TestModel::find(2);

=> App\TestModel {#4267

id: 2,

product_name: "steel plate",

amount: 0,

created_at: "2021-08-23 14:51:02",

updated_at: "2021-08-23 15:01:36",

}

delete()メソッドでデータベースから削除。

>>> $model->delete();
=> true

1 2	>>> $model->delete(); => true

全データを取得すると、id=2のデータが削除されている。

>>> App\TestModel::all();
=> Illuminate\Database\Eloquent\Collection {#4336
     all: [
       App\TestModel {#4338
         id: 1,
         product_name: "wire",
         amount: 100,
         created_at: "2021-08-23 14:33:27",
         updated_at: "2021-08-23 14:33:27",
       },
       App\TestModel {#4339
         id: 3,
         product_name: "screws",
         amount: 100,
         created_at: "2021-08-23 14:53:44",
         updated_at: "2021-08-23 14:58:51",
       },
     ],
   }

>>> App\TestModel::all();

=> Illuminate\Database\Eloquent\Collection {#4336

all: [

App\TestModel {#4338

id: 1,

product_name: "wire",

amount: 100,

created_at: "2021-08-23 14:33:27",

updated_at: "2021-08-23 14:33:27",

App\TestModel {#4339

id: 3,

product_name: "screws",

amount: 100,

created_at: "2021-08-23 14:53:44",

updated_at: "2021-08-23 14:58:51",

}

データベース側でも確認できる。

mysql> SELECT * FROM test_models;
+----+--------------+--------+---------------------+---------------------+
| id | product_name | amount | created_at          | updated_at          |
+----+--------------+--------+---------------------+---------------------+
|  1 | wire         |    100 | 2021-08-23 14:33:27 | 2021-08-23 14:33:27 |
|  3 | screws       |    150 | 2021-08-23 14:53:44 | 2021-08-23 14:53:44 |
+----+--------------+--------+---------------------+---------------------+
2 rows in set (0.00 sec)

mysql> SELECT * FROM test_models;

+----+--------------+--------+---------------------+---------------------+

+----+--------------+--------+---------------------+---------------------+

| 1 | wire | 100 | 2021-08-23 14:33:27 | 2021-08-23 14:33:27 |

| 3 | screws | 150 | 2021-08-23 14:53:44 | 2021-08-23 14:53:44 |

+----+--------------+--------+---------------------+---------------------+

2 rows in set (0.00 sec)

Laravel – モデル作成とマイグレーション

2021-08-23 / tau / コメントする

データベース設定の確認

アプリケーションディレクトリー直下の.envファイルでデータベースの設定を確認する。DB_DATABASEに設定されたデータベースが作成済みでRDBMSでアクセス可能であることを確認する。

[vagrant@localhost laravel_tutorial]$ cat .env
.....

DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=laravel_test←データベース名
DB_USERNAME=root
DB_PASSWORD=パスワード

.....

[vagrant@localhost laravel_tutorial]$ cat .env

.....

DB_CONNECTION=mysql

DB_HOST=127.0.0.1

DB_PORT=3306

DB_DATABASE=laravel_test←データベース名

DB_USERNAME=root

DB_PASSWORD=パスワード

.....

モデルの作成

モデル作成コマンド

モデルの作成には、artisanのmake:modelコマンドを使う。同時にデータベースを定義するマイグレーションファイルも作成するときは--migrationオプションを付ける。

php artisan make:model モデル名 --migration

モデル名の考え方は以下の通り。

データベースのレコードに保存する対象として、単数の名詞とする
モデル名はアッパー・キャメルケース(パスカルケース)で定義する

以下はTestModelというモデルを作成したケース。

[vagrant@localhost laravel_tutorial]$ php artisan make:model TestModel --migration
Model created successfully.
Created Migration: 2021_08_23_093211_create_test_models_table

[vagrant@localhost laravel_tutorial]$ php artisan make:model TestModel --migration

Model created successfully.

Created Migration: 2021_08_23_093211_create_test_models_table

モデルの作成に成功したことと、2021_08_23…という名前でマイグレーションファイルが作成されたことが表示されている。

マイグレーションファイルの作成は--migrationオプションを付けたためで、これをつけないとモデルのだけが作成される。

モデルクラスファイル

モデルのクラスファイルはappディレクトリー下に作成される。コマンドで指定したモデル名に拡張子.phpが付けられている。

[vagrant@localhost laravel_tutorial]$ ls -Al app
合計 8
drwxrwxr-x. 2 vagrant vagrant  24  8月 15 23:38 Console
drwxrwxr-x. 2 vagrant vagrant  25  8月 15 23:38 Exceptions
drwxrwxr-x. 4 vagrant vagrant  61  8月 15 23:38 Http
drwxrwxr-x. 2 vagrant vagrant 167  8月 15 23:38 Providers
-rw-rw-r--. 1 vagrant vagrant 105  8月 23 09:32 TestModel.php
-rw-rw-r--. 1 vagrant vagrant 734  8月 15 23:38 User.php

[vagrant@localhost laravel_tutorial]$ ls -Al app

合計 8

drwxrwxr-x. 2 vagrant vagrant 24 8月 15 23:38 Console

drwxrwxr-x. 2 vagrant vagrant 25 8月 15 23:38 Exceptions

drwxrwxr-x. 4 vagrant vagrant 61 8月 15 23:38 Http

drwxrwxr-x. 2 vagrant vagrant 167 8月 15 23:38 Providers

-rw-rw-r--. 1 vagrant vagrant 105 8月 23 09:32 TestModel.php

-rw-rw-r--. 1 vagrant vagrant 734 8月 15 23:38 User.php

以下がモデルクラスファイルの内容。

名前空間をAppとしている
名前空間Illuminate\Database\EloquentのModelファイルを利用する
ModelファイルはModelクラスのファイル
今回作成したTestModelクラスはModelクラスを継承している
モデル作成で定義した名前がそのままクラス名になっている
作成したクラスの中身は空

[vagrant@localhost laravel_tutorial]$ cat app/TestModel.php
<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class TestModel extends Model
{
    //
}

[vagrant@localhost laravel_tutorial]$ cat app/TestModel.php

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class TestModel extends Model

{

}

オプション指定

モデル作成コマンドのオプションは-h/--helpオプションで指定できる。

php artisan make:model --help

1	php artisan make:model --help

主なオプションは以下の通り。

-c/--controller: コントローラーを作成する。
-m/--migration: マイグレーションファイルを作成する。
-r/--resource: リソースベースのアクションが含まれたコントローラーが生成される。ルーティングでのonly、exceptと関係なく、すべてのアクションが含まれる。
-s/--seed: シーダーファイルを作成する。

マイグレーションファイル

ファイル名

モデルクラスファイルと同時に作成されたマイグレーションファイルは、database/migrations下にある。新たに作成された2021_08_23...のマイグレーションファイルが確認できる。

マイグレーションファイルのファイル名構成は以下の通り。

日付_時刻_create_テーブル名_table.php

テーブル名はモデル名をスネークケースに変更し、複数形となっている。

[vagrant@localhost laravel_tutorial]$ ls -Al database/migrations/
合計 16
-rw-rw-r--. 1 vagrant vagrant 813  8月 15 23:38 2014_10_12_000000_create_users_table.php
-rw-rw-r--. 1 vagrant vagrant 683  8月 15 23:38 2014_10_12_100000_create_password_resets_table.php
-rw-rw-r--. 1 vagrant vagrant 789  8月 15 23:38 2019_08_19_000000_create_failed_jobs_table.php
-rw-rw-r--. 1 vagrant vagrant 606  8月 23 09:32 2021_08_23_093211_create_test_models_table.php

[vagrant@localhost laravel_tutorial]$ ls -Al database/migrations/

合計 16

-rw-rw-r--. 1 vagrant vagrant 813 8月 15 23:38 2014_10_12_000000_create_users_table.php

-rw-rw-r--. 1 vagrant vagrant 683 8月 15 23:38 2014_10_12_100000_create_password_resets_table.php

-rw-rw-r--. 1 vagrant vagrant 789 8月 15 23:38 2019_08_19_000000_create_failed_jobs_table.php

-rw-rw-r--. 1 vagrant vagrant 606 8月 23 09:32 2021_08_23_093211_create_test_models_table.php

マイグレーションファイルの内容は以下の通り。

up()メソッド

up()メソッドではテーブルを作成するときのカラム定義が記述されている。

bigincrements()はbigint unsigned型、AUTO_INCREMENT設定のカラムidを定義
timestamps()はtimestamp型でcreated_atとupdated_atの2つのカラムを定義

bigIncrements()によるIDを外部キーで参照する場合

bigIncrements()で生成されるカラムはbigint(unsigned)となる。他テーブルでこれを外部キーとして参照する場合のカラム型はbigint unsignedとする。マイグレーションファイルで指定する場合はunsignedBigInteger()とする。

down()メソッド

down()メソッドは、test_modelsテーブルが存在する場合にこれを削除(DROP)。

[vagrant@localhost laravel_tutorial]$ cat database/migrations/2021_08_23_093211_create_test_models_table.php
<?php

use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;

class CreateTestModelsTable extends Migration
{
    /**
     * Run the migrations.
     *
     * @return void
     */
    public function up()
    {
        Schema::create('test_models', function (Blueprint $table) {
            $table->bigIncrements('id');
            $table->timestamps();
        });
    }

    /**
     * Reverse the migrations.
     *
     * @return void
     */
    public function down()
    {
        Schema::dropIfExists('test_models');
    }
}

[vagrant@localhost laravel_tutorial]$ cat database/migrations/2021_08_23_093211_create_test_models_table.php

<?php

use Illuminate\Database\Migrations\Migration;

use Illuminate\Database\Schema\Blueprint;

use Illuminate\Support\Facades\Schema;

class CreateTestModelsTable extends Migration

{

/**

* Run the migrations.

* @return void

public function up()

{

Schema::create('test_models', function (Blueprint $table) {

$table->bigIncrements('id');

$table->timestamps();

});

}

/**

* Reverse the migrations.

* @return void

public function down()

{

Schema::dropIfExists('test_models');

}

マイグレーション実行

マイグレーションコマンドについてはこちらを参照。

状態確認

マイグレーション実行前のテーブルの状態。準備の時に作成したままになっている。

mysql> SHOW TABLES;
+------------------------+
| Tables_in_laravel_test |
+------------------------+
| failed_jobs            |
| migrations             |
| password_resets        |
| users                  |
+------------------------+
5 rows in set (0.00 sec)

mysql> SHOW TABLES;

+------------------------+

| Tables_in_laravel_test |

+------------------------+

| failed_jobs |

| migrations |

| password_resets |

| users |

+------------------------+

5 rows in set (0.00 sec)

マイグレーションの実行状態は以下のコマンドで確認。

php artisan migrate:status

今回作成されたマイグレーションファイルだけが未実行となっている。

[vagrant@localhost laravel_tutorial]$ php artisan migrate:status
+------+------------------------------------------------+-------+
| Ran? | Migration                                      | Batch |
+------+------------------------------------------------+-------+
| Yes  | 2014_10_12_000000_create_users_table           | 1     |
| Yes  | 2014_10_12_100000_create_password_resets_table | 1     |
| Yes  | 2019_08_19_000000_create_failed_jobs_table     | 1     |
| No   | 2021_08_23_093211_create_test_models_table     |       |
+------+------------------------------------------------+-------+

[vagrant@localhost laravel_tutorial]$ php artisan migrate:status

+------+------------------------------------------------+-------+

| Ran? | Migration | Batch |

+------+------------------------------------------------+-------+

| Yes | 2014_10_12_000000_create_users_table | 1 |

| Yes | 2014_10_12_100000_create_password_resets_table | 1 |

| Yes | 2019_08_19_000000_create_failed_jobs_table | 1 |

| No | 2021_08_23_093211_create_test_models_table | |

+------+------------------------------------------------+-------+

マイグレート

以下のコマンドで、マイグレーションファイルの設定に従ってテーブルを作成する。

php artisan migrate

[vagrant@localhost laravel_tutorial]$ php artisan migrate
Migrating: 2021_08_23_093211_create_test_models_table
Migrated:  2021_08_23_093211_create_test_models_table (0.02 seconds)

[vagrant@localhost laravel_tutorial]$ php artisan migrate

Migrating: 2021_08_23_093211_create_test_models_table

Migrated: 2021_08_23_093211_create_test_models_table (0.02 seconds)

マイグレーションの結果、データベースにテーブルが作成される。テーブル名はマイグレーションファイル名にもあるとおりで、以下のように付けられる。

モデル名のキャメルケースをスネークケースに変更
複数形にする

[vagrant@localhost laravel_tutorial]$ php artisan migrate:status
+------+------------------------------------------------+-------+
| Ran? | Migration                                      | Batch |
+------+------------------------------------------------+-------+
| Yes  | 2014_10_12_000000_create_users_table           | 1     |
| Yes  | 2014_10_12_100000_create_password_resets_table | 1     |
| Yes  | 2019_08_19_000000_create_failed_jobs_table     | 1     |
| Yes  | 2021_08_23_093211_create_test_models_table     | 2     |
+------+------------------------------------------------+-------+

[vagrant@localhost laravel_tutorial]$ php artisan migrate:status

+------+------------------------------------------------+-------+

| Ran? | Migration | Batch |

+------+------------------------------------------------+-------+

| Yes | 2014_10_12_000000_create_users_table | 1 |

| Yes | 2014_10_12_100000_create_password_resets_table | 1 |

| Yes | 2019_08_19_000000_create_failed_jobs_table | 1 |

| Yes | 2021_08_23_093211_create_test_models_table | 2 |

+------+------------------------------------------------+-------+

データベースでテーブルが作成されていることを確認。

mysql> SHOW TABLES;
+------------------------+
| Tables_in_laravel_test |
+------------------------+
| failed_jobs            |
| migrations             |
| password_resets        |
| test_models            |
| users                  |
+------------------------+
5 rows in set (0.00 sec)

mysql> SHOW TABLES;

+------------------------+

| Tables_in_laravel_test |

+------------------------+

| failed_jobs |

| migrations |

| password_resets |

| test_models |

| users |

+------------------------+

5 rows in set (0.00 sec)

テーブル構造を確認。timestamp()によって、created_atとupdated_atの2つのカラムが作られている。

ただしtimestamp型は2038年問題が発生するため、datetime型に変更する方がよい。

mysql> DESCRIBE test_models;
+------------+-----------------+------+-----+---------+----------------+
| Field      | Type            | Null | Key | Default | Extra          |
+------------+-----------------+------+-----+---------+----------------+
| id         | bigint unsigned | NO   | PRI | NULL    | auto_increment |
| created_at | timestamp       | YES  |     | NULL    |                |
| updated_at | timestamp       | YES  |     | NULL    |                |
+------------+-----------------+------+-----+---------+----------------+
3 rows in set (0.00 sec)

mysql> DESCRIBE test_models;

+------------+-----------------+------+-----+---------+----------------+

+------------+-----------------+------+-----+---------+----------------+

| id | bigint unsigned | NO | PRI | NULL | auto_increment |

+------------+-----------------+------+-----+---------+----------------+

3 rows in set (0.00 sec)

ロールバック

ロールバックにより、作成したテーブルを削除してマイグレーション前の状態に戻すことができる。

php artisan migrate:rollback

[vagrant@localhost laravel_tutorial]$ php artisan migrate:rollback
Rolling back: 2021_08_23_093211_create_test_models_table
Rolled back:  2021_08_23_093211_create_test_models_table (0.01 seconds)

[vagrant@localhost laravel_tutorial]$ php artisan migrate:rollback

Rolling back: 2021_08_23_093211_create_test_models_table

Rolled back: 2021_08_23_093211_create_test_models_table (0.01 seconds)

ロールバックを実行することで、ここまでで作成したtest_modelsテーブルが削除される。

mysql> SHOW TABLES;
+------------------------+
| Tables_in_laravel_test |
+------------------------+
| failed_jobs            |
| migrations             |
| password_resets        |
| users                  |
+------------------------+
4 rows in set (0.00 sec)

mysql> SHOW TABLES;

+------------------------+

| Tables_in_laravel_test |

+------------------------+

| failed_jobs |

| migrations |

| password_resets |

| users |

+------------------------+

4 rows in set (0.00 sec)

ただしマイグレーションファイルは残っていて、編集などを行った後に再度マイグレーションできる。

[vagrant@localhost laravel_tutorial]$ ls -Al database/migrations/
合計 16
-rw-rw-r--. 1 vagrant vagrant 813  8月 15 23:38 2014_10_12_000000_create_users_table.php
-rw-rw-r--. 1 vagrant vagrant 683  8月 15 23:38 2014_10_12_100000_create_password_resets_table.php
-rw-rw-r--. 1 vagrant vagrant 789  8月 15 23:38 2019_08_19_000000_create_failed_jobs_table.php
-rw-rw-r--. 1 vagrant vagrant 606  8月 23 09:32 2021_08_23_093211_create_test_models_table.php

[vagrant@localhost laravel_tutorial]$ ls -Al database/migrations/

合計 16

-rw-rw-r--. 1 vagrant vagrant 813 8月 15 23:38 2014_10_12_000000_create_users_table.php

-rw-rw-r--. 1 vagrant vagrant 683 8月 15 23:38 2014_10_12_100000_create_password_resets_table.php

-rw-rw-r--. 1 vagrant vagrant 789 8月 15 23:38 2019_08_19_000000_create_failed_jobs_table.php

-rw-rw-r--. 1 vagrant vagrant 606 8月 23 09:32 2021_08_23_093211_create_test_models_table.php

マイグレーションファイルの実行状態も未実行に戻る。

[vagrant@localhost laravel_tutorial]$ php artisan migrate:status
+------+------------------------------------------------+-------+
| Ran? | Migration                                      | Batch |
+------+------------------------------------------------+-------+
| Yes  | 2014_10_12_000000_create_users_table           | 1     |
| Yes  | 2014_10_12_100000_create_password_resets_table | 1     |
| Yes  | 2019_08_19_000000_create_failed_jobs_table     | 1     |
| No   | 2021_08_23_093211_create_test_models_table     |       |
+------+------------------------------------------------+-------+

[vagrant@localhost laravel_tutorial]$ php artisan migrate:status

+------+------------------------------------------------+-------+

| Ran? | Migration | Batch |

+------+------------------------------------------------+-------+

| Yes | 2014_10_12_000000_create_users_table | 1 |

| Yes | 2014_10_12_100000_create_password_resets_table | 1 |

| Yes | 2019_08_19_000000_create_failed_jobs_table | 1 |

| No | 2021_08_23_093211_create_test_models_table | |

+------+------------------------------------------------+-------+

マイグレーションファイルの編集とマイグレーション

test_modelsテーブルのカラムを以下のように編集する。

idカラムはそのまま
VARCHAR(20)でproduct_nameカラムを追加
int型でamountカラムを追加
created_atとupdated_atをtimestamp型からdatetime型に変更

参考：利用可能なカラムタイプ

マイグレーション前のファイルを以下のように編集してマイグレート。

[vagrant@localhost laravel_tutorial]$ cat database/migrations/2021_08_23_093211_create_test_models_table.php
<?php

use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;

class CreateTestModelsTable extends Migration
{
    /**
     * Run the migrations.
     *
     * @return void
     */
    public function up()
    {
        Schema::create('test_models', function (Blueprint $table) {
            $table->bigIncrements('id');
            $table->string('product_name', 20);
            $table->integer('amount');
            $table->datetime('created_at');
            $table->datetime('updated_at');
        });
    }

    /**
     * Reverse the migrations.
     *
     * @return void
     */
    public function down()
    {
        Schema::dropIfExists('test_models');
    }
}

[vagrant@localhost laravel_tutorial]$ cat database/migrations/2021_08_23_093211_create_test_models_table.php

<?php

use Illuminate\Database\Migrations\Migration;

use Illuminate\Database\Schema\Blueprint;

use Illuminate\Support\Facades\Schema;

class CreateTestModelsTable extends Migration

{

/**

* Run the migrations.

* @return void

public function up()

{

Schema::create('test_models', function (Blueprint $table) {

$table->bigIncrements('id');

$table->string('product_name', 20);

$table->integer('amount');

$table->datetime('created_at');

$table->datetime('updated_at');

});

}

/**

* Reverse the migrations.

* @return void

public function down()

{

Schema::dropIfExists('test_models');

}

以下の構造のテーブルが作成される。

mysql> DESCRIBE test_models;
+--------------+-----------------+------+-----+---------+----------------+
| Field        | Type            | Null | Key | Default | Extra          |
+--------------+-----------------+------+-----+---------+----------------+
| id           | bigint unsigned | NO   | PRI | NULL    | auto_increment |
| product_name | varchar(20)     | NO   |     | NULL    |                |
| amount       | int             | NO   |     | NULL    |                |
| created_at   | datetime        | NO   |     | NULL    |                |
| updated_at   | datetime        | NO   |     | NULL    |                |
+--------------+-----------------+------+-----+---------+----------------+
5 rows in set (0.00 sec)

mysql> DESCRIBE test_models;

+--------------+-----------------+------+-----+---------+----------------+

+--------------+-----------------+------+-----+---------+----------------+

| id | bigint unsigned | NO | PRI | NULL | auto_increment |

| amount | int | NO | | NULL | |

+--------------+-----------------+------+-----+---------+----------------+

5 rows in set (0.00 sec)

モデルの削除

モデルとテーブルを削除する手順は以下の通り。

該当テーブルのマイグレーションの前までロールバック
マイグレーションファイル削除
モデルファイル削除

timestampの2038年問題について

モデルとマイグレーションファイルを生成させると、自動的にtimestampsが設定されるが、MySQLとの組み合わせの場合に2038年問題が発生する。datetime型で書きなおすなどの対応をしておくべき。

モデル名とテーブル名について

モデルとテーブルを生成するときの命名の流れは以下のようになっている。

モデル名は単数形でアッパーキャメルケース
モデルクラスファイル名はモデル名に.phpの拡張子
モデルクラス名はモデル名と同じ
テーブル名はキャメルケースからスネークケースに変換され、複数形になる

複数形への変更はLaravelがエレガントにやってくれて、不規則な複数形にも対応している。ただし不可算名詞にはそのままsが付くようだ。

TestModel→test_models
TestDiary→test_diaries
CompanyPerson→CompanyPeople
WildGoos→WildGees
StockWater→StockWaters

なお、敢えてモデル名をスネークケースにすると、クラスファイル名、モデルクラス名もキャメルケースのままで、テーブル名は複数形になる。

test_model→test_models

MySQL – 並べ替え～ORDER BY

2021-08-22 / tau / コメントする

準備

以下のテーブルで確認する。

mysql> SELECT * FROM test_order;
+------+------+
| num1 | num2 |
+------+------+
|    1 |   10 |
|    1 |   20 |
|    1 |   30 |
|    2 |   10 |
|    2 |   20 |
|    2 |   30 |
|    3 |   10 |
|    3 |   20 |
|    3 |   30 |
+------+------+
9 rows in set (0.00 sec)

mysql> SELECT * FROM test_order;

+------+------+

| num1 | num2 |

+------+------+

| 1 | 10 |

| 1 | 20 |

| 1 | 30 |

| 2 | 10 |

| 2 | 20 |

| 2 | 30 |

| 3 | 10 |

| 3 | 20 |

| 3 | 30 |

+------+------+

9 rows in set (0.00 sec)

指定方法

ORDER BYで指定したカラムをキーにして並べ替える。デフォルトは昇順でASCを指定したのと同じ。

SELECT カラム群 FROM テーブル ORDER BY カラム [ASC/DESC];

以下の例では、2つ目のnum2で昇順にソートしている。

mysql> SELECT * FROM test_order ORDER BY num2;
+------+------+
| num1 | num2 |
+------+------+
|    1 |   10 |
|    2 |   10 |
|    3 |   10 |
|    1 |   20 |
|    2 |   20 |
|    3 |   20 |
|    1 |   30 |
|    2 |   30 |
|    3 |   30 |
+------+------+
9 rows in set (0.00 sec)

mysql> SELECT * FROM test_order ORDER BY num2;

+------+------+

| num1 | num2 |

+------+------+

| 1 | 10 |

| 2 | 10 |

| 3 | 10 |

| 1 | 20 |

| 2 | 20 |

| 3 | 20 |

| 1 | 30 |

| 2 | 30 |

| 3 | 30 |

+------+------+

9 rows in set (0.00 sec)

降順でソートする場合はDESCを指定。以下はnum2カラムの内容で降順にソートしている。

mysql> SELECT * FROM test_order ORDER BY num2 DESC;
+------+------+
| num1 | num2 |
+------+------+
|    1 |   30 |
|    2 |   30 |
|    3 |   30 |
|    1 |   20 |
|    2 |   20 |
|    3 |   20 |
|    1 |   10 |
|    2 |   10 |
|    3 |   10 |
+------+------+
9 rows in set (0.00 sec)

mysql> SELECT * FROM test_order ORDER BY num2 DESC;

+------+------+

| num1 | num2 |

+------+------+

| 1 | 30 |

| 2 | 30 |

| 3 | 30 |

| 1 | 20 |

| 2 | 20 |

| 3 | 20 |

| 1 | 10 |

| 2 | 10 |

| 3 | 10 |

+------+------+

9 rows in set (0.00 sec)

複数カラムでのソート

ORDER BYで複数カラムを指定すると、指定したカラムの順でネストの外側のようにしてソートする。

以下の例では、num1で降順ソートし、その中でnum2で降順ソートしている。

mysql> SELECT * FROM test_order ORDER BY num1 DESC, num2 DESC;
+------+------+
| num1 | num2 |
+------+------+
|    3 |   30 |
|    3 |   20 |
|    3 |   10 |
|    2 |   30 |
|    2 |   20 |
|    2 |   10 |
|    1 |   30 |
|    1 |   20 |
|    1 |   10 |
+------+------+
9 rows in set (0.00 sec)

mysql> SELECT * FROM test_order ORDER BY num1 DESC, num2 DESC;

+------+------+

| num1 | num2 |

+------+------+

| 3 | 30 |

| 3 | 20 |

| 3 | 10 |

| 2 | 30 |

| 2 | 20 |

| 2 | 10 |

| 1 | 30 |

| 1 | 20 |

| 1 | 10 |

+------+------+

9 rows in set (0.00 sec)

順番を入れ替えた例。まずnum2で降順ソートしてから、その中でnum1でソートしている。

mysql> SELECT * FROM test_order ORDER BY num2 DESC, num1 DESC;
+------+------+
| num1 | num2 |
+------+------+
|    3 |   30 |
|    2 |   30 |
|    1 |   30 |
|    3 |   20 |
|    2 |   20 |
|    1 |   20 |
|    3 |   10 |
|    2 |   10 |
|    1 |   10 |
+------+------+
9 rows in set (0.00 sec)

mysql> SELECT * FROM test_order ORDER BY num2 DESC, num1 DESC;

+------+------+

| num1 | num2 |

+------+------+

| 3 | 30 |

| 2 | 30 |

| 1 | 30 |

| 3 | 20 |

| 2 | 20 |

| 1 | 20 |

| 3 | 10 |

| 2 | 10 |

| 1 | 10 |

+------+------+

9 rows in set (0.00 sec)

Linux – 停止中のジョブ

2021-08-22 / tau / コメントする

停止しているジョブがあってログアウトできないときなど。

[vagrant@localhost ~]$ exit
ログアウト
停止しているジョブがあります。

[vagrant@localhost ~]$ exit

ログアウト

停止しているジョブがあります。

jobsコマンドでジョブとジョブ番号の確認。

[vagrant@localhost ~]$ jobs
[1]+  停止                  mysql -u root -p

1 2	[vagrant@localhost ~]$ jobs [1]+ 停止 mysql -u root -p

fg ジョブ番号コマンドでフォアグラウンド処理に。

[vagrant@localhost ~]$ fg 1
mysql -u root -p
mysql>

[vagrant@localhost ~]$ fg 1

mysql -u root -p

mysql>

ジョブを停止する場合はkill ジョブ番号コマンド。

MySQL – JOIN – INNER/LEFT/RIGHT/FULL OUTER

2021-08-21 / tau / コメントする

準備

以下の2つのテーブルを準備する。

students: 学生IDと学生名を保存。
courses: 学科IDと学科名を保存。

studentsテーブルの作成とデータ登録のクエリー。

CREATE TABLE students (
  id INT,
  name VARCHAR(10)
);

INSERT INTO students VALUES
  (1, '安藤'),
  (2, '伊藤'),
  (3, '宇藤'),
  (4, '江藤');

CREATE TABLE students (

id INT,

name VARCHAR(10)

);

INSERT INTO students VALUES

(1, '安藤'),

(2, '伊藤'),

(3, '宇藤'),

(4, '江藤');

実行結果。

mysql> SELECT * FROM students;
+------+--------+
| id   | name   |
+------+--------+
|    1 | 安藤   |
|    2 | 伊藤   |
|    3 | 宇藤   |
|    4 | 江藤   |
+------+--------+
4 rows in set (0.00 sec)

mysql> SELECT * FROM students;

+------+--------+

| id | name |

+------+--------+

| 1 | 安藤 |

| 2 | 伊藤 |

| 3 | 宇藤 |

| 4 | 江藤 |

+------+--------+

4 rows in set (0.00 sec)

coursesテーブルの作成とデータ登録のクエリー。

CREATE TABLE courses (
  id INT,
  name VARCHAR(10)
);

INSERT INTO courses VALUES
  (10, '数学'),
  (11, '物理学'),
  (12, '化学'),
  (13, '天文学');

CREATE TABLE courses (

id INT,

name VARCHAR(10)

);

INSERT INTO courses VALUES

(10, '数学'),

(11, '物理学'),

(12, '化学'),

(13, '天文学');

実行結果。

mysql> SELECT * FROM courses;
+------+-----------+
| id   | name      |
+------+-----------+
|   10 | 数学      |
|   11 | 物理学    |
|   12 | 化学      |
|   13 | 天文学    |
+------+-----------+
4 rows in set (0.00 sec)

mysql> SELECT * FROM courses;

+------+-----------+

| id | name |

+------+-----------+

| 10 | 数学 |

| 11 | 物理学 |

| 12 | 化学 |

| 13 | 天文学 |

+------+-----------+

4 rows in set (0.00 sec)

JOIN～総当たり

FROM句のテーブルに対して単にJOINでテーブルを指定すると、2つのテーブルの全要素の組み合わせが得られる。

SELECT students.name, courses.name
FROM students
JOIN courses;

SELECT students.name, courses.name

FROM students

JOIN courses;

実行結果。

+--------+-----------+
| name   | name      |
+--------+-----------+
| 江藤   | 数学      |
| 宇藤   | 数学      |
| 伊藤   | 数学      |
| 安藤   | 数学      |
| 江藤   | 物理学    |
| 宇藤   | 物理学    |
| 伊藤   | 物理学    |
| 安藤   | 物理学    |
| 江藤   | 化学      |
| 宇藤   | 化学      |
| 伊藤   | 化学      |
| 安藤   | 化学      |
| 江藤   | 天文学    |
| 宇藤   | 天文学    |
| 伊藤   | 天文学    |
| 安藤   | 天文学    |
+--------+-----------+
16 rows in set (0.00 sec)

+--------+-----------+

| name | name |

+--------+-----------+

| 江藤 | 数学 |

| 宇藤 | 数学 |

| 伊藤 | 数学 |

| 安藤 | 数学 |

| 江藤 | 物理学 |

| 宇藤 | 物理学 |

| 伊藤 | 物理学 |

| 安藤 | 物理学 |

| 江藤 | 化学 |

| 宇藤 | 化学 |

| 伊藤 | 化学 |

| 安藤 | 化学 |

| 江藤 | 天文学 |

| 宇藤 | 天文学 |

| 伊藤 | 天文学 |

| 安藤 | 天文学 |

+--------+-----------+

16 rows in set (0.00 sec)

結合テーブル

studentsテーブルとcoursesテーブルの結合テーブルを準備する。各学生の履修学科に関するデータ。

CREATE TABLE student_courses (
  student_id INT,
  course_id INT
);

INSERT INTO student_courses VALUES
  (1, 10),
  (1, 11),
  (3, 10),
  (3, 11),
  (3, 13),
  (4, 11),
  (4, 13);

CREATE TABLE student_courses (

student_id INT,

course_id INT

);

INSERT INTO student_courses VALUES

(1, 10),

(1, 11),

(3, 10),

(3, 11),

(3, 13),

(4, 11),

(4, 13);

クエリーの実行結果、

mysql> SELECT * FROM student_courses;
+------------+-----------+
| student_id | course_id |
+------------+-----------+
|          1 |        10 |
|          1 |        11 |
|          3 |        10 |
|          3 |        11 |
|          3 |        13 |
|          4 |        11 |
|          4 |        13 |
+------------+-----------+
7 rows in set (0.00 sec)

mysql> SELECT * FROM student_courses;

+------------+-----------+

| student_id | course_id |

+------------+-----------+

| 1 | 10 |

| 1 | 11 |

| 3 | 10 |

| 3 | 11 |

| 3 | 13 |

| 4 | 11 |

| 4 | 13 |

+------------+-----------+

7 rows in set (0.00 sec)

INNER JOIN

結合テーブルに基づいて、2つのテーブルの両方に存在するデータを取り出す。studentsとcoursesの積集合に相当する。INNERは書かなくても内部結合になる。

SELECT
  カラム1,
  カラム2,
  .....
FROM テーブル1 [AS エイリアス1]
[INNER] JOIN テーブル2 [AS エイリアス2]
  ON [テーブル1].キー1 = [テーブル2].キー2;

SELECT

カラム1,

カラム2,

.....

FROM テーブル1 [AS エイリアス1]

[INNER] JOIN テーブル2 [AS エイリアス2]

ON [テーブル1].キー1 = [テーブル2].キー2;

student_coursesテーブルとstudentsテーブルを結合するクエリーの例。結合の結果、studentsテーブルから学生名を得られる。

SELECT
  stcs.student_id,
  st.name,
  stcs.course_id
FROM student_courses AS stcs
JOIN students AS st
ON stcs.student_id = st.id;

SELECT

stcs.student_id,

st.name,

stcs.course_id

FROM student_courses AS stcs

JOIN students AS st

ON stcs.student_id = st.id;

実行結果。

+------------+--------+-----------+
| student_id | name   | course_id |
+------------+--------+-----------+
|          1 | 安藤   |        10 |
|          1 | 安藤   |        11 |
|          3 | 宇藤   |        10 |
|          3 | 宇藤   |        11 |
|          3 | 宇藤   |        13 |
|          4 | 江藤   |        11 |
|          4 | 江藤   |        13 |
+------------+--------+-----------+
7 rows in set (0.00 sec)

+------------+--------+-----------+

| student_id | name | course_id |

+------------+--------+-----------+

| 1 | 安藤 | 10 |

| 1 | 安藤 | 11 |

| 3 | 宇藤 | 10 |

| 3 | 宇藤 | 11 |

| 3 | 宇藤 | 13 |

| 4 | 江藤 | 11 |

| 4 | 江藤 | 13 |

+------------+--------+-----------+

7 rows in set (0.00 sec)

3つのテーブルの場合、JOIN ... ON句を並べればよい。以下の例ではcoursesテーブルも結合して、学科名も得ている。

SELECT
  stcs.student_id,
  st.name AS student_name,
  stcs.course_id,
  cs.name AS course_name
FROM student_courses AS stcs
JOIN students AS st
  ON stcs.student_id = st.id
JOIN courses AS cs
  ON stcs.course_id = cs.id;

SELECT

stcs.student_id,

st.name AS student_name,

stcs.course_id,

cs.name AS course_name

FROM student_courses AS stcs

JOIN students AS st

ON stcs.student_id = st.id

JOIN courses AS cs

ON stcs.course_id = cs.id;

実行結果。student_coursesテーブルは学生IDと学科IDしか持っていないが、studentsテーブル、coursesテーブルと結合することで学生名と学科名を使えるようになる。

+------------+--------------+-----------+-------------+
| student_id | student_name | course_id | course_name |
+------------+--------------+-----------+-------------+
|          3 | 宇藤         |        10 | 数学        |
|          1 | 安藤         |        10 | 数学        |
|          4 | 江藤         |        11 | 物理学      |
|          3 | 宇藤         |        11 | 物理学      |
|          1 | 安藤         |        11 | 物理学      |
|          4 | 江藤         |        13 | 天文学      |
|          3 | 宇藤         |        13 | 天文学      |
+------------+--------------+-----------+-------------+
7 rows in set (0.00 sec)

+------------+--------------+-----------+-------------+

+------------+--------------+-----------+-------------+

| 3 | 宇藤 | 10 | 数学 |

| 1 | 安藤 | 10 | 数学 |

| 4 | 江藤 | 11 | 物理学 |

| 3 | 宇藤 | 11 | 物理学 |

| 1 | 安藤 | 11 | 物理学 |

| 4 | 江藤 | 13 | 天文学 |

| 3 | 宇藤 | 13 | 天文学 |

+------------+--------------+-----------+-------------+

7 rows in set (0.00 sec)

LEFT OUTER JOIN

LEFT OUTER JOINは、先に指定されたテーブル(左テーブル)の全レコードに対して、JOINで指定したレコードを対応させる。左テーブルに対応するレコードがないときはNULLになる。LEFT JOINと書いても同じ。

以下のクエリーは、studentsの全学生データに対してstudent_coursesの履修科目データを左結合させる。studentsには登録されているがstudent_coursesにない学生(学科を履修していない学生)についてはNULLになる。

SELECT
  st.id AS student_id,
  st.name,
  stcs.course_id
FROM students AS st
LEFT JOIN student_courses AS stcs
  ON st.id = stcs.student_id;

SELECT

st.id AS student_id,

st.name,

stcs.course_id

FROM students AS st

LEFT JOIN student_courses AS stcs

ON st.id = stcs.student_id;

実行結果は以下の通りで、学生IDの伊藤君はstudent_coursesテーブルに存在しないので、course_idがNULLになっている。

+------------+--------+-----------+
| student_id | name   | course_id |
+------------+--------+-----------+
|          1 | 安藤   |        11 |
|          1 | 安藤   |        10 |
|          2 | 伊藤   |      NULL |
|          3 | 宇藤   |        13 |
|          3 | 宇藤   |        11 |
|          3 | 宇藤   |        10 |
|          4 | 江藤   |        13 |
|          4 | 江藤   |        11 |
+------------+--------+-----------+
8 rows in set (0.00 sec)

+------------+--------+-----------+

| student_id | name | course_id |

+------------+--------+-----------+

| 1 | 安藤 | 11 |

| 1 | 安藤 | 10 |

| 2 | 伊藤 | NULL |

| 3 | 宇藤 | 13 |

| 3 | 宇藤 | 11 |

| 3 | 宇藤 | 10 |

| 4 | 江藤 | 13 |

| 4 | 江藤 | 11 |

+------------+--------+-----------+

8 rows in set (0.00 sec)

学科名も欲しい場合は、coursesテーブルを左結合させる。

SELECT
  st.id AS student_id,
  st.name AS student_name,
  cs.id AS course_id,
  cs.name AS course_name
FROM students AS st
LEFT JOIN student_courses AS stcs
  ON st.id = stcs.student_id
LEFT JOIN courses AS cs
  ON stcs.course_id = cs.id;

SELECT

st.id AS student_id,

st.name AS student_name,

cs.id AS course_id,

cs.name AS course_name

FROM students AS st

LEFT JOIN student_courses AS stcs

ON st.id = stcs.student_id

LEFT JOIN courses AS cs

ON stcs.course_id = cs.id;

実行結果。学科を履修していない伊藤君のデータは、course_nameについてもNULLになる。

+------------+--------------+-----------+-------------+
| student_id | student_name | course_id | course_name |
+------------+--------------+-----------+-------------+
|          1 | 安藤         |        11 | 物理学      |
|          1 | 安藤         |        10 | 数学        |
|          2 | 伊藤         |      NULL | NULL        |
|          3 | 宇藤         |        13 | 天文学      |
|          3 | 宇藤         |        11 | 物理学      |
|          3 | 宇藤         |        10 | 数学        |
|          4 | 江藤         |        13 | 天文学      |
|          4 | 江藤         |        11 | 物理学      |
+------------+--------------+-----------+-------------+
8 rows in set (0.00 sec)

+------------+--------------+-----------+-------------+

+------------+--------------+-----------+-------------+

| 1 | 安藤 | 11 | 物理学 |

| 1 | 安藤 | 10 | 数学 |

| 2 | 伊藤 | NULL | NULL |

| 3 | 宇藤 | 13 | 天文学 |

| 3 | 宇藤 | 11 | 物理学 |

| 3 | 宇藤 | 10 | 数学 |

| 4 | 江藤 | 13 | 天文学 |

| 4 | 江藤 | 11 | 物理学 |

+------------+--------------+-----------+-------------+

8 rows in set (0.00 sec)

RIGHT OUTER JOIN

RIGHT JOINは後から指定されたテーブルの全データに対して、先に指定されたテーブルを結合させる。先に指定されたテーブルに対応するレコードがない場合にはNULLになる。RIGHT JOINと書いても同じ。

以下は、student_coursesテーブルのデータにcoursesテーブルのデータを右結合させている。どの学生にも履修されていない学科がある場合はNULLになる。

SELECT
  stcs.student_id,
  cs.id AS course_id,
  cs.name AS course_name
FROM student_courses AS stcs
RIGHT JOIN courses as cs
  ON stcs.course_id = cs.id;

SELECT

stcs.student_id,

cs.id AS course_id,

cs.name AS course_name

FROM student_courses AS stcs

RIGHT JOIN courses as cs

ON stcs.course_id = cs.id;

実行結果。化学はどの学生にも履修されていないのでNULLになっている。

+------------+-----------+-------------+
| student_id | course_id | course_name |
+------------+-----------+-------------+
|          3 |        10 | 数学        |
|          1 |        10 | 数学        |
|          4 |        11 | 物理学      |
|          3 |        11 | 物理学      |
|          1 |        11 | 物理学      |
|       NULL |        12 | 化学        |
|          4 |        13 | 天文学      |
|          3 |        13 | 天文学      |
+------------+-----------+-------------+
8 rows in set (0.00 sec)

+------------+-----------+-------------+

| student_id | course_id | course_name |

+------------+-----------+-------------+

| 3 | 10 | 数学 |

| 1 | 10 | 数学 |

| 4 | 11 | 物理学 |

| 3 | 11 | 物理学 |

| 1 | 11 | 物理学 |

| NULL | 12 | 化学 |

| 4 | 13 | 天文学 |

| 3 | 13 | 天文学 |

+------------+-----------+-------------+

8 rows in set (0.00 sec)

3つ以上のテーブルでは、最も右側のテーブルをRIGHT JOINを連ねる。最後以外のJOINはRIGHTがなくても同じ結果になる。

SELECT
  st.id AS student_id,
  st.name AS student_name,
  cs.id AS course_id,
  cs.name AS course_name
FROM student_courses AS stcs
RIGHT JOIN students AS st
  ON stcs.student_id = st.id
RIGHT JOIN courses as cs
  ON stcs.course_id = cs.id;

SELECT

st.id AS student_id,

st.name AS student_name,

cs.id AS course_id,

cs.name AS course_name

FROM student_courses AS stcs

RIGHT JOIN students AS st

ON stcs.student_id = st.id

RIGHT JOIN courses as cs

ON stcs.course_id = cs.id;

実行結果。履修されていない化学の学生IDと学生名がNULLになっている。

+------------+--------------+-----------+-------------+
| student_id | student_name | course_id | course_name |
+------------+--------------+-----------+-------------+
|          3 | 宇藤         |        10 | 数学        |
|          1 | 安藤         |        10 | 数学        |
|          4 | 江藤         |        11 | 物理学      |
|          3 | 宇藤         |        11 | 物理学      |
|          1 | 安藤         |        11 | 物理学      |
|       NULL | NULL         |        12 | 化学        |
|          4 | 江藤         |        13 | 天文学      |
|          3 | 宇藤         |        13 | 天文学      |
+------------+--------------+-----------+-------------+
8 rows in set (0.00 sec)

+------------+--------------+-----------+-------------+

+------------+--------------+-----------+-------------+

| 3 | 宇藤 | 10 | 数学 |

| 1 | 安藤 | 10 | 数学 |

| 4 | 江藤 | 11 | 物理学 |

| 3 | 宇藤 | 11 | 物理学 |

| 1 | 安藤 | 11 | 物理学 |

| NULL | NULL | 12 | 化学 |

| 4 | 江藤 | 13 | 天文学 |

| 3 | 宇藤 | 13 | 天文学 |

+------------+--------------+-----------+-------------+

8 rows in set (0.00 sec)

RIGHT JOINのテーブルを入れ替えることで、LEFT JOINで同じ結果を得られる。履修科目に関する上の例をLEFT JOINで書きなおすと以下の通り。

SELECT
  st.id AS student_id,
  st.name AS student_name,
  cs.id AS course_id,
  cs.name AS course_name
FROM courses AS cs
LEFT JOIN student_courses AS stcs
  ON stcs.course_id = cs.id
LEFT JOIN students AS st
  ON stcs.student_id = st.id;

SELECT

st.id AS student_id,

st.name AS student_name,

cs.id AS course_id,

cs.name AS course_name

FROM courses AS cs

LEFT JOIN student_courses AS stcs

ON stcs.course_id = cs.id

LEFT JOIN students AS st

ON stcs.student_id = st.id;

実行結果は同じ。

+------------+--------------+-----------+-------------+
| student_id | student_name | course_id | course_name |
+------------+--------------+-----------+-------------+
|          3 | 宇藤         |        10 | 数学        |
|          1 | 安藤         |        10 | 数学        |
|          4 | 江藤         |        11 | 物理学      |
|          3 | 宇藤         |        11 | 物理学      |
|          1 | 安藤         |        11 | 物理学      |
|       NULL | NULL         |        12 | 化学        |
|          4 | 江藤         |        13 | 天文学      |
|          3 | 宇藤         |        13 | 天文学      |
+------------+--------------+-----------+-------------+
8 rows in set (0.00 sec)

+------------+--------------+-----------+-------------+

+------------+--------------+-----------+-------------+

| 3 | 宇藤 | 10 | 数学 |

| 1 | 安藤 | 10 | 数学 |

| 4 | 江藤 | 11 | 物理学 |

| 3 | 宇藤 | 11 | 物理学 |

| 1 | 安藤 | 11 | 物理学 |

| NULL | NULL | 12 | 化学 |

| 4 | 江藤 | 13 | 天文学 |

| 3 | 宇藤 | 13 | 天文学 |

+------------+--------------+-----------+-------------+

8 rows in set (0.00 sec)

FULL OUTER JOIN

FULL OUTER JOINは指定されたテーブルの全データを含める。いずれかのデータが存在しない場合はNULLとなる。テーブルのデータ群の和集合に相当する。

MySQLにはFULL JOINが定義されていないので、同等の機能はUNIONで実現する。

2つのテーブルの場合にはLEFT JOINとRIGHT JOINの結果をUNION
結合テーブルがある場合には、それぞれのLEFT JOINの結果をUNION
UNIONの際に、各SELECTのカラムを同じにしておく

以下は、students、coursesに対するstudent_coursesのLEFT JOINの結果をUNIONで結合している。科目を履修していない学生は学科がNULLとなり、履修されていない科目が学生がNULLとなる。

SELECT
  st.id AS student_id,
  st.name AS student_name,
  cs.id AS course_id,
  cs.name AS course_name
FROM students AS st
LEFT JOIN student_courses AS stcs
  ON st.id = stcs.student_id
LEFT JOIN courses AS cs
  ON stcs.course_id = cs.id
UNION
SELECT
  st.id AS student_id,
  st.name AS student_name,
  cs.id AS course_id,
  cs.name AS course_name
FROM courses AS cs
LEFT JOIN student_courses AS stcs
  ON stcs.course_id = cs.id
LEFT JOIN students AS st
  ON stcs.student_id = st.id;

SELECT

st.id AS student_id,

st.name AS student_name,

cs.id AS course_id,

cs.name AS course_name

FROM students AS st

LEFT JOIN student_courses AS stcs

ON st.id = stcs.student_id

LEFT JOIN courses AS cs

ON stcs.course_id = cs.id

UNION

SELECT

st.id AS student_id,

st.name AS student_name,

cs.id AS course_id,

cs.name AS course_name

FROM courses AS cs

LEFT JOIN student_courses AS stcs

ON stcs.course_id = cs.id

LEFT JOIN students AS st

ON stcs.student_id = st.id;

実行結果。学科を履修していない伊藤君の学科欄はNULLになり、だれにも履修されていない化学は学生欄がNULLになっている。

+------------+--------------+-----------+-------------+
| student_id | student_name | course_id | course_name |
+------------+--------------+-----------+-------------+
|          1 | 安藤         |        11 | 物理学      |
|          1 | 安藤         |        10 | 数学        |
|          2 | 伊藤         |      NULL | NULL        |
|          3 | 宇藤         |        13 | 天文学      |
|          3 | 宇藤         |        11 | 物理学      |
|          3 | 宇藤         |        10 | 数学        |
|          4 | 江藤         |        13 | 天文学      |
|          4 | 江藤         |        11 | 物理学      |
|       NULL | NULL         |        12 | 化学        |
+------------+--------------+-----------+-------------+
9 rows in set (0.00 sec)

+------------+--------------+-----------+-------------+

+------------+--------------+-----------+-------------+

| 1 | 安藤 | 11 | 物理学 |

| 1 | 安藤 | 10 | 数学 |

| 2 | 伊藤 | NULL | NULL |

| 3 | 宇藤 | 13 | 天文学 |

| 3 | 宇藤 | 11 | 物理学 |

| 3 | 宇藤 | 10 | 数学 |

| 4 | 江藤 | 13 | 天文学 |

| 4 | 江藤 | 11 | 物理学 |

| NULL | NULL | 12 | 化学 |

+------------+--------------+-----------+-------------+

9 rows in set (0.00 sec)

カラム名の指定によって結果が違う

LEFT OUTER JOINのところで、学生IDと学科IDをstudents.id、couses.idのようにそれぞれのテーブルから指定していた。

一方で、同じIDをstudent_courseのstudent_id、couse_idで指定することもできる。こちらで指定すれば、識別のためのエイリアスを定義しなくていいので便利そうだ。

SELECT
  stcs.student_id,
  st.name AS student_name,
  stcs.course_id,
  cs.name AS course_name
FROM courses AS cs
LEFT JOIN student_courses AS stcs
  ON stcs.course_id = cs.id
LEFT JOIN students AS st
  ON stcs.student_id = st.id;

SELECT

stcs.student_id,

st.name AS student_name,

stcs.course_id,

cs.name AS course_name

FROM courses AS cs

LEFT JOIN student_courses AS stcs

ON stcs.course_id = cs.id

LEFT JOIN students AS st

ON stcs.student_id = st.id;

しかしこれらを使うと、OUTER JOINの際に存在しないIDとして扱われてNULLになってしまう。

上のクエリーを実行した結果が以下で、化学を履修している学生がいないので、student_coursesに該当するデータがなく、student_idとcourse_idがNULLになっている。

+------------+--------------+-----------+-------------+
| student_id | student_name | course_id | course_name |
+------------+--------------+-----------+-------------+
|          3 | 宇藤         |        10 | 数学        |
|          1 | 安藤         |        10 | 数学        |
|          4 | 江藤         |        11 | 物理学      |
|          3 | 宇藤         |        11 | 物理学      |
|          1 | 安藤         |        11 | 物理学      |
|       NULL | NULL         |      NULL | 化学        |
|          4 | 江藤         |        13 | 天文学      |
|          3 | 宇藤         |        13 | 天文学      |
+------------+--------------+-----------+-------------+
8 rows in set (0.00 sec)

+------------+--------------+-----------+-------------+

+------------+--------------+-----------+-------------+

| 3 | 宇藤 | 10 | 数学 |

| 1 | 安藤 | 10 | 数学 |

| 4 | 江藤 | 11 | 物理学 |

| 3 | 宇藤 | 11 | 物理学 |

| 1 | 安藤 | 11 | 物理学 |

| 4 | 江藤 | 13 | 天文学 |

| 3 | 宇藤 | 13 | 天文学 |

+------------+--------------+-----------+-------------+

8 rows in set (0.00 sec)

これらを表示させたいときには、LEFT OUTER JOINの例のように、左結合される側(全データが使われる側)のテーブルでカラムを指定するとよい。

MySQL – 外部キー制約

2021-08-21 / tau / コメントする

外部キーの設定

テーブル構成

学生の履修科目に関する簡単なデータベースを考える。

studentsテーブルは学生に関するデータを保存
- 学生ID(主キー)
- 学生の名前
student_coursesテーブルは学生の履修科目に関するデータを保存
- 履修科目ID(主キー)
- 学生ID
- 科目名

学生テーブル

以下のクエリーでテーブルを作成し、学生データを登録。

CREATE TABLE students (
  id INT PRIMARY KEY,
  name VARCHAR(10)
);

INSERT INTO students (id, name) VALUES
  (1, '安藤'),
  (2, '伊藤'),
  (3, '宇藤');

CREATE TABLE students (

id INT PRIMARY KEY,

name VARCHAR(10)

);

INSERT INTO students (id, name) VALUES

(1, '安藤'),

(2, '伊藤'),

(3, '宇藤');

登録結果の確認。

mysql> SELECT * FROM students;
+----+--------+
| id | name   |
+----+--------+
|  1 | 安藤   |
|  2 | 伊藤   |
|  3 | 宇藤   |
+----+--------+
3 rows in set (0.00 sec)

mysql> SELECT * FROM students;

+----+--------+

| id | name |

+----+--------+

| 1 | 安藤 |

| 2 | 伊藤 |

| 3 | 宇藤 |

+----+--------+

3 rows in set (0.00 sec)

履修科目テーブル～外部キーの設定

以下のクエリーで履修科目テーブルを作成。student_idを外部キーとして、studentsテーブルのid(学生ID)を参照している。

外部キーを設定するカラムについて、以下のように定義する。

FOREIGN_KEY (参照するキー) REFERENCES 参照されるテーブル(参照されるキー)

CREATE TABLE student_courses (
  id INT PRIMARY KEY,
  student_id INT,
  FOREIGN KEY (student_id) REFERENCES students(id),
  course_name VARCHAR(10)
);

CREATE TABLE student_courses (

id INT PRIMARY KEY,

student_id INT,

FOREIGN KEY (student_id) REFERENCES students(id),

course_name VARCHAR(10)

);

テーブル構造を確認すると、student_idのKey欄がMULとなる。このMULについてはぴったりの情報が得られなかったが、以下のようなことらしい。

外部参照するキーにはインデックスが設定される
PRIMARY KEYやINIQUEが設定されていないインデックスは同じ値を取り得る
なのでmultiple keyでMULと表示される

mysql> DESCRIBE student_courses;
+-------------+-------------+------+-----+---------+-------+
| Field       | Type        | Null | Key | Default | Extra |
+-------------+-------------+------+-----+---------+-------+
| id          | int         | NO   | PRI | NULL    |       |
| student_id  | int         | YES  | MUL | NULL    |       |
| course_name | varchar(10) | YES  |     | NULL    |       |
+-------------+-------------+------+-----+---------+-------+
3 rows in set (0.00 sec)

mysql> DESCRIBE student_courses;

+-------------+-------------+------+-----+---------+-------+

+-------------+-------------+------+-----+---------+-------+

| id | int | NO | PRI | NULL | |

| student_id | int | YES | MUL | NULL | |

+-------------+-------------+------+-----+---------+-------+

3 rows in set (0.00 sec)

外部キー制約の確認

正常な登録

新しいデータをstudent_coursesテーブルに登録する。student_idとして登録済みのstudents.id = 1の学生IDを指定する。

INSERT INTO student_courses (id, student_id, course_name) VALUES (1, 1, '数学');

1	INSERT INTO student_courses (id, student_id, course_name) VALUES (1, 1, '数学');

正常に登録されて、students_coursesテーブルは以下のようになる。

mysql> INSERT INTO student_courses (id, student_id, course_name) VALUES (1, 1, '数学');
Query OK, 1 row affected (0.01 sec)

mysql> SELECT * FROM student_courses;
+------+------------+-------------+
| id   | student_id | course_name |
+------+------------+-------------+
|    1 |          1 | 数学        |
+------+------------+-------------+
1 row in set (0.00 sec)

mysql> INSERT INTO student_courses (id, student_id, course_name) VALUES (1, 1, '数学');

Query OK, 1 row affected (0.01 sec)

mysql> SELECT * FROM student_courses;

+------+------------+-------------+

| id | student_id | course_name |

+------+------------+-------------+

| 1 | 1 | 数学 |

+------+------------+-------------+

1 row in set (0.00 sec)

存在しないデータの登録はエラー

student_idに、studentsテーブルでは登録されていない値を指定する。

INSERT INTO student_courses (id, student_id, course_name) VALUES (2, 4, '数学');

1	INSERT INTO student_courses (id, student_id, course_name) VALUES (2, 4, '数学');

外部キー制約でエラーとなる。

mysql> INSERT INTO student_courses (id, student_id, course_name) VALUES (2, 4, '数学');
ERROR 1452 (23000): Cannot add or update a child row:
 a foreign key constraint fails (`testdb`.`student_courses`,
 CONSTRAINT `student_courses_ibfk_1` FOREIGN KEY (`student_id`) REFERENCES `students` (`id`))
mysql>

mysql> INSERT INTO student_courses (id, student_id, course_name) VALUES (2, 4, '数学');

ERROR 1452 (23000): Cannot add or update a child row:

a foreign key constraint fails (`testdb`.`student_courses`,

CONSTRAINT `student_courses_ibfk_1` FOREIGN KEY (`student_id`) REFERENCES `students` (`id`))

mysql>

参照されている親のデータは消せない

student_coursesテーブルのデータから参照されている、studentsテーブルのid=1のデータを削除しようとするとエラーになる。

mysql> DELETE FROM students WHERE id=1;
ERROR 1451 (23000): Cannot delete or update a parent row:
 a foreign key constraint fails (`testdb`.`student_courses`,
 CONSTRAINT `student_courses_ibfk_1` FOREIGN KEY (`student_id`) REFERENCES `students` (`id`))

mysql> DELETE FROM students WHERE id=1;

ERROR 1451 (23000): Cannot delete or update a parent row:

a foreign key constraint fails (`testdb`.`student_courses`,

CONSTRAINT `student_courses_ibfk_1` FOREIGN KEY (`student_id`) REFERENCES `students` (`id`))

参照されていない親のデータは削除できる

mysql> DELETE FROM students WHERE id=2;
Query OK, 1 row affected (0.01 sec)

1 2	mysql> DELETE FROM students WHERE id=2; Query OK, 1 row affected (0.01 sec)

student_coursesのデータから参照されていない、studentsテーブルのid=2のデータは削除できる。

CREATE TABLE student_courses (
  id INT,
  student_id INT,
  FOREIGN KEY fk_student_id(student_id) REFERENCES students(id)
    ON DELETE CASCADE
    ON UPDATE CASCADE,
  course_name VARCHAR(10)
);

CREATE TABLE student_courses (

id INT,

student_id INT,

FOREIGN KEY fk_student_id(student_id) REFERENCES students(id)

ON DELETE CASCADE

ON UPDATE CASCADE,

course_name VARCHAR(10)

);

不整合時の挙動～RESTRICTやCASCADEなど

FOREIGN KEY指定時に、参照先のデータの削除時と変更時の挙動を指定できる。

ON DELETE 挙動指定 ON UPDATE 挙動指定

挙動指定には以下の4つがあり、指定しない場合はRESTRICTとなる。

RESTRICT: DELETE, UPDATEともエラーになる。
CASCADE: DELETEでは参照元のデータも削除され、UPDATEでは参照先の変更が参照元のデータに反映される。
SET NULL: DELETE, UPDATEともNULLに置き換わる。
NO ACTION: RESTRICTと同じ挙動。

外部キー制約をCASCADEに変更する

CREATE TABLEの確認

外部キー制約設定後のテーブル定義を以下のコマンドで確認してみる。

SHOW CREATE TABLE テーブル名\G;

最初に実行したクエリーの内容に即している
CONSTRAINT `外部制約名`が追加されている

mysql> SHOW CREATE TABLE student_courses\G
*************************** 1. row ***************************
       Table: student_courses
Create Table: CREATE TABLE `student_courses` (
  `id` int NOT NULL,
  `student_id` int DEFAULT NULL,
  `course_name` varchar(10) DEFAULT NULL,
  PRIMARY KEY (`id`),
  KEY `student_id` (`student_id`),
  CONSTRAINT `student_courses_ibfk_1` FOREIGN KEY (`student_id`) REFERENCES `students` (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci
1 row in set (0.00 sec)

mysql> SHOW CREATE TABLE student_courses\G

*************************** 1. row ***************************

Table: student_courses

Create Table: CREATE TABLE `student_courses` (

`id` int NOT NULL,

`student_id` int DEFAULT NULL,

`course_name` varchar(10) DEFAULT NULL,

PRIMARY KEY (`id`),

KEY `student_id` (`student_id`),

CONSTRAINT `student_courses_ibfk_1` FOREIGN KEY (`student_id`) REFERENCES `students` (`id`)

) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci

1 row in set (0.00 sec)

挙動の変更

外部キー制約の挙動をRESTRICTからCASCADEに変更する。外部キーの操作はALTER TABLEで行うが、一度に変更できないので一旦外部キーを削除し、新たな条件で外部キーを追加する。

外部キーの削除

外部キー削除のコマンドは以下の通り。

ALTER TABLE 参照元テーブル DROP FOREIGN KEY 外部制約名;

外部制約名は、先のSHOW CREATE TABLEで確認した内容で指定する。

mysql> ALTER TABLE student_courses DROP FOREIGN KEY student_courses_ibfk_1;
Query OK, 0 rows affected (0.01 sec)
Records: 0  Duplicates: 0  Warnings: 0

mysql> ALTER TABLE student_courses DROP FOREIGN KEY student_courses_ibfk_1;

Query OK, 0 rows affected (0.01 sec)

Records: 0 Duplicates: 0 Warnings: 0

外部キー削除後もインデックスは残っている。

mysql> DESCRIBE student_courses;
+-------------+-------------+------+-----+---------+-------+
| Field       | Type        | Null | Key | Default | Extra |
+-------------+-------------+------+-----+---------+-------+
| id          | int         | NO   | PRI | NULL    |       |
| student_id  | int         | YES  | MUL | NULL    |       |
| course_name | varchar(10) | YES  |     | NULL    |       |
+-------------+-------------+------+-----+---------+-------+
3 rows in set (0.00 sec)

mysql> DESCRIBE student_courses;

+-------------+-------------+------+-----+---------+-------+

+-------------+-------------+------+-----+---------+-------+

| id | int | NO | PRI | NULL | |

| student_id | int | YES | MUL | NULL | |

+-------------+-------------+------+-----+---------+-------+

3 rows in set (0.00 sec)

外部キー削除後のCREATE TABLEを確認すると、student_idにインデックスが設定されている。

mysql> SHOW CREATE TABLE student_courses\G
*************************** 1. row ***************************
       Table: student_courses
Create Table: CREATE TABLE `student_courses` (
  `id` int NOT NULL,
  `student_id` int DEFAULT NULL,
  `course_name` varchar(10) DEFAULT NULL,
  PRIMARY KEY (`id`),
  KEY `student_id` (`student_id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci
1 row in set (0.00 sec)

mysql> SHOW CREATE TABLE student_courses\G

*************************** 1. row ***************************

Table: student_courses

Create Table: CREATE TABLE `student_courses` (

`id` int NOT NULL,

`student_id` int DEFAULT NULL,

`course_name` varchar(10) DEFAULT NULL,

PRIMARY KEY (`id`),

KEY `student_id` (`student_id`)

) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci

1 row in set (0.00 sec)

外部キーの追加

以下のクエリーで削除・更新時の挙動を指定して外部キーを追加。

ALTER TABLE student_courses
ADD FOREIGN KEY (student_id) REFERENCES students(id)
  ON DELETE CASCADE
  ON UPDATE CASCADE;

ALTER TABLE student_courses

ADD FOREIGN KEY (student_id) REFERENCES students(id)

ON DELETE CASCADE

ON UPDATE CASCADE;

クエリー実行。

mysql> ALTER TABLE student_courses
    -> ADD FOREIGN KEY (student_id) REFERENCES students(id)
    ->   ON DELETE CASCADE
    ->   ON UPDATE CASCADE;
Query OK, 5 rows affected (0.03 sec)
Records: 5  Duplicates: 0  Warnings: 0

mysql> ALTER TABLE student_courses

-> ADD FOREIGN KEY (student_id) REFERENCES students(id)

-> ON DELETE CASCADE

-> ON UPDATE CASCADE;

Query OK, 5 rows affected (0.03 sec)

Records: 5 Duplicates: 0 Warnings: 0

CREATE TABLE確認。

mysql> SHOW CREATE TABLE student_courses\G
*************************** 1. row ***************************
       Table: student_courses
Create Table: CREATE TABLE `student_courses` (
  `id` int NOT NULL,
  `student_id` int DEFAULT NULL,
  `course_name` varchar(10) DEFAULT NULL,
  PRIMARY KEY (`id`),
  KEY `student_id` (`student_id`),
  CONSTRAINT `student_courses_ibfk_1` FOREIGN KEY (`student_id`) REFERENCES `students` (`id`) ON DELETE CASCADE ON UPDATE CASCADE
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci
1 row in set (0.00 sec)

mysql> SHOW CREATE TABLE student_courses\G

*************************** 1. row ***************************

Table: student_courses

Create Table: CREATE TABLE `student_courses` (

`id` int NOT NULL,

`student_id` int DEFAULT NULL,

`course_name` varchar(10) DEFAULT NULL,

PRIMARY KEY (`id`),

KEY `student_id` (`student_id`),

CONSTRAINT `student_courses_ibfk_1` FOREIGN KEY (`student_id`) REFERENCES `students` (`id`) ON DELETE CASCADE ON UPDATE CASCADE

) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci

1 row in set (0.00 sec)

CASCADEの挙動

ON UPDATE CASCADE

参照先、親テーブルstudentsのデータのid=3を9に変更する。RESTRICTではエラーになったが、CASCADEの場合は変更が通る。

mysql> UPDATE students SET id = 9 WHERE id = 3;
Query OK, 1 row affected (0.01 sec)
Rows matched: 1  Changed: 1  Warnings: 0

mysql> UPDATE students SET id = 9 WHERE id = 3;

Query OK, 1 row affected (0.01 sec)

Rows matched: 1 Changed: 1 Warnings: 0

student_coursesのstudent_idも変更されている。

+----+------------+--------+-------------+
| id | student_id | name   | course_name |
+----+------------+--------+-------------+
|  1 |          1 | 安藤   | 数学        |
|  2 |          1 | 安藤   | 物理学      |
|  3 |          2 | 伊藤   | 数学        |
|  4 |          9 | 宇藤   | 物理学      |
|  5 |          9 | 宇藤   | 化学        |
+----+------------+--------+-------------+
5 rows in set (0.00 sec)

+----+------------+--------+-------------+

+----+------------+--------+-------------+

| 1 | 1 | 安藤 | 数学 |

| 2 | 1 | 安藤 | 物理学 |

| 3 | 2 | 伊藤 | 数学 |

| 4 | 9 | 宇藤 | 物理学 |

| 5 | 9 | 宇藤 | 化学 |

+----+------------+--------+-------------+

5 rows in set (0.00 sec)

ON DELETE CASCADE

参照先、親テーブルのid=9のレコードを削除する。RESTRICTではエラーになったが、CASCADEの場合は削除される。

mysql> DELETE FROM students WHERE id = 9;
Query OK, 1 row affected (0.00 sec)

1 2	mysql> DELETE FROM students WHERE id = 9; Query OK, 1 row affected (0.00 sec)

student_coursesのstudent_id=9のレコードも削除されている。

+----+------------+--------+-------------+
| id | student_id | name   | course_name |
+----+------------+--------+-------------+
|  1 |          1 | 安藤   | 数学        |
|  2 |          1 | 安藤   | 物理学      |
|  3 |          2 | 伊藤   | 数学        |
+----+------------+--------+-------------+
3 rows in set (0.01 sec)

+----+------------+--------+-------------+

+----+------------+--------+-------------+

| 1 | 1 | 安藤 | 数学 |

| 2 | 1 | 安藤 | 物理学 |

| 3 | 2 | 伊藤 | 数学 |

+----+------------+--------+-------------+

3 rows in set (0.01 sec)

外部キー制約の追加・削除

外部キーの追加は、ALTER TABLE ... ADD FOREIGIN KEYで行う。被参照キーにインデックスが設定されている必要がある。

ALTER TABLE 参照テーブル
ADD FOREIGN KEY (参照キー)
REFERENCES 被参照テーブル(被参照キー);

ALTER TABLE 参照テーブル

ADD FOREIGN KEY (参照キー)

REFERENCES 被参照テーブル(被参照キー);

外部キーの削除はALTER TABLE ... DROP FOREIGN KEYで行う。制約名はSHOW CREATE TABLEで確認できる。

ALTER TABLE 参照テーブル DROP FOREIGN KEY 制約名;

1	ALTER TABLE 参照テーブル DROP FOREIGN KEY 制約名;