How to use Phinx database migration tool in PHP

Phinx is a powerful PHP database migration tool that can help us simplify the update and maintenance of the database structure. This article will introduce the installation and use of Phinx in detail to help developers better use this tool.

1. Install Phinx
Before using Phinx, we need to install it first. You can use Composer to install the Phinx toolkit. Please make sure Composer is installed on your system, then execute the following command in the terminal:

composer require robmorgan/phinx

This command will install the Phinx toolkit and its dependencies to your project , developers can use Phinx at any time this way.

2. Configure Phinx
Phinx configuration is usually stored in the phinx.yml or phinx.php file. These files should be located in the root directory of the Phinx toolkit. Phinx supports multiple database types, including MySQL, PostgreSQL, SQLite and SQL Server, so you need to specify the database type to be used in the configuration file.

The following is the content of an example phinx.yml file:

paths:

migrations: '%%PHINX_CONFIG_DIR%%/db/migrations'

environments:

default_migration_table: phinxlog
default_database: development
production:
    adapter: mysql
    host: localhost
    name: production_db
    user: root
    pass: ''
    port: 3306
    charset: utf8
development:
    adapter: mysql
    host: localhost
    name: development_db
    user: root
    pass: ''
    port: 3306
    charset: utf8

In this configuration file, we define The two environments, development and production, represent development and production environments respectively. The adapter field defines the database type, the host field specifies the address of the database server, the name field specifies the database name, the user and pass fields specify the user name and password required for the connection, the port field specifies the port number required for the connection, and the charset field Specifies the character encoding required for the connection.

3. Create migration files
In Phinx, all database structure changes need to be implemented in "migration". We use Phinx’s command line tools to create new migration files. Enter the path to the Phinx toolkit in the terminal, and then enter the following command to generate the migration file:

vendor/bin/phinx create AddUsersTable

The above command will create a file named Migration file for AddUsersTable. The naming convention for migration files is CamelCase, and must follow the format of date_time_migration name, such as 20190717180931_AddUsersTable.php.

Next, we rewrite the migration file generated by Phinx to make it meet our needs. For example, we can create the AddUsersTable migration file like this:

use PhinxMigrationAbstractMigration;

class AddUsersTable extends AbstractMigration
{

public function up()
{
    $table = $this->table('users');
    $table->addColumn('username', 'string')
          ->addColumn('email', 'string')
          ->addColumn('password', 'string')
          ->addColumn('created_at', 'datetime')
          ->addColumn('updated_at', 'datetime')
          ->create();
}

public function down()
{
    $this->table('users')->drop();
}

}

In the migration file above, we use the table() method provided by Phinx to create the users table, and add some fields, such as username, email, password, created_at and updated_at.

4. Run the migration file
In Phinx, we can use the command line tool to run the migration file. Enter the path to the Phinx toolkit in the terminal, and then enter the following command to run the migration file:

vendor/bin/phinx migrate -e development

The above command will run in the development environment All migration files.

If we need to roll back to the previous migration file, we can enter the following command:

vendor/bin/phinx rollback -e development

The above command will roll back to The most recent migration file.

In addition, Phinx also supports other commands, such as status, seed, etc.

5. Conclusion
Phinx is a very useful PHP database migration tool, which can help us simplify the update and maintenance of the database structure. In this article, we introduce the installation, configuration and use of Phinx, we hope it will be helpful to you.

The above is the detailed content of How to use Phinx database migration tool in PHP. For more information, please follow other related articles on the PHP Chinese website!