Docs For Class MDB2_Driver_Manager

MDB2_Driver_Manager_Common MDB2_Driver_Manager_Common(

$db_index)

Parameters:

$db_index —

[ Top ]

MDB2_Driver_Manager_Common __construct(

$db_index)

Constructor

Parameters:

$db_index —

[ Top ]

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

alter an existing table

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

Overridden in child classes as:

MDB2_Driver_Manager_ibase::alterTable(): alter an existing table

MDB2_Driver_Manager_fbsql::alterTable(): alter an existing table

MDB2_Driver_Manager_oci8::alterTable(): alter an existing table

MDB2_Driver_Manager_mssql::alterTable(): alter an existing table

MDB2_Driver_Manager_mysqli::alterTable(): alter an existing table

MDB2_Driver_Manager_xxx::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(

$database, string
$name)

create a new database

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

Overridden in child classes as:

MDB2_Driver_Manager_ibase::createDatabase(): create a new database

MDB2_Driver_Manager_fbsql::createDatabase(): create a new database

MDB2_Driver_Manager_oci8::createDatabase(): create a new database

MDB2_Driver_Manager_sqlite::createDatabase(): create a new database

MDB2_Driver_Manager_mssql::createDatabase(): create a new database

MDB2_Driver_Manager_mysqli::createDatabase(): create a new database

MDB2_Driver_Manager_xxx::createDatabase(): create a new database

Parameters:

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

[ 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

Overridden in child classes as:

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

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

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

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

MDB2_Driver_Manager_xxx::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(

$name, [string
$start = 1], string
$seq_name)

create sequence

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

Overridden in child classes as:

MDB2_Driver_Manager_ibase::createSequence(): create sequence

MDB2_Driver_Manager_fbsql::createSequence(): create sequence

MDB2_Driver_Manager_oci8::createSequence(): create sequence

MDB2_Driver_Manager_sqlite::createSequence(): create sequence

MDB2_Driver_Manager_mssql::createSequence(): create sequence

MDB2_Driver_Manager_mysqli::createSequence(): create sequence

MDB2_Driver_Manager_xxx::createSequence(): create sequence

Parameters:

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

[ Top ]

mixed createTable(
string
$name, array
$fields)

create a new table

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

Overridden in child classes as:

MDB2_Driver_Manager_mysqli::createTable(): create a new table

MDB2_Driver_Manager_xxx::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(

$database, string
$name)

drop an existing database

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

Overridden in child classes as:

MDB2_Driver_Manager_ibase::dropDatabase(): drop an existing database

MDB2_Driver_Manager_fbsql::dropDatabase(): drop an existing database

MDB2_Driver_Manager_oci8::dropDatabase(): drop an existing database

MDB2_Driver_Manager_sqlite::dropDatabase(): drop an existing database

MDB2_Driver_Manager_mssql::dropDatabase(): drop an existing database

MDB2_Driver_Manager_mysqli::dropDatabase(): drop an existing database

MDB2_Driver_Manager_xxx::dropDatabase(): drop an existing database

Parameters:

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

[ Top ]

mixed dropIndex(
string
$table, string
$name)

drop existing index

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

Overridden in child classes as:

MDB2_Driver_Manager_fbsql::dropIndex(): drop existing index

MDB2_Driver_Manager_sqlite::dropIndex(): drop existing index

MDB2_Driver_Manager_mysqli::dropIndex(): drop existing index

MDB2_Driver_Manager_xxx::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(

$name, string
$seq_name)

drop existing sequence

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

Overridden in child classes as:

MDB2_Driver_Manager_ibase::dropSequence(): drop existing sequence

MDB2_Driver_Manager_fbsql::dropSequence(): drop existing sequence

MDB2_Driver_Manager_oci8::dropSequence(): drop existing sequence

MDB2_Driver_Manager_sqlite::dropSequence(): drop existing sequence

MDB2_Driver_Manager_mssql::dropSequence(): drop existing sequence

MDB2_Driver_Manager_mysqli::dropSequence(): drop existing sequence

MDB2_Driver_Manager_xxx::dropSequence(): drop existing sequence

Parameters:

string	`$seq_name`	—	name of the sequence to be dropped
	`$name`	—

[ Top ]

mixed dropTable(
string
$name)

drop an existing table

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

Overridden in child classes as:

MDB2_Driver_Manager_fbsql::dropTable(): drop an existing table

Parameters:

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

[ Top ]

mixed getFieldDeclarationList(
string
$fields)

get declaration of a number of field in bulk

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

Parameters:

string

$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.

[ Top ]

mixed listDatabases(
)

list all databases

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

Overridden in child classes as:

MDB2_Driver_Manager_fbsql::listDatabases(): list all databases

MDB2_Driver_Manager_oci8::listDatabases(): list all databases

MDB2_Driver_Manager_sqlite::listDatabases(): list all databases

MDB2_Driver_Manager_mysqli::listDatabases(): list all databases

MDB2_Driver_Manager_xxx::listDatabases(): list all databases

[ Top ]

mixed listFunctions(
)

list all functions in the current database

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

Overridden in child classes as:

MDB2_Driver_Manager_oci8::listFunctions(): list all functions in the current database

[ Top ]

mixed listSequences(
)

list all sequences in the current database

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

Overridden in child classes as:

MDB2_Driver_Manager_ibase::listSequences(): list all sequences in the current database

MDB2_Driver_Manager_fbsql::listSequences(): list all sequences in the current database

MDB2_Driver_Manager_oci8::listSequences(): list all sequences in the current database

MDB2_Driver_Manager_sqlite::listSequences(): list all sequences in the current database

MDB2_Driver_Manager_mssql::listSequences(): list all sequences in the current database

MDB2_Driver_Manager_mysqli::listSequences(): list all sequences in the current database

MDB2_Driver_Manager_xxx::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

Overridden in child classes as:

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

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

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

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

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

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

MDB2_Driver_Manager_xxx::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

Overridden in child classes as:

MDB2_Driver_Manager_fbsql::listTableIndexes(): list all indexes in a table

MDB2_Driver_Manager_sqlite::listTableIndexes(): list all indexes in a table

MDB2_Driver_Manager_mssql::listTableIndexes(): list all indexes in a table

MDB2_Driver_Manager_mysqli::listTableIndexes(): list all indexes in a table

MDB2_Driver_Manager_xxx::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

Overridden in child classes as:

MDB2_Driver_Manager_fbsql::listTables(): list all tables in the current database

MDB2_Driver_Manager_oci8::listTables(): list all tables in the current database

MDB2_Driver_Manager_sqlite::listTables(): list all tables in the current database

MDB2_Driver_Manager_mssql::listTables(): list all tables in the current database

MDB2_Driver_Manager_mysqli::listTables(): list all tables in the current database

MDB2_Driver_Manager_xxx::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

Overridden in child classes as:

MDB2_Driver_Manager_fbsql::listUsers(): list all users

MDB2_Driver_Manager_oci8::listUsers(): list all users in the current database

MDB2_Driver_Manager_sqlite::listUsers(): list all users

MDB2_Driver_Manager_mysqli::listUsers(): list all users

MDB2_Driver_Manager_xxx::listUsers(): list all users

[ Top ]

mixed listViews(
)

list all views in the current database

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

Overridden in child classes as:

MDB2_Driver_Manager_ibase::listViews(): list the views in the database

MDB2_Driver_Manager_oci8::listViews(): list all views in the current database

[ Top ]

mixed _isSequenceName(
string
$sqn)

list all tables in the current database

Return: name of the sequence if $sqn is a name of a sequence, else false
Access: protected

Parameters:

string $sqn — string that containts name of a potential sequence

[ Top ]

Class: MDB2_Driver_Manager_Common

Class Overview

Author(s):

Variables

Methods

Child classes:

Inherited Variables

Inherited Methods

Class Details

Class Variables

$db_index =

Method Detail

MDB2_Driver_Manager_Common (Constructor) [line 75]

Parameters:

__construct (Constructor) [line 70]

Parameters:

alterTable [line 340]

Parameters:

createDatabase [line 150]

Parameters:

createIndex [line 479]

Parameters:

createSequence [line 554]

Parameters:

createTable [line 207]

Parameters:

dropDatabase [line 167]

Parameters:

dropIndex [line 520]

Parameters:

dropSequence [line 571]

Parameters:

dropTable [line 237]

Parameters:

getFieldDeclarationList [line 102]

Parameters:

listDatabases [line 356]

listFunctions [line 404]

listSequences [line 587]

listTableFields [line 437]

Parameters:

listTableIndexes [line 536]

Parameters:

listTables [line 420]

listUsers [line 372]

listViews [line 388]

_isSequenceName [line 129]

Parameters: