/plugins/dbmigrate/templates/create-index.cfc

http://raihan.googlecode.com/ · ColdFusion CFScript · 25 lines · 24 code · 1 blank · 0 comment · 2 complexity · 58f5a964888b49e69d267583dbfc1a96 MD5 · raw file

  1. <!---
  2. |----------------------------------------------------------------------------------------------------------------------------|
  3. | Parameter | Required | Type | Default | Description |
  4. |----------------------------------------------------------------------------------------------------------------------------|
  5. | table | Yes | string | | table name |
  6. | columnNames | Yes | string | | one or more column names to index, comma separated |
  7. | unique | No | boolean | false | if true will create a unique index constraint |
  8. | indexName | No | string | | use for index name. Defaults to table name + underscore + first column name |
  9. |----------------------------------------------------------------------------------------------------------------------------|
  10. EXAMPLE:
  11. addIndex(table='members',columnNames='username',unique=true);
  12. --->
  13. <cfcomponent extends="[extends]" hint="[description]">
  14. <cffunction name="up">
  15. <cfscript>
  16. addIndex(table='tableName',columnNames='columnName',unique=true);
  17. </cfscript>
  18. </cffunction>
  19. <cffunction name="down">
  20. <cfscript>
  21. removeIndex(table='tableName', indexName='');
  22. </cfscript>
  23. </cffunction>
  24. </cfcomponent>