- skip to content

# Database Abstraction Layer

### User Tools

- Login

### Site Tools

- Recent changes
- Media Manager
- Sitemap

### Sidebar

##### Resources

- Reference Manual
- User Guide
- The Data Dictionary
- ADOdb-xmlschema
- ADOdb Active Record
- Performance Monitoring
- Date/Time Library
- Session Management Library
- Unsupported Addons
- Coding Standards

##### Supported Databases

- Access
- ADO
- CSV
- Firebird
- Frontbase
- IBM DB2
- Informix
- Interbase
- LDAP
- Microsoft SQL Server
- MySQL
- Netezza
- ODBC
- ODBTP
- Oracle
- PDO
- Postgresql
- SAP ADS
- SAP ASE
- SAP Maxdb
- SAP Sqlanywhere
- Sqlite
- Sybase
- Plain Text
- Visual Foxpro

##### Other

- Feature Comparison Matrix
- Connection Matrix
- Include File Guide

v5:dictionary:renamecolumnsql

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

    */

v5/dictionary/renamecolumnsql.txt · Last modified: 2016/01/12 17:06 by mnewnham

### Page Tools

- Show pagesource
- Old revisions
- Backlinks
- Rename Page
- Back to top