How to Use Doctrine DBAL

Note

ノート

This article is about the Doctrine DBAL. Typically, you'll work with the higher level Doctrine ORM layer, which uses the DBAL behind the scenes to actually communicate with the database. To read more about the Doctrine ORM, see "Databases and the Doctrine ORM".

この記事は Doctrine DBAL に関するものです。通常、バックグラウンドで DBAL を使用して実際にデータベースと通信する、より高いレベルの Doctrine ORM レイヤーを使用します。 Doctrine ORM の詳細については、「データベースと Doctrine ORM」を参照してください。

The Doctrine Database Abstraction Layer (DBAL) is an abstraction layer that sits on top of PDO and offers an intuitive and flexible API for communicating with the most popular relational databases. The DBAL library allows you to write queries independently of your ORM models, e.g. for building reports or direct data manipulations.

Doctrine Database Abstraction Layer (DBAL) は、PDO の上にある抽象化レイヤーであり、最も一般的なリレーショナル データベースと通信するための直感的で柔軟な API を提供します。 DBAL ライブラリを使用すると、ORM モデルから独立してクエリを作成できます。レポートの作成または直接データ操作用。

Tip

ヒント

Read the official Doctrine DBAL Documentation to learn all the details and capabilities of Doctrine's DBAL library.

Doctrine の DBAL ライブラリのすべての詳細と機能については、公式の Doctrine DBAL ドキュメントをお読みください。

First, install the Doctrine orm Symfony pack:

まず、Doctrine orm Symfony パックをインストールします。
1
 
$ composer require symfony/orm-pack

Then configure the DATABASE_URL environment variable in .env:

次に、.env で DATABASE_URL 環境変数を構成します。
1
2
3
4
 
# .env (or override DATABASE_URL in .env.local to avoid committing your changes)

# customize this line!
DATABASE_URL="mysql://db_user:db_password@127.0.0.1:3306/db_name?serverVersion=5.7"

Further things can be configured in config/packages/doctrine.yaml - see Doctrine Configuration Reference (DoctrineBundle). Remove the orm key in that file if you don't want to use the Doctrine ORM.

さらに、config/packages/doctrine.yaml で設定できます -Doctrine 設定リファレンス (DoctrineBundle) を参照してください。 Doctrine ORM を使用したくない場合は、そのファイルの orm キーを削除してください。

You can then access the Doctrine DBAL connection by autowiring the Connection object:

次に、Connection オブジェクトをオートワイヤーすることで、Doctrine DBAL 接続にアクセスできます。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
 
// src/Controller/UserController.php
namespace App\Controller;

use Doctrine\DBAL\Connection;
use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\HttpFoundation\Response;

class UserController extends AbstractController
{
    public function index(Connection $connection): Response
    {
        $users = $connection->fetchAllAssociative('SELECT * FROM users');

        // ...
    }
}

This will pass you the database_connection service.

これにより、database_connection サービスが渡されます。

Registering custom Mapping Types

You can register custom mapping types through Symfony's configuration. They will be added to all configured connections. For more information on custom mapping types, read Doctrine's Custom Mapping Types section of their documentation.

Symfony の設定を通じてカスタム マッピング タイプを登録できます。これらは、構成されたすべての接続に追加されます。カスタムマッピング タイプの詳細については、Doctrine のドキュメントのカスタム マッピング タイプのセクションを参照してください。
  • YAML
    YAML
  • XML
    XML
  • PHP
    PHP
1
2
3
4
5
6
 
# config/packages/doctrine.yaml
doctrine:
    dbal:
        types:
            custom_first:  App\Type\CustomFirst
            custom_second: App\Type\CustomSecond

Registering custom Mapping Types in the SchemaTool

The SchemaTool is used to inspect the database to compare the schema. To achieve this task, it needs to know which mapping type needs to be used for each database type. Registering new ones can be done through the configuration.

SchemaTool は、データベースを検査してスキーマを比較するために使用されます。このタスクを達成するには、データベース タイプごとにどのマッピング タイプを使用する必要があるかを知る必要があります。新しいものを登録するには、構成を介して行うことができます。

Now, map the ENUM type (not supported by DBAL by default) to the string mapping type:

ここで、ENUM 型 (デフォルトでは DBAL ではサポートされていません) を stringmapping 型にマップします。
  • YAML
    YAML
  • XML
    XML
  • PHP
    PHP
1
2
3
4
5
 
# config/packages/doctrine.yaml
doctrine:
    dbal:
        mapping_types:
            enum: string