drupal_uninstall_schema

• Drupal 6
• Drupal 7

includes/common.inc, line 3237

Versions

6 – 7

drupal_uninstall_schema($module)

Remove all tables that a module defines in its hook_schema().

Note: This function does not pass the module's schema through hook_schema_alter(). The module's tables will be created exactly as the module defines them.

Parameters

$module The module for which the tables will be removed.

Return value

An array of arrays with the following key/value pairs:

• success: a boolean indicating whether the query succeeded.
• query: the SQL query(s) executed, passed through check_plain().

Related topics

Schema API

A Drupal schema definition is an array structure representing one or more tables and their related keys and indexes. A schema is defined by hook_schema(), which usually lives in a modulename.install file.

Code

<?php
function drupal_uninstall_schema($module) {
  $schema = drupal_get_schema_unprocessed($module);
  _drupal_initialize_schema($module, $schema);

  $ret = array();
  foreach ($schema as $table) {
    db_drop_table($ret, $table['name']);
  }
  return $ret;
}
?>