Learn more about db schema whitelist in Magento 2. Our Magento Support team is here to help you with your questions and concerns.

More about db schema whitelist in Magento 2

When it comes to managing an e-commerce platform, security and stability are critical. In the world of Magento 2, the “db schema whitelist” protects our database from unauthorized modifications during the deployment or upgrade process.

Today, we are going to dive deep into this feature and explore how it ensures a secure experience for our Magento 2 store.

Magento examines the current state of our database schema against the desired state defined in the modules’ declarative schema files. In case of any issues, Magento applies the necessary modifications to align the schema flawlessly with the desired state. This is the power of the “db schema whitelist” at work.

The db schema whitelist allows us to control which modules are authorized to make changes to the database schema during the setup upgrade process. This boosts the security and stability of our Magento 2 store.

How to configure the db schema whitelist

We can configure db schema whitelist in our Magento 2 store with these steps:

1. First, head to the app/etc/config.php file and look for the following section:

   'db' => ['table_prefix' => '', 'connection' => ... ]
2. Then, head to the ‘connection’ key, and add an array entry called ‘schema’. Next, we have to list the modules authorized to modify the database schema.

This allows us to set boundaries and entrust certain modules with managing the database structure.

More about db_schema_whitelist.json

The db_schema_whitelist.json file holds the history of all tables, columns, and keys added through declarative schema. It helps Magento tell which tables and columns can be safely modified with only the db_schema.xml files.

In fact, with this file in place, Magento can detect changes in upgraded db_schema.xml files and ensure backward compatibility.

We can generate db_schema_whitelist.json in two different ways:

• We can create it manually by keeping track of all the DB tables, columns, indexes, and constraints created via declarative schema.
• Alternatively, we can run the following command:

  php bin/magento setup:db-declaration:generate-whitelist –module-name=Vendorname_Modulename

[Need assistance with a different issue? Our team is available 24/7.]

Conclusion

In summary, our Support Techs demonstrated how to configure the db schema whitelist in Magento.