renameColumnSql

See Also

Column Attributes Reference

Syntax
 array renameColumnSql(
  string $tableName,
  string $oldColumnName,
  string $newColumnName,
  optional string $columnSpec=''
)

Description

The method renameColumnSql() creates the SQL statement necessary to rename an existing column name given by $oldColumnName from an existing table, given by $tableName, to a new name, given by $newTableName.

For MySQL databases, You must provide the entire column specification, given by $columnSpec. Check the manual page for the driver for more information.

In order to actually rename the column, the returned array must be passed to the executeSqlArray() method.

Usage

$dict = NewDataDictionary($db);
$sqlarray = $dict->renameColumnSql('ACT','ACTDESC','ACTDESCRIPTION');
 
print_r($sqlarray);
/*
 * Prints
 Array
(
    [0] => ALTER TABLE ACT RENAME COLUMN ACTDESC TO ACTDESCRIPTION
)
 
*/