function drupal_get_schema_unprocessed
Returns the unprocessed and unaltered version of a module's schema.
Use this function only if you explicitly need the original specification of a schema, as it was defined in a module's hook_schema(). No additional default values will be set, hook_schema_alter() is not invoked and these unprocessed definitions won't be cached. To retrieve the schema after hook_schema_alter() has been invoked use drupal_get_schema().
This function can be used to retrieve a schema specification in hook_schema(), so it allows you to derive your tables from existing specifications.
It is also used by drupal_install_schema() and drupal_uninstall_schema() to ensure that a module's tables are created exactly as specified without any changes introduced by a module that implements hook_schema_alter().
Parameters
$module: The module to which the table belongs.
$table: The name of the table. If not given, the module's complete schema is returned.
Related topics
11 calls to drupal_get_schema_unprocessed()
- block_schema in modules/
block/ block.install - Implements hook_schema().
- dblog_update_7003 in modules/
dblog/ dblog.install - Account for possible legacy systems where dblog was not installed.
- drupal_install_schema in includes/
common.inc - Creates all tables defined in a module's hook_schema().
- drupal_uninstall_schema in includes/
common.inc - Removes all tables defined in a module's hook_schema().
- field_schema in modules/
field/ field.install - Implements hook_schema().
File
-
includes/
common.inc, line 7357
Code
function drupal_get_schema_unprocessed($module, $table = NULL) {
// Load the .install file to get hook_schema.
module_load_install($module);
$schema = module_invoke($module, 'schema');
if (isset($table) && isset($schema[$table])) {
return $schema[$table];
}
elseif (!empty($schema)) {
return $schema;
}
return array();
}
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.