How do I remove a configuration object from the active configuration?

Question

I'm writing a custom module for Drupal 8. It defines a field storage configuration object, in a file called modules/mymod/config/install/field.storage.bloom_stem.bs_twitter_ac.yml.

The problem is that this is not removed when I uninstall the module; it is apparently left behind because, when I re-install the module, I get a crash.

drush -y pm-uninstall mymod
drush cr
drush -y en mymod

exception 'Drupal\Core\Config\PreExistingConfigException' with message 'Configuration objects (field.storage.bloom_stem.bs_twitter_ac) provided by mymod already exist in active configuration'

So it seems I need to some how manually remove this configuration object. Do I need to provide some more code that deletes it when the module is uninstalled?

Answer 1

The easiest way to do this at the moment is to use drush php (or core-cli) to open an interactive session.

Then use:

Drupal::configFactory()->getEditable('system.menu.devel')->delete();

This functionality will be added into Drupal console as well.

Answer 2

Drush command to delete configuration object: drush config-delete <config_name>.

Answer 3

You can use the following methods. Use the following code in hook_uninstall

Drupal::configFactory()->reset('field.storage.bloom_stem.bs_twitter_ac');

OR

in the yml file you can put the dependencies like

dependencies:
  module:
    - yourmodule
  enforced:
    module:
      - yourmodule

then drupal will automatically remove this configurations on uninstalling your module as described by Berdir here https://drupal.stackexchange.com/a/173879/10436

Answer 4

Using the drupal console:

$ drupal config:delete 'the_config_to_delete'

Answer 5

Drupal::configFactory()->reset() does not delete the config object. For this run Drupal::configFactory()->getEditable('field.storage.node.your_field_name')->delete()

Answer 6

Use hook_uninstall to remove the configuration, when the module is uninstalled.

Then delete the configuration:

function hook_uninstall() {
  \Drupal::configFactory()->getEditable('the_setting.you.want.to.delete')->delete();
}

Answer 7

Uninstall Active Configuration from Custom Module

I ran into the same problem trying to uninstall config files from a custom module. I have a custom module used to pass custom configuration files for webform. Since I'm not perfect I want to be able to uninstall the module, edit code and reinstall. I found if I referenced my custom module (my_module) in the dependencies/enforced section in the config/install yml file, when I uninstalled my module the configuration files would also uninstall.

   langcode: en
    status: true
    dependencies:
        enforced:
            module:
                - webform
                - my_module // reference your module here

Answer 8

I created a simple module that you can use to delete configuration items.

https://www.drupal.org/project/config_delete

Answer 9

You can remove all the configs you imported from config/install by implementing HOOK_uninstall():

function my_module_uninstall() {

  $module_path = \Drupal::service('extension.list.module')->getPath('my_module') . '/config/install';

  $configs = [];
  $files = \Drupal::service('file_system')->scanDirectory($module_path, '/\.yml$/');

  if ($files) {
    foreach ($files as $file) {
        $configs[] = $file->name;
    }

    foreach ($configs as $config_name) {
        \Drupal::configFactory()->getEditable($config_name)->delete();
    }

    return TRUE;
  }
}

Answer 10

You can use Drupal console to delete the active configuration, with drupal config:delete active config_to_delete.

Answer 11

All these answers recommend deleting the underlying config object directly, but the correct way is to delete the entity through the entity storage system.

For example, if you have an image style with ID "large" and you want to delete it, you should do this:

\Drupal::entityTypeManager()->getStorage('image_style')->load('large')->delete();

Doing it this way, core will invoke "predelete" before the config is deleted and "delete" hooks after the config is deleted, which other modules may rely on to perform various clean up operations.

Answer 12

I could delete the active configuration using the drush config:delete command as below drush cdel "name of the config" for example in my case it was drush cdel dtn_apple_news.setting

after running this the configuration got deleted and then running drush en-y "module name" got the module to be installed.

Answer 13

Search for all the configurations listed using drush config-list Then identify the configuration that you would like to delete. Use the below command to delete the configuration drush config-delete

Answer 14

Use Easy Install module to avoid this configuration issues, this module will allow to delete configurations while uninstalling a module, it works even if a module's configs not contains enforced in yml or not added configs in optional folder.

Answer 15

I leave here a tiny (yet a bit over-engineered) Python script which removes the configuration leftovers. It relies on drush config-delete.

# 'batch_config_delete.py'
# 'drush' has to be available in the current directory

import os
import argparse
import subprocess

MODULES_ROOT = "/var/www/html/MYSITE/web/modules/custom"

if __name__ == "__main__":
    parser = argparse.ArgumentParser(description="Batch config delete.")
    parser.add_argument("-m", "--module", required=True, help="Module name")
    args = parser.parse_args()
    install_path = os.path.join(MODULES_ROOT, args.module, 'config/install')

    for f in os.listdir(install_path):
        if f.endswith('.yml'):
            config_name = os.path.splitext(f)[0]
            print "Delete config:", config_name
            subprocess.call(['drush', 'config-delete', config_name])

Should be executed like this:

python ../scripts/batch_config_delete.py -m foobar