PDO::connect

(PHP 8 >= 8.4.0)

PDO::connect — データベースに接続しドライバが対応する PDO サブクラスを返す

説明

public static PDO::connect(
    string $dsn,
    ?string $username = null,
    #[\SensitiveParameter] ?string $password = null,
    ?array $options = null
): static

接続するデータベースに対応する PDO サブクラスが存在する場合そのインスタンスを、存在しない場合は汎用的な PDO インスタンスを作成します。

パラメータ

dsn

データソース名(Data Source Name)またはDSN。データベースに接続するために必要な情報が含まれます。

一般に、DSNはPDOドライバ名の後にコロンが続き、各PDOドライバに固有の接続構文が続きます。より多くの情報は PDO driver-specific documentation にあります。

dsn パラメータは、データベースへの接続を生成するために必要な引数を指定する方法として、3種類の方法をサポートします。

ドライバ呼び出し

dsn に完全な DSN を指定します。

URI 呼び出し

dsn は、uri: の後に DSN 文字列を含むファイルの位置を定義する URI が続く形式となります。この URI には、ローカルファイルまたはリモート URL を指定することができます。

uri:file:///path/to/dsnfile

エイリアス

dsn は、DSN 文字列を定義する php.ini の pdo.dsn.name へマップする名前 name からなります。

注意:
エイリアスは、.htaccess や httpd.conf ではなく、 php.ini で定義する必要があります。

username

DSN 文字列のユーザー名。このパラメータは、いくつかの PDO ドライバではオプションです。

password

DSN 文字列のパスワード。このパラメータは、いくつかの PDO ドライバではオプションです。

options

ドライバ固有の接続オプションを指定するキー=> 値の配列。

戻り値

接続するデータベースに対応する PDO サブクラスが存在する場合そのインスタンス、または汎用的な PDO インスタンスを返します。

エラー / 例外

指定されたデータベースへの接続に失敗した場合、 PDO::ATTR_ERRMODE が設定されているかどうかに関わらず、 PDOException をスローします。

参考

Pdo\Dblib
Pdo\Firebird
Pdo\Mysql
Pdo\Odbc
Pdo\Pgsql
Pdo\Sqlite
PDO::__construct() - データベースへの接続を表す PDO インスタンスを生成する