ILIAS
Release_5_0_x_branch Revision 61816
|
Public Member Functions | |
createDatabase ($name) | |
create a new database | |
dropDatabase ($name) | |
drop an existing database | |
createTable ($name, $fields, $options=array()) | |
create a new table | |
alterTable ($name, $changes, $check) | |
alter an existing table | |
listDatabases () | |
list all databases | |
listUsers () | |
list all users | |
listFunctions () | |
list all functions in the current database | |
listTableTriggers ($table=null) | |
list all triggers in the database that reference a given table | |
listTables ($database=null) | |
list all tables in the current database | |
listViews ($database=null) | |
list all views in the current database | |
listTableFields ($table) | |
list all fields in a table in the current database | |
createIndex ($table, $name, $definition) | |
Get the stucture of a field into an array. | |
dropIndex ($table, $name) | |
drop existing index | |
listTableIndexes ($table) | |
list all indexes in a table | |
createConstraint ($table, $name, $definition) | |
create a constraint on a table | |
dropConstraint ($table, $name, $primary=false) | |
drop existing constraint | |
listTableConstraints ($table) | |
list all constraints in a table | |
createSequence ($seq_name, $start=1, $options=array()) | |
create sequence | |
dropSequence ($seq_name) | |
drop existing sequence | |
listSequences ($database=null) | |
list all sequences in the current database | |
Public Member Functions inherited from MDB2_Driver_Manager_Common | |
getFieldDeclarationList ($fields) | |
Get declaration of a number of field in bulk. | |
_fixSequenceName ($sqn, $check=false) | |
Removes any formatting in an sequence name using the 'seqname_format' option. | |
_fixIndexName ($idx) | |
Removes any formatting in an index name using the 'idxname_format' option. | |
_getCreateTableQuery ($name, $fields, $options=array()) | |
Create a basic SQL query for a new table creation. | |
_getTemporaryTableQuery () | |
A method to return the required SQL string that fits between CREATE ... | |
dropTable ($name) | |
drop an existing table | |
listTableViews ($table) | |
list the views in the database that reference a given table | |
createSequence ($seq_name, $start=1) | |
create sequence | |
Public Member Functions inherited from MDB2_Module_Common | |
__construct ($db_index) | |
Constructor. | |
MDB2_Module_Common ($db_index) | |
PHP 4 Constructor. | |
& | getDBInstance () |
Get the instance of MDB2 associated with the module instance. |
Additional Inherited Members | |
Data Fields inherited from MDB2_Module_Common | |
$db_index |
Definition at line 57 of file mysqli.php.
MDB2_Driver_Manager_mysqli::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 |
Reimplemented from MDB2_Driver_Manager_Common.
Definition at line 284 of file mysqli.php.
References $query, MDB2_Module_Common\getDBInstance(), PEAR\isError(), MDB2_ERROR_CANNOT_ALTER, and MDB2_OK.
MDB2_Driver_Manager_mysqli::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() ) )
Reimplemented from MDB2_Driver_Manager_Common.
Definition at line 743 of file mysqli.php.
References $query, MDB2_Module_Common\getDBInstance(), PEAR\isError(), and MDB2_ERROR_NEED_MORE_DATA.
MDB2_Driver_Manager_mysqli::createDatabase | ( | $name | ) |
create a new database
string | $name | name of the database that should be created |
Reimplemented from MDB2_Driver_Manager_Common.
Definition at line 70 of file mysqli.php.
References $query, $result, MDB2_Module_Common\getDBInstance(), PEAR\isError(), and MDB2_OK.
MDB2_Driver_Manager_mysqli::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' 'length' => 10 ), 'last_login' => array() ) )
Reimplemented from MDB2_Driver_Manager_Common.
Definition at line 624 of file mysqli.php.
References $query, MDB2_Module_Common\getDBInstance(), and PEAR\isError().
MDB2_Driver_Manager_mysqli::createSequence | ( | $seq_name, | |
$start = 1 , |
|||
$options = array() |
|||
) |
create sequence
string | $seq_name | name of the sequence to be created |
string | $start | start value of the sequence; default is 1 |
array | $options | An associative array of table options: array( 'comment' => 'Foo', 'charset' => 'utf8', 'collate' => 'utf8_unicode_ci', 'type' => 'innodb', ); |
Definition at line 876 of file mysqli.php.
References $options, $query, $res, $result, MDB2_Module_Common\getDBInstance(), PEAR\isError(), and MDB2_OK.
MDB2_Driver_Manager_mysqli::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', 'charset' => 'utf8', 'collate' => 'utf8_unicode_ci', 'type' => 'innodb', ); |
Reimplemented from MDB2_Driver_Manager_Common.
Definition at line 150 of file mysqli.php.
References $options, $query, MDB2_Driver_Manager_Common\_getCreateTableQuery(), MDB2_Module_Common\getDBInstance(), and PEAR\isError().
MDB2_Driver_Manager_mysqli::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 |
Reimplemented from MDB2_Driver_Manager_Common.
Definition at line 785 of file mysqli.php.
References $query, MDB2_Module_Common\getDBInstance(), and PEAR\isError().
MDB2_Driver_Manager_mysqli::dropDatabase | ( | $name | ) |
drop an existing database
string | $name | name of the database that should be dropped |
Reimplemented from MDB2_Driver_Manager_Common.
Definition at line 96 of file mysqli.php.
References $query, $result, MDB2_Module_Common\getDBInstance(), PEAR\isError(), and MDB2_OK.
MDB2_Driver_Manager_mysqli::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 |
Reimplemented from MDB2_Driver_Manager_Common.
Definition at line 657 of file mysqli.php.
References MDB2_Module_Common\getDBInstance(), and PEAR\isError().
MDB2_Driver_Manager_mysqli::dropSequence | ( | $seq_name | ) |
drop existing sequence
string | $seq_name | name of the sequence to be dropped |
Reimplemented from MDB2_Driver_Manager_Common.
Definition at line 953 of file mysqli.php.
References MDB2_Module_Common\getDBInstance(), and PEAR\isError().
MDB2_Driver_Manager_mysqli::listDatabases | ( | ) |
list all databases
Reimplemented from MDB2_Driver_Manager_Common.
Definition at line 385 of file mysqli.php.
References $result, MDB2_Module_Common\getDBInstance(), PEAR\isError(), and MDB2_PORTABILITY_FIX_CASE.
MDB2_Driver_Manager_mysqli::listFunctions | ( | ) |
list all functions in the current database
Reimplemented from MDB2_Driver_Manager_Common.
Definition at line 430 of file mysqli.php.
References $query, $result, MDB2_Module_Common\getDBInstance(), PEAR\isError(), and MDB2_PORTABILITY_FIX_CASE.
MDB2_Driver_Manager_mysqli::listSequences | ( | $database = null | ) |
list all sequences in the current database
string | database, the current is default |
Reimplemented from MDB2_Driver_Manager_Common.
Definition at line 974 of file mysqli.php.
References $query, $result, MDB2_Driver_Manager_Common\_fixSequenceName(), MDB2_Module_Common\getDBInstance(), PEAR\isError(), and MDB2_PORTABILITY_FIX_CASE.
MDB2_Driver_Manager_mysqli::listTableConstraints | ( | $table | ) |
list all constraints in a table
string | $table | name of table that should be used in method |
Reimplemented from MDB2_Driver_Manager_Common.
Definition at line 812 of file mysqli.php.
References $query, $result, MDB2_Driver_Manager_Common\_fixIndexName(), MDB2_Module_Common\getDBInstance(), PEAR\isError(), MDB2_FETCHMODE_ASSOC, and MDB2_PORTABILITY_FIX_CASE.
MDB2_Driver_Manager_mysqli::listTableFields | ( | $table | ) |
list all fields in a table in the current database
string | $table | name of table that should be used in method |
Reimplemented from MDB2_Driver_Manager_Common.
Definition at line 569 of file mysqli.php.
References $result, MDB2_Module_Common\getDBInstance(), PEAR\isError(), and MDB2_PORTABILITY_FIX_CASE.
MDB2_Driver_Manager_mysqli::listTableIndexes | ( | $table | ) |
list all indexes in a table
string | $table | name of table that should be used in method |
Reimplemented from MDB2_Driver_Manager_Common.
Definition at line 679 of file mysqli.php.
References $query, $result, MDB2_Driver_Manager_Common\_fixIndexName(), MDB2_Module_Common\getDBInstance(), PEAR\isError(), MDB2_FETCHMODE_ASSOC, and MDB2_PORTABILITY_FIX_CASE.
MDB2_Driver_Manager_mysqli::listTables | ( | $database = null | ) |
list all tables in the current database
string | database, the current is default |
Reimplemented from MDB2_Driver_Manager_Common.
Definition at line 495 of file mysqli.php.
References $query, $result, MDB2_Driver_Manager_Common\_fixSequenceName(), MDB2_Module_Common\getDBInstance(), PEAR\isError(), MDB2_FETCHMODE_ORDERED, and MDB2_PORTABILITY_FIX_CASE.
MDB2_Driver_Manager_mysqli::listTableTriggers | ( | $table = null | ) |
list all triggers in the database that reference a given table
string | table for which all referenced triggers should be found |
Reimplemented from MDB2_Driver_Manager_Common.
Definition at line 463 of file mysqli.php.
References $query, $result, MDB2_Module_Common\getDBInstance(), PEAR\isError(), and MDB2_PORTABILITY_FIX_CASE.
MDB2_Driver_Manager_mysqli::listUsers | ( | ) |
list all users
Reimplemented from MDB2_Driver_Manager_Common.
Definition at line 411 of file mysqli.php.
References MDB2_Module_Common\getDBInstance(), and PEAR\isError().
MDB2_Driver_Manager_mysqli::listViews | ( | $database = null | ) |
list all views in the current database
string | database, the current is default |
Reimplemented from MDB2_Driver_Manager_Common.
Definition at line 535 of file mysqli.php.
References $query, $result, MDB2_Module_Common\getDBInstance(), PEAR\isError(), and MDB2_PORTABILITY_FIX_CASE.