X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FSchema%2FLoader.pm;h=0bd0049779899a19286a4d3bc3c8fd81baee8c25;hb=fc2b71fda3e7cebcb8df6430eb866754bf009350;hp=75318cf1c8cf08c8bcfce9641966b1aed261e602;hpb=18fca96ada05368ead5bb38b5c868e9c4d5c0c07;p=dbsrgits%2FDBIx-Class-Schema-Loader.git diff --git a/lib/DBIx/Class/Schema/Loader.pm b/lib/DBIx/Class/Schema/Loader.pm index 75318cf..0bd0049 100644 --- a/lib/DBIx/Class/Schema/Loader.pm +++ b/lib/DBIx/Class/Schema/Loader.pm @@ -1,9 +1,23 @@ package DBIx::Class::Schema::Loader; use strict; +use warnings; +use base qw/DBIx::Class::Schema/; +use base qw/Class::Data::Accessor/; +use Carp; use UNIVERSAL::require; +use Class::C3; +use Data::Dump qw/ dump /; +use Scalar::Util qw/ weaken /; -our $VERSION = '0.01'; +# 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.03002'; + +__PACKAGE__->mk_classaccessor('dump_to_dir'); +__PACKAGE__->mk_classaccessor('loader'); +__PACKAGE__->mk_classaccessor('_loader_args'); =head1 NAME @@ -11,104 +25,385 @@ DBIx::Class::Schema::Loader - Dynamic definition of a DBIx::Class::Schema =head1 SYNOPSIS - use DBIx::Class::Schema::Loader; - - my $loader = DBIx::Class::Schema::Loader->new( - dsn => "dbi:mysql:dbname", - user => "root", - password => "", - namespace => "Data", - additional_classes => [qw/DBIx::Class::Foo/], - additional_base_classes => [qw/My::Stuff/], - left_base_classes => [qw/DBIx::Class::Bar/], - constraint => '^foo.*', - relationships => 1, - options => { AutoCommit => 1 }, - inflect => { child => 'children' }, - debug => 1, + package My::Schema; + use base qw/DBIx::Class::Schema::Loader/; + + __PACKAGE__->loader_options( + relationships => 1, + constraint => '^foo.*', + # debug => 1, ); - my $conn = $loader->connection($dsn, $user, $password); # - my $conn = $loader->connection(); # uses same dsn as ->new(); + # in seperate application code ... -use with mod_perl + use My::Schema; -in your startup.pl + my $schema1 = My::Schema->connect( $dsn, $user, $password, $attrs); + # -or- + my $schema1 = "My::Schema"; $schema1->connection(as above); - # load all tables - use DBIx::Class::Loader; - my $loader = DBIx::Class::Loader->new( - dsn => "dbi:mysql:dbname", - user => "root", - password => "", - namespace => "Data", - ); +=head1 DESCRIPTION -in your web application. +DBIx::Class::Schema::Loader automates the definition of a +L by scanning database table definitions and +setting up the columns and primary keys. - use strict; +DBIx::Class::Schema::Loader currently supports DBI for MySQL, +PostgreSQL, SQLite and DB2. - # you can use Data::Film directly - my $conn = $loader->connection(); - my $film_moniker = $loader->moniker('film'); - my $a_film = $conn->resultset($film_moniker)->find($id); +See L for notes on writing +your own vendor-specific subclass for an unsupported DBD driver. -=head1 DESCRIPTION +This module requires L 0.06 or later, and obsoletes +the older L. -DBIx::Class::Schema::Loader automate the definition of a -DBIx::Class::Schema by scanning table schemas and setting up -columns and primary keys. +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. + +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 (as long as you're not using any methods that are now deprecated +in this document), so don't shy away from it just for fears of the +transition down the road. + +=head1 METHODS -DBIx::Class::Schema::Loader supports MySQL, Postgres, SQLite and DB2. See -L for more, and -L for notes on writing your own -db-specific subclass for an unsupported db. +=head2 loader_options -L, L, and L are now -obsolete, use L and this module instead. ;) +Example in Synopsis above demonstrates a few common arguments. For +detailed information on all of the arguments, most of which are +only useful in fairly complex scenarios, see the +L documentation. + +This method is *required*, for backwards compatibility reasons. If +you do not wish to change any options, just call it with an empty +argument list during schema class initialization. =cut -=head1 METHODS +sub loader_options { + my $self = shift; + + my %args; + if(ref $_[0] eq 'HASH') { + %args = %{$_[0]}; + } + else { + %args = @_; + } + + my $class = ref $self || $self; + $args{schema} = $self; + $args{schema_class} = $class; + weaken($args{schema}) if ref $self; + + $self->_loader_args(\%args); + $self->_invoke_loader if $self->storage && !$class->loader; + + $self; +} + +sub _invoke_loader { + my $self = shift; + my $class = ref $self || $self; + + $self->_loader_args->{dump_directory} ||= $self->dump_to_dir; + + # XXX this only works for relative storage_type, like ::DBI ... + my $impl = "DBIx::Class::Schema::Loader" . $self->storage_type; + $impl->require or + croak qq/Could not load storage_type loader "$impl": / . + qq/"$UNIVERSAL::require::ERROR"/; + + # XXX in the future when we get rid of ->loader, the next two + # lines can be replaced by "$impl->new(%{$self->_loader_args})->load;" + $class->loader($impl->new(%{$self->_loader_args})); + $class->loader->load; + + $self; +} -=head2 new +=head2 connection -Example in Synopsis above demonstrates the available arguments. For -detailed information on the arguments, see the -L documentation. +See L. =cut -sub new { - my ( $class, %args ) = @_; +sub connection { + my $self = shift->next::method(@_); + + my $class = ref $self || $self; + $self->_invoke_loader if $self->_loader_args && !$class->loader; + + return $self; +} + +=head2 clone + +See L. + +=cut + +sub clone { + my $self = shift; + + my $clone = $self->next::method(@_); + + $clone->_loader_args($self->_loader_args); + $clone->_loader_args->{schema} = $clone; + weaken($clone->_loader_args->{schema}); + + $clone; +} + +=head2 dump_to_dir + +Argument: directory name. + +Calling this as a class method on either L +or any derived schema class will cause all affected schemas to dump +manual versions of themselves to the named directory when they are +loaded. In order to be effective, this must be set before defining a +connection on this schema class or any derived object (as the loading +happens as soon as both a connection and loader_options are set, and +only once per class). + +See L for more +details on the dumping mechanism. + +This can also be set at module import time via the import option +C to L, where +C is the target directory. + +Examples: + + # My::Schema isa DBIx::Class::Schema::Loader, and has connection info + # hardcoded in the class itself: + perl -MDBIx::Class::Schema::Loader=dump_to_dir:/foo/bar -MMy::Schema -e1 + + # Same, but no hard-coded connection, so we must provide one: + perl -MDBIx::Class::Schema::Loader=dump_to_dir:/foo/bar -MMy::Schema -e 'My::Schema->connection("dbi:Pg:dbname=foo", ...)' + + # Or as a class method, as long as you get it done *before* defining a + # connection on this schema class or any derived object: + use My::Schema; + My::Schema->dump_to_dir('/foo/bar'); + My::Schema->connection(........); - foreach (qw/namespace dsn/) { - die qq/Argument $_ is required/ if ! $args{$_}; + # Or as a class method on the DBIx::Class::Schema::Loader itself, which affects all + # derived schemas + use My::Schema; + use My::OtherSchema; + DBIx::Class::Schema::Loader->dump_to_dir('/foo/bar'); + My::Schema->connection(.......); + My::OtherSchema->connection(.......); + + # Another alternative to the above: + use DBIx::Class::Schema::Loader qw| dump_to_dir:/foo/bar |; + use My::Schema; + use My::OtherSchema; + My::Schema->connection(.......); + My::OtherSchema->connection(.......); + +=cut + +sub import { + my $self = shift; + return if !@_; + 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; + } } +} - $args{namespace} =~ s/(.*)::$/$1/; +=head2 make_schema_at + +This simple function allows one to create a Loader-based schema +in-memory on the fly without any on-disk class files of any +kind. When used with the C option, you can +use this to generate a rough draft manual schema from a dsn +without the intermediate step of creating a physical Loader-based +schema class. + +This function can be exported/imported by the normal means, as +illustrated in these Examples: + + # Simple example, creates as a new class 'New::Schema::Name' in + # memory in the running perl interpreter. + use DBIx::Class::Schema::Loader qw/ make_schema_at /; + make_schema_at( + 'New::Schema::Name', + { relationships => 1, debug => 1 }, + [ 'dbi:Pg:dbname="foo"','postgres' ], + ); + + # Complex: dump loaded schema to disk, all from the commandline: + perl -MDBIx::Class::Schema::Loader=make_schema_at,dump_to_dir:./lib -e 'make_schema_at("New::Schema::Name", { relationships => 1 }, [ "dbi:Pg:dbname=foo","postgres" ])' + + # Same, but inside a script, and using a different way to specify the + # dump directory: + use DBIx::Class::Schema::Loader qw/ make_schema_at /; + make_schema_at( + 'New::Schema::Name', + { relationships => 1, debug => 1, dump_directory => './lib' }, + [ 'dbi:Pg:dbname="foo"','postgres' ], + ); - my $dsn = $args{dsn}; - my ($driver) = $dsn =~ m/^dbi:(\w*?)(?:\((.*?)\))?:/i; - $driver = 'SQLite' if $driver eq 'SQLite2'; - my $impl = "DBIx::Class::Schema::Loader::" . $driver; +=cut - $impl->require or - die qq/Couldn't require loader class "$impl", "$UNIVERSAL::require::ERROR"/; +sub make_schema_at { + my ($target, $opts, $connect_info) = @_; + + my $opts_dumped = dump($opts); + my $cinfo_dumped = dump(@$connect_info); + eval qq| + package $target; + use base qw/DBIx::Class::Schema::Loader/; + __PACKAGE__->loader_options($opts_dumped); + __PACKAGE__->connection($cinfo_dumped); + |; + croak "make_schema_at failed: $@" if $@; +} + +=head1 EXAMPLE + +Using the example in L as a basis +replace the DB::Main with the following code: + + package DB::Main; + + use base qw/DBIx::Class::Schema::Loader/; + + __PACKAGE__->loader_options( + relationships => 1, + debug => 1, + ); + __PACKAGE__->connection('dbi:SQLite:example.db'); + + 1; + +and remove the Main directory tree (optional). Every thing else +should work the same + +=head1 DEPRECATED METHODS + +You don't need to read anything in this section unless you're upgrading +code that was written against pre-0.03 versions of this module. This +version is intended to be backwards-compatible with pre-0.03 code, but +will issue warnings about your usage of deprecated features/methods. + +=head2 load_from_connection + +This deprecated method is now roughly an alias for L. + +This method *will* disappear in a future version. - return $impl->new(%args); +For now, using this method will invoke the legacy behavior for +backwards compatibility, and merely emit a warning about upgrading +your code. + +It also reverts the default inflection scheme to +use L just like pre-0.03 versions of this +module did. + +You can force these legacy inflections with the +option C, even after switch over +to the preferred L way of doing things. + +See the source of this method for more details. + +=cut + +sub load_from_connection { + my ($self, %args) = @_; + + my $cmds_ver = $Catalyst::Model::DBIC::Schema::VERSION; + if($cmds_ver) { + if($cmds_ver < 0.14) { + warn 'You should upgrade your installation of' + . ' Catalyst::Model::DBIC::Schema to 0.14 or higher, then:'; + } + warn 'You should regenerate your Model files, which may eliminate' + . ' the following deprecation warning:'; + } + warn 'load_from_connection deprecated, please [re-]read the' + . ' [new] DBIx::Class::Schema::Loader documentation'; + + # Support the old connect_info / dsn / etc args... + $args{connect_info} = [ + delete $args{dsn}, + delete $args{user}, + delete $args{password}, + delete $args{options}, + ] if $args{dsn}; + + $self->connection(@{delete $args{connect_info}}) + if $args{connect_info}; + + $self->loader_options('legacy_default_inflections' => 1, %args); } +=head2 loader + +This is an accessor in the generated Schema class for accessing +the L -based loader object +that was used during construction. See the +L docs for more information +on the available loader methods there. + +This accessor is deprecated. Do not use it. Anything you can +get from C, you can get via the normal L +methods, and your code will be more robust and forward-thinking +for doing so. + +If you're already using C in your code, make an effort +to get rid of it. If you think you've found a situation where it +is necessary, let me know and we'll see what we can do to remedy +that situation. + +In some future version, this accessor *will* disappear. It was +apparently quite a design/API mistake to ever have exposed it to +user-land in the first place, all things considered. + +=head1 KNOWN ISSUES + +=head2 Multiple Database Schemas + +Currently the loader is limited to working within a single schema +(using the database vendors' 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 only get to +automatically load the tables of one schema, and any relationships +to tables in other schemas will be silently ignored. + +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, or perhaps even offering schema +constraint/exclusion options just like the table ones. + +In "normal" L usage, manually-defined +source classes and relationships have no problems crossing vendor schemas. + =head1 AUTHOR -Sebastian Riedel, C +Brandon Black, C + +Based on L by Sebastian Riedel Based upon the work of IKEBE Tomohiro =head1 THANK YOU Adam Anderson, Andy Grundman, Autrijus Tang, Dan Kubb, David Naughton, -Randal Schwartz, Simon Flack and all the others who've helped. +Randal Schwartz, Simon Flack, Matt S Trout, everyone on #dbix-class, and +all the others who've helped. =head1 LICENSE @@ -117,7 +412,7 @@ the same terms as Perl itself. =head1 SEE ALSO -L +L, L =cut