Docs For Class mysqlDbTools

Description

Provides utilities methods for a mysql database

Located in /plugins/db/mysql/mysql.dbtools.php (line 22)

jDbTools
   |
   --mysqlDbTools

Variable Summary

mixed $typesInfo

Method Summary

void encloseName ( $name)

void execSQLScript ( $file)

array getFieldList (string $tableName, [string $sequence = ''])

array getTableList ()

void parseSQLScript ( $script)

Variables

mixed $typesInfo = array(
// type native type unified type minvalue maxvalue minlength maxlength
'bool' =>array('boolean', 'boolean', 0, 1, null, null),'boolean'=>array('boolean','boolean',0,1,null,null),'bit'=>array('bit','integer',0,1,null,null),'tinyint'=>array('tinyint','integer',-128,127,null,null),'smallint'=>array('smallint','integer',-32768,32767,null,null),'mediumint'=>array('mediumint','integer',-8388608,8388607,null,null),'integer'=>array('integer','integer',-2147483648,2147483647,null,null),'int'=>array('integer','integer',-2147483648,2147483647,null,null),'bigint'=>array('bigint','numeric','-9223372036854775808','9223372036854775807',null,null),'serial'=>array('integer','numeric','-9223372036854775808','9223372036854775807',null,null),'bigserial'=>array('integer','numeric','-9223372036854775808','9223372036854775807',null,null),'autoincrement'=>array('integer','integer',-2147483648,2147483647,null,null),// for old dao files
'bigautoincrement'=>array('bigint','numeric','-9223372036854775808','9223372036854775807',null,null),// for old dao files
'float'=>array('float','float',null,null,null,null),//4bytes
'money'=>array('float','float',null,null,null,null),//4bytes
'double precision'=>array('double precision','decimal',null,null,null,null),//8bytes
'double'=>array('double precision','decimal',null,null,null,null),//8bytes
'real'=>array('real','decimal',null,null,null,null),//8bytes
'number'=>array('real','decimal',null,null,null,null),//8bytes
'binary_float'=>array('float','float',null,null,null,null),//4bytes
'binary_double'=>array('real','decimal',null,null,null,null),//8bytes
'numeric'=>array('numeric','numeric',null,null,null,null),'decimal'=>array('decimal','decimal',null,null,null,null),'dec'=>array('decimal','decimal',null,null,null,null),'date'=>array('date','date',null,null,10,10),'time'=>array('time','time',null,null,8,8),'datetime'=>array('datetime','datetime',null,null,19,19),'timestamp'=>array('datetime','datetime',null,null,19,19),// oracle/pgsql timestamp
'utimestamp'=>array('timestamp','integer',0,2147483647,null,null),// mysql timestamp
'year'=>array('year','year',null,null,2,4),'interval'=>array('datetime','datetime',null,null,19,19),'char'=>array('char','char',null,null,0,255),'nchar'=>array('char','char',null,null,0,255),'varchar'=>array('varchar','varchar',null,null,0,65535),'varchar2'=>array('varchar','varchar',null,null,0,4000),'nvarchar2'=>array('varchar','varchar',null,null,0,4000),'character'=>array('varchar','varchar',null,null,0,65535),'character varying'=>array('varchar','varchar',null,null,0,65535),'name'=>array('varchar','varchar',null,null,0,64),'longvarchar'=>array('varchar','varchar',null,null,0,65535),'string'=>array('varchar','varchar',null,null,0,65535),// for old dao files
'tinytext'=>array('tinytext','text',null,null,0,255),'text'=>array('text','text',null,null,0,65535),'mediumtext'=>array('mediumtext','text',null,null,0,16777215),'longtext'=>array('longtext','text',null,null,0,0),'long'=>array('longtext','text',null,null,0,0),'clob'=>array('longtext','text',null,null,0,0),'nclob'=>array('longtext','text',null,null,0,0),'tinyblob'=>array('tinyblob','varbinary',null,null,0,255),'blob'=>array('blob','varbinary',null,null,0,65535),'mediumblob'=>array('mediumblob','varbinary',null,null,0,16777215),'longblob'=>array('longblob','varbinary',null,null,0,0),'bfile'=>array('longblob','varbinary',null,null,0,0),'bytea'=>array('longblob','varbinary',null,null,0,0),'binary'=>array('binary','binary',null,null,0,255),'varbinary'=>array('varbinary','varbinary',null,null,0,255),'raw'=>array('varbinary','varbinary',null,null,0,2000),'long raw'=>array('varbinary','varbinary',null,null,0,0),'enum'=>array('varchar','varchar',null,null,0,65535),'set'=>array('varchar','varchar',null,null,0,65535),'xmltype'=>array('varchar','varchar',null,null,0,65535),'point'=>array('varchar','varchar',null,null,0,16),'line'=>array('varchar','varchar',null,null,0,32),'lsed'=>array('varchar','varchar',null,null,0,32),'box'=>array('varchar','varchar',null,null,0,32),'path'=>array('varchar','varchar',null,null,0,65535),'polygon'=>array('varchar','varchar',null,null,0,65535),'circle'=>array('varchar','varchar',null,null,0,24),'cidr'=>array('varchar','varchar',null,null,0,24),'inet'=>array('varchar','varchar',null,null,0,24),'macaddr'=>array('integer','integer',0,0xFFFFFFFFFFFF,null,null),'bit varying'=>array('varchar','varchar',null,null,0,65535),'arrays'=>array('varchar','varchar',null,null,0,65535),'complex types'=>array('varchar','varchar',null,null,0,65535),) (line 24)

access: protected

Redefinition of:

jDbTools::$typesInfo

Inherited Variables

Inherited from jDbTools

jDbTools::$dbmsStyle
jDbTools::$falseValue
jDbTools::$trueValue
jDbTools::$unifiedToPhp
jDbTools::$_conn

Methods

encloseName (line 112)

access: public

void encloseName ( $name)

$name

Redefinition of:

jDbTools::encloseName(): enclose the field name

execSQLScript (line 190)

access: public

void execSQLScript ( $file)

$file

Redefinition of:

jDbTools::execSQLScript()

getFieldList (line 148)

retrieve the list of fields of a table

return: keys are field names and values are jDbFieldProperties objects
access: public

array getFieldList (string $tableName, [string $sequence = ''])

string $tableName: the name of the table
string $sequence: the sequence used to auto increment the primary key (not supported here)

Redefinition of:

jDbTools::getFieldList(): retrieve the list of fields of a table

getTableList (line 120)

returns the list of tables

return: list of table names
access: public

array getTableList ()

Redefinition of:

jDbTools::getTableList(): returns the table list

parseSQLScript (line 205)

access: protected

void parseSQLScript ( $script)

$script

Inherited Methods

Inherited From jDbTools

jDbTools::__construct()
jDbTools::encloseName()
jDbTools::escapeValue()
jDbTools::execSQLScript()
jDbTools::getBooleanValue()
jDbTools::getFieldList()
jDbTools::getTableList()
jDbTools::getTypeInfo()
jDbTools::stringToPhpValue()
jDbTools::unifiedToPHPType()