Docs For Class MDB2_Driver_Manager

mixed alterTable(
string
$name, array
$changes, boolean
$check)

alter an existing table

Return: MDB2_OK on success, a MDB2 error on failure
Access: public

Overrides MDB2_Driver_Manager_Common::alterTable() (alter an existing table)

Parameters:

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.

added_fields

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 Metabase parser.

Additionally, there should be an 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.

removed_fields

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.

renamed_fields

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.

changed_fields

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 changed_fields 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 Metabase parser.

If the default property is meant to be added, removed or changed, there should also be an entry with index ChangedDefault assigned to 1. Similarly, if the notnull constraint is to be added or removed, there should also be an entry with index ChangedNotNull assigned to 1.

Additionally, there should be an entry named Declaration that is expected to contain the portion of the field changed declaration already in DBMS specific SQL code as it is used in the CREATE TABLE statement. Example array( 'name' => 'userlist', 'added_fields' => array( 'quota' => array( 'type' => 'integer', 'unsigned' => 1 'declaration' => 'quota INT' ) ), 'removed_fields' => array( 'file_limit' => array(), 'time_limit' => array() ), 'changed_fields' => array( 'gender' => array( 'default' => 'M', 'change_default' => 1, 'declaration' => "gender CHAR(1) DEFAULT 'M'" ) ), 'renamed_fields' => array( 'sex' => array( 'name' => 'gender', 'declaration' => "gender CHAR(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.

[ Top ]

mixed createDatabase(
string
$name)

create a new database

Return: MDB2_OK on success, a MDB2 error on failure
Access: public

Overrides MDB2_Driver_Manager_Common::createDatabase() (create a new database)

Parameters:

string $name — name of the database that should be created

[ Top ]

mixed createIndex(
string
$table, string
$name, array
$definition)

get the stucture of a field into an array

Return: MDB2_OK on success, a MDB2 error on failure
Access: public

Overrides MDB2_Driver_Manager_Common::createIndex() (get the stucture of a field into an array)

Parameters:

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() ) )

[ Top ]

mixed createSequence(
string
$seq_name, [string
$start = 1])

create sequence

Return: MDB2_OK on success, a MDB2 error on failure
Access: public

Overrides MDB2_Driver_Manager_Common::createSequence() (create sequence)

Parameters:

string	`$seq_name`	—	name of the sequence to be created
string	`$start`	—	start value of the sequence; default is 1

[ Top ]

mixed createTable(
string
$name, array
$fields)

create a new table

Return: MDB2_OK on success, a MDB2 error on failure
Access: public

Overrides MDB2_Driver_Manager_Common::createTable() (create a new table)

Parameters:

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.

Example array(

'id' => array( 'type' => 'integer', 'unsigned' => 1 'notnull' => 1 'default' => 0 ), 'name' => array( 'type' => 'text', 'length' => 12 ), 'password' => array( 'type' => 'text', 'length' => 12 ) );

[ Top ]

mixed dropDatabase(
string
$name)

drop an existing database

Return: MDB2_OK on success, a MDB2 error on failure
Access: public

Overrides MDB2_Driver_Manager_Common::dropDatabase() (drop an existing database)

Parameters:

string $name — name of the database that should be dropped

[ Top ]

mixed dropIndex(
string
$table, string
$name)

drop existing index

Return: MDB2_OK on success, a MDB2 error on failure
Access: public

Overrides MDB2_Driver_Manager_Common::dropIndex() (drop existing index)

Parameters:

string	`$table`	—	name of table that should be used in method
string	`$name`	—	name of the index to be dropped

[ Top ]

mixed dropSequence(
string
$seq_name)

drop existing sequence

Return: MDB2_OK on success, a MDB2 error on failure
Access: public

Overrides MDB2_Driver_Manager_Common::dropSequence() (drop existing sequence)

Parameters:

string $seq_name — name of the sequence to be dropped

[ Top ]

mixed listDatabases(
)

list all databases

Return: data array on success, a MDB2 error on failure
Access: public

Overrides MDB2_Driver_Manager_Common::listDatabases() (list all databases)

[ Top ]

mixed listSequences(
)

list all sequences in the current database

Return: data array on success, a MDB2 error on failure
Access: public

Overrides MDB2_Driver_Manager_Common::listSequences() (list all sequences in the current database)

[ Top ]

mixed listTableFields(
string
$table)

list all fields in a tables in the current database

Return: data array on success, a MDB2 error on failure
Access: public

Overrides MDB2_Driver_Manager_Common::listTableFields() (list all fields in a tables in the current database)

Parameters:

string $table — name of table that should be used in method

[ Top ]

mixed listTableIndexes(
string
$table)

list all indexes in a table

Return: data array on success, a MDB2 error on failure
Access: public

Overrides MDB2_Driver_Manager_Common::listTableIndexes() (list all indexes in a table)

Parameters:

string $table — name of table that should be used in method

[ Top ]

mixed listTables(
)

list all tables in the current database

Return: data array on success, a MDB2 error on failure
Access: public

Overrides MDB2_Driver_Manager_Common::listTables() (list all tables in the current database)

[ Top ]

mixed listUsers(
)

list all users

Return: data array on success, a MDB2 error on failure
Access: public

Overrides MDB2_Driver_Manager_Common::listUsers() (list all users)

[ Top ]

mixed _verifyTableType(
string
$table_type)

verify that chosen transactional table hanlder is available in the database

Return: MDB2_OK on success, a MDB2 error on failure
Access: protected

Parameters:

string $table_type — name of the table handler

[ Top ]

Class: MDB2_Driver_Manager_mysqli

Class Overview

Author(s):

Variables

Methods

Child classes:

Inherited Variables

Class: MDB2_Driver_Manager_Common

Inherited Methods

Class: MDB2_Driver_Manager_Common

Class Details

Class Variables

$verified_table_types = array()

Method Detail

alterTable [line 329]

Parameters:

createDatabase [line 136]

Parameters:

createIndex [line 524]

Parameters:

createSequence [line 605]

Parameters:

createTable [line 201]

Parameters:

dropDatabase [line 157]

Parameters:

dropIndex [line 551]

Parameters:

dropSequence [line 650]

Parameters:

listDatabases [line 413]

listSequences [line 666]

listTableFields [line 473]

Parameters:

listTableIndexes [line 567]

Parameters:

listTables [line 445]

listUsers [line 429]

_verifyTableType [line 73]

Parameters: