X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FSchema%2FLoader.pm;h=61a6d3c2563d75470d6cae128e259b1a46522a36;hb=0f8448322561029d7265adc51484136b2433ad28;hp=659391b9b296b205ef179cee45565777de1fbebb;hpb=be80bba7041914683ec2afd00aaa54d6459cbaee;p=dbsrgits%2FDBIx-Class-Schema-Loader.git diff --git a/lib/DBIx/Class/Schema/Loader.pm b/lib/DBIx/Class/Schema/Loader.pm index 659391b..61a6d3c 100644 --- a/lib/DBIx/Class/Schema/Loader.pm +++ b/lib/DBIx/Class/Schema/Loader.pm @@ -2,22 +2,34 @@ package DBIx::Class::Schema::Loader; use strict; use warnings; -use base qw/DBIx::Class::Schema Class::Data::Accessor/; +use base qw/DBIx::Class::Schema Class::Accessor::Grouped/; +use MRO::Compat; +use mro 'c3'; use Carp::Clan qw/^DBIx::Class/; -use Class::C3; -use Scalar::Util qw/ weaken /; +use Scalar::Util 'weaken'; +use Sub::Name 'subname'; +use DBIx::Class::Schema::Loader::Utils 'array_eq'; +use namespace::clean; # Always remember to do all digits for the version even if they're 0 # i.e. first release of 0.XX *must* be 0.XX000. This avoids fBSD ports # brain damage and presumably various other packaging systems too -our $VERSION = '0.04999_10'; - -__PACKAGE__->mk_classaccessor('_loader_args' => {}); -__PACKAGE__->mk_classaccessors(qw/dump_to_dir _loader_invoked _loader loader_class/); +our $VERSION = '0.07014'; + +__PACKAGE__->mk_group_accessors('inherited', qw/ + _loader_args + dump_to_dir + _loader_invoked + _loader + loader_class + naming + use_namespaces +/); +__PACKAGE__->_loader_args({}); =head1 NAME -DBIx::Class::Schema::Loader - Dynamic definition of a DBIx::Class::Schema +DBIx::Class::Schema::Loader - Create a DBIx::Class::Schema based on a database =head1 SYNOPSIS @@ -30,12 +42,15 @@ DBIx::Class::Schema::Loader - Dynamic definition of a DBIx::Class::Schema { debug => 1, dump_directory => './lib', }, - [ 'dbi:Pg:dbname="foo"', 'myuser', 'mypassword' ], + [ 'dbi:Pg:dbname="foo"', 'myuser', 'mypassword', + { loader_class => 'MyLoader' } # optionally + ], ); # from the command line or a shell script with dbicdump (distributed # with this module). Do `perldoc dbicdump` for usage. dbicdump -o dump_directory=./lib \ + -o components='["InflateColumn::DateTime"]' \ -o debug=1 \ My::Schema \ 'dbi:Pg:dbname=foo' \ @@ -65,34 +80,44 @@ DBIx::Class::Schema::Loader - Dynamic definition of a DBIx::Class::Schema =head1 DESCRIPTION DBIx::Class::Schema::Loader automates the definition of a -L by scanning database table definitions and -setting up the columns, primary keys, and relationships. +L by scanning database table definitions and setting up +the columns, primary keys, unique constraints and relationships. + +See L for the C utility. -DBIx::Class::Schema::Loader currently supports only the DBI storage type. -It has explicit support for L, L, L, -L, and L. Other DBI drivers may function to -a greater or lesser degree with this loader, depending on how much of the -DBI spec they implement, and how standard their implementation is. +DBIx::Class::Schema::Loader currently supports only the DBI storage type. It +has explicit support for L, L, L, +L, L, L, L, +L, L (for Sybase ASE and MSSSQL), L (for +MSSQL, MSAccess, Firebird and SQL Anywhere) L (for MSSQL and +MSAccess) and L. Other DBI drivers may function to a greater or +lesser degree with this loader, depending on how much of the DBI spec they +implement, and how standard their implementation is. Patches to make other DBDs work correctly welcome. See L for notes on writing your own vendor-specific subclass for an unsupported DBD driver. -This module requires L 0.07006 or later, and obsoletes -the older L. - -This module is designed more to get you up and running quickly against -an existing database, or to be effective for simple situations, rather -than to be what you use in the long term for a complex database/project. +This module requires L 0.08127 or later, and obsoletes the older +L. -That being said, transitioning your code from a Schema generated by this -module to one that doesn't use this module should be straightforward and -painless, so don't shy away from it just for fears of the transition down -the road. +See L for available options. =head1 METHODS +=head2 loader + +The loader object, as class data on your Schema. For methods available see +L and L. + +=cut + +sub loader { + my $self = shift; + $self->_loader(@_); +} + =head2 loader_class =over 4 @@ -132,7 +157,7 @@ already been made is useless. sub loader_options { my $self = shift; - + my %args = (ref $_[0] eq 'HASH') ? %{$_[0]} : @_; $self->_loader_args(\%args); @@ -150,16 +175,22 @@ sub _invoke_loader { $args->{schema_class} = $class; weaken($args->{schema}) if ref $self; $args->{dump_directory} ||= $self->dump_to_dir; + $args->{naming} = $self->naming if $self->naming; + $args->{use_namespaces} = $self->use_namespaces if defined $self->use_namespaces; # XXX this only works for relative storage_type, like ::DBI ... - my $impl = $self->loader_class - || "DBIx::Class::Schema::Loader" . $self->storage_type; - $impl = "DBIx::Class::Schema::Loader${impl}" if $impl =~ /^::/; + my $loader_class = $self->loader_class; + if ($loader_class) { + $loader_class = "DBIx::Class::Schema::Loader${loader_class}" if $loader_class =~ /^::/; + $args->{loader_class} = $loader_class; + }; + + my $impl = $loader_class || "DBIx::Class::Schema::Loader" . $self->storage_type; eval { $self->ensure_class_loaded($impl) }; - croak qq/Could not load storage_type loader "$impl": "$@"/ if $@; + croak qq/Could not load loader_class "$impl": "$@"/ if $@; - $self->_loader($impl->new(%$args)); - $self->_loader->load; + $self->loader($impl->new(%$args)); + $self->loader->load; $self->_loader_invoked(1); $self; @@ -188,10 +219,11 @@ as soon as the connection information is defined. =cut sub connection { - my $self = shift; + my $self = shift; + my $class = ref $self || $self; if($_[-1] && ref $_[-1] eq 'HASH') { - for my $option (qw/ loader_class loader_options result_base_class schema_base_class/) { + for my $option (qw/loader_class loader_options/) { if(my $value = delete $_[-1]->{$option}) { $self->$option($value); } @@ -199,9 +231,66 @@ sub connection { pop @_ if !keys %{$_[-1]}; } - $self = $self->next::method(@_); + # Make sure we inherit from schema_base_class and load schema_components + # before connecting. + require DBIx::Class::Schema::Loader::Base; + my $temp_loader = DBIx::Class::Schema::Loader::Base->new( + %{ $self->_loader_args }, + schema => $self, + naming => 'current', + use_namespaces => 1, + ); + + my $modify_isa = 0; + my @components; + + if ($temp_loader->schema_base_class || $temp_loader->schema_components) { + @components = @{ $temp_loader->schema_components } + if $temp_loader->schema_components; + + push @components, ('+'.$temp_loader->schema_base_class) + if $temp_loader->schema_base_class; + + my $class_isa = do { + no strict 'refs'; + \@{"${class}::ISA"}; + }; + + my @component_classes = map { + /^\+/ ? substr($_, 1, length($_) - 1) : "DBIx::Class::$_" + } @components; + + $modify_isa++ if not array_eq([ @$class_isa[0..(@components-1)] ], \@component_classes) + } + + if ($modify_isa) { + $class->load_components(@components); + + # This hack is necessary because we changed @ISA of $self through + # ->load_components and we are now in a different place in the mro. + no warnings 'redefine'; + + local *connection = subname __PACKAGE__.'::connection' => sub { + my $self = shift; + $self->next::method(@_); + }; + + my @linear_isa = @{ mro::get_linear_isa($class) }; + + my $next_method; + + foreach my $i (1..$#linear_isa) { + no strict 'refs'; + $next_method = *{$linear_isa[$i].'::connection'}{CODE}; + last if $next_method; + } + + $self = $self->$next_method(@_); + } + else { + $self = $self->next::method(@_); + } - my $class = ref $self || $self; if(!$class->_loader_invoked) { $self->_invoke_loader } @@ -285,16 +374,27 @@ Examples: sub import { my $self = shift; + return if !@_; + + my $cpkg = (caller)[0]; + foreach my $opt (@_) { if($opt =~ m{^dump_to_dir:(.*)$}) { $self->dump_to_dir($1) } elsif($opt eq 'make_schema_at') { no strict 'refs'; - my $cpkg = (caller)[0]; *{"${cpkg}::make_schema_at"} = \&make_schema_at; } + elsif($opt eq 'naming') { + no strict 'refs'; + *{"${cpkg}::naming"} = sub { $self->naming(@_) }; + } + elsif($opt eq 'use_namespaces') { + no strict 'refs'; + *{"${cpkg}::use_namespaces"} = sub { $self->use_namespaces(@_) }; + } } } @@ -317,6 +417,8 @@ memory at runtime without generating on-disk class files. For a complete list of supported loader_options, see L +The last hashref in the C<\@connect_info> can specify the L. + This function can be imported in the usual way, as illustrated in these Examples: @@ -326,7 +428,9 @@ these Examples: make_schema_at( 'New::Schema::Name', { debug => 1 }, - [ 'dbi:Pg:dbname="foo"','postgres' ], + [ 'dbi:Pg:dbname="foo"','postgres','', + { loader_class => 'MyLoader' } # optionally + ], ); # Inside a script, specifying a dump directory in which to write @@ -335,9 +439,14 @@ these Examples: make_schema_at( 'New::Schema::Name', { debug => 1, dump_directory => './lib' }, - [ 'dbi:Pg:dbname="foo"','postgres' ], + [ 'dbi:Pg:dbname="foo"','postgres','', + { loader_class => 'MyLoader' } # optionally + ], ); +The last hashref in the C<\@connect_info> is checked for loader arguments such +as C and C, see L for more details. + =cut sub make_schema_at { @@ -348,6 +457,8 @@ sub make_schema_at { @{$target . '::ISA'} = qw/DBIx::Class::Schema::Loader/; } + eval { $target->_loader_invoked(0) }; + $target->loader_options($opts); $target->connection(@$connect_info); } @@ -368,26 +479,51 @@ Returns a list of the new monikers added. =cut -sub rescan { my $self = shift; $self->_loader->rescan($self) } +sub rescan { my $self = shift; $self->loader->rescan($self) } +=head2 naming -=head1 KNOWN ISSUES +=over 4 -=head2 Multiple Database Schemas +=item Arguments: \%opts | $ver + +=back + +Controls the naming options for backward compatibility, see +L for details. + +To upgrade a dynamic schema, use: + + __PACKAGE__->naming('current'); + +Can be imported into your dump script and called as a function as well: + + naming('v4'); + +=head2 use_namespaces + +=over 4 + +=item Arguments: 1|0 + +=back + +Controls the use_namespaces options for backward compatibility, see +L for details. + +To upgrade a dynamic schema, use: + + __PACKAGE__->use_namespaces(1); + +Can be imported into your dump script and called as a function as well: + + use_namespaces(1); -Currently the loader is limited to working within a single schema -(using the underlying RDBMS's definition of "schema"). If you have a -multi-schema database with inter-schema relationships (which is easy -to do in PostgreSQL or DB2 for instance), you currently can only -automatically load the tables of one schema, and relationships to -tables in other schemas will be silently ignored. +=head1 KNOWN ISSUES -At some point in the future, an intelligent way around this might be -devised, probably by allowing the C option to be an -arrayref of schemas to load. +=head2 Multiple Database Schemas -In "normal" L usage, manually-defined -source classes and relationships have no problems crossing vendor schemas. +See L. =head1 ACKNOWLEDGEMENTS @@ -404,30 +540,72 @@ blblack: Brandon Black =head1 CONTRIBUTORS -ilmarii: Dagfinn Ilmari Mannsåker +ilmari: Dagfinn Ilmari MannsEker arcanez: Justin Hunter ash: Ash Berlin +btilly: Ben Tilly + Caelum: Rafael Kitover TSUNODA Kazuya -Robert Bohne +rbo: Robert Bohne + +ribasushi: Peter Rabbitson + +gugu: Andrey Kostenko + +jhannah: Jay Hannah + +rbuels: Robert Buels + +timbunce: Tim Bunce + +mst: Matt S. Trout + +mstratman: Mark A. Stratman + +kane: Jos Boumans + +waawaamilk: Nigel McNie + +acmoore: Andrew Moore + +bphillips: Brian Phillips + +schwern: Michael G. Schwern + +hobbs: Andrew Rodland + +domm: Thomas Klausner + +spb: Stephen Bennett + +Matias E. Fernandez + +alnewkirk: Al Newkirk ... and lots of other folks. If we forgot you, please write the current maintainer or RT. -=head1 LICENSE +=head1 COPYRIGHT & LICENSE + +Copyright (c) 2006 - 2009 by the aforementioned +L and +L. This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself. =head1 SEE ALSO -L, L +L, L, L, +L =cut 1; +# vim:et sts=4 sw=4 tw=0: