ILIAS
release_5-2 Revision v5.2.25-18-g3f80b828510
|
Public Member Functions | |
getFieldDeclarationList ($fields) | |
Get declaration of a number of field in bulk. More... | |
_fixSequenceName ($sqn, $check=false) | |
Removes any formatting in an sequence name using the 'seqname_format' option. More... | |
_fixIndexName ($idx) | |
Removes any formatting in an index name using the 'idxname_format' option. More... | |
createDatabase ($database) | |
create a new database More... | |
dropDatabase ($database) | |
drop an existing database More... | |
_getCreateTableQuery ($name, $fields, $options=array()) | |
Create a basic SQL query for a new table creation. More... | |
_getTemporaryTableQuery () | |
A method to return the required SQL string that fits between CREATE ... More... | |
createTable ($name, $fields, $options=array()) | |
create a new table More... | |
getTableCreationQuery ($name, $fields, $options=array()) | |
PATCH: For Testcases Only. More... | |
dropTable ($name) | |
drop an existing table More... | |
alterTable ($name, $changes, $check) | |
alter an existing table More... | |
listDatabases () | |
list all databases More... | |
listUsers () | |
list all users More... | |
listViews ($database=null) | |
list all views in the current database More... | |
listTableViews ($table) | |
list the views in the database that reference a given table More... | |
listTableTriggers ($table=null) | |
list all triggers in the database that reference a given table More... | |
listFunctions () | |
list all functions in the current database More... | |
listTables ($database=null) | |
list all tables in the current database More... | |
listTableFields ($table) | |
list all fields in a table in the current database More... | |
createIndex ($table, $name, $definition) | |
Get the stucture of a field into an array. More... | |
dropIndex ($table, $name) | |
drop existing index More... | |
listTableIndexes ($table) | |
list all indexes in a table More... | |
createConstraint ($table, $name, $definition) | |
create a constraint on a table More... | |
dropConstraint ($table, $name, $primary=false) | |
drop existing constraint More... | |
listTableConstraints ($table) | |
list all constraints in a table More... | |
createSequence ($seq_name, $start=1) | |
create sequence More... | |
dropSequence ($name) | |
drop existing sequence More... | |
listSequences ($database=null) | |
list all sequences in the current database More... | |
Public Member Functions inherited from MDB2_Module_Common | |
__construct ($db_index) | |
Constructor. More... | |
MDB2_Module_Common ($db_index) | |
PHP 4 Constructor. More... | |
& | getDBInstance () |
Get the instance of MDB2 associated with the module instance. More... | |
Additional Inherited Members | |
Data Fields inherited from MDB2_Module_Common | |
$db_index | |
Definition at line 61 of file Common.php.
MDB2_Driver_Manager_Common::_fixIndexName | ( | $idx | ) |
Removes any formatting in an index name using the 'idxname_format' option.
string | $idx | string that containts name of anl index |
Definition at line 144 of file Common.php.
References MDB2_Module_Common\getDBInstance(), and PEAR\isError().
Referenced by MDB2_Driver_Manager_pgsql\listTableConstraints(), MDB2_Driver_Manager_mysql\listTableConstraints(), MDB2_Driver_Manager_mysqli\listTableConstraints(), MDB2_Driver_Manager_pgsql\listTableIndexes(), MDB2_Driver_Manager_mysql\listTableIndexes(), and MDB2_Driver_Manager_mysqli\listTableIndexes().
MDB2_Driver_Manager_Common::_fixSequenceName | ( | $sqn, | |
$check = false |
|||
) |
Removes any formatting in an sequence name using the 'seqname_format' option.
string | $sqn | string that containts name of a potential sequence |
bool | $check | if only formatted sequences should be returned |
Definition at line 116 of file Common.php.
References MDB2_Module_Common\getDBInstance(), and PEAR\isError().
Referenced by MDB2_Driver_Manager_pgsql\listSequences(), MDB2_Driver_Manager_mysql\listSequences(), MDB2_Driver_Manager_mysqli\listSequences(), MDB2_Driver_Manager_mysql\listTables(), and MDB2_Driver_Manager_mysqli\listTables().
MDB2_Driver_Manager_Common::_getCreateTableQuery | ( | $name, | |
$fields, | |||
$options = array() |
|||
) |
Create a basic SQL query for a new table creation.
string | $name | Name of the database that should be created |
array | $fields | Associative array that contains the definition of each field of the new table |
array | $options | An associative array of table options |
Definition at line 212 of file Common.php.
References $options, $result, _getTemporaryTableQuery(), MDB2_Module_Common\getDBInstance(), getFieldDeclarationList(), PEAR\isError(), and MDB2_ERROR_CANNOT_CREATE.
Referenced by MDB2_Driver_Manager_mysql\createTable(), MDB2_Driver_Manager_mysqli\createTable(), createTable(), MDB2_Driver_Manager_mysqli\getTableCreationQuery(), and getTableCreationQuery().
MDB2_Driver_Manager_Common::_getTemporaryTableQuery | ( | ) |
A method to return the required SQL string that fits between CREATE ...
TABLE to create the table as a temporary table.
Should be overridden in driver classes to return the correct string for the specific database type.
The default is to return the string "TEMPORARY" - this will result in a SQL error for any database that does not support temporary tables, or that requires a different SQL command from "CREATE TEMPORARY TABLE".
Definition at line 261 of file Common.php.
Referenced by _getCreateTableQuery().
MDB2_Driver_Manager_Common::alterTable | ( | $name, | |
$changes, | |||
$check | |||
) |
alter an existing table
string | $name | name of the table that is intended to be changed. |
array | $changes | associative array that contains the details of each type of change that is intended to be performed. The types of changes that are currently supported are defined as follows: |
name
New name for the table.
add
Associative array with the names of fields to be added as indexes of the array. The value of each entry of the array should be set to another associative array with the properties of the fields to be added. The properties of the fields should be the same as defined by the MDB2 parser.
remove
Associative array with the names of fields to be removed as indexes of the array. Currently the values assigned to each entry are ignored. An empty array should be used for future compatibility.
rename
Associative array with the names of fields to be renamed as indexes of the array. The value of each entry of the array should be set to another associative array with the entry named name with the new field name and the entry named Declaration that is expected to contain the portion of the field declaration already in DBMS specific SQL code as it is used in the CREATE TABLE statement.
change
Associative array with the names of the fields to be changed as indexes of the array. Keep in mind that if it is intended to change either the name of a field and any other properties, the change array entries should have the new names of the fields as array indexes. The value of each entry of the array should be set to another associative array with the properties of the fields to that are meant to be changed as array entries. These entries should be assigned to the new values of the respective properties. The properties of the fields should be the same as defined by the MDB2 parser.
Example array( 'name' => 'userlist', 'add' => array( 'quota' => array( 'type' => 'integer', 'unsigned' => 1 ) ), 'remove' => array( 'file_limit' => array(), 'time_limit' => array() ), 'change' => array( 'name' => array( 'length' => '20', 'definition' => array( 'type' => 'text', 'length' => 20, ), ) ), 'rename' => array( 'sex' => array( 'name' => 'gender', 'definition' => array( 'type' => 'text', 'length' => 1, 'default' => 'M', ), ) ) )
boolean | $check | indicates whether the function should just check if the DBMS driver can perform the requested table alterations if the value is true or actually perform them otherwise. public |
Definition at line 435 of file Common.php.
References MDB2_Module_Common\getDBInstance(), PEAR\isError(), and MDB2_ERROR_UNSUPPORTED.
MDB2_Driver_Manager_Common::createConstraint | ( | $table, | |
$name, | |||
$definition | |||
) |
create a constraint on a table
string | $table | name of the table on which the constraint is to be created |
string | $name | name of the constraint to be created |
array | $definition | associative array that defines properties of the constraint to be created. Currently, only one property named FIELDS is supported. This property is also an associative with the names of the constraint fields as array constraints. Each entry of this array is set to another type of associative array that specifies properties of the constraint that are specific to each field. |
Example array( 'fields' => array( 'user_name' => array(), 'last_login' => array() ) )
Definition at line 736 of file Common.php.
References $query, array, MDB2_Module_Common\getDBInstance(), and PEAR\isError().
Referenced by MDB2_Driver_Manager_oci8\_makeAutoincrement().
MDB2_Driver_Manager_Common::createDatabase | ( | $database | ) |
create a new database
string | $name | name of the database that should be created |
Definition at line 169 of file Common.php.
References MDB2_Module_Common\getDBInstance(), PEAR\isError(), and MDB2_ERROR_UNSUPPORTED.
MDB2_Driver_Manager_Common::createIndex | ( | $table, | |
$name, | |||
$definition | |||
) |
Get the stucture of a field into an array.
string | $table | name of the table on which the index is to be created |
string | $name | name of the index to be created |
array | $definition | associative array that defines properties of the index to be created. Currently, only one property named FIELDS is supported. This property is also an associative with the names of the index fields as array indexes. Each entry of this array is set to another type of associative array that specifies properties of the index that are specific to each field. |
Currently, only the sorting property is supported. It should be used to define the sorting direction of the index. It may be set to either ascending or descending.
Not all DBMS support index sorting direction configuration. The DBMS drivers of those that do not support it ignore this property. Use the function supports() to determine whether the DBMS driver can manage indexes.
Example array( 'fields' => array( 'user_name' => array( 'sorting' => 'ascending' ), 'last_login' => array() ) )
Definition at line 650 of file Common.php.
References $query, array, MDB2_Module_Common\getDBInstance(), and PEAR\isError().
MDB2_Driver_Manager_Common::createSequence | ( | $seq_name, | |
$start = 1 |
|||
) |
create sequence
string | $seq_name | name of the sequence to be created |
string | $start | start value of the sequence; default is 1 |
Definition at line 814 of file Common.php.
References MDB2_Module_Common\getDBInstance(), PEAR\isError(), and MDB2_ERROR_UNSUPPORTED.
MDB2_Driver_Manager_Common::createTable | ( | $name, | |
$fields, | |||
$options = array() |
|||
) |
create a new table
string | $name | Name of the database that should be created |
array | $fields | Associative array that contains the definition of each field of the new table The indexes of the array entries are the names of the fields of the table an the array entry values are associative arrays like those that are meant to be passed with the field definitions to get[Type]Declaration() functions. array( 'id' => array( 'type' => 'integer', 'unsigned' => 1 'notnull' => 1 'default' => 0 ), 'name' => array( 'type' => 'text', 'length' => 12 ), 'password' => array( 'type' => 'text', 'length' => 12 ) ); |
array | $options | An associative array of table options: array( 'comment' => 'Foo', 'temporary' => true|false, ); |
Definition at line 301 of file Common.php.
References $options, $query, _getCreateTableQuery(), MDB2_Module_Common\getDBInstance(), and PEAR\isError().
MDB2_Driver_Manager_Common::dropConstraint | ( | $table, | |
$name, | |||
$primary = false |
|||
) |
drop existing constraint
string | $table | name of table that should be used in method |
string | $name | name of the constraint to be dropped |
string | $primary | hint if the constraint is primary |
Definition at line 770 of file Common.php.
References MDB2_Module_Common\getDBInstance(), and PEAR\isError().
MDB2_Driver_Manager_Common::dropDatabase | ( | $database | ) |
drop an existing database
string | $name | name of the database that should be dropped |
Definition at line 190 of file Common.php.
References MDB2_Module_Common\getDBInstance(), PEAR\isError(), and MDB2_ERROR_UNSUPPORTED.
MDB2_Driver_Manager_Common::dropIndex | ( | $table, | |
$name | |||
) |
drop existing index
string | $table | name of table that should be used in method |
string | $name | name of the index to be dropped |
Definition at line 679 of file Common.php.
References MDB2_Module_Common\getDBInstance(), and PEAR\isError().
MDB2_Driver_Manager_Common::dropSequence | ( | $name | ) |
drop existing sequence
string | $seq_name | name of the sequence to be dropped |
Definition at line 835 of file Common.php.
References MDB2_Module_Common\getDBInstance(), PEAR\isError(), and MDB2_ERROR_UNSUPPORTED.
MDB2_Driver_Manager_Common::dropTable | ( | $name | ) |
drop an existing table
string | $name | name of the table that should be dropped |
Definition at line 331 of file Common.php.
References MDB2_Module_Common\getDBInstance(), and PEAR\isError().
MDB2_Driver_Manager_Common::getFieldDeclarationList | ( | $fields | ) |
Get declaration of a number of field in bulk.
array | $fields | a multidimensional associative array. The first dimension determines the field name, while the second dimension is keyed with the name of the properties of the field being declared as array indexes. Currently, the types of supported field properties are as follows: |
default Boolean value to be used as default for this field.
notnull Boolean flag that indicates whether this field is constrained to not be set to null.
Definition at line 84 of file Common.php.
References $query, MDB2_Module_Common\getDBInstance(), PEAR\isError(), and MDB2_ERROR_NEED_MORE_DATA.
Referenced by _getCreateTableQuery().
MDB2_Driver_Manager_Common::getTableCreationQuery | ( | $name, | |
$fields, | |||
$options = array() |
|||
) |
PATCH: For Testcases Only.
Definition at line 317 of file Common.php.
References $options, and _getCreateTableQuery().
MDB2_Driver_Manager_Common::listDatabases | ( | ) |
list all databases
Definition at line 455 of file Common.php.
References MDB2_Module_Common\getDBInstance(), PEAR\isError(), and MDB2_ERROR_UNSUPPORTED.
MDB2_Driver_Manager_Common::listFunctions | ( | ) |
list all functions in the current database
Definition at line 560 of file Common.php.
References MDB2_Module_Common\getDBInstance(), PEAR\isError(), and MDB2_ERROR_UNSUPPORTED.
MDB2_Driver_Manager_Common::listSequences | ( | $database = null | ) |
list all sequences in the current database
string | database, the current is default NB: not all the drivers can get the sequence names from a database other than the current one |
Definition at line 858 of file Common.php.
References MDB2_Module_Common\getDBInstance(), PEAR\isError(), and MDB2_ERROR_UNSUPPORTED.
MDB2_Driver_Manager_Common::listTableConstraints | ( | $table | ) |
list all constraints in a table
string | $table | name of table that should be used in method |
Definition at line 792 of file Common.php.
References MDB2_Module_Common\getDBInstance(), PEAR\isError(), and MDB2_ERROR_UNSUPPORTED.
MDB2_Driver_Manager_Common::listTableFields | ( | $table | ) |
list all fields in a table in the current database
string | $table | name of table that should be used in method |
Definition at line 604 of file Common.php.
References MDB2_Module_Common\getDBInstance(), PEAR\isError(), and MDB2_ERROR_UNSUPPORTED.
MDB2_Driver_Manager_Common::listTableIndexes | ( | $table | ) |
list all indexes in a table
string | $table | name of table that should be used in method |
Definition at line 700 of file Common.php.
References MDB2_Module_Common\getDBInstance(), PEAR\isError(), and MDB2_ERROR_UNSUPPORTED.
MDB2_Driver_Manager_Common::listTables | ( | $database = null | ) |
list all tables in the current database
string | database, the current is default. NB: not all the drivers can get the table names from a database other than the current one |
Definition at line 583 of file Common.php.
References MDB2_Module_Common\getDBInstance(), PEAR\isError(), and MDB2_ERROR_UNSUPPORTED.
MDB2_Driver_Manager_Common::listTableTriggers | ( | $table = null | ) |
list all triggers in the database that reference a given table
string | table for which all referenced triggers should be found |
Definition at line 540 of file Common.php.
References MDB2_Module_Common\getDBInstance(), PEAR\isError(), and MDB2_ERROR_UNSUPPORTED.
MDB2_Driver_Manager_Common::listTableViews | ( | $table | ) |
list the views in the database that reference a given table
string | table for which all referenced views should be found |
Definition at line 519 of file Common.php.
References MDB2_Module_Common\getDBInstance(), PEAR\isError(), and MDB2_ERROR_UNSUPPORTED.
MDB2_Driver_Manager_Common::listUsers | ( | ) |
list all users
Definition at line 475 of file Common.php.
References MDB2_Module_Common\getDBInstance(), PEAR\isError(), and MDB2_ERROR_UNSUPPORTED.
MDB2_Driver_Manager_Common::listViews | ( | $database = null | ) |
list all views in the current database
string | database, the current is default NB: not all the drivers can get the view names from a database other than the current one |
Definition at line 498 of file Common.php.
References MDB2_Module_Common\getDBInstance(), PEAR\isError(), and MDB2_ERROR_UNSUPPORTED.