X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FAdmin.pm;h=300c48540bcabc788631b8ecc98d154418b4aeca;hb=367eaf50970dd3fd223ce5e1f0337703f2a6c70e;hp=318dd87e7802094e4f98fd744755ac10609f6152;hpb=2bf51de058416a26d50e595603f0d266f5b481dc;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class/Admin.pm b/lib/DBIx/Class/Admin.pm index 318dd87..300c485 100644 --- a/lib/DBIx/Class/Admin.pm +++ b/lib/DBIx/Class/Admin.pm @@ -1,38 +1,24 @@ package DBIx::Class::Admin; +use warnings; +use strict; + # check deps BEGIN { - my @_deps = qw( - Moose MooseX::Types MooseX::Types::JSON MooseX::Types::Path::Class - Try::Tiny parent JSON::Any Class::C3::Componentised - namespace::autoclean - ); - - my @_missing_deps; - foreach my $dep (@_deps) { - eval "require $dep"; - if ($@) { - push @_missing_deps, $dep; - } - } - - if (@_missing_deps > 0) { - die "The following dependecies are missing " . join ",", @_missing_deps; - } + require DBIx::Class::Optional::Dependencies; + if (my $missing = DBIx::Class::Optional::Dependencies->req_missing_for ('admin') ) { + die "The following extra modules are required for DBIx::Class::Admin: $missing\n"; + } } +use JSON::Any qw(DWIW PP JSON CPANEL XS); use Moose; -use parent 'DBIx::Class::Schema'; -use Carp::Clan qw/^DBIx::Class/; - use MooseX::Types::Moose qw/Int Str Any Bool/; use DBIx::Class::Admin::Types qw/DBICConnectInfo DBICHashRef/; use MooseX::Types::JSON qw(JSON); use MooseX::Types::Path::Class qw(Dir File); -use Try::Tiny; -use JSON::Any; -use namespace::autoclean; - +use MooseX::Types::LoadableClass qw(LoadableClass); +use namespace::clean; =head1 NAME @@ -40,6 +26,16 @@ DBIx::Class::Admin - Administration object for schemas =head1 SYNOPSIS + $ dbicadmin --help + + $ dbicadmin --schema=MyApp::Schema \ + --connect='["dbi:SQLite:my.db", "", ""]' \ + --deploy + + $ dbicadmin --schema=MyApp::Schema --class=Employee \ + --connect='["dbi:SQLite:my.db", "", ""]' \ + --op=update --set='{ "name": "New_Employee" }' + use DBIx::Class::Admin; # ddl manipulation @@ -61,7 +57,12 @@ DBIx::Class::Admin - Administration object for schemas # install a version for an unversioned schema $admin->install("3.0"); -=head1 Attributes +=head1 REQUIREMENTS + +The Admin interface has additional requirements not currently part of +L. See L for more details. + +=head1 ATTRIBUTES =head2 schema_class @@ -70,8 +71,8 @@ the class of the schema to load =cut has 'schema_class' => ( - is => 'ro', - isa => Str, + is => 'ro', + isa => LoadableClass, ); @@ -82,20 +83,18 @@ A pre-connected schema object can be provided for manipulation =cut has 'schema' => ( - is => 'ro', - isa => 'DBIx::Class::Schema', + is => 'ro', + isa => 'DBIx::Class::Schema', lazy_build => 1, ); sub _build_schema { my ($self) = @_; - $self->ensure_class_loaded($self->schema_class); - $self->connect_info->[3]->{ignore_version} =1; - return $self->schema_class->connect(@{$self->connect_info()} ); # , $self->connect_info->[3], { ignore_version => 1} ); + $self->connect_info->[3]{ignore_version} = 1; + return $self->schema_class->clone->connection(@{$self->connect_info}); } - =head2 resultset a resultset from the schema to operate on @@ -103,8 +102,8 @@ a resultset from the schema to operate on =cut has 'resultset' => ( - is => 'rw', - isa => Str, + is => 'rw', + isa => Str, ); @@ -116,8 +115,8 @@ a hash ref or json string to be used for identifying data to manipulate has 'where' => ( is => 'rw', - isa => DBICHashRef, - coerce => 1, + isa => DBICHashRef, + coerce => 1, ); @@ -129,21 +128,21 @@ a hash ref or json string to be used for inserting or updating data has 'set' => ( is => 'rw', - isa => DBICHashRef, - coerce => 1, + isa => DBICHashRef, + coerce => 1, ); =head2 attrs -a hash ref or json string to be used for passing additonal info to the ->search call +a hash ref or json string to be used for passing additional info to the ->search call =cut has 'attrs' => ( - is => 'rw', - isa => DBICHashRef, - coerce => 1, + is => 'rw', + isa => DBICHashRef, + coerce => 1, ); @@ -154,10 +153,10 @@ connect_info the arguments to provide to the connect call of the schema_class =cut has 'connect_info' => ( - is => 'ro', - isa => DBICConnectInfo, + is => 'ro', + isa => DBICConnectInfo, lazy_build => 1, - coerce => 1, + coerce => 1, ); sub _build_connect_info { @@ -170,46 +169,45 @@ sub _build_connect_info { config_file provide a config_file to read connect_info from, if this is provided config_stanze should also be provided to locate where the connect_info is in the config -The config file should be in a format readable by Config::General +The config file should be in a format readable by Config::Any. =cut has config_file => ( is => 'ro', - isa => File, - coerce => 1, + isa => File, + coerce => 1, ); =head2 config_stanza -config_stanza for use with config_file should be a '::' deliminated 'path' to the connection information +config_stanza for use with config_file should be a '::' delimited 'path' to the connection information designed for use with catalyst config files =cut has 'config_stanza' => ( - is => 'ro', - isa => Str, + is => 'ro', + isa => Str, ); =head2 config -Instead of loading from a file the configuration can be provided directly as a hash ref. Please note +Instead of loading from a file the configuration can be provided directly as a hash ref. Please note config_stanza will still be required. =cut has config => ( - is => 'ro', - isa => DBICHashRef, + is => 'ro', + isa => DBICHashRef, lazy_build => 1, ); sub _build_config { my ($self) = @_; - try { require Config::Any } catch { $self->throw_exception( "Config::Any is required to parse the config file"); }; my $cfg = Config::Any->load_files ( {files => [$self->config_file], use_ext =>1, flatten_to_hash=>1}); @@ -227,11 +225,22 @@ The location where sql ddl files should be created or found for an upgrade. has 'sql_dir' => ( is => 'ro', - isa => Dir, - coerce => 1, + isa => Dir, + coerce => 1, ); +=head2 sql_type + +The type of sql dialect to use for creating sql files from schema + +=cut + +has 'sql_type' => ( + is => 'ro', + isa => Str, +); + =head2 version Used for install, the version which will be 'installed' in the schema @@ -239,20 +248,20 @@ Used for install, the version which will be 'installed' in the schema =cut has version => ( - is => 'rw', - isa => Str, + is => 'rw', + isa => Str, ); =head2 preversion -Previouse version of the schema to create an upgrade diff for, the full sql for that version of the sql must be in the sql_dir +Previous version of the schema to create an upgrade diff for, the full sql for that version of the sql must be in the sql_dir =cut has preversion => ( - is => 'rw', - isa => Str, + is => 'rw', + isa => Str, ); @@ -263,8 +272,8 @@ Try and force certain operations. =cut has force => ( - is => 'rw', - isa => Bool, + is => 'rw', + isa => Bool, ); @@ -275,16 +284,34 @@ Be less verbose about actions =cut has quiet => ( - is => 'rw', - isa => Bool, + is => 'rw', + isa => Bool, ); has '_confirm' => ( - is => 'bare', - isa => Bool, + is => 'bare', + isa => Bool, ); +=head2 trace + +Toggle DBIx::Class debug output + +=cut + +has trace => ( + is => 'rw', + isa => Bool, + trigger => \&_trigger_trace, +); + +sub _trigger_trace { + my ($self, $new, $old) = @_; + $self->schema->storage->debug($new); +} + + =head1 METHODS =head2 create @@ -295,8 +322,9 @@ has '_confirm' => ( =back -L will generate sql for the supplied schema_class in sql_dir. The flavour of sql to -generate can be controlled by suppling a sqlt_type which should be a L name. +C will generate sql for the supplied schema_class in sql_dir. The +flavour of sql to generate can be controlled by supplying a sqlt_type which +should be a L name. Arguments for L can be supplied in the sqlt_args hashref. @@ -308,12 +336,17 @@ sub create { my ($self, $sqlt_type, $sqlt_args, $preversion) = @_; $preversion ||= $self->preversion(); + $sqlt_type ||= $self->sql_type(); my $schema = $self->schema(); - # create the dir if does not exist - $self->sql_dir->mkpath() if ( ! -d $self->sql_dir); - $schema->create_ddl_dir( $sqlt_type, (defined $schema->schema_version ? $schema->schema_version : ""), $self->sql_dir->stringify, $preversion, $sqlt_args ); + $schema->create_ddl_dir( + $sqlt_type, + (defined $schema->schema_version ? $schema->schema_version : ""), + $self->sql_dir, + $preversion, + $sqlt_args, + ); } @@ -333,10 +366,12 @@ B sub upgrade { my ($self) = @_; my $schema = $self->schema(); + if (!$schema->get_db_version()) { # schema is unversioned - $self->throw_exception ("could not determin current schema version, please either install or deploy"); + $schema->throw_exception ("Could not determin current schema version, please either install() or deploy().\n"); } else { + $schema->upgrade_directory ($self->sql_dir) if $self->sql_dir; # this will override whatever default the schema has my $ret = $schema->upgrade(); return $ret; } @@ -351,9 +386,9 @@ sub upgrade { =back -install is here to help when you want to move to L and have an existing -database. install will take a version and add the version tracking tables and 'install' the version. No -further ddl modification takes place. Setting the force attribute to a true value will allow overriding of +install is here to help when you want to move to L and have an existing +database. install will take a version and add the version tracking tables and 'install' the version. No +further ddl modification takes place. Setting the force attribute to a true value will allow overriding of already versioned databases. =cut @@ -365,18 +400,18 @@ sub install { $version ||= $self->version(); if (!$schema->get_db_version() ) { # schema is unversioned - print "Going to install schema version\n"; + print "Going to install schema version\n" if (!$self->quiet); my $ret = $schema->install($version); - print "retun is $ret\n"; + print "return is $ret\n" if (!$self->quiet); } elsif ($schema->get_db_version() and $self->force ) { - carp "Forcing install may not be a good idea"; + warn "Forcing install may not be a good idea\n"; if($self->_confirm() ) { $self->schema->_set_db_version({ version => $version}); } } else { - $self->throw_exception ("schema already has a version not installing, try upgrade instead"); + $schema->throw_exception ("Schema already has a version. Try upgrade instead.\n"); } } @@ -390,7 +425,7 @@ sub install { =back -deploy will create the schema at the connected database. C<$args> are passed straight to +deploy will create the schema at the connected database. C<$args> are passed straight to L. =cut @@ -398,13 +433,7 @@ L. sub deploy { my ($self, $args) = @_; my $schema = $self->schema(); - if (!$schema->get_db_version() ) { - # schema is unversioned - $schema->deploy( $args, $self->sql_dir) - or $self->throw_exception ("could not deploy schema"); - } else { - $self->throw_exception("there already is a database with a version here, try upgrade instead"); - } + $schema->deploy( $args, $self->sql_dir ); } =head2 insert @@ -426,7 +455,7 @@ sub insert { $rs ||= $self->resultset(); $set ||= $self->set(); my $resultset = $self->schema->resultset($rs); - my $obj = $resultset->create( $set ); + my $obj = $resultset->new_result($set)->insert; print ''.ref($resultset).' ID: '.join(',',$obj->id())."\n" if (!$self->quiet); } @@ -451,7 +480,8 @@ sub update { $where ||= $self->where(); $set ||= $self->set(); my $resultset = $self->schema->resultset($rs); - $resultset = $resultset->search( ($where||{}) ); + $resultset = $resultset->search_rs( $where ) + if $where; my $count = $resultset->count(); print "This action will modify $count ".ref($resultset)." records.\n" if (!$self->quiet); @@ -482,7 +512,8 @@ sub delete { $where ||= $self->where(); $attrs ||= $self->attrs(); my $resultset = $self->schema->resultset($rs); - $resultset = $resultset->search( ($where||{}), ($attrs||()) ); + $resultset = $resultset->search_rs( ($where||{}), ($attrs||()) ) + if $where or $attrs; my $count = $resultset->count(); print "This action will delete $count ".ref($resultset)." records.\n" if (!$self->quiet); @@ -501,7 +532,7 @@ sub delete { =back -select takes the name of a resultset from the schema_class, a where hashref and a attrs to pass to ->search. +select takes the name of a resultset from the schema_class, a where hashref and a attrs to pass to ->search. The found data is returned in a array ref where the first row will be the columns list. =cut @@ -513,11 +544,12 @@ sub select { $where ||= $self->where(); $attrs ||= $self->attrs(); my $resultset = $self->schema->resultset($rs); - $resultset = $resultset->search( ($where||{}), ($attrs||()) ); + $resultset = $resultset->search_rs( ($where||{}), ($attrs||()) ) + if $where or $attrs; my @data; my @columns = $resultset->result_source->columns(); - push @data, [@columns];# + push @data, [@columns];# while (my $row = $resultset->next()) { my @fields; @@ -532,12 +564,14 @@ sub select { sub _confirm { my ($self) = @_; - print "Are you sure you want to do this? (type YES to confirm) \n"; + # mainly here for testing return 1 if ($self->meta->get_attribute('_confirm')->get_value($self)); + + print "Are you sure you want to do this? (type YES to confirm) \n"; my $response = ; - return 1 if ($response=~/^YES/); - return; + + return ($response=~/^YES/); } sub _find_stanza { @@ -548,19 +582,23 @@ sub _find_stanza { $cfg = $cfg->{$path}; } else { - $self->throw_exception("could not find $stanza in config, $path did not seem to exist"); + die ("Could not find $stanza in config, $path does not seem to exist.\n"); } } + $cfg = $cfg->{connect_info} if exists $cfg->{connect_info}; return $cfg; } -=head1 AUTHORS +=head1 FURTHER QUESTIONS? -See L. +Check the list of L. -=head1 LICENSE +=head1 COPYRIGHT AND LICENSE -You may distribute this code under the same terms as Perl itself +This module is free software L +by the L. You can +redistribute it and/or modify it under the same terms as the +L. =cut