Docs For Class MDB2_Driver_Manager

alterTable [line 400]

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

alter an existing table

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

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.

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

[ Top ]

createDatabase [line 68]

mixed createDatabase(
string
$name, object
$db)

create a new database

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

Parameters:

object	`$db`	—	database object that is extended by this class
string	`$name`	—	name of the database that should be created

[ Top ]

createSequence [line 761]

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

create sequence

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

Parameters:

object	`$db`	—	database object that is extended by this class
string	`$seq_name`	—	name of the sequence to be created
string	`$start`	—	start value of the sequence; default is 1

[ Top ]

createTable [line 275]

mixed createTable(
string
$name, array
$fields)

create a new table

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

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 ]

dropDatabase [line 115]

mixed dropDatabase(
string
$name, object
$db)

drop an existing database

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

Parameters:

object	`$db`	—	database object that is extended by this class
string	`$name`	—	name of the database that should be dropped

[ Top ]

dropSequence [line 785]

mixed dropSequence(
string
$seq_name, object
$db)

drop existing sequence

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

Parameters:

object	`$db`	—	database object that is extended by this class
string	`$seq_name`	—	name of the sequence to be dropped

[ Top ]

dropTable [line 298]

mixed dropTable(
string
$name)

drop an existing table

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

Parameters:

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

[ Top ]

listDatabases [line 491]

mixed listDatabases(
)

list all databases

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

[ Top ]

listFunctions [line 592]

mixed listFunctions(
)

list all functions in the current database

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

[ Top ]

listSequences [line 805]

mixed listSequences(
)

list all sequences in the current database

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

[ Top ]

listTableConstraints [line 721]

mixed listTableConstraints(
string
$table)

list all sonstraints in a table

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

Parameters:

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

[ Top ]

listTableFields [line 651]

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

Parameters:

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

[ Top ]

listTableIndexes [line 683]

mixed listTableIndexes(
string
$table)

list all indexes in a table

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

Parameters:

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

[ Top ]

listTables [line 621]

mixed listTables(
)

list all tables in the current database

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

[ Top ]

listUsers [line 537]

mixed listUsers(
)

list all users in the current database

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

[ Top ]

listViews [line 563]

mixed listViews(
)

list all views in the current database

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

[ Top ]

Class: MDB2_Driver_Manager_oci8

Class Overview

Author(s):

Methods

Inherited Variables

Inherited Methods

Class Details

Method Detail

alterTable [line 400]

Parameters:

createDatabase [line 68]

Parameters:

createSequence [line 761]

Parameters:

createTable [line 275]

Parameters:

dropDatabase [line 115]

Parameters:

dropSequence [line 785]

Parameters:

dropTable [line 298]

Parameters:

listDatabases [line 491]

listFunctions [line 592]

listSequences [line 805]

listTableConstraints [line 721]

Parameters:

listTableFields [line 651]

Parameters:

listTableIndexes [line 683]

Parameters:

listTables [line 621]

listUsers [line 537]

listViews [line 563]