exception 'DatabaseSchemaObjectExistsException' with message 'Table cache_entity_file already exists.' [#2897150]

It has observed that, entitycache creates tables during install under hook_schema() but tables are not droped during hook_uninstall()

This causes issues when module is disabled and someone try to enable it again.

This may leads to erro like:
exception 'DatabaseSchemaObjectExistsException' with message 'Table cache_entity_file already exists.'

Comment	File	Size	Author
#10	2897150-10.patch	673 bytes	mcdruid
#10	7.x-1.x: PHP 7.4 & MySQL 5.7, D7 278 pass
#7	exception-cache_entity_-already-exist-2897150-7.patch	891 bytes	greggles
#7	7.x-1.x: PHP 5.4 & MySQL 5.5, D7 Build Successful PHP 7.4 & MySQL 5.7, D7 268 pass, 16 fail
#3	exception-cache_entity_-already-exist-2897150-3.patch	890 bytes	dineshw
#3	7.x-1.x: PHP 5.6 & MySQL 5.5, D7 259 pass, 10 fail
#2	exception-cache_entity_$type-already-exist-2897150-2.patch	1.04 KB	dineshw
#2	7.x-1.x: PHP 5.4 & MySQL 5.5, D7 Patch Validation Error

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

Comment #1

25 July 2017 at 08:24

dineshw created an issue. See original summary.

Comment #2

dineshw CreditAttribution: dineshw as a volunteer and at TATA Consultancy Services for Pfizer, Inc. commented 25 July 2017 at 08:27

Status:

Active

» Needs work

File	Size
exception-cache_entity_$type-already-exist-2897150-2.patch	1.04 KB
7.x-1.x: PHP 5.4 & MySQL 5.5, D7 Patch Validation Error

Trying to drop existing tables in case hook_schema() gets executed again.

Better approach could be using hook_uninstall().

File	Size
exception-cache_entity_-already-exist-2897150-3.patch	890 bytes
7.x-1.x: PHP 5.6 & MySQL 5.5, D7 259 pass, 10 fail

Comment #4

dineshw CreditAttribution: dineshw as a volunteer and at TATA Consultancy Services for Pfizer, Inc. commented 8 August 2017 at 07:15

Status:

Needs work

» Needs review

Comment #5

8 August 2017 at 07:18

The last submitted patch, 2: exception-cache_entity_$type-already-exist-2897150-2.patch, failed testing. View results

Comment #6

greggles

he/him

English

Denver, Colorado, USA

CreditAttribution: greggles at CARD.com commented 27 September 2018 at 23:00

Status:

Needs review

» Needs work

A small code style nitpick:

+    if(db_table_exists("cache_entity_$type")){

There needs to be a space after the `if` and before the `(`.

File	Size
exception-cache_entity_-already-exist-2897150-7.patch	891 bytes
7.x-1.x: PHP 5.4 & MySQL 5.5, D7 Build Successful PHP 7.4 & MySQL 5.7, D7 268 pass, 16 fail

Comment #8

27 September 2018 at 23:13

Status:

Needs review

» Needs work

The last submitted patch, 7: exception-cache_entity_-already-exist-2897150-7.patch, failed testing. View results

Comment #9

mcdruid

🇬🇧🇪🇺

CreditAttribution: mcdruid at Acquia commented 25 July 2023 at 11:54

Hmm, as mentioned in #2 I'm not certain we want to be dropping all the existing tables every time hook_schema() is invoked.

Manually testing this patch and installing, enabling and disabling entitycache I'm still hitting errors when drupal_flush_all_caches() tries to flush tables that no longer exist.

We can keep adding workarounds (e.g. check if the table exists before adding each bin in entitycache_flush_caches()) but I think perhaps it'd be better to try a slightly different approach to solving the problem.

That may be as simple as dropping the tables in hook_uninstall(), but we'll want to check if that covers enabling/disabling too.

Comment #10

mcdruid

🇬🇧🇪🇺

CreditAttribution: mcdruid at Acquia commented 25 July 2023 at 12:51

Priority:	Critical	» Major
Status:	Needs work	» Needs review

File	Size
2897150-10.patch	673 bytes
7.x-1.x: PHP 7.4 & MySQL 5.7, D7 278 pass

Here's a patch that drops the tables in hook_uninstall().

However, this doesn't actually seem to be necessary AFAICS.

https://api.drupal.org/api/drupal/modules%21system%21system.api.php/func... says:

Database tables defined by hook_schema() will be removed automatically.

...and I've verified that works okay with some manual testing (using drush).

When the module is disabled, the tables are not removed (which I think is the correct behaviour).

I don't see any errors when the module is enabled again.

So I'm not actually able to reproduce there being any problem with letting the install/enable/disable/uninstall API work as it does now alongside the existing hook_schema() implementation.

Can anyone provide any steps to reproduce an error that requires a change in entitycache?