DBX_CONNECT(3) 1 DBX_CONNECT(3)
dbx_connect - Open a connection/database
SYNOPSIS
object dbx_connect (mixed $module, string $host, string $database, string $username, string $password, [int $persistent])
DESCRIPTION
Opens a connection to a database.
PARAMETERS
o $module
- The $module parameter can be either a string or a constant, though the latter form is preferred. The possible values are given
below, but keep in mind that they only work if the module is actually loaded.
o DBX_MYSQL or "mysql"
o DBX_ODBC or "odbc"
o DBX_PGSQL or "pgsql"
o DBX_MSSQL or "mssql"
o DBX_FBSQL or "fbsql"
o DBX_SYBASECT or "sybase_ct"
o DBX_OCI8 or "oci8"
o DBX_SQLITE or "sqlite"
o $host
- The SQL server host
o $database
- The database name
o $username
- The username
o $password
- The password
o $persistent
- The $persistent parameter can be set to DBX_PERSISTENT, if so, a persistent connection will be created.
The $host, $database, $username and $password parameters are expected, but not always used depending on the connect functions for the
abstracted module.
RETURN VALUES
Returns an object on success, FALSE on error. If a connection has been made but the database could not be selected, the connection is
closed and FALSE is returned.
The returned $object has three properties:
o database
- It is the name of the currently selected database.
o handle
- It is a valid handle for the connected database, and as such it can be used in module-specific functions (if required).
<?php
$link = dbx_connect(DBX_MYSQL, "localhost", "db", "username", "password");
mysql_close($link->handle); // dbx_close($link) would be better here
?>
o module
- It is used internally by dbx only, and is actually the module number mentioned above.
CHANGELOG
+--------+---------------------------+
|Version | |
| | |
| | Description |
| | |
+--------+---------------------------+
| 5.0.0 | |
| | |
| | Introduced DBX_SQLITE. |
| | |
| 4.3.0 | |
| | |
| | Introduced DBX_OCI8. |
| | |
| 4.2.0 | |
| | |
| | Introduced DBX_SYBASECT. |
| | |
| 4.1.0 | |
| | |
| | Introduced DBX_FBSQL. |
| | |
+--------+---------------------------+
EXAMPLES
Example #1
dbx_connect(3) example
<?php
$link = dbx_connect(DBX_ODBC, "", "db", "username", "password", DBX_PERSISTENT)
or die("Could not connect");
echo "Connected successfully";
dbx_close($link);
?>
NOTES
Note
Always refer to the module-specific documentation as well.
SEE ALSO
dbx_close(3).
PHP Documentation Group DBX_CONNECT(3)