Docs For Class MDB2_Driver_Manager

alterTable [line 213]

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 ]

createConstraint [line 530]

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

create a constraint on a table

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

Parameters:

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

[ Top ]

createDatabase [line 68]

mixed createDatabase(
string
$name)

create a new database

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

Parameters:

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

[ Top ]

createIndex [line 416]

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

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 support() to determine whether the DBMS driver can manage indexes. Example array( 'fields' => array( 'user_name' => array( 'sorting' => 'ascending' ), 'last_login' => array() ) )

[ Top ]

createSequence [line 640]

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

create sequence

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

Parameters:

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

[ Top ]

dropConstraint [line 575]

mixed dropConstraint(
string
$table, string
$name)

drop existing constraint

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

Parameters:

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

[ Top ]

dropDatabase [line 100]

mixed dropDatabase(
string
$name)

drop an existing database

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

Parameters:

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

[ Top ]

dropIndex [line 456]

mixed dropIndex(
string
$table, string
$name)

drop existing index

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

Parameters:

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

[ Top ]

dropSequence [line 683]

mixed dropSequence(
string
$seq_name)

drop existing sequence

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

Parameters:

string $seq_name — name of the sequence to be dropped

[ Top ]

listDatabases [line 285]

mixed listDatabases(
)

list all databases

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

[ Top ]

listSequences [line 703]

mixed listSequences(
)

list all sequences in the current database

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

[ Top ]

listTableConstraints [line 601]

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 359]

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 477]

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 325]

mixed listTables(
)

list all tables in the current database

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

[ Top ]

listUsers [line 305]

mixed listUsers(
)

list all users

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

[ Top ]

Class: MDB2_Driver_Manager_sqlite

Class Overview

Author(s):

Methods

Inherited Variables

Inherited Methods

Class Details

Method Detail

alterTable [line 213]

Parameters:

createConstraint [line 530]

Parameters:

createDatabase [line 68]

Parameters:

createIndex [line 416]

Parameters:

createSequence [line 640]

Parameters:

dropConstraint [line 575]

Parameters:

dropDatabase [line 100]

Parameters:

dropIndex [line 456]

Parameters:

dropSequence [line 683]

Parameters:

listDatabases [line 285]

listSequences [line 703]

listTableConstraints [line 601]

Parameters:

listTableFields [line 359]

Parameters:

listTableIndexes [line 477]

Parameters:

listTables [line 325]

listUsers [line 305]