Missing database fields and the importance of updating Drupal's schema correctly

Today I was presented with a problem. Data wasn't being saved to one particular field in a Drupal custom module's table. Looking into the client's custom module code everything looked OK. Looking at MySQL the table matched OK too.

So I dug into the drupal_write_record function and added some debugging. The returned schema was missing this field. I'm guessing that the original developers of this module had changed the database directly by adding in the extra "type" field. Unfortunately the mistake hadn't been spotted until now and a few months of reports are missing the information that should have been saved in this field.

The drupal_write_record function is great but ONLY if you use schema API correctly.

Here's a better way to add a field to a database which conforms to schema API and avoids this type of problem: -

  • Add the new field definition to the existing hook_schema function found in the module's install file
  • Add the new field to a hook_update_N function, again in the modules' install file

Sometimes we need to work on the database directly. If this is the case you can always check if the field exists first. Just use the db_field_exists function.

Of course everything worked perfectly fine when we added the missing schema api code and ran Drupal's database update script.

 

Get in touch

4 + 6 =
Solve this simple math problem and enter the result. E.g. for 1+3, enter 4.

This form collects your name, telephone number (optionally) and email address only so we can contact you back about your enquiry. We do not and will never use your data for any other purposes other than contacting you regarding this enquiry and no data is shared with any third-party.