DBIx::Class::DeploymentHandler::DeployMethod::SQL::Translator - Manage your SQL and Perl migrations in nicely laid out directories
This class is the meat of DBIx::Class::DeploymentHandler. It takes care of generating sql files representing schemata as well as sql files to move from one version of a schema to the rest. One of the hallmark features of this class is that it allows for multiple sql files for deploy and upgrade, allowing developers to fine tune deployment. In addition it also allows for perl files to be run at any stage of the process.
For basic usage see DBIx::Class::DeploymentHandler::HandlesDeploy. What's documented here is extra fun stuff or private methods.
Arguably this is the best feature of DBIx::Class::DeploymentHandler. It's heavily based upon DBIx::Migration::Directories, but has some extensions and modifications, so even if you are familiar with it, please read this. I feel like the best way to describe the layout is with the following example:
$sql_migration_dir |- SQLite | |- down | | `- 2-1 | | `- 001-auto.sql | |- schema | | `- 1 | | `- 001-auto.sql | `- up | |- 1-2 | | `- 001-auto.sql | `- 2-3 | `- 001-auto.sql |- _common | |- down | | `- 2-1 | | `- 002-remove-customers.pl | `- up | `- 1-2 | `- 002-generate-customers.pl |- _generic | |- down | | `- 2-1 | | `- 001-auto.sql | |- schema | | `- 1 | | `- 001-auto.sql | `- up | `- 1-2 | |- 001-auto.sql | `- 002-create-stored-procedures.sql `- MySQL |- down | `- 2-1 | `- 001-auto.sql |- preinstall | `- 1 | |- 001-create_database.pl | `- 002-create_users_and_permissions.pl |- schema | `- 1 | `- 001-auto.sql `- up `- 1-2 `- 001-auto.sql
So basically, the code
$dm->deploy(1)
on an SQLite database that would simply run $sql_migration_dir/SQLite/schema/1/001-auto.sql. Next,
SQLite
$sql_migration_dir/SQLite/schema/1/001-auto.sql
$dm->upgrade_single_step([1,2])
would run $sql_migration_dir/SQLite/up/1-2/001-auto.sql followed by $sql_migration_dir/_common/up/1-2/002-generate-customers.pl.
$sql_migration_dir/SQLite/up/1-2/001-auto.sql
$sql_migration_dir/_common/up/1-2/002-generate-customers.pl
Now, a .pl file doesn't have to be in the _common directory, but most of the time it probably should be, since perl scripts will mostly be database independent.
.pl
_common
_generic exists for when you for some reason are sure that your SQL is generic enough to run on all databases. Good luck with that one.
_generic
Note that unlike most steps in the process, preinstall will not run SQL, as there may not even be an database at preinstall time. It will run perl scripts just like the other steps in the process, but nothing is passed to them. Until people have used this more it will remain freeform, but a recommended use of preinstall is to have it prompt for username and password, and then call the appropriate CREATE DATABASE commands etc.
preinstall
CREATE DATABASE
A perl script for this tool is very simple. It merely needs to contain an anonymous sub that takes a DBIx::Class::Schema as it's only argument. A very basic perl script might look like:
#!perl use strict; use warnings; sub { my $schema = shift; $schema->resultset('Users')->create({ name => 'root', password => 'root', }) }
The DBIx::Class::Schema (required) that is used to talk to the database and generate the DDL.
The DBIx::Class::Storage that is actually used to talk to the database and generate the DDL. This is automatically created with "_build_storage".
The arguments that get passed to SQL::Translator when it's used.
The directory (default 'sql') that scripts are stored in
'sql'
The types of databases (default [qw( MySQL SQLite PostgreSQL )]) to generate files for
[qw( MySQL SQLite PostgreSQL )]
Set to true (which is the default) to wrap all upgrades and deploys in a single transaction.
The version the schema on your harddrive is at. Defaults to $self->schema->schema_version.
$self->schema->schema_version
Arthur Axel "fREW" Schmidt <frioux+cpan@gmail.com>
This software is copyright (c) 2010 by Arthur Axel "fREW" Schmidt.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
To install DBIx::Class::DeploymentHandler, copy and paste the appropriate command in to your terminal.
cpanm
cpanm DBIx::Class::DeploymentHandler
CPAN shell
perl -MCPAN -e shell install DBIx::Class::DeploymentHandler
For more information on module installation, please visit the detailed CPAN module installation guide.