PDO::connect
Connect to a database and return a PDO subclass for drivers that support it
Description
public static static PDO::connect(
string $dsn,
stringnull $username = null,
#[\SensitiveParameter]stringnull $password = null,
arraynull $options = null
)
Creates an instance of a PDO subclass for the
database being connection if it exists,
otherwise return a generic PDO instance.
Parameters
-
dsn
-
The Data Source Name, or DSN, contains the information required to
connect to the database.
In general, a DSN consists of the PDO driver name, followed by a colon,
followed by the PDO driver-specific connection syntax. Further
information is available from the PDO
driver-specific documentation.
The dsn parameter supports three
different methods of specifying the arguments required to create
a database connection:
-
Driver invocation
-
dsn contains the full DSN.
-
URI invocation
-
dsn consists of uri:
followed by a URI that defines the location of a file containing
the DSN string. The URI can specify a local file or a remote URL.
uri:file:///path/to/dsnfile
-
Aliasing
-
dsn consists of a name
name that maps to
pdo.dsn.name in php.ini
defining the DSN string.
Note:
The alias must be defined in php.ini, and not .htaccess or httpd.conf
-
username
-
The user name for the DSN string. This parameter is optional for
some PDO drivers.
-
password
-
The password for the DSN string. This parameter is optional for
some PDO drivers.
-
options
-
A key=>value array of driver-specific connection options.
Return Values
Returns an instance of a PDO subclass for the
corresponding PDO driver if it exists,
or a generic PDO instance.
Errors/Exceptions
A PDOException is thrown if the attempt
to connect to the requested database fails,
regardless of which PDO::ATTR_ERRMODE is currently set.
See Also
- Pdo\Dblib
- Pdo\Firebird
- Pdo\Mysql
- Pdo\Odbc
- Pdo\Pgsql
- Pdo\Sqlite
- PDO::__construct