Source for file odbc.php
Documentation is available at odbc.php
// vim: set et ts=4 sw=4 fdm=marker:
//echo "\n".$connection."\n";
return odbc_do ($connection, $query);
return odbc_fetch_array ($result);
// {{{ Class MDB2_Driver_odbc
* MDB2 odbc Server driver
* @author Frank M. Kromann <frank@kromann.info> rewritten for ODBC by Philipp Schellhaas (mail@pschellhaas.de)
var $string_quoting = array ('start' => "'", 'end' => "'", 'escape' => "'", 'escape_pattern' => false );
$this->dbsyntax = 'odbc';
$this->supported['sequences'] = 'emulated';
$this->supported['indexes'] = true;
$this->supported['affected_rows'] = false;
$this->supported['transactions'] = false;
$this->supported['savepoints'] = false;
$this->supported['summary_functions'] = true;
$this->supported['order_by_text'] = true;
$this->supported['current_id'] = 'emulated';
$this->supported['limit_queries'] = 'emulated';
$this->supported['LOBs'] = true;
$this->supported['replace'] = 'emulated';
$this->supported['sub_selects'] = true;
$this->supported['triggers'] = true;
$this->supported['auto_increment'] = true;
$this->supported['primary_key'] = true;
$this->supported['result_introspection'] = false;
$this->supported['prepared_statements'] = 'emulated';
$this->supported['pattern_escaping'] = true;
$this->supported['new_link'] = true;
$this->options['DBA_username'] = false;
$this->options['DBA_password'] = false;
$this->options['database_device'] = false;
$this->options['database_size'] = false;
$this->options['max_identifiers_length'] = 128; // MS Access: 64
* This method is used to collect information about an error
function errorInfo($error = null , $connection = null )
$connection = $this->connection;
$result = @odbc_query('select @@ERROR as ErrorCode', $connection);
$native_code = @odbc_result ($result, 0 , 0 );
@odbc_free_result ($result);
$native_msg = @odbc_errormsg ();
102 => MDB2_ERROR_SYNTAX ,
110 => MDB2_ERROR_VALUE_COUNT_ON_ROW ,
155 => MDB2_ERROR_NOSUCHFIELD ,
156 => MDB2_ERROR_SYNTAX ,
170 => MDB2_ERROR_SYNTAX ,
207 => MDB2_ERROR_NOSUCHFIELD ,
208 => MDB2_ERROR_NOSUCHTABLE ,
245 => MDB2_ERROR_INVALID_NUMBER ,
319 => MDB2_ERROR_SYNTAX ,
321 => MDB2_ERROR_NOSUCHFIELD ,
325 => MDB2_ERROR_SYNTAX ,
336 => MDB2_ERROR_SYNTAX ,
515 => MDB2_ERROR_CONSTRAINT_NOT_NULL ,
547 => MDB2_ERROR_CONSTRAINT ,
911 => MDB2_ERROR_NOT_FOUND ,
1018 => MDB2_ERROR_SYNTAX ,
1035 => MDB2_ERROR_SYNTAX ,
1801 => MDB2_ERROR_ALREADY_EXISTS ,
1913 => MDB2_ERROR_ALREADY_EXISTS ,
2209 => MDB2_ERROR_SYNTAX ,
2223 => MDB2_ERROR_SYNTAX ,
2248 => MDB2_ERROR_SYNTAX ,
2256 => MDB2_ERROR_SYNTAX ,
2257 => MDB2_ERROR_SYNTAX ,
2627 => MDB2_ERROR_CONSTRAINT ,
2714 => MDB2_ERROR_ALREADY_EXISTS ,
3607 => MDB2_ERROR_DIVZERO ,
3701 => MDB2_ERROR_NOSUCHTABLE ,
7630 => MDB2_ERROR_SYNTAX ,
8134 => MDB2_ERROR_DIVZERO ,
9303 => MDB2_ERROR_SYNTAX ,
9317 => MDB2_ERROR_SYNTAX ,
9318 => MDB2_ERROR_SYNTAX ,
9331 => MDB2_ERROR_SYNTAX ,
9332 => MDB2_ERROR_SYNTAX ,
15253 => MDB2_ERROR_SYNTAX ,
if (isset ($ecode_map[$native_code])) {
&& preg_match('/Cannot drop the index/i', $native_msg)
$error = MDB2_ERROR_NOT_FOUND;
$error = $ecode_map[$native_code];
return array ($error, $native_code, $native_msg);
// {{{ function escapePattern($text)
* Quotes pattern (% and _) characters in a string)
* @param string the input string to quote
* @return string quoted string
foreach ($this->wildcards as $wildcard) {
$text = str_replace($wildcard, '[' . $wildcard . ']', $text);
// {{{ beginTransaction()
* Start a transaction or set a savepoint.
* @param string name of a savepoint to set
* @return mixed MDB2_OK on success, a MDB2 error on failure
$this->debug ('Starting transaction/savepoint', __FUNCTION__ , array ('is_manip' => true , 'savepoint' => $savepoint));
if (!$this->in_transaction) {
return $this->raiseError (MDB2_ERROR_INVALID , null , null ,
'savepoint cannot be released when changes are auto committed', __FUNCTION__ );
$query = 'SAVE TRANSACTION '. $savepoint;
} elseif ($this->in_transaction) {
return MDB2_OK; //nothing to do
if (!$this->destructor_registered && $this->opened_persistent) {
$this->destructor_registered = true;
$result = & $this->_doQuery('BEGIN TRANSACTION', true );
if (MDB2 ::isError ($result)) {
$this->in_transaction = true;
* Commit the database changes done during a transaction that is in
* progress or release a savepoint. This function may only be called when
* auto-committing is disabled, otherwise it will fail. Therefore, a new
* transaction is implicitly started after committing the pending changes.
* @param string name of a savepoint to release
* @return mixed MDB2_OK on success, a MDB2 error on failure
function commit($savepoint = null )
$this->debug ('Committing transaction/savepoint', __FUNCTION__ , array ('is_manip' => true , 'savepoint' => $savepoint));
if (!$this->in_transaction) {
return $this->raiseError (MDB2_ERROR_INVALID , null , null ,
'commit/release savepoint cannot be done changes are auto committed', __FUNCTION__ );
$result = & $this->_doQuery('COMMIT TRANSACTION', true );
if (MDB2 ::isError ($result)) {
$this->in_transaction = false;
* Cancel any database changes done during a transaction or since a specific
* savepoint that is in progress. This function may only be called when
* auto-committing is disabled, otherwise it will fail. Therefore, a new
* transaction is implicitly started after canceling the pending changes.
* @param string name of a savepoint to rollback to
* @return mixed MDB2_OK on success, a MDB2 error on failure
$this->debug ('Rolling back transaction/savepoint', __FUNCTION__ , array ('is_manip' => true , 'savepoint' => $savepoint));
if (!$this->in_transaction) {
return $this->raiseError (MDB2_ERROR_INVALID , null , null ,
'rollback cannot be done changes are auto committed', __FUNCTION__ );
$query = 'ROLLBACK TRANSACTION '. $savepoint;
$result = & $this->_doQuery('ROLLBACK TRANSACTION', true );
if (MDB2 ::isError ($result)) {
$this->in_transaction = false;
* do the grunt work of the connect
* @return connection on success or MDB2 Error Object on failure
function _doConnect($username, $password, $persistent = false )
return $this->raiseError (MDB2_ERROR_NOT_FOUND , null , null ,
'extension '. $this->phptype. ' is not compiled into PHP', __FUNCTION__ );
$this->dsn['hostspec'] ? $this->dsn['hostspec'] : 'localhost',
$username ? $username : null ,
$password ? $password : null ,
if ($this->dsn['port']) {
$params[0 ].= ((substr(PHP_OS , 0 , 3 ) == 'WIN') ? ',' : ':'). $this->dsn['port'];
if ($this->_isNewLinkSet ()) {
$connect_function = $persistent ? 'odbc_pconnect' : 'odbc_connect';
$params = array ($this->database_name,$this->dsn[username ],$this->dsn[password ]);
return $this->raiseError (MDB2_ERROR_CONNECT_FAILED , null , null ,
'unable to establish a connection', __FUNCTION__ , __FUNCTION__ );
//odbc_query('SET ANSI_NULL_DFLT_ON ON', $connection);
if (!empty($this->dsn['charset'])) {
$result = $this->setCharset($this->dsn['charset'], $connection);
if (MDB2::isError($result)) {
if ((bool) ini_get('odbc.datetimeconvert')) {
@ini_set('odbc.datetimeconvert', '0');
if (empty($this->dsn['disable_iso_date'])) {
@odbc_query('SET DATEFORMAT ymd', $connection);
* Connect to the database
* @return true on success, MDB2 Error Object on failure
//if (count(array_diff($this->connected_dsn, $this->dsn)) == 0
if (MDB2 ::areEquals ($this->connected_dsn, $this->dsn)
&& $this->opened_persistent == $this->options['persistent']
$this->options['persistent']
if (MDB2 ::isError ($connection)) {
$this->connection = $connection;
$this->connected_dsn = $this->dsn;
$this->connected_database_name = '';
$this->opened_persistent = $this->options['persistent'];
$this->dbsyntax = $this->dsn['dbsyntax'] ? $this->dsn['dbsyntax'] : $this->phptype;
if ($this->database_name) {
if ($this->database_name != $this->connected_database_name) {
if (!odbc_select_db($this->database_name, $connection)) {
$err = $this->raiseError(null, null, null,
'Could not select the database: '.$this->database_name, __FUNCTION__);
$this->connected_database_name = $this->database_name;
* check if given database name is exists?
* @param string $name name of the database that should be checked
* @return mixed true/false on success, a MDB2 error on failure
$connection = $this->_doConnect($this->dsn['username'],
$this->options['persistent']);
if (MDB2 ::isError ($connection)) {
$result = odbc_select_db ($name, $connection);
$errorInfo = $this->errorInfo(null , $connection);
if ($errorInfo[0 ] != MDB2_ERROR_NOT_FOUND ) {
$result = $this->raiseError ($errorInfo[0 ], null , null , $errorInfo[2 ], __FUNCTION__ );
* Log out and disconnect from the database.
* @param boolean $force if the disconnect should be forced even if the
* connection is opened persistently
* @return mixed true on success, false if not connected and error
if ($this->in_transaction) {
$database_name = $this->database_name;
$persistent = $this->options['persistent'];
$this->dsn = $this->connected_dsn;
$this->database_name = $this->connected_database_name;
$this->options['persistent'] = $this->opened_persistent;
$this->database_name = $database_name;
$this->options['persistent'] = $persistent;
if (!$this->opened_persistent || $force) {
$ok = odbc_close ($this->connection);
return $this->raiseError (MDB2_ERROR_DISCONNECT_FAILED ,
null , null , null , __FUNCTION__ );
return parent ::disconnect ($force);
* @param string $query the SQL query
* @param mixed $types array that contains the types of the columns in
* @param boolean $is_manip if the query is a manipulation query
* @return mixed MDB2_OK on success, a MDB2 error on failure
$user = $this->options['DBA_username']? $this->options['DBA_username'] : $this->dsn['username'];
$pass = $this->options['DBA_password']? $this->options['DBA_password'] : $this->dsn['password'];
$connection = $this->_doConnect($user, $pass, $this->options['persistent']);
if (MDB2 ::isError ($connection)) {
$this->offset = $this->limit = 0;
$query = $this->_modifyQuery($query, $is_manip, $limit, $offset);
$result = & $this->_doQuery($query, $is_manip, $connection, $this->database_name);
if (!MDB2 ::isError ($result)) {
$result = $this->_affectedRows ($connection, $result);
* @param string $query query
* @param boolean $is_manip if the query is a manipulation query
* @param resource $connection
* @param string $database_name
* @return result or error object
function &_doQuery($query, $is_manip = false , $connection = null , $database_name = null )
// echo "<hr>".$query."<br>\n";
$this->last_query = $query;
$result = $this->debug ($query, 'query', array ('is_manip' => $is_manip, 'when' => 'pre'));
if (MDB2 ::isError ($result)) {
if ($this->options['disable_query']) {
$result = $is_manip ? 0 : null;
$connection = $this->getConnection ();
if (MDB2 ::isError ($connection)) {
$database_name = $this->database_name;
if ($database_name != $this->connected_database_name) {
if (!odbc_select_db($database_name, $connection)) {
$err = $this->raiseError(null, null, null,
'Could not select the database: '.$database_name, __FUNCTION__);
$this->connected_database_name = $database_name;
$err = & $this->raiseError (null , null , null ,
'Could not execute statement', __FUNCTION__ );
$this->debug ($query, 'query', array ('is_manip' => $is_manip, 'when' => 'post', 'result' => $result));
//print_r(odbc_fetch_array($result));
* Returns the number of rows affected
* @param resource $result
* @param resource $connection
* @return mixed MDB2 Error Object or the number of rows affected
function _affectedRows ($connection, $result = null )
$connection = $this->getConnection ();
if (MDB2 ::isError ($connection)) {
return odbc_rows_affected ($connection);
* Changes a query string for various DBMS specific reasons
* @param string $query query to modify
* @param boolean $is_manip if it is a DML query
* @param integer $limit limit the number of rows
* @param integer $offset start reading from given offset
* @return string modified query
$fetch = $offset + $limit;
return preg_replace('/^([\s(])*SELECT( DISTINCT)?(?!\s*TOP\s*\()/i',
" \\1SELECT\\2 TOP $fetch" , $query);
// {{{ getServerVersion()
* return version information about the server
* @param bool $native determines if the raw version string should be returned
* @return mixed array/string with version information or MDB2 error object
if ($this->connected_server_info) {
$server_info = $this->connected_server_info;
$query = 'SELECT @@VERSION';
$server_info = $this->queryOne ($query, 'text');
if (MDB2 ::isError ($server_info)) {
$this->connected_server_info = $server_info;
if (!$native && !MDB2 ::isError ($server_info)) {
if (preg_match('/(\d+)\.(\d+)\.(\d+)/', $server_info, $tmp)) {
'native' => $server_info,
'native' => $server_info,
* Checks if there's a sequence that exists.
* @param string $seq_name The sequence name to verify.
* @return bool $tableExists The value if the table exists or not
function _checkSequence ($seq_name)
$query = " SELECT * FROM $seq_name";
$tableExists = & $this->_doQuery($query, true );
if (MDB2 ::isError ($tableExists)) {
if ($tableExists->getCode () == MDB2_ERROR_NOSUCHTABLE ) {
return odbc_result ($tableExists, 0 , 0 );
* Returns the next free id of a sequence
* @param string $seq_name name of the sequence
* @param boolean $ondemand when true the sequence is
* automatic created, if it
* @return mixed MDB2 Error Object or id
function nextID($seq_name, $ondemand = true )
$sequence_name = $this->quoteIdentifier ($this->getSequenceName ($seq_name), true );
$seqcol_name = $this->quoteIdentifier ($this->options['seqcol_name'], true );
$this->pushErrorHandling (PEAR_ERROR_RETURN );
$this->expectError (MDB2_ERROR_NOSUCHTABLE );
$seq_val = $this->_checkSequence ($sequence_name);
$query = " SET IDENTITY_INSERT $sequence_name OFF ".
" INSERT INTO $sequence_name DEFAULT VALUES";
$query = " INSERT INTO $sequence_name ($seqcol_name) VALUES (0)";
$result = & $this->_doQuery($query, true );
$this->popErrorHandling ();
if (MDB2 ::isError ($result)) {
if ($ondemand && !$this->_checkSequence ($sequence_name)) {
$this->loadModule ('Manager', null , true );
$result = $this->manager->createSequence ($seq_name);
if (MDB2 ::isError ($result)) {
return $this->raiseError ($result, null , null ,
'on demand sequence '. $seq_name. ' could not be created', __FUNCTION__ );
* Little off-by-one problem with the sequence emulation
* here being fixed, that instead of re-calling nextID
* and forcing an increment by one, we simply check if it
* exists, then we get the last inserted id if it does.
* In theory, $seq_name should be created otherwise there would
* have been an error thrown somewhere up there..
if ($this->_checkSequence ($seq_name)) {
return $this->nextID($seq_name, false );
$query = " DELETE FROM $sequence_name WHERE $seqcol_name < $value";
$result = & $this->_doQuery($query, true );
if (MDB2 ::isError ($result)) {
$this->warnings[] = 'nextID: could not delete previous sequence table values from '. $seq_name;
* Returns the autoincrement ID if supported or $id or fetches the current
* ID in a sequence called: $table.(empty($field) ? '' : '_'.$field)
* @param string $table name of the table into which a new row was inserted
* @param string $field name of the field into which a new row was inserted
* @return mixed MDB2 Error Object or id
&& $server_info['major'] >= 8
$query = " SELECT IDENT_CURRENT('$table')";
$query = "SELECT @@IDENTITY";
$query .= ' FROM '. $this->quoteIdentifier ($table, true );
return $this->queryOne ($query, 'integer');
// {{{ Class MDB2_Result_odbc
* MDB2 odbc Server result driver
* @author Frank M. Kromann <frank@kromann.info>
// {{{ _skipLimitOffset()
* Skip the first row of a result set.
* @param resource $result
* @return mixed a result handle or MDB2_OK on success, a MDB2 error on failure
if ($this->rownum >= $this->limit) {
while ($this->offset_count < $this->offset) {
$this->offset_count = $this->limit;
* Fetch a row and insert the data into an existing array.
* @param int $fetchmode how the array data should be indexed
* @param int $rownum number of the row where the data can be found
* @return int data array on success, a MDB2 error on failure
function &fetchRow($fetchmode = MDB2_FETCHMODE_DEFAULT , $rownum = null )
$seek = $this->seek ($rownum);
if (MDB2 ::isError ($seek)) {
if ($fetchmode == MDB2_FETCHMODE_DEFAULT ) {
$fetchmode = $this->db->fetchmode;
if ( $fetchmode == MDB2_FETCHMODE_ASSOC
|| $fetchmode == MDB2_FETCHMODE_OBJECT
&& $this->db->options ['portability'] & MDB2_PORTABILITY_FIX_CASE
if ($this->result === false ) {
$err = & $this->db->raiseError (MDB2_ERROR_NEED_MORE_DATA , null , null ,
'resultset has already been freed', __FUNCTION__ );
$mode = $this->db->options ['portability'] & MDB2_PORTABILITY_EMPTY_TO_NULL;
if ($this->db->options ['portability'] & MDB2_PORTABILITY_RTRIM ) {
if (empty ($this->types)) {
$mode += MDB2_PORTABILITY_RTRIM;
$this->db->_fixResultArrayValues ($row, $mode);
if ( ( $fetchmode != MDB2_FETCHMODE_ASSOC
&& $fetchmode != MDB2_FETCHMODE_OBJECT )
$row = $this->db->datatype ->convertResultRow ($this->types, $row, $rtrim);
} elseif (($fetchmode == MDB2_FETCHMODE_ASSOC
|| $fetchmode == MDB2_FETCHMODE_OBJECT )
&& !empty ($this->types_assoc)
$row = $this->db->datatype ->convertResultRow ($this->types_assoc, $row, $rtrim);
if (!empty ($this->values)) {
$this->_assignBindColumns ($row);
if ($fetchmode === MDB2_FETCHMODE_OBJECT ) {
$object_class = $this->db->options ['fetch_class'];
if ($object_class == 'stdClass') {
$row = new $object_class($row);
* Retrieve the names of columns returned by the DBMS in a query result.
* @return mixed Array variable that holds the names of columns as keys
* or an MDB2 error on failure.
* Some DBMS may not return any columns when the result set
* does not contain any rows.
function _getColumnNames ()
if (MDB2 ::isError ($numcols)) {
for ($column = 0; $column < $numcols; $column++ ) {
$column_name = odbc_field_name ($this->result, $column);
$columns[$column_name] = $column;
if ($this->db->options ['portability'] & MDB2_PORTABILITY_FIX_CASE ) {
* Count the number of columns returned by the DBMS in a query result.
* @return mixed integer value with the number of columns, a MDB2 error
$cols = odbc_num_fields ($this->result);
if ($this->result === false ) {
return $this->db->raiseError (MDB2_ERROR_NEED_MORE_DATA , null , null ,
'resultset has already been freed', __FUNCTION__ );
} elseif (is_null($this->result)) {
return count($this->types);
return $this->db->raiseError (null , null , null ,
'Could not get column count', __FUNCTION__ );
* Move the internal result pointer to the next available result
* @return true on success, false if there is no more result set or an error object on failure
if ($this->result === false ) {
return $this->db->raiseError (MDB2_ERROR_NEED_MORE_DATA , null , null ,
'resultset has already been freed', __FUNCTION__ );
} elseif (is_null($this->result)) {
return odbc_next_result ($this->result);
* Free the internal resources associated with $result.
* @return boolean true on success, false if $result is invalid
if (is_resource($this->result) && $this->db->connection ) {
$free = odbc_free_result ($this->result);
return $this->db->raiseError (null , null , null ,
'Could not free result', __FUNCTION__ );
// {{{ class MDB2_BufferedResult_odbc
* MDB2 odbc Server buffered result driver
* @author Frank M. Kromann <frank@kromann.info>
* Seek to a specific row in a result set
* @param int $rownum number of the row where the data can be found
* @return mixed MDB2_OK on success, a MDB2 error on failure
function seek($rownum = 0 )
if ($this->rownum != ($rownum - 1 ) && !odbc_data_seek ($this->result, $rownum)) {
if ($this->result === false ) {
return $this->db->raiseError (MDB2_ERROR_NEED_MORE_DATA , null , null ,
'resultset has already been freed', __FUNCTION__ );
} elseif (is_null($this->result)) {
return $this->db->raiseError (MDB2_ERROR_INVALID , null , null ,
'tried to seek to an invalid row number ('. $rownum. ')', __FUNCTION__ );
$this->rownum = $rownum - 1;
* Check if the end of the result set has been reached
* @return mixed true or false on sucess, a MDB2 error on failure
if (MDB2 ::isError ($numrows)) {
return $this->rownum < ($numrows - 1 );
* Returns the number of rows in a result object
* @return mixed MDB2 Error Object or the number of rows
$rows = odbc_num_rows ($this->result);
while ($row = odbc_fetch_row ($this->result)) {
@odbc_fetch_row ($this->result, 0 );
if ($this->result === false ) {
return $this->db->raiseError (MDB2_ERROR_NEED_MORE_DATA , null , null ,
'resultset has already been freed', __FUNCTION__ );
} elseif (is_null($this->result)) {
return $this->db->raiseError (null , null , null ,
'Could not get row count', __FUNCTION__ );
if ($rows > $this->limit) {
// {{{ MDB2_Statement_odbc
* MDB2 odbc Server statement driver
* @author Frank M. Kromann <frank@kromann.info>
Documentation generated on Mon, 11 Mar 2019 15:51:21 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.
|