- 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:setcommentsql

# setCommentSql

##### Syntax

    string setCommentSql(
      string $tableName,
      string $columnName,
      string $comment
      )

## Description

The method `setCommentSql()` returns a string containing the SQL necessary to set the column comments on a table to the specified value, if the database supports it.

## Usage

    /*
    * On an Oracle Database
    */
    $dict = newDataDictionary($db);
    $s = $dict->setColumnSql('mytable','mycolumn','This is a comment');
    print $s;
    /*
    * Prints: COMMENT ON COLUMN mytable.mycolumn IS 'This is a comment';
    */

## Notes

- Support for this method is limited
- Special rights may be required to execute the returned SQL
- If not supported, the method returns false

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

### Page Tools

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