Function DatabaseDriver->alter_table_field__sql

Definitions

sources/database.php

  • Get SQL for changing the type of a DB field in a table.
  • Visibility: public
  • Is abstract?: Yes
  • Is static?: No
  • Is final?: No
  • Return: array

Parameters

Name Type Default Set Range Description
$table_name ID_TEXT required parameter N/A N/A The table name
$name ID_TEXT required parameter N/A N/A The field name
$db_type ID_TEXT required parameter N/A N/A The new field type
$may_be_null boolean required parameter N/A N/A If the field may be null
$is_autoincrement ?boolean required parameter N/A N/A Whether it is an autoincrement field (null: could not set it, returned by reference)
$new_name ID_TEXT required parameter N/A N/A The new field name

Return

  • List of SQL queries to run
  • Type: array
  • Set: N/A
  • Range: N/A