lib/DBIx/Class/Admin.pm

   1 #
   2 #===============================================================================
   3 #
   4 #         FILE:  Admin.pm
   5 #
   6 #  DESCRIPTION:  Administrative functions for DBIx::Class Schemata
   7 #
   8 #        FILES:  ---
   9 #         BUGS:  ---
  10 #        NOTES:  ---
  11 #       AUTHOR:  Gordon Irving (), <Gordon.irving@sophos.com>
  12 #      VERSION:  1.0
  13 #      CREATED:  28/11/09 12:27:15 GMT
  14 #     REVISION:  ---
  15 #===============================================================================
  16
  17 package DBIx::Class::Admin;
  18
  19 use Moose;
  20 use MooseX::Types
  21         -declare => [qw( DBICConnectInfo )];
  22 use MooseX::Types::Moose qw/Int HashRef ArrayRef Str Any/;
  23 use MooseX::Types::JSON qw(JSON);
  24 use MooseX::Types::Path::Class qw(Dir File);
  25 use Try::Tiny;
  26 use parent 'Class::C3::Componentised';
  27
  28 use Data::Dumper;
  29 use JSON::Any;
  30
  31
  32 coerce ArrayRef,
  33         from JSON,
  34         via { _json_to_data ($_) };
  35
  36 coerce HashRef,
  37         from JSON,
  38         via { _json_to_data($_) };
  39
  40 subtype DBICConnectInfo,
  41         as ArrayRef;
  42
  43 coerce DBICConnectInfo,
  44         from JSON,
  45          via { return _json_to_data($_) } ;
  46
  47 coerce DBICConnectInfo,
  48         from Str,
  49                 via { return _json_to_data($_) };
  50
  51 coerce DBICConnectInfo,
  52         from HashRef,
  53          via { [ $_->{dsn}, $_->{user}, $_->{password} ]  };
  54
  55 =head1 NAME
  56
  57 DBIx::Class::Admin - Administration object for schemas
  58
  59 =head1 SYNOPSIS
  60
  61         use DBIx::Class::Admin;
  62
  63         # ddl manipulation
  64         my $admin = DBIx::Class::Admin->new(
  65                 schema_class=> 'MY::Schema',
  66                 sql_dir=> $sql_dir,
  67                 connect_info => { dsn => $dsn, user => $user, password => $pass },
  68         );
  69
  70         # create SQLite sql
  71         $admin->create('SQLite');
  72
  73         # create SQL diff for an upgrade
  74         $admin->create('SQLite', {} , "1.0");
  75
  76         # upgrade a database
  77         $admin->upgrade();
  78
  79         # install a version for an unversioned schema
  80         $admin->install("3.0");
  81
  82 =head1 Attributes
  83
  84 =head2 lib
  85
  86 add a library search path
  87 =cut
  88 has lib => (
  89         is              => 'ro',
  90         isa             => Dir,
  91         coerce  => 1,
  92         trigger => \&_set_inc,
  93 );
  94
  95 sub _set_inc {
  96         my ($self, $lib) = @_;
  97         push @INC, $lib->stringify;
  98 }
  99
 100 =head2 schema_class
 101
 102 the class of the schema to load
 103 =cut
 104 has 'schema_class' => (
 105         is              => 'ro',
 106         isa             => 'Str',
 107         coerce  => 1,
 108 );
 109
 110 =head2 schema
 111
 112 A pre-connected schema object can be provided for manipulation
 113 =cut
 114 has 'schema' => (
 115         is                      => 'ro',
 116         isa                     => 'DBIx::Class::Schema',
 117         lazy_build      => 1,
 118 );
 119
 120 sub _build_schema {
 121         my ($self)  = @_;
 122         $self->ensure_class_loaded($self->schema_class);
 123
 124         $self->connect_info->[3]->{ignore_version} =1;
 125         return $self->schema_class->connect(@{$self->connect_info()} ); # ,  $self->connect_info->[3], { ignore_version => 1} );
 126 }
 127
 128 =head2 resultset
 129
 130 a resultset from the schema to operate on
 131 =cut
 132 has 'resultset' => (
 133         is                      => 'rw',
 134         isa                     => Str,
 135 );
 136
 137 =head2 where
 138
 139 a hash ref or json string to be used for identifying data to manipulate
 140 =cut
 141
 142 has 'where' => (
 143         is                      => 'rw',
 144         isa                     => HashRef,
 145         coerce          => 1,
 146 );
 147
 148 =head2 set
 149 a hash ref or json string to be used for inserting or updating data
 150 =cut
 151
 152 has 'set' => (
 153         is                      => 'rw',
 154         isa                     => HashRef,
 155         coerce          => 1,
 156 );
 157
 158 =head2 attrs
 159 a hash ref or json string to be used for passing additonal info to the ->search call
 160 =cut
 161 has 'attrs' => (
 162         is                      => 'rw',
 163         isa                     => HashRef,
 164         coerce          => 1,
 165 );
 166 =head2 connect_info
 167
 168 connect_info the arguments to provide to the connect call of the schema_class
 169 =cut
 170
 171
 172 has 'connect_info' => (
 173         is                      => 'ro',
 174         isa                     => DBICConnectInfo,
 175         lazy_build      => 1,
 176         coerce          => 1,
 177 );
 178
 179 sub _build_connect_info {
 180         my ($self) = @_;
 181         return $self->_find_stanza($self->config, $self->config_stanza);
 182 }
 183
 184 =head2 config_file
 185
 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
 189 =cut
 190 has config_file => (
 191         is                      => 'ro',
 192         isa                     => File,
 193         coerce          => 1,
 194 );
 195
 196 =head2 config_stanza
 197
 198 config_stanza for use with config_file should be a '::' deliminated 'path' to the connection information
 199 designed for use with catalyst config files
 200 =cut
 201 has 'config_stanza' => (
 202         is                      => 'ro',
 203         isa                     => 'Str',
 204 );
 205
 206 =head2 config
 207
 208 Instead of loading from a file the configuration can be provided directly as a hash ref.  Please note
 209 config_stanza will still be required.
 210 =cut
 211 has config => (
 212         is                      => 'ro',
 213         isa                     => HashRef,
 214         lazy_build      => 1,
 215 );
 216
 217 sub _build_config {
 218         my ($self) = @_;
 219         try { require 'Config::Any'; } catch { die "Config::Any is required to parse the config file"; };
 220
 221         my $cfg = Config::Any->load_files ( {files => [$self->config_file], use_ext =>1, flatten_to_hash=>1});
 222
 223         # just grab the config from the config file
 224         $cfg = $cfg->{$self->config_file};
 225         return $cfg;
 226 }
 227
 228 =head2 sql_dir
 229
 230 The location where sql ddl files should be created or found for an upgrade.
 231 =cut
 232 has 'sql_dir' => (
 233         is                      => 'ro',
 234         isa                     => Dir,
 235         coerce          => 1,
 236 );
 237
 238 =head2 version
 239
 240 Used for install, the version which will be 'installed' in the schema
 241 =cut
 242 has version => (
 243         is                      => 'rw',
 244         isa                     => 'Str',
 245 );
 246
 247 =head2 preversion
 248
 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
 250 =cut
 251 has preversion => (
 252         is                      => 'rw',
 253         isa                     => 'Str',
 254 );
 255
 256 =head2 force
 257
 258 Try and force certain operations.
 259 =cut
 260 has force => (
 261         is                      => 'rw',
 262         isa                     => 'Bool',
 263 );
 264
 265 =head2 quiet
 266
 267 Be less verbose about actions
 268 =cut
 269 has quiet => (
 270         is                      => 'rw',
 271         isa                     => 'Bool',
 272 );
 273
 274 has '_confirm' => (
 275         is              => 'bare',
 276         isa             => 'Bool',
 277 );
 278
 279 =head1 METHODS
 280
 281 =head2 create
 282
 283 =over 4
 284
 285 =item Arguments: $sqlt_type, \%sqlt_args, $preversion
 286
 287 =back
 288
 289 L<create> will generate sql for the supplied schema_class in sql_dir.  The flavour of sql to
 290 generate can be controlled by suppling a sqlt_type which should be a L<SQL::Translator> name.
 291
 292 Arguments for L<SQL::Translator> can be supplied in the sqlt_args hashref.
 293
 294 Optional preversion can be supplied to generate a diff to be used by upgrade.
 295 =cut
 296
 297 sub create {
 298         my ($self, $sqlt_type, $sqlt_args, $preversion) = @_;
 299
 300         $preversion ||= $self->preversion();
 301
 302         my $schema = $self->schema();
 303         # create the dir if does not exist
 304         $self->sql_dir->mkpath() if ( ! -d $self->sql_dir);
 305
 306         $schema->create_ddl_dir( $sqlt_type, (defined $schema->schema_version ? $schema->schema_version : ""), $self->sql_dir->stringify, $preversion, $sqlt_args );
 307 }
 308
 309 =head2 upgrade
 310
 311 =over 4
 312
 313 =item Arguments: <none>
 314
 315 =back
 316
 317 upgrade will attempt to upgrade the connected database to the same version as the schema_class.
 318 B<MAKE SURE YOU BACKUP YOUR DB FIRST>
 319 =cut
 320
 321 sub upgrade {
 322         my ($self) = @_;
 323         my $schema = $self->schema();
 324         if (!$schema->get_db_version()) {
 325                 # schema is unversioned
 326                 die "could not determin current schema version, please either install or deploy";
 327         } else {
 328                 my $ret = $schema->upgrade();
 329                 return $ret;
 330         }
 331 }
 332
 333 =head2 install
 334
 335 =over 4
 336
 337 =item Arguments: $version
 338
 339 =back
 340
 341 install is here to help when you want to move to L<DBIx::Class::Schema::Versioned> and have an existing
 342 database.  install will take a version and add the version tracking tables and 'install' the version.  No
 343 further ddl modification takes place.  Setting the force attribute to a true value will allow overriding of
 344 already versioned databases.
 345 =cut
 346 sub install {
 347         my ($self, $version) = @_;
 348
 349         my $schema = $self->schema();
 350         $version ||= $self->version();
 351         if (!$schema->get_db_version() ) {
 352                 # schema is unversioned
 353                 print "Going to install schema version\n";
 354                 my $ret = $schema->install($version);
 355                 print "retun is $ret\n";
 356         }
 357         elsif ($schema->get_db_version() and $self->force ) {
 358                 warn "forcing install may not be a good idea";
 359                 if($self->_confirm() ) {
 360                         # FIXME private api
 361                         $self->schema->_set_db_version({ version => $version});
 362                 }
 363         }
 364         else {
 365                 die "schema already has a version not installing, try upgrade instead";
 366         }
 367
 368 }
 369
 370 =head2 deploy
 371
 372 =over 4
 373
 374 =item Arguments: $args
 375
 376 =back
 377
 378 deploy will create the schema at the connected database.  C<$args> are passed straight to
 379 L<DBIx::Class::Schema/deploy>.
 380 =cut
 381 sub deploy {
 382         my ($self, $args) = @_;
 383         my $schema = $self->schema();
 384         if (!$schema->get_db_version() ) {
 385                 # schema is unversioned
 386                 $schema->deploy( $args, $self->sql_dir)
 387                         or die "could not deploy schema";
 388         } else {
 389                 die "there already is a database with a version here, try upgrade instead";
 390         }
 391 }
 392
 393
 394 # FIXME ensure option spec compatability
 395 #die('Do not use the where option with the insert op') if ($where);
 396 #die('Do not use the attrs option with the insert op') if ($attrs);
 397
 398 =head2 insert
 399
 400 =over 4
 401
 402 =item Arguments: $rs, $set
 403
 404 =back
 405
 406 insert takes the name of a resultset from the schema_class and a hashref of data to insert
 407 into that resultset
 408
 409 =cut
 410 sub insert {
 411         my ($self, $rs, $set) = @_;
 412
 413         $rs ||= $self->resultset();
 414         $set ||= $self->set();
 415         my $resultset = $self->schema->resultset($rs);
 416         my $obj = $resultset->create( $set );
 417         print ''.ref($resultset).' ID: '.join(',',$obj->id())."\n" if (!$self->quiet);
 418 }
 419
 420
 421 =head2 update
 422
 423 =over 4
 424
 425 =item Arguments: $rs, $set, $where
 426
 427 =back
 428
 429 update takes the name of a resultset from the schema_class, a hashref of data to update and
 430 a where hash used to form the search for the rows to update.
 431 =cut
 432 sub update {
 433         my ($self, $rs, $set, $where) = @_;
 434
 435         $rs ||= $self->resultset();
 436         $where ||= $self->where();
 437         $set ||= $self->set();
 438         my $resultset = $self->schema->resultset($rs);
 439         $resultset = $resultset->search( ($where||{}) );
 440
 441         my $count = $resultset->count();
 442         print "This action will modify $count ".ref($resultset)." records.\n" if (!$self->quiet);
 443
 444         if ( $self->force || $self->_confirm() ) {
 445                 $resultset->update_all( $set );
 446         }
 447 }
 448
 449 # FIXME
 450 #die('Do not use the set option with the delete op') if ($set);
 451 =head2 delete
 452
 453 =over 4
 454
 455 =item Arguments: $rs, $where, $attrs
 456
 457 =back
 458
 459 delete takes the name of a resultset from the schema_class, a where hashref and a attrs to pass to ->search.
 460 The found data is deleted and cannot be recovered.
 461 =cut
 462 sub delete {
 463         my ($self, $rs, $where, $attrs) = @_;
 464
 465         $rs ||= $self->resultset();
 466         $where ||= $self->where();
 467         $attrs ||= $self->attrs();
 468         my $resultset = $self->schema->resultset($rs);
 469         $resultset = $resultset->search( ($where||{}), ($attrs||()) );
 470
 471         my $count = $resultset->count();
 472         print "This action will delete $count ".ref($resultset)." records.\n" if (!$self->quiet);
 473
 474         if ( $self->force || $self->_confirm() ) {
 475                 $resultset->delete_all();
 476         }
 477 }
 478
 479 =head2 select
 480
 481 =over 4
 482
 483 =item Arguments: $rs, $where, $attrs
 484
 485 =back
 486
 487 select takes the name of a resultset from the schema_class, a where hashref and a attrs to pass to ->search.
 488 The found data is returned in a array ref where the first row will be the columns list.
 489
 490 =cut
 491 sub select {
 492         my ($self, $rs, $where, $attrs) = @_;
 493
 494         $rs ||= $self->resultset();
 495         $where ||= $self->where();
 496         $attrs ||= $self->attrs();
 497         my $resultset = $self->schema->resultset($rs);
 498         $resultset = $resultset->search( ($where||{}), ($attrs||()) );
 499
 500         my @data;
 501         my @columns = $resultset->result_source->columns();
 502         push @data, [@columns];#
 503
 504         while (my $row = $resultset->next()) {
 505                 my @fields;
 506                 foreach my $column (@columns) {
 507                         push( @fields, $row->get_column($column) );
 508                 }
 509                 push @data, [@fields];
 510         }
 511
 512         return \@data;
 513 }
 514
 515 sub _confirm {
 516         my ($self) = @_;
 517         print "Are you sure you want to do this? (type YES to confirm) \n";
 518         # mainly here for testing
 519         return 1 if ($self->meta->get_attribute('_confirm')->get_value($self));
 520         my $response = <STDIN>;
 521         return 1 if ($response=~/^YES/);
 522         return;
 523 }
 524
 525 sub _find_stanza {
 526         my ($self, $cfg, $stanza) = @_;
 527         my @path = split /::/, $stanza;
 528         while (my $path = shift @path) {
 529                 if (exists $cfg->{$path}) {
 530                         $cfg = $cfg->{$path};
 531                 }
 532                 else {
 533                         die "could not find $stanza in config, $path did not seem to exist";
 534                 }
 535         }
 536         return $cfg;
 537 }
 538
 539 sub _json_to_data {
 540         my ($json_str) = @_;
 541         my $json = JSON::Any->new(allow_barekey => 1, allow_singlequote => 1, relaxed=>1);
 542         my $ret = $json->jsonToObj($json_str);
 543         return $ret;
 544 }
 545
 546 =head1 AUTHOR
 547
 548 Gordon Irving <goraxe@cpan.org>
 549
 550 with code taken from dbicadmin by
 551 Aran Deltac <bluefeet@cpan.org>
 552
 553
 554 =head1 LICENSE
 555
 556 You may distribute this code under the same terms as Perl itself.
 557 =cut
 558 1;