ADOdb

Database Abstraction Layer for PHP

User Tools

Site Tools


v5:reference:connection:adonewconnection

This is an old revision of the document!


adoNewConnection

Syntax before version 6.0.0
mixed adoNewConnection(
    optional string $driverType=''
)
Syntax version 6.0.0
mixed adoNewConnection(
    string $driverType
) 

Description

The function adoNewConnection, in the simple form, loads the database driver specific files as specified by the string $driverType. The driver name must match the name of a file adodb-$driverType-inc.php in the adodb/drivers directory. As there is no 'master list' of drivers, the driver can be named anything, it's existence in this directory is the only way of checking it's validity. This simplicity makes it easy to create a new driver.

Passing a connection DSN

In addition to the simple form, a DSN connection string can be passed to any database that supports that connection type. The $driverType string must be in the following format:

"valid driver name" + "://" + "standard DSN string"

If the DSN string parses correctly, an attempt is made to automatically connect to the database. If the connection succeeds, then there is no need to issue a connect() statement.

Usage

Simple Usage

include 'adodb.inc.php';
/*
 * Simple connection
 */
$driver = 'mysqli';
$db     = adoNewConnection($driver);
/*
 * Now connect to the database
 */
$db->connect('localhost','user','password','employees');

DSN Usage

include 'adodb.inc.php';
/*
 * Set DSN
 */
$driver = 'mysqli';
$DSN    = "user:password@localhost/employees";
$db     = adoNewConnection($driver + '://' + $DSN);
/*
 * Now connected
 */

Additional Parameters To DSN connection

The following additional parameter can be added to the DSN connection string. Some of the parameters only work with specific drivers.

CodeValueParameterDescription
newtruenConnect()Forces a new connection
persisttruepConnect()Creates a persistent connection
persistenttruepConnect()Creates a persistent connection
debugtruedebugEnables debug mode
rolestringWhen using the ibase driver, allows setting a role
dialectintegerUndocumented option
charsetstringsetCharSet()Sets a character set
buffersstringUndocumented option
fetchmodeintsetFetchMode()Sets the fetch mode
charpagestringUndocumented option
clientflagsstringUndocumented option
portintSets the connection port
socketintSets the connection socket
nls_date_formatstringSet date format
cachesecsintSets the number of cache seconds
memcachestringUndocumented series of options

Error Codes

As of version 6.0.0 , the following error codes will be returned if a connection fails.

CodeDescription
-1An invalid driver name was given
-2Unable to parse DSN string
-3Connection to database via DSN string failed
-4DSN option not supported by driver

Note that, because no connection object is available, the codes cannot be retrieved via errorMsg()

v5/reference/connection/adonewconnection.1453040873.txt.gz · Last modified: 2017/04/21 11:37 (external edit)