drupal_get_schema_unprocessed
Definition
drupal_get_schema_unprocessed($module, $table = NULL)
drupal/includes/common.inc, line 3623
Description
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.
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
Name | Description |
|---|---|
| Input validation | Functions to validate user input. |
| 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
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 (!is_null($table) && isset($schema[$table])) {
return $schema[$table];
}
else {
return $schema;
}
}