# LaravelのEloquent ORMを使ったデータベース操作入門

## 1-0 目次

1. 1-1 Eloquent ORMとは
2. 1-2 基本設定と準備
3. 1-3 モデルの作成と基本的な使い方
4. 1-4 データの取得
5. 1-5 データの挿入と更新
6. 1-6 データの削除
7. 1-7 リレーションの定義と活用
8. 1-8 ソフトデリート
9. 1-9 スコープとクエリビルダの拡張
10. 1-10 まとめ

## 1-1 Eloquent ORMとは

Eloquent ORMは、Laravelフレームワークに組み込まれているオブジェクトリレーショナルマッピング（ORM）ツールです。オブジェクト指向プログラミングとデータベース操作をスムーズに連携させ、開発者がコードをアクセスしやすく、保守しやすく作成できるように設計されています。

Eloquentでは、テーブルごとにモデルクラスを作成し、データベーステーブルとデータを操作します。このモデルを利用して、データベースクエリの作成、データの取得、作成、更新、削除といった基本的な操作を簡単に実行できます。

また、Eloquentは「アクティブレコードパターン」に基づいており、各モデルクラスのインスタンスがデータベーステーブルの一行を表現します。

## 1-2 基本設定と準備

### 1-2-1 Laravelプロジェクトの初期化

Laravelプロジェクトを開始するには、Composerを使用します。

![img](/mosaic-code.jpg)

### 1-2-2 データベース設定ファイルの編集

データベース接続の設定は、`.env`ファイルで管理されます。以下のように、データベースの情報を入力します。

![img](/mosaic-code.jpg)

### 1-2-3 マイグレーションの実行

モデルの構築前に、Laravelのマイグレーション機能を使用してテーブルを作成します。

![img](/mosaic-code.jpg)

このコマンドは、`database/migrations`ディレクトリ内にマイグレーションファイルを作成します。中でテーブルのスキーマを定義します。

![img](/mosaic-code.jpg)

マイグレーションを適用するには、以下のコマンドを実行します。

![img](/mosaic-code.jpg)

## 1-3 モデルの作成と基本的な使い方

### 1-3-1 モデルの作成

Eloquentモデルを作成するには、artisanコマンドを使用します。

![img](/mosaic-code.jpg)

モデルファイルは`app/Models`ディレクトリに作成され、`User`モデルは`users`テーブルを操作するために使用されます。

### 1-3-2 モデルの基本構成

`User`モデルの基本構成は以下のとおりです。

![img](/mosaic-code.jpg)

## 1-4 データの取得

### 1-4-1 全データの取得

`User`テーブルから全てのレコードを取得するには、以下のようにします。

![img](/mosaic-code.jpg)

### 1-4-2 条件付きのデータ取得

フィルター条件を使用してデータを取得できます。例えば、特定のメールアドレスを持つユーザーを取得するには、次のコードを使用します。

![img](/mosaic-code.jpg)

### 1-4-3 ペジネーション

大量のデータを取得する時は、ページネーションを活用します。

![img](/mosaic-code.jpg)

これにより、指定した件数ごとにデータを区切って表示できます。

## 1-5 データの挿入と更新

### 1-5-1 データの挿入

新しいユーザーをデータベースに挿入するには、新しいインスタンスを作成し、`save`メソッドを使用します。

![img](/mosaic-code.jpg)

### 1-5-2 マスアサインメントを使ったデータの挿入

`create`メソッドを使用して、より簡潔にデータを挿入できます。ただし、安全性のためにモデルの`$fillable`プロパティに許可する属性を設定する必要があります。

![img](/mosaic-code.jpg)

### 1-5-3 データの更新

既存のデータを更新するには、`find`メソッドで対象レコードを取得し、属性を更新後、`save`メソッドを使用します。

![img](/mosaic-code.jpg)

## 1-6 データの削除

### 1-6-1 データの削除

特定のユーザーを削除するには、対象のモデルインスタンスを取得し、`delete`メソッドを使用します。

![img](/mosaic-code.jpg)

### 1-6-2 複数データの削除

複数の行をまとめて削除する場合は、条件を指定して`delete`メソッドを使用します。

![img](/mosaic-code.jpg)

## 1-7 リレーションの定義と活用

Eloquentはリレーショナルデータベースのテーブル間のリレーションを簡単に定義し、操作を可能にします。

### 1-7-1 リレーションの種類

- **一対一（一つのモデルが他のモデルの一つのレコードと関係する）**
- **一対多（例えば、ユーザーが複数の記事を持つ）**
- **多対多（例えば、役割が複数のユーザーに関連し、ユーザーも複数の役割を持つことができる）**

### 1-7-2 一対多のリレーション

例えば、ユーザーとポストの関係を定義する場合：

![img](/mosaic-code.jpg)

この定義をすることで、あるユーザーの投稿を簡易的に取得できます。

![img](/mosaic-code.jpg)

## 1-8 ソフトデリート

ソフトデリートを使用することで、データを物理削除せずに「削除済み」とマークすることが可能です。

### 1-8-1 ソフトデリートの設定

モデルクラスに`SoftDeletes`トレイトを追加し、マイグレーションで`deleted_at`カラムを追加します。

![img](/mosaic-code.jpg)

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

![img](/mosaic-code.jpg)

これで、通常通りに`delete()`メソッドを呼び出すとソフトデリートされます。

![img](/mosaic-code.jpg)

### 1-8-2 ソフトデリート済みデータの取得

ソフトデリートされたデータも取得したい場合は、`withTrashed`メソッドを使用します。

![img](/mosaic-code.jpg)

## 1-9 スコープとクエリビルダの拡張

Eloquentのスコープ機能を使用することで、再利用可能なクエリ条件をモデルに追加できます。

例えば、アクティブなユーザーを取得するスコープを定義する場合：

![img](/mosaic-code.jpg)

これを適用する際には：

![img](/mosaic-code.jpg)

## 1-10 まとめ

Eloquent ORMは、Laravelの強力なデータベース操作ツールであり、データベースとのやりとりを簡単にし、複雑なリレーショナルデータベースの操作をよりわかりやすく管理することが可能です。本記事では、基本的な使い方を中心に解説しましたが、Eloquentにはさらに多くの機能があります。Eloquentは標準機能の豊富さから、迅速かつ柔軟にアプリケーションを構築する強い味方となります。 [cv:issue_marketplace_engineer]

# LaravelのEloquent ORMを使ったデータベース操作入門

## 1-0 目次

1. 1-1 Eloquent ORMとは
2. 1-2 基本設定と準備
3. 1-3 モデルの作成と基本的な使い方
4. 1-4 データの取得
5. 1-5 データの挿入と更新
6. 1-6 データの削除
7. 1-7 リレーションの定義と活用
8. 1-8 ソフトデリート
9. 1-9 スコープとクエリビルダの拡張
10. 1-10 まとめ

## 1-1 Eloquent ORMとは

Eloquent ORMは、Laravelフレームワークに組み込まれているオブジェクトリレーショナルマッピング（ORM）ツールです。オブジェクト指向プログラミングとデータベース操作をスムーズに連携させ、開発者がコードをアクセスしやすく、保守しやすく作成できるように設計されています。

Eloquentでは、テーブルごとにモデルクラスを作成し、データベーステーブルとデータを操作します。このモデルを利用して、データベースクエリの作成、データの取得、作成、更新、削除といった基本的な操作を簡単に実行できます。

また、Eloquentは「アクティブレコードパターン」に基づいており、各モデルクラスのインスタンスがデータベーステーブルの一行を表現します。

## 1-2 基本設定と準備

### 1-2-1 Laravelプロジェクトの初期化

Laravelプロジェクトを開始するには、Composerを使用します。

```bash
composer create-project --prefer-dist laravel/laravel your-project-name
```

### 1-2-2 データベース設定ファイルの編集

データベース接続の設定は、`.env`ファイルで管理されます。以下のように、データベースの情報を入力します。

```
DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=your_database
DB_USERNAME=your_username
DB_PASSWORD=your_password
```

### 1-2-3 マイグレーションの実行

モデルの構築前に、Laravelのマイグレーション機能を使用してテーブルを作成します。

```bash
php artisan make:migration create_users_table
```

このコマンドは、`database/migrations`ディレクトリ内にマイグレーションファイルを作成します。中でテーブルのスキーマを定義します。

```php
Schema::create('users', function (Blueprint $table) {
    $table->id();
    $table->string('name');
    $table->string('email')->unique();
    $table->timestamps();
});
```

マイグレーションを適用するには、以下のコマンドを実行します。

```bash
php artisan migrate
```

## 1-3 モデルの作成と基本的な使い方

### 1-3-1 モデルの作成

Eloquentモデルを作成するには、artisanコマンドを使用します。

```bash
php artisan make:model User
```

モデルファイルは`app/Models`ディレクトリに作成され、`User`モデルは`users`テーブルを操作するために使用されます。

### 1-3-2 モデルの基本構成

`User`モデルの基本構成は以下のとおりです。

```php
<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;

class User extends Model
{
    use HasFactory;

    // 必要に応じてテーブル名の設定を行うことができます。
    // protected $table = 'users';

    // fillableプロパティを使用してマスアサインメントが可能な属性を指定
    protected $fillable = ['name', 'email'];
}
```

## 1-4 データの取得

### 1-4-1 全データの取得

`User`テーブルから全てのレコードを取得するには、以下のようにします。

```php
$users = User::all();
```

### 1-4-2 条件付きのデータ取得

フィルター条件を使用してデータを取得できます。例えば、特定のメールアドレスを持つユーザーを取得するには、次のコードを使用します。

```php
$user = User::where('email', 'example@example.com')->first();
```

### 1-4-3 ペジネーション

大量のデータを取得する時は、ページネーションを活用します。

```php
$users = User::paginate(15);
```

これにより、指定した件数ごとにデータを区切って表示できます。

## 1-5 データの挿入と更新

### 1-5-1 データの挿入

新しいユーザーをデータベースに挿入するには、新しいインスタンスを作成し、`save`メソッドを使用します。

```php
$user = new User();
$user->name = 'John Doe';
$user->email = 'john@example.com';
$user->save();
```

### 1-5-2 マスアサインメントを使ったデータの挿入

`create`メソッドを使用して、より簡潔にデータを挿入できます。ただし、安全性のためにモデルの`$fillable`プロパティに許可する属性を設定する必要があります。

```php
User::create([
    'name' => 'Jane Doe',
    'email' => 'jane@example.com'
]);
```

### 1-5-3 データの更新

既存のデータを更新するには、`find`メソッドで対象レコードを取得し、属性を更新後、`save`メソッドを使用します。

```php
$user = User::find(1);
$user->name = 'Johnny Doe';
$user->save();
```

## 1-6 データの削除

### 1-6-1 データの削除

特定のユーザーを削除するには、対象のモデルインスタンスを取得し、`delete`メソッドを使用します。

```php
$user = User::find(1);
$user->delete();
```

### 1-6-2 複数データの削除

複数の行をまとめて削除する場合は、条件を指定して`delete`メソッドを使用します。

```php
User::where('created_at', '<', now()->subMonth())->delete();
```

## 1-7 リレーションの定義と活用

Eloquentはリレーショナルデータベースのテーブル間のリレーションを簡単に定義し、操作を可能にします。

### 1-7-1 リレーションの種類

- **一対一（一つのモデルが他のモデルの一つのレコードと関係する）**
- **一対多（例えば、ユーザーが複数の記事を持つ）**
- **多対多（例えば、役割が複数のユーザーに関連し、ユーザーも複数の役割を持つことができる）**

### 1-7-2 一対多のリレーション

例えば、ユーザーとポストの関係を定義する場合：

```php
// Userモデル
public function posts()
{
    return $this->hasMany(Post::class);
}

// Postモデル
public function user()
{
    return $this->belongsTo(User::class);
}
```

この定義をすることで、あるユーザーの投稿を簡易的に取得できます。

```php
$user = User::find(1);
$posts = $user->posts;
```

## 1-8 ソフトデリート

ソフトデリートを使用することで、データを物理削除せずに「削除済み」とマークすることが可能です。

### 1-8-1 ソフトデリートの設定

モデルクラスに`SoftDeletes`トレイトを追加し、マイグレーションで`deleted_at`カラムを追加します。

```php
use Illuminate\Database\Eloquent\SoftDeletes;

class User extends Model
{
    use SoftDeletes;
}
```

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

```php
Schema::table('users', function (Blueprint $table) {
    $table->softDeletes();
});
```

これで、通常通りに`delete()`メソッドを呼び出すとソフトデリートされます。

```php
$user = User::find(1);
$user->delete();
```

### 1-8-2 ソフトデリート済みデータの取得

ソフトデリートされたデータも取得したい場合は、`withTrashed`メソッドを使用します。

```php
$users = User::withTrashed()->get();
```

## 1-9 スコープとクエリビルダの拡張

Eloquentのスコープ機能を使用することで、再利用可能なクエリ条件をモデルに追加できます。

例えば、アクティブなユーザーを取得するスコープを定義する場合：

```php
public function scopeActive($query)
{
    return $query->where('active', 1);
}
```

これを適用する際には：

```php
$activeUsers = User::active()->get();
```

## 1-10 まとめ

Eloquent ORMは、Laravelの強力なデータベース操作ツールであり、データベースとのやりとりを簡単にし、複雑なリレーショナルデータベースの操作をよりわかりやすく管理することが可能です。本記事では、基本的な使い方を中心に解説しましたが、Eloquentにはさらに多くの機能があります。Eloquentは標準機能の豊富さから、迅速かつ柔軟にアプリケーションを構築する強い味方となります。 [![image](https://firebasestorage.googleapis.com/v0/b/issue-pro-42602.appspot.com/o/topics%2F17fa658b-53c7-4ca0-a28b-e588ed1bd371?alt=media&token=2c00afff-85ff-4428-8d15-696ab676dcb0)](https://i-ssue.com/lp/check_salary)

LaravelのEloquent ORMを使ったデータベース操作入門

1-0 目次

続きを読むには単価診断を受けてください（30秒）