drush_sql_register_post_sync_op() query with braces enclosing table does not work

[txemapamundi9l]

Works when using drush sql-sanitize:
drush_sql_register_post_sync_op('password_policy_history', dt('Delete all Password Policy history table entries'), "DELETE FROM password_policy_history;");

Does not work:
drush_sql_register_post_sync_op('password_policy_history', dt('Delete all Password Policy history table entries'), "DELETE FROM {password_policy_history};");

The former, though, presumably does not work for sites using table prefixes. So there seems to be no single way to write the query that works for all configurations.

Using Drush Git master latest.

This issue arose from this issue:
https://www.drupal.org/node/2555053

[mstrelan]

sql_drush_sql_sync_sanitize() includes checks to determine if the table name should be wrapped in braces. For me this seems to wrap the table names regardless because my db prefix is apparently an array and therefore not empty. Regardless of whether or not it should be wrapped, ultimately the query is written to a temporary file and read directly by mysql, so if there are braces they will throw an error. Braces should be replaced by the actual prefix.

[weitzman]

Drush sql-sanitize replaces braces when the --db-prefix option is provided.

[txemapamundi9l]

Drush sql-sanitize replaces braces when the --db-prefix option is provided.

But it errors when --db-prefix is not provided and braces are used in the query. So it seems to be impossible to write a query for sql_drush_sql_sync_sanitize() that works for both sites using or not using database prefixes.

[weitzman]

Oh crap. That does look like awkward. Today, you have to write your sanitize hook like Drush core does it in sql_drush_sql_sync_sanitize():

if (drush_get_option('db-prefix') || !empty($databases['default']['default']['prefix'])) {
    $wrap_table_name = TRUE;
  }
  else {
    $wrap_table_name = FALSE;
  }

Or more tersely:

$wrap_table_name = drush_get_option('db-prefix') || !empty($databases['default']['default']['prefix'])`. 

Then you add braces based on $wrap_table_name.

Ping @bjeavons since this went in with fdffc65.

I'm not sure why we don't unconditionally do the prefix replacement. This is such a useless part of Drupal that I hesitate to spend much time making it better. It could easily cause more harm than help.

[weitzman]

I updated the example in https://github.com/drush-ops/drush/blob/master/drush.api.php#L282 to show current table wrapping best practice.