Magento Install and Upgrade Data Scripts Explained

Installation and upgrade scripts in Magento module development: Ensure the database is correct

Magento installation and upgrade scripts are a key component of module development, especially for modules that interact with databases. These scripts run when you access a specific URL and are located in the module's code directory. This article will dive into how to write reliable Magento installation and upgrade scripts to avoid common naming conventions, version numbers, or syntax errors.

Prerequisite knowledge: Before reading this article, it is recommended that you have basic knowledge on Magento module development. When you install or create any new module that interacts with the database, you will find installation and upgrade scripts in the module's code directory that run when you access the URL. Magento's core modules also follow the same installation and upgrade structure.

Installation script:

In order to run the installation script, we need to create a custom module (this article assumes that you have created a custom module named Sitepoint_Articles to record all written articles in the database). The basic components of a module include: blocks, models, resource models, controllers, etc directories (including module-related configurations), auxiliary classes and sql directories (including database upgrade and installation scripts).

Module directory structure is as follows:

<code>app
 --code
 ---local
 ----Sitepoint
 ------Articles
 --------Block
  --------controllers
   --------etc
    --------Model
     --------sql</code>

Open the app/code/local/Sitepoint/Articles/etc file in the config.xml directory. We need to add some configuration related to the location of the installation script in this file. Add the following sub-tags under the <global></global> tag:

<global>
    <models>
        <sitepoint_articles>
            <class>Sitepoint_Articles_Model</class>
            <resourceModel>articles_mysql4</resourceModel>
        </sitepoint_articles>
        <sitepoint_articles_mysql4>
            <class>Sitepoint_Articles_Model_Mysql4</class>
            <entities>
                <articles>
                    <table>articles</table>
                </articles>
            </entities>
        </sitepoint_articles_mysql4>
    </models>
    <resources>
        <setup>
            <module>Sitepoint_Articles</module>
        </setup>
        <connection>
            <use>core_setup</use>
        </connection>
        <connection>
            <use>core_write</use>
        </connection>
        <connection>
            <use>core_read</use>
        </connection>
    </resources>
</global>

The

tag under the <resources><setup> tag tells Magento that our database settings file is located in the articles_setup directory.

Create the installation script in the Articles/sql/articles_setup directory mysql4-install-0.1.0.php:

<?php
$installer = $this;
$installer->startSetup();
$table = $installer->getConnection()->newTable($installer->getTable('articles'))
    ->addColumn('articles_id', Varien_Db_Ddl_Table::TYPE_INTEGER, 11, array(
        'unsigned' => true,
        'nullable' => false,
        'primary' => true,
        'identity' => true,
        ), 'Article ID')
    // ... 其他列定义 ...
    ->setComment('Articles table');
$installer->getConnection()->createTable($table);
$installer->endSetup();
?>

The

version number (0.1.0) is the same as the version number defined in the config.xml file. In config.xml:

<sitepoint_articles>
    <version>0.1.0</version>
</sitepoint_articles>

After setting up the installation script, refresh the Magento URL and view the database. If the installation script runs successfully, your table should be created. Magento checks whether any installation or upgrade scripts need to be run based on the version number in the configuration file and database table. When the version does not match, it will look for the corresponding version file to run. core_resource

Upgrade script:

You can use upgrade scripts when you need to update modules (such as adding new database fields or changing database schemas). The upgrade script is similar to the installation script, except that the name and version number are different.

Suppose we want to add one column and change another column, create an upgrade script in the

directory: Articles/sql/articles_setup mysql4-upgrade-0.1.0-0.1.1.php

Update the version number in the

<?php
$installer = $this;
$installer->startSetup();
$installer->getConnection()
    ->changeColumn($installer->getTable('articles'), 'long_desc', 'long_desc', array(
        'type' => Varien_Db_Ddl_Table::TYPE_TEXT,
        'nullable' => true,
    ))
    ->addColumn($installer->getTable('articles'), 'sub_title', array(
        'type' => Varien_Db_Ddl_Table::TYPE_VARCHAR,
        'nullable' => false,
        'comment' => 'Sub title'
    ));
$installer->endSetup();
?>

file is 0.1.1:

<code>app
 --code
 ---local
 ----Sitepoint
 ------Articles
 --------Block
  --------controllers
   --------etc
    --------Model
     --------sql</code>

After refreshing the URL, Magento will run the upgrade script and update the database schema.

Summary:

This is how Magento installation and upgrade scripts work. You can try to create a new module and run these scripts. If you have any questions, please feel free to ask.

(The FAQ part in the original text is omitted here because the FAQ part has little to do with how to write the installation and upgrade script itself, and is a wider topic of Magento upgrade.)

The above is the detailed content of Magento Install and Upgrade Data Scripts Explained. For more information, please follow other related articles on the PHP Chinese website!