ADODB_DataDict Class Reference

Inheritance diagram for ADODB_DataDict:


Public Member Functions
	GetCommentSQL ($table, $col)
	in other words, we use a text area for editting.
	SetCommentSQL ($table, $col, $cmt)
	MetaTables ()
	MetaColumns ($tab, $upper=true, $schema=false)
	MetaPrimaryKeys ($tab, $owner=false, $intkey=false)
	MetaIndexes ($table, $primary=false, $owner=false)
	MetaType ($t, $len=-1, $fieldobj=false)
	NameQuote ($name=NULL, $allowBrackets=false)
	TableName ($name)
	ExecuteSQLArray ($sql, $continueOnError=true)
	ActualType ($meta)
	CreateDatabase ($dbname, $options=false)
	CreateIndexSQL ($idxname, $tabname, $flds, $idxoptions=false)
	DropIndexSQL ($idxname, $tabname=NULL)
	SetSchema ($schema)
	AddColumnSQL ($tabname, $flds)
	AlterColumnSQL ($tabname, $flds, $tableflds='', $tableoptions='')
	RenameColumnSQL ($tabname, $oldcolumn, $newcolumn, $flds='')
	DropColumnSQL ($tabname, $flds, $tableflds='', $tableoptions='')
	DropTableSQL ($tabname)
	RenameTableSQL ($tabname, $newname)
	CreateTableSQL ($tabname, $flds, $tableoptions=false)
	_GenFields ($flds, $widespacing=false)
	_GetSize ($ftype, $ty, $fsize, $fprec)
	_CreateSuffix ($fname, $ftype, $fnotnull, $fdefault, $fautoinc, $fconstraint)
	_IndexSQL ($idxname, $tabname, $flds, $idxoptions)
	_DropAutoIncrement ($tabname)
	_TableSQL ($tabname, $lines, $pkey, $tableoptions)
	_Triggers ($tabname, $taboptions)
	_Options ($opts)
	ChangeTableSQL ($tablename, $flds, $tableoptions=false)
Public Attributes
	$connection
	$debug = false
	$dropTable = 'DROP TABLE %s'
	$renameTable = 'RENAME TABLE %s TO %s'
	$dropIndex = 'DROP INDEX %s'
	$addCol = ' ADD'
	$alterCol = ' ALTER COLUMN'
	$dropCol = ' DROP COLUMN'
	$renameColumn = 'ALTER TABLE %s RENAME COLUMN %s TO %s'
	$nameRegex = '\w'
	$nameRegexBrackets = 'a-zA-Z0-9_'
	$schema = false
	$serverInfo = array()
	$autoIncrement = false
	$dataProvider
	$invalidResizeTypes4 = array('CLOB','BLOB','TEXT','DATE','TIME')
	$blobSize = 100

Detailed Description

Definition at line 164 of file adodb-datadict.inc.php.

Member Function Documentation

ADODB_DataDict._CreateSuffix ( $ fname,

$ ftype,

$ fnotnull,

$ fdefault,

$ fautoinc,

$ fconstraint

)

Reimplemented in ADODB2_db2, ADODB2_mssql, and ADODB2_sybase.
Definition at line 607 of file adodb-datadict.inc.php.

ADODB_DataDict._DropAutoIncrement ( $ tabname )

Reimplemented in ADODB2_firebird, ADODB2_oci8, and ADODB2_postgres.
Definition at line 645 of file adodb-datadict.inc.php.

ADODB_DataDict._GenFields ( $ flds,

$ widespacing = false

)

Definition at line 451 of file adodb-datadict.inc.php.

ADODB_DataDict._GetSize ( $ ftype,

$ ty,

$ fsize,

$ fprec

)

Reimplemented in ADODB2_mssql, and ADODB2_postgres.
Definition at line 595 of file adodb-datadict.inc.php.

ADODB_DataDict._IndexSQL ( $ idxname,

$ tabname,

$ flds,

$ idxoptions

)

Reimplemented in ADODB2_mssql, ADODB2_mysql, ADODB2_oci8, ADODB2_postgres, and ADODB2_sybase.
Definition at line 616 of file adodb-datadict.inc.php.

ADODB_DataDict._Options ( $ opts )

Definition at line 695 of file adodb-datadict.inc.php.

ADODB_DataDict._TableSQL ( $ tabname,

$ lines,

$ pkey,

$ tableoptions

)

Definition at line 650 of file adodb-datadict.inc.php.

ADODB_DataDict._Triggers ( $ tabname,

$ taboptions

)

Reimplemented in ADODB2_firebird, and ADODB2_oci8.
Definition at line 687 of file adodb-datadict.inc.php.

ADODB_DataDict.ActualType ( $ meta )

Reimplemented in ADODB2_access, ADODB2_db2, ADODB2_firebird, ADODB2_generic, ADODB2_ibase, ADODB2_informix, ADODB2_mssql, ADODB2_mysql, ADODB2_oci8, ADODB2_postgres, ADODB2_sapdb, and ADODB2_sybase.
Definition at line 298 of file adodb-datadict.inc.php.

ADODB_DataDict.AddColumnSQL ( $ tabname,

$ flds

)

Reimplemented in ADODB2_mssql, ADODB2_oci8, ADODB2_postgres, ADODB2_sapdb, and ADODB2_sybase.
Definition at line 343 of file adodb-datadict.inc.php.

ADODB_DataDict.AlterColumnSQL ( $ tabname,

$ flds,

$ tableflds = '',

$ tableoptions = ''

)

Change the definition of one column
As some DBM's can't do that on there own, you need to supply the complete defintion of the new table, to allow, recreating the table and copying the content over to the new table
Parameters:

string $tabname table-name

string $flds column-name and type for the changed column

string $tableflds='' complete defintion of the new table, eg. for postgres, default ''

array/string $tableoptions='' options for the new table see CreateTableSQL, default ''

Returns:
array with SQL strings

Reimplemented in ADODB2_postgres.
Definition at line 366 of file adodb-datadict.inc.php.

ADODB_DataDict.ChangeTableSQL ( $ tablename,

$ flds,

$ tableoptions = false

)

Reimplemented in ADODB2_db2.
Definition at line 712 of file adodb-datadict.inc.php.

ADODB_DataDict.CreateDatabase ( $ dbname,

$ options = false

)

Reimplemented in ADODB2_access, ADODB2_firebird, and ADODB2_oci8.
Definition at line 303 of file adodb-datadict.inc.php.

ADODB_DataDict.CreateIndexSQL ( $ idxname,

$ tabname,

$ flds,

$ idxoptions = false

)

Definition at line 319 of file adodb-datadict.inc.php.

ADODB_DataDict.CreateTableSQL ( $ tabname,

$ flds,

$ tableoptions = false

)

Definition at line 435 of file adodb-datadict.inc.php.

ADODB_DataDict.DropColumnSQL ( $ tabname,

$ flds,

$ tableflds = '',

$ tableoptions = ''

)

Drop one column
Some DBM's can't do that on there own, you need to supply the complete defintion of the new table, to allow, recreating the table and copying the content over to the new table
Parameters:

string $tabname table-name

string $flds column-name and type for the changed column

string $tableflds='' complete defintion of the new table, eg. for postgres, default ''

array/string $tableoptions='' options for the new table see CreateTableSQL, default ''

Returns:
array with SQL strings

Reimplemented in ADODB2_postgres.
Definition at line 410 of file adodb-datadict.inc.php.

ADODB_DataDict.DropIndexSQL ( $ idxname,

$ tabname = NULL

)

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

ADODB_DataDict.DropTableSQL ( $ tabname )

Reimplemented in ADODB2_postgres.
Definition at line 422 of file adodb-datadict.inc.php.

ADODB_DataDict.ExecuteSQLArray ( $ sql,

$ continueOnError = true

)

Definition at line 261 of file adodb-datadict.inc.php.

ADODB_DataDict.GetCommentSQL ( $ table,

$ col

)

in other words, we use a text area for editting.
any varchar/char field this size or greater is treated as a blob
Reimplemented in ADODB2_oci8.
Definition at line 184 of file adodb-datadict.inc.php.

ADODB_DataDict.MetaColumns ( $ tab,

$ upper = true,

$ schema = false

)

Definition at line 200 of file adodb-datadict.inc.php.

ADODB_DataDict.MetaIndexes ( $ table,

$ primary = false,

$ owner = false

)

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

ADODB_DataDict.MetaPrimaryKeys ( $ tab,

$ owner = false,

$ intkey = false

)

Definition at line 206 of file adodb-datadict.inc.php.

ADODB_DataDict.MetaTables ( )

Definition at line 194 of file adodb-datadict.inc.php.

ADODB_DataDict.MetaType ( $ t,

$ len = -1,

$ fieldobj = false

)

Reimplemented in ADODB2_mssql, ADODB2_mysql, ADODB2_postgres, ADODB2_sapdb, and ADODB2_sybase.
Definition at line 218 of file adodb-datadict.inc.php.

ADODB_DataDict.NameQuote ( $ name = NULL,

$ allowBrackets = false

)

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

ADODB_DataDict.RenameColumnSQL ( $ tabname,

$ oldcolumn,

$ newcolumn,

$ flds = ''

)

Rename one column
Some DBM's can only do this together with changeing the type of the column (even if that stays the same, eg. mysql)
Parameters:

string $tabname table-name

string $oldcolumn column-name to be renamed

string $newcolumn new column-name

string $flds='' complete column-defintion-string like for AddColumnSQL, only used by mysql atm., default=''

Returns:
array with SQL strings

Definition at line 388 of file adodb-datadict.inc.php.

ADODB_DataDict.RenameTableSQL ( $ tabname,

$ newname

)

Definition at line 427 of file adodb-datadict.inc.php.

ADODB_DataDict.SetCommentSQL ( $ table,

$ col,

$ cmt

)

Reimplemented in ADODB2_oci8.
Definition at line 189 of file adodb-datadict.inc.php.

ADODB_DataDict.SetSchema ( $ schema )

Reimplemented in ADODB2_access.
Definition at line 338 of file adodb-datadict.inc.php.

ADODB_DataDict.TableName ( $ name )

Definition at line 252 of file adodb-datadict.inc.php.

Member Data Documentation

ADODB_DataDict.$addCol = ' ADD'

Reimplemented in ADODB2_postgres.
Definition at line 170 of file adodb-datadict.inc.php.

ADODB_DataDict.$alterCol = ' ALTER COLUMN'

Reimplemented in ADODB2_mysql, and ADODB2_oci8.
Definition at line 171 of file adodb-datadict.inc.php.

ADODB_DataDict.$autoIncrement = false

Definition at line 178 of file adodb-datadict.inc.php.

ADODB_DataDict.$blobSize = 100

Reimplemented in ADODB2_firebird.
Definition at line 181 of file adodb-datadict.inc.php.

ADODB_DataDict.$connection

Definition at line 165 of file adodb-datadict.inc.php.

ADODB_DataDict.$dataProvider

Definition at line 179 of file adodb-datadict.inc.php.

ADODB_DataDict.$debug = false

Definition at line 166 of file adodb-datadict.inc.php.

ADODB_DataDict.$dropCol = ' DROP COLUMN'

Definition at line 172 of file adodb-datadict.inc.php.

ADODB_DataDict.$dropIndex = 'DROP INDEX %s'

Reimplemented in ADODB2_mssql, ADODB2_mysql, and ADODB2_sybase.
Definition at line 169 of file adodb-datadict.inc.php.

ADODB_DataDict.$dropTable = 'DROP TABLE %s'

Reimplemented in ADODB2_mysql, ADODB2_oci8, and ADODB2_postgres.
Definition at line 167 of file adodb-datadict.inc.php.

ADODB_DataDict.$invalidResizeTypes4 = array('CLOB','BLOB','TEXT','DATE','TIME')

Definition at line 180 of file adodb-datadict.inc.php.

ADODB_DataDict.$nameRegex = '\w'

Definition at line 174 of file adodb-datadict.inc.php.

ADODB_DataDict.$nameRegexBrackets = 'a-zA-Z0-9_'

Definition at line 175 of file adodb-datadict.inc.php.

ADODB_DataDict.$renameColumn = 'ALTER TABLE %s RENAME COLUMN %s TO %s'

Reimplemented in ADODB2_mssql, ADODB2_mysql, and ADODB2_sapdb.
Definition at line 173 of file adodb-datadict.inc.php.

ADODB_DataDict.$renameTable = 'RENAME TABLE %s TO %s'

Reimplemented in ADODB2_mssql, and ADODB2_postgres.
Definition at line 168 of file adodb-datadict.inc.php.

ADODB_DataDict.$schema = false

Definition at line 176 of file adodb-datadict.inc.php.

ADODB_DataDict.$serverInfo = array()

Definition at line 177 of file adodb-datadict.inc.php.

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

typo3/sysext/adodb/adodb/adodb-datadict.inc.php

Generated on Fri Apr 7 10:48:43 2006 for TYPO3 by

1.4.6

ADODB_DataDict Class Reference

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

Member Data Documentation