ADODB_odbc Class Reference

Inheritance diagram for ADODB_odbc:

Collaboration diagram for ADODB_odbc:

List of all members.

Public Member Functions

ADODB_odbc ()

_connect ($argDSN, $argUsername, $argPassword, $argDatabasename)

_pconnect ($argDSN, $argUsername, $argPassword, $argDatabasename)

ServerInfo ()

CreateSequence ($seqname='adodbseq', $start=1)

DropSequence ($seqname)

GenID ($seq='adodbseq', $start=1)

ErrorMsg ()

ErrorNo ()

BeginTrans ()

CommitTrans ($ok=true)

RollbackTrans ()

MetaPrimaryKeys ($table)

& MetaTables ($ttype=false)

ODBCTypes ($t)

& MetaColumns ($table)

Prepare ($sql)

_query ($sql, $inputarr=false)

UpdateBlob ($table, $column, $val, $where, $blobtype='BLOB')

_close ()

_affectedrows ()

Public Attributes

$databaseType = "odbc"

$fmtDate = "'Y-m-d'"

uppercase function

$fmtTimeStamp = "'Y-m-d, h:i:sA'"

used by DBDate() as the default date format used by the database

$replaceQuote = "''"

string that represents FALSE for a database

$dataProvider = "odbc"

$hasAffectedRows = true

supports autoincrement ID?

$binmode = ODBC_BINMODE_RETURN

$useFetchArray = false

$_bindInputArray = false

A boolean variable to state whether its a persistent connection or normal connection. */.

$curmode = SQL_CUR_USE_DRIVER

$_genSeqSQL = "create table %s (id integer)"

$_autocommit = true

$_haserrorfunctions = true

$_has_stupid_odbc_fetch_api_change = true

$_lastAffectedRows = 0

$uCaseTables = true

$_dropSeqSQL = 'drop table %s'

Detailed Description

Definition at line 22 of file adodb-odbc.inc.php.

Member Function Documentation

ADODB_odbc.ADODB_odbc ( )

Definition at line 42 of file adodb-odbc.inc.php.

Referenced by ADODB_access.ADODB_access(), ADODB_ODBC_DB2.ADODB_DB2(), ADODB_odbc_mssql.ADODB_odbc_mssql(), ADODB_odbc_oracle.ADODB_odbc_oracle(), ADODB_SAPDB.ADODB_SAPDB(), ADODB_sqlanywhere.ADODB_sqlanywhere(), and ADODB_vfp.ADODB_vfp().

ADODB_odbc._connect	(	$	argDSN,
		$	argUsername,
		$	argPassword,
		$	argDatabasename
	)

Reimplemented in ADODB_odbc_oracle.

Definition at line 49 of file adodb-odbc.inc.php.

References debug, ADOConnection.Execute(), and ADOConnection.outp().

Here is the call graph for this function:

ADODB_odbc._pconnect	(	$	argDSN,
		$	argUsername,
		$	argPassword,
		$	argDatabasename
	)

Reimplemented in ADODB_odbc_oracle.

Definition at line 68 of file adodb-odbc.inc.php.

References debug, ADOConnection.Execute(), and ADOConnection.outp().

Here is the call graph for this function:

ADODB_odbc.ServerInfo ( )

Get server version info...

Returns:: An array with 2 elements: $arr['string'] is the description string, and $arr[version] is the version (also a string).

Reimplemented from ADOConnection.

Reimplemented in ADODB_ODBC_DB2, ADODB_odbc_mssql, and ADODB_SAPDB.

Definition at line 91 of file adodb-odbc.inc.php.

References $dsn, $rez, and ADOConnection.ServerInfo().

Referenced by ADODB_SAPDB.ServerInfo().

Here is the call graph for this function:

ADODB_odbc.CreateSequence	(	$	seqname = `'adodbseq'`,
		$	start = `1`
	)

Reimplemented from ADOConnection.

Definition at line 121 of file adodb-odbc.inc.php.

References $ok, and ADOConnection.Execute().

Here is the call graph for this function:

ADODB_odbc.DropSequence ( $ seqname )

Reimplemented from ADOConnection.

Definition at line 131 of file adodb-odbc.inc.php.

References ADOConnection.Execute().

Here is the call graph for this function:

ADODB_odbc.GenID	(	$	seqname = `'adodbseq'`,
		$	startID = `1`
	)

Generates a sequence id and stores it in $this->genID; GenID is only available if $this->hasGenID = true;

Parameters:

	seqname	name of sequence to use
	startID	if sequence does not exist, start at this ID

Returns:: 0 if not supported, otherwise a sequence id

Reimplemented from ADOConnection.

Definition at line 143 of file adodb-odbc.inc.php.

References $ok, ADOConnection.Execute(), and ADOConnection.GetOne().

Here is the call graph for this function:

ADODB_odbc.ErrorMsg ( )

Returns:: the last error message

Reimplemented from ADOConnection.

Definition at line 173 of file adodb-odbc.inc.php.

References ADOConnection.ErrorMsg().

Here is the call graph for this function:

ADODB_odbc.ErrorNo ( )

Returns:: the last error number. Normally 0 means no error.

Reimplemented from ADOConnection.

Definition at line 182 of file adodb-odbc.inc.php.

References ADOConnection.ErrorNo().

Here is the call graph for this function:

ADODB_odbc.BeginTrans ( )

Begin a Transaction. Must be followed by CommitTrans() or RollbackTrans().

Returns:: true if succeeded or false if database does not support transactions

Reimplemented from ADOConnection.

Reimplemented in ADODB_access, and ADODB_vfp.

Definition at line 203 of file adodb-odbc.inc.php.

References hasTransactions.

Referenced by ADODB_ODBC_DB2.RowLock().

ADODB_odbc.CommitTrans ( $ ok = true )

If database does not support transactions, always return true as data always commited

Parameters:

$ok

set to false to rollback transaction, true to commit

Returns:: true/false.

Reimplemented from ADOConnection.

Definition at line 212 of file adodb-odbc.inc.php.

References $ok, and RollbackTrans().

Here is the call graph for this function:

ADODB_odbc.RollbackTrans ( )

If database does not support transactions, rollbacks always fail, so return false

Returns:: true/false.

Reimplemented from ADOConnection.

Definition at line 223 of file adodb-odbc.inc.php.

Referenced by CommitTrans().

ADODB_odbc.MetaPrimaryKeys ( $ table )

Reimplemented in ADODB_odbc_mssql, and ADODB_SAPDB.

Definition at line 233 of file adodb-odbc.inc.php.

References $ADODB_FETCH_MODE, $arr, $rs, $schema, and ADOConnection._findschema().

Here is the call graph for this function:

& ADODB_odbc.MetaTables ( $ ttype = false )

Definition at line 267 of file adodb-odbc.inc.php.

References $ADODB_FETCH_MODE, $arr, ADOConnection.$false, and $rs.

ADODB_odbc.ODBCTypes ( $ t )

Definition at line 333 of file adodb-odbc.inc.php.

References $t.

Referenced by MetaColumns().

& ADODB_odbc.MetaColumns ( $ table )

Reimplemented in ADODB_odbc_mssql, ADODB_odbc_oracle, and ADODB_SAPDB.

Definition at line 373 of file adodb-odbc.inc.php.

References $ADODB_FETCH_MODE, ADOConnection.$false, $rs, $schema, ADOConnection._findschema(), and ODBCTypes().

Here is the call graph for this function:

ADODB_odbc.Prepare ( $ sql )

Should prepare the sql statement and return the stmt resource. For databases that do not support this, we return the $sql. To ensure compatibility with databases that do not support prepare:

$stmt = $db->Prepare("insert into table (id, name) values (?,?)"); $db->Execute($stmt,array(1,'Jill')) or die('insert failed'); $db->Execute($stmt,array(2,'Joe')) or die('insert failed');

Parameters:

sql

SQL to send to database

Returns:: return FALSE, or the prepared statement, or the original sql if if the database does not support prepare.

Reimplemented from ADOConnection.

Definition at line 480 of file adodb-odbc.inc.php.

References $sql, $stmt, and _bindInputArray.

ADODB_odbc._query	(	$	sql,
		$	inputarr = `false`
	)

Reimplemented in ADODB_odbc_mssql.

Definition at line 492 of file adodb-odbc.inc.php.

References $sql.

Referenced by ADODB_odbc_mssql._query().

ADODB_odbc.UpdateBlob	(	$	table,
		$	column,
		$	val,
		$	where,
		$	blobtype = `'BLOB'`
	)

Update a blob column, given a where clause. There are more sophisticated blob handling functions that we could have implemented, but all require a very complex API. Instead we have chosen something that is extremely simple to understand and use.

Note: $blobtype supports 'BLOB' and 'CLOB', default is BLOB of course.

Usage to update a $blobvalue which has a primary key blob_id=1 into a field blobtable.blobcolumn:

UpdateBlob('blobtable', 'blobcolumn', $blobvalue, 'blob_id=1');

Insert example:

$conn->Execute('INSERT INTO blobtable (id, blobcol) VALUES (1, null)'); $conn->UpdateBlob('blobtable','blobcol',$blob,'id=1');

Reimplemented from ADOConnection.

Definition at line 577 of file adodb-odbc.inc.php.

References $val, and ADOConnection.Execute().

Here is the call graph for this function:

ADODB_odbc._close ( )

Definition at line 583 of file adodb-odbc.inc.php.

ADODB_odbc._affectedrows ( )

Definition at line 590 of file adodb-odbc.inc.php.

Member Data Documentation

ADODB_odbc.$databaseType = "odbc"

Reimplemented from ADOConnection.

Reimplemented in ADODB_access, ADODB_ODBC_DB2, ADODB_odbc_mssql, ADODB_odbc_oracle, ADODB_SAPDB, ADODB_sqlanywhere, and ADODB_vfp.

Definition at line 23 of file adodb-odbc.inc.php.

ADODB_odbc.$fmtDate = "'Y-m-d'"

uppercase function

Reimplemented from ADOConnection.

Reimplemented in ADODB_access, ADODB_odbc_mssql, ADODB_odbc_oracle, ADODB_SAPDB, and ADODB_vfp.

Definition at line 24 of file adodb-odbc.inc.php.

ADODB_odbc.$fmtTimeStamp = "'Y-m-d, h:i:sA'"

used by DBDate() as the default date format used by the database

Reimplemented from ADOConnection.

Reimplemented in ADODB_access, ADODB_ODBC_DB2, ADODB_odbc_mssql, ADODB_odbc_oracle, ADODB_SAPDB, and ADODB_vfp.

Definition at line 25 of file adodb-odbc.inc.php.

ADODB_odbc.$replaceQuote = "''"

string that represents FALSE for a database

Reimplemented from ADOConnection.

Reimplemented in ADODB_odbc_oracle, and ADODB_vfp.

Definition at line 26 of file adodb-odbc.inc.php.

ADODB_odbc.$dataProvider = "odbc"

Reimplemented from ADOConnection.

Definition at line 27 of file adodb-odbc.inc.php.

ADODB_odbc.$hasAffectedRows = true

supports autoincrement ID?

Reimplemented from ADOConnection.

Definition at line 28 of file adodb-odbc.inc.php.

ADODB_odbc.$binmode = ODBC_BINMODE_RETURN

Definition at line 29 of file adodb-odbc.inc.php.

ADODB_odbc.$useFetchArray = false

Definition at line 30 of file adodb-odbc.inc.php.

ADODB_odbc.$_bindInputArray = false

A boolean variable to state whether its a persistent connection or normal connection. */.

Reimplemented from ADOConnection.

Reimplemented in ADODB_access, ADODB_ODBC_DB2, ADODB_odbc_mssql, ADODB_SAPDB, and ADODB_vfp.

Definition at line 33 of file adodb-odbc.inc.php.

ADODB_odbc.$curmode = SQL_CUR_USE_DRIVER

Reimplemented in ADODB_vfp.

Definition at line 34 of file adodb-odbc.inc.php.

ADODB_odbc.$_genSeqSQL = "create table %s (id integer)"

Definition at line 35 of file adodb-odbc.inc.php.

ADODB_odbc.$_autocommit = true

Definition at line 36 of file adodb-odbc.inc.php.

ADODB_odbc.$_haserrorfunctions = true

Definition at line 37 of file adodb-odbc.inc.php.

ADODB_odbc.$_has_stupid_odbc_fetch_api_change = true

Definition at line 38 of file adodb-odbc.inc.php.

ADODB_odbc.$_lastAffectedRows = 0

Definition at line 39 of file adodb-odbc.inc.php.

ADODB_odbc.$uCaseTables = true

Definition at line 40 of file adodb-odbc.inc.php.

ADODB_odbc.$_dropSeqSQL = 'drop table %s'

Definition at line 130 of file adodb-odbc.inc.php.

The documentation for this class was generated from the following file:

typo3/sysext/adodb/adodb/drivers/adodb-odbc.inc.php


Public Member Functions
	ADODB_odbc ()
	_connect ($argDSN, $argUsername, $argPassword, $argDatabasename)
	_pconnect ($argDSN, $argUsername, $argPassword, $argDatabasename)
	ServerInfo ()
	CreateSequence ($seqname='adodbseq', $start=1)
	DropSequence ($seqname)
	GenID ($seq='adodbseq', $start=1)
	ErrorMsg ()
	ErrorNo ()
	BeginTrans ()
	CommitTrans ($ok=true)
	RollbackTrans ()
	MetaPrimaryKeys ($table)
&	MetaTables ($ttype=false)
	ODBCTypes ($t)
&	MetaColumns ($table)
	Prepare ($sql)
	_query ($sql, $inputarr=false)
	UpdateBlob ($table, $column, $val, $where, $blobtype='BLOB')
	_close ()
	_affectedrows ()
Public Attributes
	$databaseType = "odbc"
	$fmtDate = "'Y-m-d'"
	uppercase function
	$fmtTimeStamp = "'Y-m-d, h:i:sA'"
	used by DBDate() as the default date format used by the database
	$replaceQuote = "''"
	string that represents FALSE for a database
	$dataProvider = "odbc"
	$hasAffectedRows = true
	supports autoincrement ID?
	$binmode = ODBC_BINMODE_RETURN
	$useFetchArray = false
	$_bindInputArray = false
	A boolean variable to state whether its a persistent connection or normal connection. */.
	$curmode = SQL_CUR_USE_DRIVER
	$_genSeqSQL = "create table %s (id integer)"
	$_autocommit = true
	$_haserrorfunctions = true
	$_has_stupid_odbc_fetch_api_change = true
	$_lastAffectedRows = 0
	$uCaseTables = true
	$_dropSeqSQL = 'drop table %s'