field_read_fields() omits indexes from hook_field_schema [#2003746]

I have a custom module that calls field_update_field(), but that function fails with exceptions like "DatabaseSchemaObjectExistsException: Cannot add index field_sunflower_geo_lat to table field_data_field_sunflower_geo: index already exists." In this case "lat" is the first of many indexes on a geofield.

I'm trying to track down the problem, and I suspect this portion of field_read_fields() may be a problem. Here's a portion of that function:

// Populate storage information.
    module_load_install($field['module']);
    $schema = (array) module_invoke($field['module'], 'field_schema', $field);
    $schema += array(
      'columns' => array(),
      'indexes' => array(),
    );
    $field['columns'] = $schema['columns'];

Notice that the code builds $schema['columns'] and $schema['indexes'], then copies only the columns to the field data. Why not also copy the indexes? Later, field_update_fields() looks to $prior_field['indexes'] and finds nothing there!

Comment	File	Size	Author
#2	drupal-missing_indexes_field_crud-2003746-2.patch	1.08 KB	JvE
#2

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

Comment #1

skruf CreditAttribution: skruf commented 17 June 2014 at 14:45

Issue summary:

View changes

I have the same issue. My problem is that the field collection module adds a new index 'revision_id'. When field_update_field() is called (via features) Drupal doesn't know about this new index as its not added to the $field array so attempts to create it but it already exists.

Comment #2

JvE CreditAttribution: JvE commented 17 October 2014 at 13:02

Title:	field_read_fields() omits schema	» field_read_fields() omits indexes from hook_field_schema
Status:	Active	» Needs review

File	Size
drupal-missing_indexes_field_crud-2003746-2.patch	1.08 KB

This happens when
1. a field is created at a point in time where there are no indexes and the module's hook_field_schema does not contain indexes.
2. at a later point in time hook_field_schema for that module does include indexes.

This situation does occur since field_collection update 7004.
Features that have fields created before that update can no longer be reverted after that update.

To reproduce:

Create a module that defines a field. Without hook_field_schema or indexes.
Create an instance of such a field.
Create a new feature which includes this field.
Add hook_field_schema to the modules install file with one or more indexes.
Add an update hook to the modules install file that uses db_add_index to add the indexes to the existing field tables
Perform updates.
Change something to the field settings.
Revert the feature.

Attached patch should resolve the issue by including indexes from hook_field_schema when doing a field_read_field.

Comment #3

JvE CreditAttribution: JvE commented 23 October 2014 at 09:16

Comment #4

Dave Reid

he/him

English

Nebraska USA

CreditAttribution: Dave Reid commented 10 December 2014 at 17:30

Comment #5

scuba_fly

Netherlands, Vinkeveen

CreditAttribution: scuba_fly at LimoenGroen commented 4 January 2017 at 14:09

I ran into this problem with the relation module ( Relation_endpoint_7002 )

Combined with the #2 patch this fixed my problem.

Since this is core I guess we need an second reviewer?

But +1 RTBC from me.

Comment #6

shrop CreditAttribution: shrop at Mediacurrent commented 6 March 2017 at 02:21

Description

A coworker was working on an issue where Field Collection would not run hook_update_7007 due to the error Cannot add index field_<name>_value to table field_data_field_<name>: index already exists. She said that patch #2 allowed the hook_update to run. I tested and confirmed that the patch resolved the issue in our case since the indexes exist.

Thanks for the work on this!

Next Steps

RTBC

Comment #7

shrop CreditAttribution: shrop at Mediacurrent commented 6 March 2017 at 02:20

Status:

Needs review

» Reviewed & tested by the community

Comment #8

David_Rothstein CreditAttribution: David_Rothstein as a volunteer commented 6 June 2017 at 06:15

Issue tags:

+Drupal 7.60 target

Is it possible to write a test for this?

And are we sure there's no similar problem in Drupal 8?

Comment #9

JvE CreditAttribution: JvE as a volunteer commented 6 June 2017 at 07:07

Looks like D8's \Drupal\Core\Field\BaseFieldDefinition::getSchema() and \Drupal\field\Entity\FieldStorageConfig::getSchema() get it right.

And while it may be possible to add a D7 test for this in \FieldCrudTestCase::testFieldIndexes() (using multiple test modules and/or lots of direct database manipulation) I don't think it's worth the effort.
If you want to try:
- Add a new field type, with no indexes in field_test_field_schema().
- Create a field of that type.
- Make field_test_field_schema() somehow return indexes for that field after all.
- Possibly clear some static caches.
- Read the field and see it has no indexes while you expect there to be.