1 package DBIx::Class::Admin;
5 use Carp::Clan qw/^DBIx::Class/;
7 croak('The following modules are required for DBIx::Class::Admin ' . DBIx::Class::Optional::Dependencies->req_missing_for ('admin') )
8 unless DBIx::Class::Optional::Dependencies->req_ok_for ('admin');
12 use MooseX::Types::Moose qw/Int Str Any Bool/;
13 use DBIx::Class::Admin::Types qw/DBICConnectInfo DBICHashRef/;
14 use MooseX::Types::JSON qw(JSON);
15 use MooseX::Types::Path::Class qw(Dir File);
17 use JSON::Any qw(DWIW XS JSON);
18 use namespace::autoclean;
22 DBIx::Class::Admin - Administration object for schemas
28 $ dbicadmin --schema=MyApp::Schema \
29 --connect='["dbi:SQLite:my.db", "", ""]' \
32 $ dbicadmin --schema=MyApp::Schema --class=Employee \
33 --connect='["dbi:SQLite:my.db", "", ""]' \
34 --op=update --set='{ "name": "New_Employee" }'
36 use DBIx::Class::Admin;
39 my $admin = DBIx::Class::Admin->new(
40 schema_class=> 'MY::Schema',
42 connect_info => { dsn => $dsn, user => $user, password => $pass },
46 $admin->create('SQLite');
48 # create SQL diff for an upgrade
49 $admin->create('SQLite', {} , "1.0");
54 # install a version for an unversioned schema
55 $admin->install("3.0");
59 The Admin interface has additional requirements not currently part of
60 L<DBIx::Class>. See L<DBIx::Class::Optional::Dependencies> for more details.
66 the class of the schema to load
70 has 'schema_class' => (
78 A pre-connected schema object can be provided for manipulation
84 isa => 'DBIx::Class::Schema',
92 my @include_dirs = @{$self->include_dirs};
93 $self->_debug("Adding to \@INC:\n".join "\n",@include_dirs)
95 local @INC = (@include_dirs, @INC);
96 Class::MOP::load_class($self->schema_class);
98 $self->connect_info->[3]->{ignore_version} =1;
99 return $self->schema_class->connect(@{$self->connect_info()} ); # , $self->connect_info->[3], { ignore_version => 1} );
104 Extra include directories to look when loading C<schema_class>
108 has 'include_dirs' => (
116 a resultset from the schema to operate on
128 a hash ref or json string to be used for identifying data to manipulate
141 a hash ref or json string to be used for inserting or updating data
154 a hash ref or json string to be used for passing additonal info to the ->search call
167 connect_info the arguments to provide to the connect call of the schema_class
171 has 'connect_info' => (
173 isa => DBICConnectInfo,
178 sub _build_connect_info {
180 return $self->_find_stanza($self->config, $self->config_stanza);
186 config_file provide a config_file to read connect_info from, if this is provided
187 config_stanze should also be provided to locate where the connect_info is in the config
188 The config file should be in a format readable by Config::General
201 config_stanza for use with config_file should be a '::' deliminated 'path' to the connection information
202 designed for use with catalyst config files
206 has 'config_stanza' => (
214 Instead of loading from a file the configuration can be provided directly as a hash ref. Please note
215 config_stanza will still be required.
228 try { require Config::Any }
229 catch { die ("Config::Any is required to parse the config file.\n") };
231 my $cfg = Config::Any->load_files ( {files => [$self->config_file], use_ext =>1, flatten_to_hash=>1});
233 # just grab the config from the config file
234 $cfg = $cfg->{$self->config_file};
241 The location where sql ddl files should be created or found for an upgrade.
254 Used for install, the version which will be 'installed' in the schema
266 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
278 Try and force certain operations.
290 Be less verbose about actions
301 Print debug information
311 sub _debug { shift; print @_ }
325 =item Arguments: $sqlt_type, \%sqlt_args, $preversion
329 L<create> will generate sql for the supplied schema_class in sql_dir. The flavour of sql to
330 generate can be controlled by suppling a sqlt_type which should be a L<SQL::Translator> name.
332 Arguments for L<SQL::Translator> can be supplied in the sqlt_args hashref.
334 Optional preversion can be supplied to generate a diff to be used by upgrade.
339 my ($self, $sqlt_type, $sqlt_args, $preversion) = @_;
341 $preversion ||= $self->preversion();
343 my $schema = $self->schema();
344 # create the dir if does not exist
345 $self->sql_dir->mkpath() if ( ! -d $self->sql_dir);
347 $schema->create_ddl_dir( $sqlt_type, (defined $schema->schema_version ? $schema->schema_version : ""), $self->sql_dir->stringify, $preversion, $sqlt_args );
355 =item Arguments: <none>
359 upgrade will attempt to upgrade the connected database to the same version as the schema_class.
360 B<MAKE SURE YOU BACKUP YOUR DB FIRST>
366 my $schema = $self->schema();
367 if (!$schema->get_db_version()) {
368 # schema is unversioned
369 $schema->throw_exception ("Could not determin current schema version, please either install() or deploy().\n");
371 my $ret = $schema->upgrade();
381 =item Arguments: $version
385 install is here to help when you want to move to L<DBIx::Class::Schema::Versioned> and have an existing
386 database. install will take a version and add the version tracking tables and 'install' the version. No
387 further ddl modification takes place. Setting the force attribute to a true value will allow overriding of
388 already versioned databases.
393 my ($self, $version) = @_;
395 my $schema = $self->schema();
396 $version ||= $self->version();
397 if (!$schema->get_db_version() ) {
398 # schema is unversioned
399 print "Going to install schema version\n";
400 my $ret = $schema->install($version);
401 print "retun is $ret\n";
403 elsif ($schema->get_db_version() and $self->force ) {
404 carp "Forcing install may not be a good idea";
405 if($self->_confirm() ) {
406 $self->schema->_set_db_version({ version => $version});
410 $schema->throw_exception ("Schema already has a version. Try upgrade instead.\n");
420 =item Arguments: $args
424 deploy will create the schema at the connected database. C<$args> are passed straight to
425 L<DBIx::Class::Schema/deploy>.
430 my ($self, $args) = @_;
431 my $schema = $self->schema();
432 $schema->deploy( $args, $self->sql_dir );
439 =item Arguments: $rs, $set
443 insert takes the name of a resultset from the schema_class and a hashref of data to insert
449 my ($self, $rs, $set) = @_;
451 $rs ||= $self->resultset();
452 $set ||= $self->set();
453 my $resultset = $self->schema->resultset($rs);
454 my $obj = $resultset->create( $set );
455 print ''.ref($resultset).' ID: '.join(',',$obj->id())."\n" if (!$self->quiet);
463 =item Arguments: $rs, $set, $where
467 update takes the name of a resultset from the schema_class, a hashref of data to update and
468 a where hash used to form the search for the rows to update.
473 my ($self, $rs, $set, $where) = @_;
475 $rs ||= $self->resultset();
476 $where ||= $self->where();
477 $set ||= $self->set();
478 my $resultset = $self->schema->resultset($rs);
479 $resultset = $resultset->search( ($where||{}) );
481 my $count = $resultset->count();
482 print "This action will modify $count ".ref($resultset)." records.\n" if (!$self->quiet);
484 if ( $self->force || $self->_confirm() ) {
485 $resultset->update_all( $set );
494 =item Arguments: $rs, $where, $attrs
498 delete takes the name of a resultset from the schema_class, a where hashref and a attrs to pass to ->search.
499 The found data is deleted and cannot be recovered.
504 my ($self, $rs, $where, $attrs) = @_;
506 $rs ||= $self->resultset();
507 $where ||= $self->where();
508 $attrs ||= $self->attrs();
509 my $resultset = $self->schema->resultset($rs);
510 $resultset = $resultset->search( ($where||{}), ($attrs||()) );
512 my $count = $resultset->count();
513 print "This action will delete $count ".ref($resultset)." records.\n" if (!$self->quiet);
515 if ( $self->force || $self->_confirm() ) {
516 $resultset->delete_all();
525 =item Arguments: $rs, $where, $attrs
529 select takes the name of a resultset from the schema_class, a where hashref and a attrs to pass to ->search.
530 The found data is returned in a array ref where the first row will be the columns list.
535 my ($self, $rs, $where, $attrs) = @_;
537 $rs ||= $self->resultset();
538 $where ||= $self->where();
539 $attrs ||= $self->attrs();
540 my $resultset = $self->schema->resultset($rs);
541 $resultset = $resultset->search( ($where||{}), ($attrs||()) );
544 my @columns = $resultset->result_source->columns();
545 push @data, [@columns];#
547 while (my $row = $resultset->next()) {
549 foreach my $column (@columns) {
550 push( @fields, $row->get_column($column) );
552 push @data, [@fields];
560 print "Are you sure you want to do this? (type YES to confirm) \n";
561 # mainly here for testing
562 return 1 if ($self->meta->get_attribute('_confirm')->get_value($self));
563 my $response = <STDIN>;
564 return 1 if ($response=~/^YES/);
569 my ($self, $cfg, $stanza) = @_;
570 my @path = split /::/, $stanza;
571 while (my $path = shift @path) {
572 if (exists $cfg->{$path}) {
573 $cfg = $cfg->{$path};
576 die ("Could not find $stanza in config, $path does not seem to exist.\n");
584 See L<DBIx::Class/CONTRIBUTORS>.
588 You may distribute this code under the same terms as Perl itself