isa => 'DBIx::Class::Schema',
is => 'ro',
required => 1,
- handles => [qw( schema_version )],
);
has storage => (
$s
}
-has sqltargs => (
+has sql_translator_args => (
isa => 'HashRef',
is => 'ro',
default => sub { {} },
default => 1,
);
+has schema_version => (
+ is => 'ro',
+ lazy_build => 1,
+);
+
+method _build_schema_version { $self->schema->schema_version }
+
method __ddl_consume_with_prefix($type, $versions, $prefix) {
my $base_dir = $self->upgrade_directory;
sub deploy {
my $self = shift;
+ my $version = shift || $self->schema_version;
return $self->_run_sql_and_perl($self->_ddl_schema_consume_filenames(
$self->storage->sqlt_type,
- $self->schema_version
+ $version,
));
}
sub _prepare_install {
- my $self = shift;
- my $sqltargs = { %{$self->sqltargs}, %{shift @_} };
+ my $self = shift;
+ my $sqltargs = { %{$self->sql_translator_args}, %{shift @_} };
my $to_file = shift;
my $schema = $self->schema;
my $databases = $self->databases;
my $dir = $self->upgrade_directory;
- my $version = $schema->schema_version;
+ my $version = $self->schema_version;
my $sqlt = SQL::Translator->new({
add_drop_table => 1,
}, $filename);
}
-sub prepare_install {
+sub prepare_deploy {
my $self = shift;
$self->_prepare_install({}, '_ddl_schema_produce_filename');
}
my $schema = $self->schema;
my $databases = $self->databases;
my $dir = $self->upgrade_directory;
- my $sqltargs = $self->sqltargs;
+ my $sqltargs = $self->sql_translator_args;
- my $schema_version = $schema->schema_version;
+ my $schema_version = $self->schema_version;
$sqltargs = {
add_drop_table => 1,
__END__
+=head1 DESCRIPTION
+
+This class is the meat of L<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 L<DBIx::Class::DeploymentHandler::HandlesDeploy>. What's
+documented here is extra fun stuff or private methods.
+
+=head1 DIRECTORY LAYOUT
+
+Arguably this is the best feature of L<DBIx::Class::DeploymentHandler>. It's
+heavily based upon L<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
+ | | `- 1-2
+ | | `- 001-auto.sql
+ | |- schema
+ | | `- 1
+ | | `- 001-auto.sql
+ | `- up
+ | |- 1-2
+ | | `- 001-auto.sql
+ | `- 2-3
+ | `- 001-auto.sql
+ |- _common
+ | |- down
+ | | `- 1-2
+ | | `- 002-remove-customers.pl
+ | `- up
+ | `- 1-2
+ | `- 002-generate-customers.pl
+ |- _generic
+ | |- down
+ | | `- 1-2
+ | | `- 001-auto.sql
+ | |- schema
+ | | `- 1
+ | | `- 001-auto.sql
+ | `- up
+ | `- 1-2
+ | |- 001-auto.sql
+ | `- 002-create-stored-procedures.sql
+ `- MySQL
+ |- down
+ | `- 1-2
+ | `- 001-auto.sql
+ |- schema
+ | `- 1
+ | `- 001-auto.sql
+ `- up
+ `- 1-2
+ `- 001-auto.sql
+
+So basically, the code
+
+ $dm->deploy(1)
+
+on an C<SQLite> database that would simply run
+C<$sql_migration_dir/SQLite/schema/1/001-auto.sql>. Next,
+
+ $dm->upgrade_single_step([1,2])
+
+would run C<$sql_migration_dir/SQLite/up/1-2/001-auto.sql> followed by
+C<$sql_migration_dir/_common/up/1-2/002-generate-customers.pl>.
+
+Now, a C<.pl> file doesn't have to be in the C<_common> directory, but most of
+the time it probably should be, since perl scripts will mostly be database
+independent.
+
+C<_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.
+
+=head1 PERL SCRIPTS
+
+A perl script for this tool is very simple. It merely needs to contain a
+sub called C<run> that takes a L<DBIx::Class::Schema> as it's only argument.
+A very basic perl script might look like:
+
+ #!perl
+
+ use strict;
+ use warnings;
+
+ sub run {
+ my $schema = shift;
+
+ $schema->resultset('Users')->create({
+ name => 'root',
+ password => 'root',
+ })
+ }
+
=attr schema
+The L<DBIx::Class::Schema> (B<required>) that is used to talk to the database
+and generate the DDL.
+
=attr storage
-=attr sqltargs
+The L<DBIx::Class::Storage> that is I<actually> used to talk to the database
+and generate the DDL. This is automatically created with L</_build_storage>.
+
+=attr sql_translator_args
-#rename
+The arguments that get passed to L<SQL::Translator> when it's used.
=attr upgrade_directory
=attr txn_wrap
+Set to true (which is the default) to wrap all upgrades and deploys in a single
+transaction.
+
+=attr schema_version
+
+The version the schema on your harddrive is at. Defaults to
+C<< $self->schema->schema_version >>.
+
=method __ddl_consume_with_prefix
+ $dm->__ddl_consume_with_prefix( 'SQLite', [qw( 1.00 1.01 )], 'up' )
+
+This is the meat of the multi-file upgrade/deploy stuff. It returns a list of
+files in the order that they should be run for a generic "type" of upgrade.
+You should not be calling this in user code.
+
=method _ddl_schema_consume_filenames
+ $dm->__ddl_schema_consume_filenames( 'SQLite', [qw( 1.00 )] )
+
+Just a curried L</__ddl_consume_with_prefix>. Get's a list of files for an
+initial deploy.
+
=method _ddl_schema_produce_filename
+ $dm->__ddl_schema_produce_filename( 'SQLite', [qw( 1.00 )] )
+
+Returns a single file in which an initial schema will be stored.
+
=method _ddl_schema_up_consume_filenames
+ $dm->_ddl_schema_up_consume_filenames( 'SQLite', [qw( 1.00 )] )
+
+Just a curried L</__ddl_consume_with_prefix>. Get's a list of files for an
+upgrade.
+
=method _ddl_schema_down_consume_filenames
+ $dm->_ddl_schema_down_consume_filenames( 'SQLite', [qw( 1.00 )] )
+
+Just a curried L</__ddl_consume_with_prefix>. Get's a list of files for a
+downgrade.
+
=method _ddl_schema_up_produce_filenames
-=method _ddl_schema_down_produce_filenames
+ $dm->_ddl_schema_up_produce_filename( 'SQLite', [qw( 1.00 1.01 )] )
+
+Returns a single file in which the sql to upgrade from one schema to another
+will be stored.
+
+=method _ddl_schema_down_produce_filename
+
+ $dm->_ddl_schema_down_produce_filename( 'SQLite', [qw( 1.00 1.01 )] )
+
+Returns a single file in which the sql to downgrade from one schema to another
+will be stored.
=method _resultsource_install_filename
+ my $filename_fn = $dm->_resultsource_install_filename('User');
+ $dm->$filename_fn('SQLite', '1.00')
+
+Returns a function which in turn returns a single filename used to install a
+single resultsource. Weird interface is convenient for me. Deal with it.
+
=method _run_sql_and_perl
-=method _prepare_install
+ $dm->_run_sql_and_perl([qw( list of filenames )])
-=method _prepare_changegrade
+Simply put, this runs the list of files passed to it. If the file ends in
+C<.sql> it runs it as sql and if it ends in C<.pl> it runs it as a perl file.
-=method _read_sql_file
+Depending on L</txn_wrap> all of the files run will be wrapped in a single
+transaction.
-=method deploy
+=method _prepare_install
+
+ $dm->_prepare_install({ add_drop_table => 0 }, sub { 'file_to_create' })
-=method install_resultsource
+Generates the sql file for installing the database. First arg is simply
+L<SQL::Translator> args and the second is a coderef that returns the filename
+to store the sql in.
-=method prepare_resultsouce_install
+=method _prepare_changegrade
-=method prepare_install
+ $dm->_prepare_changegrade('1.00', '1.01', [qw( 1.00 1.01)], 'up')
-=method prepare_upgrade
+Generates the sql file for migrating from one schema version to another. First
+arg is the version to start from, second is the version to go to, third is the
+L<version set|DBIx::Class::DeploymentHandler/VERSION SET>, and last is the
+direction of the changegrade, be it 'up' or 'down'.
-=method prepare_downgrade
+=method _read_sql_file
-=method upgrade_single_step
+ $dm->_read_sql_file('foo.sql')
-=method downgrade_single_step
+Reads a sql file and returns lines in an C<ArrayRef>. Strips out comments,
+transactions, and blank lines.