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

Class: DB_Table_Manager_oci8

Source Location: /DB_Table-1.5.6/DB/Table/Manager/oci8.php

Class Overview


Index, constraint and alter methods for DB_Table usage with PEAR::DB as backend.


Author(s):

Version:

  • Release: 1.5.6

Methods


Inherited Variables

Inherited Methods


Class Details

[line 73]
Index, constraint and alter methods for DB_Table usage with PEAR::DB as backend.

The code in this class was adopted from the MDB2 PEAR package.



[ Top ]


Method Detail

alterTable   [line 349]

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

alter an existing table
  • Return: DB_OK on success, a PEAR 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     (ignored in DB_Table)

[ Top ]

dropConstraint   [line 253]

mixed dropConstraint( string $table, string $name)

drop existing constraint
  • Return: DB_OK on success, a PEAR 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 ]

dropIndex   [line 238]

mixed dropIndex( string $table, string $name)

drop existing index
  • Return: DB_OK on success, a PEAR 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 ]

getTableConstraintDefinition   [line 192]

mixed getTableConstraintDefinition( string $table, string $index_name)

get the structure of a constraint into an array
  • Return: data array on success, a PEAR error on failure
  • Access: public

Parameters:

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

[ Top ]

getTableIndexDefinition   [line 148]

mixed getTableIndexDefinition( string $table, string $index_name)

get the structure of an index into an array
  • Return: data array on success, a PEAR error on failure
  • Access: public

Parameters:

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

[ Top ]

listTableConstraints   [line 121]

mixed listTableConstraints( string $table)

list all constraints in a table
  • Return: data array on success, a PEAR error on failure
  • Access: public

Parameters:

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

[ Top ]

listTableIndexes   [line 95]

mixed listTableIndexes( string $table)

list all indexes in a table
  • Return: data array on success, a PEAR error on failure
  • Access: public

Parameters:

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

[ Top ]


Documentation generated on Thu, 25 Dec 2008 15:00:29 -0500 by phpDocumentor 1.4.0. PEAR Logo Copyright © PHP Group 2004.