1 package DBIx::Class::Admin;
6 Moose MooseX::Types MooseX::Types::JSON MooseX::Types::Path::Class
7 Try::Tiny parent JSON::Any Class::C3::Componentised
12 foreach my $dep (@_deps) {
15 push @_missing_deps, $dep;
19 if (@_missing_deps > 0) {
20 die "The following dependecies are missing " . join ",", @_missing_deps;
25 use parent 'DBIx::Class::Schema';
26 use Carp::Clan qw/^DBIx::Class/;
28 use MooseX::Types::Moose qw/Int Str Any Bool/;
29 use DBIx::Class::Admin::Types qw/DBICConnectInfo DBICHashRef/;
30 use MooseX::Types::JSON qw(JSON);
31 use MooseX::Types::Path::Class qw(Dir File);
34 use namespace::autoclean;
39 DBIx::Class::Admin - Administration object for schemas
43 use DBIx::Class::Admin;
46 my $admin = DBIx::Class::Admin->new(
47 schema_class=> 'MY::Schema',
49 connect_info => { dsn => $dsn, user => $user, password => $pass },
53 $admin->create('SQLite');
55 # create SQL diff for an upgrade
56 $admin->create('SQLite', {} , "1.0");
61 # install a version for an unversioned schema
62 $admin->install("3.0");
68 the class of the schema to load
72 has 'schema_class' => (
80 A pre-connected schema object can be provided for manipulation
86 isa => 'DBIx::Class::Schema',
92 $self->ensure_class_loaded($self->schema_class);
94 $self->connect_info->[3]->{ignore_version} =1;
95 return $self->schema_class->connect(@{$self->connect_info()} ); # , $self->connect_info->[3], { ignore_version => 1} );
101 a resultset from the schema to operate on
113 a hash ref or json string to be used for identifying data to manipulate
126 a hash ref or json string to be used for inserting or updating data
139 a hash ref or json string to be used for passing additonal info to the ->search call
152 connect_info the arguments to provide to the connect call of the schema_class
156 has 'connect_info' => (
158 isa => DBICConnectInfo,
163 sub _build_connect_info {
165 return $self->_find_stanza($self->config, $self->config_stanza);
171 config_file provide a config_file to read connect_info from, if this is provided
172 config_stanze should also be provided to locate where the connect_info is in the config
173 The config file should be in a format readable by Config::General
186 config_stanza for use with config_file should be a '::' deliminated 'path' to the connection information
187 designed for use with catalyst config files
191 has 'config_stanza' => (
199 Instead of loading from a file the configuration can be provided directly as a hash ref. Please note
200 config_stanza will still be required.
212 try { require Config::Any } catch { $self->throw_exception( "Config::Any is required to parse the config file"); };
214 my $cfg = Config::Any->load_files ( {files => [$self->config_file], use_ext =>1, flatten_to_hash=>1});
216 # just grab the config from the config file
217 $cfg = $cfg->{$self->config_file};
224 The location where sql ddl files should be created or found for an upgrade.
237 Used for install, the version which will be 'installed' in the schema
249 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
261 Try and force certain operations.
273 Be less verbose about actions
294 =item Arguments: $sqlt_type, \%sqlt_args, $preversion
298 L<create> will generate sql for the supplied schema_class in sql_dir. The flavour of sql to
299 generate can be controlled by suppling a sqlt_type which should be a L<SQL::Translator> name.
301 Arguments for L<SQL::Translator> can be supplied in the sqlt_args hashref.
303 Optional preversion can be supplied to generate a diff to be used by upgrade.
308 my ($self, $sqlt_type, $sqlt_args, $preversion) = @_;
310 $preversion ||= $self->preversion();
312 my $schema = $self->schema();
313 # create the dir if does not exist
314 $self->sql_dir->mkpath() if ( ! -d $self->sql_dir);
316 $schema->create_ddl_dir( $sqlt_type, (defined $schema->schema_version ? $schema->schema_version : ""), $self->sql_dir->stringify, $preversion, $sqlt_args );
324 =item Arguments: <none>
328 upgrade will attempt to upgrade the connected database to the same version as the schema_class.
329 B<MAKE SURE YOU BACKUP YOUR DB FIRST>
335 my $schema = $self->schema();
336 if (!$schema->get_db_version()) {
337 # schema is unversioned
338 $self->throw_exception ("could not determin current schema version, please either install or deploy");
340 my $ret = $schema->upgrade();
350 =item Arguments: $version
354 install is here to help when you want to move to L<DBIx::Class::Schema::Versioned> and have an existing
355 database. install will take a version and add the version tracking tables and 'install' the version. No
356 further ddl modification takes place. Setting the force attribute to a true value will allow overriding of
357 already versioned databases.
362 my ($self, $version) = @_;
364 my $schema = $self->schema();
365 $version ||= $self->version();
366 if (!$schema->get_db_version() ) {
367 # schema is unversioned
368 print "Going to install schema version\n";
369 my $ret = $schema->install($version);
370 print "retun is $ret\n";
372 elsif ($schema->get_db_version() and $self->force ) {
373 carp "Forcing install may not be a good idea";
374 if($self->_confirm() ) {
375 $self->schema->_set_db_version({ version => $version});
379 $self->throw_exception ("schema already has a version not installing, try upgrade instead");
389 =item Arguments: $args
393 deploy will create the schema at the connected database. C<$args> are passed straight to
394 L<DBIx::Class::Schema/deploy>.
399 my ($self, $args) = @_;
400 my $schema = $self->schema();
401 if (!$schema->get_db_version() ) {
402 # schema is unversioned
403 $schema->deploy( $args, $self->sql_dir)
404 or $self->throw_exception ("could not deploy schema");
406 $self->throw_exception("there already is a database with a version here, try upgrade instead");
414 =item Arguments: $rs, $set
418 insert takes the name of a resultset from the schema_class and a hashref of data to insert
424 my ($self, $rs, $set) = @_;
426 $rs ||= $self->resultset();
427 $set ||= $self->set();
428 my $resultset = $self->schema->resultset($rs);
429 my $obj = $resultset->create( $set );
430 print ''.ref($resultset).' ID: '.join(',',$obj->id())."\n" if (!$self->quiet);
438 =item Arguments: $rs, $set, $where
442 update takes the name of a resultset from the schema_class, a hashref of data to update and
443 a where hash used to form the search for the rows to update.
448 my ($self, $rs, $set, $where) = @_;
450 $rs ||= $self->resultset();
451 $where ||= $self->where();
452 $set ||= $self->set();
453 my $resultset = $self->schema->resultset($rs);
454 $resultset = $resultset->search( ($where||{}) );
456 my $count = $resultset->count();
457 print "This action will modify $count ".ref($resultset)." records.\n" if (!$self->quiet);
459 if ( $self->force || $self->_confirm() ) {
460 $resultset->update_all( $set );
469 =item Arguments: $rs, $where, $attrs
473 delete takes the name of a resultset from the schema_class, a where hashref and a attrs to pass to ->search.
474 The found data is deleted and cannot be recovered.
479 my ($self, $rs, $where, $attrs) = @_;
481 $rs ||= $self->resultset();
482 $where ||= $self->where();
483 $attrs ||= $self->attrs();
484 my $resultset = $self->schema->resultset($rs);
485 $resultset = $resultset->search( ($where||{}), ($attrs||()) );
487 my $count = $resultset->count();
488 print "This action will delete $count ".ref($resultset)." records.\n" if (!$self->quiet);
490 if ( $self->force || $self->_confirm() ) {
491 $resultset->delete_all();
500 =item Arguments: $rs, $where, $attrs
504 select takes the name of a resultset from the schema_class, a where hashref and a attrs to pass to ->search.
505 The found data is returned in a array ref where the first row will be the columns list.
510 my ($self, $rs, $where, $attrs) = @_;
512 $rs ||= $self->resultset();
513 $where ||= $self->where();
514 $attrs ||= $self->attrs();
515 my $resultset = $self->schema->resultset($rs);
516 $resultset = $resultset->search( ($where||{}), ($attrs||()) );
519 my @columns = $resultset->result_source->columns();
520 push @data, [@columns];#
522 while (my $row = $resultset->next()) {
524 foreach my $column (@columns) {
525 push( @fields, $row->get_column($column) );
527 push @data, [@fields];
535 print "Are you sure you want to do this? (type YES to confirm) \n";
536 # mainly here for testing
537 return 1 if ($self->meta->get_attribute('_confirm')->get_value($self));
538 my $response = <STDIN>;
539 return 1 if ($response=~/^YES/);
544 my ($self, $cfg, $stanza) = @_;
545 my @path = split /::/, $stanza;
546 while (my $path = shift @path) {
547 if (exists $cfg->{$path}) {
548 $cfg = $cfg->{$path};
551 $self->throw_exception("could not find $stanza in config, $path did not seem to exist");
559 See L<DBIx::Class/CONTRIBUTORS>.
563 You may distribute this code under the same terms as Perl itself