How to Use Setup Scripts for Your Module in Magento

-setupconfigurationinstallationmagento-1sql

I realize, you can use setup scripts for your own module by declaring them in the etc/config.xml file of your module within the <global> space like this:

<resources>
    <catalog_setup>
        <setup>
            <module>Mage_Catalog</module>
            <class>Mage_Catalog_Model_Resource_Setup</class>
        </setup>
    </catalog_setup>
</resources>

Some modules then use the file mysql4-install-0.0.1.php whereas others use install-0.0.1.php.
So when do I use the mysql4 in front of the file name and when do I not use it?

Also, what can I do when my setup script is not running to find out why it is not?

Best Answer

From Magento 1.6 and upwards you don't need to use mysql4 anymore because of added multi-RDBMS support.

To find out why it's not running, you can check the exception.log or system.log, maybe Magento coudn't find your setup class. Creating an install script is pretty straightforward though.

Also check Alan Storm's guide: http://alanstorm.com/magento_setup_resources

Related Solutions

Magento – Magento will not run the customer install script

I think you need to add the mysql4-install-0.1.0.php inside a folder called blizzardlabs_customer_setup. Just like the name of your xml tag inside the <resources> tag. So the path should be BlizzardLabs/Customer/sql/blizzardlabs_customer_setup/mysql4-install-0.1.0.php. Before trying it again with the modified path make sure you delete the record from the table core_resource with the code blizzardlabs_customer_setup and clear the cache.
Off topic. If you work with Magento EE 1.12 you can lose the mysql4 in the install script name. You can make it install-0.1.0.php. But it's not that important. It works both ways.

[EDIT]
I've tested tried to run your script. I've created the files as you described. The only thing I added was the module declaration file: app/etc/modules/BlizzardLabs_Customer.xml with this content.

<?xml version="1.0"?>
<config>
    <modules>
        <BlizzardLabs_Customer>
            <active>true</active>
            <codePool>local</codePool>
            <depends>
                <Mage_Customer />
            </depends>
        </BlizzardLabs_Customer>
    </modules>
</config>

And everything worked perfectly. Make sure you cleared the cache. Make sure that the local modules are not disabled (in app/etc/local.xml this tag is set to false <disable_local_modules>false</disable_local_modules>). This is all I can think about.

Best Answer

Related Solutions

Magento – Magento will not run the customer install script

Related Topic