MDB2
[ class tree: MDB2 ] [ index: MDB2 ] [ all elements ]

Class: MDB2_Driver_Manager_Common

Source Location: /MDB2-2.5.0b5/MDB2/Driver/Manager/Common.php

Class Overview

MDB2_Module_Common
   |
   --MDB2_Driver_Manager_Common

Base class for the management modules that is extended by each MDB2 driver


Author(s):

Methods


Inherited Variables

Inherited Methods

Class: MDB2_Module_Common

MDB2_Module_Common::__construct()
Constructor
MDB2_Module_Common::getDBInstance()
Get the instance of MDB2 associated with the module instance

Class Details

[line 66]
Base class for the management modules that is extended by each MDB2 driver

To load this module in the MDB2 object: $mdb->loadModule('Manager');



[ Top ]


Method Detail

alterDatabase   [line 219]

mixed alterDatabase( $database, [array $options = array()], string $name)

alter 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 created
array   $options     array with charset, collation info
   $database     

[ Top ]

alterTable   [line 542]

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

[ Top ]

createConstraint   [line 884]

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. The full structure of the array looks like this:
          array (
              [primary] => 0
              [unique]  => 0
              [foreign] => 1
              [check]   => 0
              [fields] => array (
                  [field1name] => array() // one entry per each field covered
                  [field2name] => array() // by the index
                  [field3name] => array(
                      [sorting]  => ascending
                      [position] => 3
                  )
              )
              [references] => array(
                  [table] => name
                  [fields] => array(
                      [field1name] => array(  //one entry per each referenced field
                           [position] => 1
                      )
                  )
              )
              [deferrable] => 0
              [initiallydeferred] => 0
              [onupdate] => CASCADE|RESTRICT|SET NULL|SET DEFAULT|NO ACTION
              [ondelete] => CASCADE|RESTRICT|SET NULL|SET DEFAULT|NO ACTION
              [match] => SIMPLE|PARTIAL|FULL
          );

[ Top ]

createDatabase   [line 196]

mixed createDatabase( $database, [array $options = array()], 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
array   $options     array with charset, collation info
   $database     

[ Top ]

createIndex   [line 757]

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 supports() to determine whether the DBMS driver can manage indexes.

Example array( 'fields' => array( 'user_name' => array( 'sorting' => 'ascending' ), 'last_login' => array() ) )


[ Top ]

createSequence   [line 981]

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 ]

createTable   [line 353]

mixed createTable( string $name, array $fields, [array $options = array()])

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. 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', 'temporary' => true|false, );

[ Top ]

dropConstraint   [line 933]

mixed dropConstraint( string $table, string $name, [string $primary = false])

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
string   $primary     hint if the constraint is primary

[ Top ]

dropDatabase   [line 240]

mixed dropDatabase( $database, 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
   $database     

[ Top ]

dropIndex   [line 790]

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

mixed dropSequence( $name, 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
   $name     

[ Top ]

dropTable   [line 380]

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 ]

getFieldDeclarationList   [line 109]

mixed getFieldDeclarationList( array $fields)

Get declaration of a number of field in bulk
  • Return: string on success, a MDB2 error on failure
  • Access: public

Parameters:

array   $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 ]

listDatabases   [line 562]

mixed listDatabases( )

list all databases
  • Return: array of database names on success, a MDB2 error on failure
  • Access: public

[ Top ]

listFunctions   [line 667]

mixed listFunctions( )

list all functions in the current database
  • Return: array of function names on success, a MDB2 error on failure
  • Access: public

[ Top ]

listSequences   [line 1025]

mixed listSequences( [string $database = null])

list all sequences in the current database
  • Return: array of sequence names on success, a MDB2 error on failure
  • Access: public

Parameters:

string   $database     database, the current is default NB: not all the drivers can get the sequence names from a database other than the current one

[ Top ]

listTableConstraints   [line 959]

mixed listTableConstraints( string $table)

list all constraints in a table
  • Return: array of constraint names on success, a MDB2 error on failure
  • Access: public

Parameters:

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

[ Top ]

listTableFields   [line 711]

mixed listTableFields( string $table)

list all fields in a table in the current database
  • Return: array of field names on success, a MDB2 error on failure
  • Access: public

Parameters:

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

[ Top ]

listTableIndexes   [line 815]

mixed listTableIndexes( string $table)

list all indexes in a table
  • Return: array of index names on success, a MDB2 error on failure
  • Access: public

Parameters:

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

[ Top ]

listTables   [line 690]

mixed listTables( [string $database = null])

list all tables in the current database
  • Return: array of table names on success, a MDB2 error on failure
  • Access: public

Parameters:

string   $database     database, the current is default. NB: not all the drivers can get the table names from a database other than the current one

[ Top ]

listTableTriggers   [line 647]

mixed listTableTriggers( [string $table = null])

list all triggers in the database that reference a given table
  • Return: array of trigger names on success, a MDB2 error on failure
  • Access: public

Parameters:

string   $table     table for which all referenced triggers should be found

[ Top ]

listTableViews   [line 626]

mixed listTableViews( string $table)

list the views in the database that reference a given table
  • Return: array of view names on success, a MDB2 error on failure
  • Access: public

Parameters:

string   $table     table for which all referenced views should be found

[ Top ]

listUsers   [line 582]

mixed listUsers( )

list all users
  • Return: array of user names on success, a MDB2 error on failure
  • Access: public

[ Top ]

listViews   [line 605]

mixed listViews( [string $database = null])

list all views in the current database
  • Return: array of view names on success, a MDB2 error on failure
  • Access: public

Parameters:

string   $database     database, the current is default NB: not all the drivers can get the view names from a database other than the current one

[ Top ]

truncateTable   [line 406]

mixed truncateTable( string $name)

Truncate an existing table (if the TRUNCATE TABLE syntax is not supported, it falls back to a DELETE FROM TABLE query)
  • Return: MDB2_OK on success, a MDB2 error on failure
  • Access: public

Parameters:

string   $name     name of the table that should be truncated

[ Top ]

vacuum   [line 438]

mixed vacuum( [string $table = null], [array $options = array()])

Optimize (vacuum) all the tables in the db (or only the specified table) and optionally run ANALYZE.
  • Return: MDB2_OK success, a MDB2 error on failure
  • Access: public

Parameters:

string   $table     table name (all the tables if empty)
array   $options     an array with driver-specific options:
  • timeout [int] (in seconds) [mssql-only]
  • analyze [boolean] [pgsql and mysql]
  • full [boolean] [pgsql-only]
  • freeze [boolean] [pgsql-only]

[ Top ]

_fixIndexName   [line 169]

string _fixIndexName( string $idx)

Removes any formatting in an index name using the 'idxname_format' option
  • Return: name of the index with eventual formatting removed
  • Access: protected

Parameters:

string   $idx     string that containts name of anl index

[ Top ]

_fixSequenceName   [line 141]

string _fixSequenceName( string $sqn, [bool $check = false])

Removes any formatting in an sequence name using the 'seqname_format' option
  • Return: name of the sequence with possible formatting removed
  • Access: protected

Parameters:

string   $sqn     string that containts name of a potential sequence
bool   $check     if only formatted sequences should be returned

[ Top ]

_getAdvancedFKOptions   [line 837]

string _getAdvancedFKOptions( array $definition)

Return the FOREIGN KEY query section dealing with non-standard options as MATCH, INITIALLY DEFERRED, ON UPDATE, ...
  • Access: protected

Parameters:

array   $definition     

[ Top ]


Documentation generated on Mon, 29 Oct 2012 16:00:07 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.