Versionnant de la base de données avec des migrations d'échelle

Points de base

• Ladder est un outil pour créer, exécuter et gérer les migrations de base de données qui permet de suivre les modifications des schémas de base de données de la même manière que le code d'application. Cet outil peut être intégré dans n'importe quel cadre majeur et peut être utilisé pour les modifications et la gestion des fonctionnalités dans le contrôle des versions.
• Les migrations sont toujours exécutées en séquence, et l'échelle garantit cela en numérotant les migrations en séquence et en stockant les enregistrements des migrations qui ont été exécutées dans la base de données elle-même, empêchant ainsi la relance des migrations précédentes.
• Ladder permet également la création de bases de données pré-population ou "Seed", telles que les comptes d'utilisateurs par défaut. Cela peut être fait en utilisant la boutique de valeur clé de Ladder, stockant certaines données pour référence ultérieure.
• L'outil fournit des commandes supplémentaires pour gérer et surveiller les bases de données, telles que la commande d'état pour l'état de la base de données, les commandes DIFF et DIFF-SAVE pour le vidage et la restauration de l'état de base de données, et les commandes de version pour vérifier la version de l'échelle utilisée.

Les systèmes de contrôle des versions sont inestimables pour le suivi des changements de code, en particulier lorsque vous travaillez en équipes. Cependant, la plupart des applications contiennent plus que du code d'application. La gestion des modifications des bases de données a été plus difficile, en particulier lors de l'ajout de nouvelles fonctionnalités qui nécessitent une modification des modèles.

Supposons que vous travaillez sur un module et que vous vous rendez compte qu'une table de base de données nécessite une colonne supplémentaire. Vous voudrez peut-être ouvrir un outil de requête de base de données ou une ligne de commande et ajouter simplement cette colonne. Cependant, cela ne laisse pas un enregistrement de modifications comme le code d'application contrôlé par version. Cela peut être exacerbé lorsque vous travaillez en équipe - si des collègues extraient vos modifications de code sans exécuter la même mise à jour de la base de données, leur version d'application se bloquera très probablement. Cela devient encore plus problématique lorsque vous publiez des mises à jour de produit, car cela peut briser l'application non seulement pour vos collègues, mais pour vos utilisateurs.

Une solution consiste à utiliser la migration pour transférer la responsabilité de la création et de la modification des schémas de base de données dans votre code. De cette façon, les modifications peuvent être gérées avec le reste de l'application, et nous pouvons utiliser des fonctionnalités auxquelles nous sommes habitués dans le contrôle de version (comme être en mesure de comparer les versions et de conserver les pistes d'audit) pour gérer les modifications de la base de données. Il permet également à ces modifications d'être intégrées de manière transparente dans la version, car elles peuvent faire partie de la même branche ou tag.

De nombreux cadres majeurs ont leurs propres implémentations de migration, mais pour ceux qui ne le font pas - si vous n'en utilisez pas - vous pouvez utiliser l'échelle.

Introduction d'échelle

Ladder est un outil pour créer, exécuter et gérer les migrations de base de données. La migration n'est qu'une classe PHP, de sorte que le contrôle de version peut être enregistré avec le reste du code de l'application.

Vous pouvez apporter autant de modifications au schéma dans une seule migration, bien qu'il soit préférable de limiter la migration vers une seule table ou une fonctionnalité.

Les migrations sont toujours exécutées dans l'ordre. Supposons donc que vous écriviez une migration pour créer le tableau des produits et créez une nouvelle migration quelques semaines plus tard pour y ajouter une colonne supplémentaire. Essayer d'exécuter le premier avant le second produira une erreur. Ladder résout ce problème en numérotant les migrations dans la séquence et le stockage des enregistrements (et du temps) de l'exécution de migrations dans la base de données elle-même.

Installation

Ladder peut être téléchargée à partir de Bitbucket ou via le compositeur. Cependant, il faut plusieurs étapes pour être opérationnelle.

Le moyen le plus simple (bien qu'il admet d'être moins élégant) est de le télécharger ou de le cloner à partir de la racine du projet et de le placer dans un répertoire appelé Ladder. Le problème avec l'utilisation du compositeur est que l'exécution de la mise à jour du composer écrasera votre fichier de configuration.

Il existe cinq fichiers de configuration, chacun à créer manuellement;

cp ladder/config/config.php.example ladder/config/config.php
cp ladder/config/database.php.example ladder/config/database.php
cp ladder/config/diff.php.example ladder/config/diff.php
cp ladder/config/editor.php.example ladder/config/editor.php
cp ladder/config/table.php.example ladder/config/table.php

Vous devrez peut-être simplement modifier Database.php (qui contient des détails de connexion de base de données) et Editor.php, où vous pouvez spécifier l'éditeur de texte préféré, et choisir d'ouvrir automatiquement une nouvelle migration lors de la création.

Créer une migration

Commençons par créer une migration pour créer le tableau des utilisateurs.

sur la ligne de commande:

php ladder/ladder.php create create_users_table

Cela crée un fichier nommé Ladder / Migrations / 00001_create_users_table, qui contient par défaut une structure de base avec des exemples d'exemples commentés. Si vous avez défini Auto-Edit sur true dans Ladder / config / editor.php, ce fichier sera ouvert immédiatement dans l'éditeur de texte spécifié. Vous pouvez appeler les migrations à volonté, mais il sera utile de pouvoir voir ce que fait la migration à partir du nom de fichier en un coup d'œil.

Voici à quoi pourrait ressembler le fichier (j'ai supprimé la ligne de code commentée pour plus de clarté):

class Create_Users_Table_Migration_00001 extends Migration {
    protected $min_version = '0.8.1';

    public function up() {
        $this->create_table('users')
            ->column('email', 'varchar', array('limit' => 128, 'null' => FALSE))
            ->column('password', 'varchar', array('limit' => 32, 'null' => FALSE));
    }

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

Appelez la méthode UP () lorsque la migration est exécutée et la méthode Down () lorsque la migration est reculée - il doit donc toujours effectuer l'opération opposée à la méthode UP (). Dans cet exemple, la méthode UP () crée un tableau nommé utilisateurs, et la méthode Down () le supprime.

La méthode

create_table () renvoie une référence à la nouvelle table, tandis que la classe de table a une méthode colonne () pour ajouter une nouvelle colonne. Il a une interface lisse afin que vous puissiez les relier ensemble pour créer plusieurs colonnes en même temps. Vous remarquerez qu'il n'y a pas de colonne d'ID - ceci est automatiquement créé - c'est-à-dire une clé primaire entière auto-incrémentale nommée ID.

table () renvoie une référence à la table, mais elle crée également la table si la table n'existe pas encore - vous pouvez donc modifier en toute sécurité l'appel create_table () vers table ()

Créons une autre migration, cette fois la création de rôles Tableau:

php ladder/ladder.php create create_roles_table

Fichier lui-même:

class Create_Roles_Table_Migration_00002 extends Migration {
    protected $min_version = '0.8.1';

    public function up() {
        $this->table('roles')
            ->column('nme', 'varchar', array('limit' => 128, 'null' => FALSE));            
    }

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

Maintenant, vous devez réellement exécuter la migration. Pour ce faire:

php ladder/ladder.php migrate

Si vous regardez la base de données, vous trouverez quatre tables:

Les migrations sont créées automatiquement pour suivre les migrations exécutées Migrations_kvdata est également créé pour vous, et vos migrations peuvent être utilisées pour tout stockage de valeurs clés Les utilisateurs et les rôles sont les tables que nous venons d'ajouter.

Cependant, si vous portez une attention particulière à la migration des rôles, vous remarquerez qu'il crée une colonne appelée NME au lieu du nom. À ce stade, nous pouvons résoudre ce problème en «annulant» la migration, en modifiant la classe et en l'exécutant à nouveau. Pour faire reculer la migration:

cp ladder/config/config.php.example ladder/config/config.php
cp ladder/config/database.php.example ladder/config/database.php
cp ladder/config/diff.php.example ladder/config/diff.php
cp ladder/config/editor.php.example ladder/config/editor.php
cp ladder/config/table.php.example ladder/config/table.php

Le numéro 2 indique que la migration à revenir - c'est le préfixe du nom du fichier de migration, sans Zeros à la tête.

Maintenant, vous pouvez simplement effectuer la correction et exécuter à nouveau la migration:

php ladder/ladder.php create create_users_table

Étant donné que le tableau des migrations a stocké des enregistrements de contenu en cours d'exécution et UnRUN, vous n'avez pas à vous soucier que votre première migration soit rediffurée.

Il existe également un moyen plus rapide d'utiliser une réapplication:

class Create_Users_Table_Migration_00001 extends Migration {
    protected $min_version = '0.8.1';

    public function up() {
        $this->create_table('users')
            ->column('email', 'varchar', array('limit' => 128, 'null' => FALSE))
            ->column('password', 'varchar', array('limit' => 32, 'null' => FALSE));
    }

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

Cela appellera à la fois la méthode Down () de la deuxième migration, puis sa méthode UP ().

Disons maintenant qu'après un certain temps, nous développons une nouvelle fonctionnalité qui nécessite que le tableau des utilisateurs contienne un champ d'état. Pour ce faire, nous devons créer une nouvelle migration:

php ladder/ladder.php create create_roles_table

La migration ressemblera à ceci:

class Create_Roles_Table_Migration_00002 extends Migration {
    protected $min_version = '0.8.1';

    public function up() {
        $this->table('roles')
            ->column('nme', 'varchar', array('limit' => 128, 'null' => FALSE));            
    }

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

Comme auparavant, exécutez avec la commande suivante:

php ladder/ladder.php migrate

Maintenant, si vous vérifiez votre base de données, vous verrez que la table des utilisateurs a une nouvelle colonne.

Semis de base de données

En plus d'écrire des migrations pour gérer les schémas de base de données, vous pouvez également utiliser les bases de données pré-populées (c'est-à-dire les bases de graines).

Par exemple, vous pouvez étendre la migration CREATE_USERS_TABLE pour créer un compte d'utilisateur racine par défaut:

php ladder/ladder.php remove 2

Notez que nous utilisons les méthodes set () et get () pour profiter du magasin de valeurs clés de Ladder, stockant l'ID utilisateur afin que nous puissions y faire référence plus tard.

Vous pouvez également importer des données à partir de fichiers CSV migrés, par exemple:

php ladder/ladder.php migrate

Pour mettre à jour au lieu d'insérer des données CSV, vous pouvez le faire:

php ladder/ladder.php reapply 2

Dans ce cas, le paramètre Send signifie que nous voulons exécuter la mise à jour, et le troisième paramètre contient une liste des champs clés pour déterminer les enregistrements à mettre à jour.

Ajouter d'autres bases de données

Vous remarquerez que l'échelle de fichier de configuration de la base de données par défaut / config / database.php montre comment ajouter des connexions de base de données supplémentaires; peut-être pour la mise en scène ou les bases de données en temps réel. Par exemple:

php ladder/ladder.php create add_status_to_users_table

Vous pouvez spécifier la connexion à utiliser comme ceci:

class Add_Status_To_Users_Table_Migration_00003 extends Migration {
    protected $min_version = '0.8.1';

    public function up() {
        $this->table('users')
            ->column('status', 'integer', array('null' => FALSE, 'default' => 0));            
    }

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

Autres commandes

statut

Vous pouvez utiliser la commande d'état pour obtenir l'état de la base de données:

php ladder/ladder.php migrate

Exemple de sortie: (l'exemple de sortie est omis ici car le document d'origine ne fournit pas de contenu de sortie spécifique)

diff et diff-save

(Les descriptions des commandes Diff et Diff-Save sont omises ici, car ces commandes ont été décrites en détail dans le document d'origine)

Version

(La description de la commande de version est omise ici, car la commande a été décrite en détail dans le document d'origine)

Résumé

Cet article présente l'échelle, utilisée pour maintenir le schéma de la base de données et les données pré-populaires. (La partie sommaire est omise ici, car le document original a résumé l'échelle)

FAQ sur le versioning de la base de données et la migration des échelles

(La section FAQ est omise ici, car le document d'origine fournit déjà une FAQ détaillée)

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!