lib/DBIx/Class/Schema.pm

   1 package DBIx::Class::Schema;
   2
   3 use strict;
   4 use warnings;
   5
   6 use Carp::Clan qw/^DBIx::Class/;
   7
   8 use base qw/DBIx::Class/;
   9
  10 __PACKAGE__->mk_classdata('class_mappings' => {});
  11 __PACKAGE__->mk_classdata('source_registrations' => {});
  12 __PACKAGE__->mk_classdata('storage_type' => '::DBI');
  13 __PACKAGE__->mk_classdata('storage');
  14
  15 =head1 NAME
  16
  17 DBIx::Class::Schema - composable schemas
  18
  19 =head1 SYNOPSIS
  20
  21   package My::Schema;
  22   use base qw/DBIx::Class::Schema/;
  23
  24   # load My::Schema::Foo, My::Schema::Bar, My::Schema::Baz
  25   __PACKAGE__->load_classes(qw/Foo Bar Baz/);
  26
  27   package My::Schema::Foo;
  28   use base qw/DBIx::Class/;
  29   __PACKAGE__->load_components(qw/PK::Auto::Pg Core/); # for example
  30   __PACKAGE__->table('foo');
  31
  32   # Elsewhere in your code:
  33   my $schema1 = My::Schema->connect(
  34     $dsn,
  35     $user,
  36     $password,
  37     $attrs
  38   );
  39
  40   my $schema2 = My::Schema->connect( ... );
  41
  42   # fetch objects using My::Schema::Foo
  43   my $resultset = $schema1->resultset('Foo')->search( ... );
  44   my @objects = $schema2->resultset('Foo')->search( ... );
  45
  46 =head1 DESCRIPTION
  47
  48 Creates database classes based on a schema. This is the recommended way to
  49 use L<DBIx::Class> and allows you to use more than one concurrent connection
  50 with your classes.
  51
  52 NB: If you're used to L<Class::DBI> it's worth reading the L</SYNOPSIS>
  53 carefully as DBIx::Class does things a little differently. Note in
  54 particular which module inherits off which.
  55
  56 =head1 METHODS
  57
  58 =head2 register_class
  59
  60 =head3 Arguments: <moniker> <component_class>
  61
  62 Registers a class which isa ResultSourceProxy; equivalent to calling
  63
  64   $schema->register_source($moniker, $class->result_source_instance);
  65
  66 =cut
  67
  68 sub register_class {
  69   my ($self, $moniker, $to_register) = @_;
  70   $self->register_source($moniker => $to_register->result_source_instance);
  71 }
  72
  73 =head2 register_source
  74
  75 =head3 Arguments: <moniker> <result source>
  76
  77 Registers the result source in the schema with the given moniker
  78
  79 =cut
  80
  81 sub register_source {
  82   my ($self, $moniker, $source) = @_;
  83   my %reg = %{$self->source_registrations};
  84   $reg{$moniker} = $source;
  85   $self->source_registrations(\%reg);
  86   $source->schema($self);
  87   if ($source->result_class) {
  88     my %map = %{$self->class_mappings};
  89     $map{$source->result_class} = $moniker;
  90     $self->class_mappings(\%map);
  91   }
  92 }
  93
  94 =head2 class
  95
  96   my $class = $schema->class('Foo');
  97
  98 Retrieves the result class name for a given result source
  99
 100 =cut
 101
 102 sub class {
 103   my ($self, $moniker) = @_;
 104   return $self->source($moniker)->result_class;
 105 }
 106
 107 =head2 source
 108
 109   my $source = $schema->source('Foo');
 110
 111 Returns the result source object for the registered name
 112
 113 =cut
 114
 115 sub source {
 116   my ($self, $moniker) = @_;
 117   my $sreg = $self->source_registrations;
 118   return $sreg->{$moniker} if exists $sreg->{$moniker};
 119
 120   # if we got here, they probably passed a full class name
 121   my $mapped = $self->class_mappings->{$moniker};
 122   $self->throw_exception("Can't find source for ${moniker}")
 123     unless $mapped && exists $sreg->{$mapped};
 124   return $sreg->{$mapped};
 125 }
 126
 127 =head2 sources
 128
 129   my @source_monikers = $schema->sources;
 130
 131 Returns the source monikers of all source registrations on this schema
 132
 133 =cut
 134
 135 sub sources { return keys %{shift->source_registrations}; }
 136
 137 =head2 resultset
 138
 139   my $rs = $schema->resultset('Foo');
 140
 141 Returns the resultset for the registered moniker
 142
 143 =cut
 144
 145 sub resultset {
 146   my ($self, $moniker) = @_;
 147   return $self->source($moniker)->resultset;
 148 }
 149
 150 =head2 load_classes
 151
 152 =head3 Arguments: [<classes>, (<class>, <class>), {<namespace> => [<classes>]}]
 153
 154 Uses L<Module::Find> to find all classes under the database class' namespace,
 155 or uses the classes you select.  Then it loads the component (using L<use>),
 156 and registers them (using B<register_class>);
 157
 158 It is possible to comment out classes with a leading '#', but note that perl
 159 will think it's a mistake (trying to use a comment in a qw list) so you'll
 160 need to add "no warnings 'qw';" before your load_classes call.
 161
 162 =cut
 163
 164 sub load_classes {
 165   my ($class, @params) = @_;
 166
 167   my %comps_for;
 168
 169   if (@params) {
 170     foreach my $param (@params) {
 171       if (ref $param eq 'ARRAY') {
 172         # filter out commented entries
 173         my @modules = grep { $_ !~ /^#/ } @$param;
 174
 175         push (@{$comps_for{$class}}, @modules);
 176       }
 177       elsif (ref $param eq 'HASH') {
 178         # more than one namespace possible
 179         for my $comp ( keys %$param ) {
 180           # filter out commented entries
 181           my @modules = grep { $_ !~ /^#/ } @{$param->{$comp}};
 182
 183           push (@{$comps_for{$comp}}, @modules);
 184         }
 185       }
 186       else {
 187         # filter out commented entries
 188         push (@{$comps_for{$class}}, $param) if $param !~ /^#/;
 189       }
 190     }
 191   } else {
 192     eval "require Module::Find;";
 193     $class->throw_exception("No arguments to load_classes and couldn't load".
 194       " Module::Find ($@)") if $@;
 195     my @comp = map { substr $_, length "${class}::"  } Module::Find::findallmod($class);
 196     $comps_for{$class} = \@comp;
 197   }
 198
 199   foreach my $prefix (keys %comps_for) {
 200     foreach my $comp (@{$comps_for{$prefix}||[]}) {
 201       my $comp_class = "${prefix}::${comp}";
 202       eval "use $comp_class"; # If it fails, assume the user fixed it
 203       if ($@) {
 204         die $@ unless $@ =~ /Can't locate/;
 205       }
 206       $class->register_class($comp => $comp_class);
 207       #  if $class->can('result_source_instance');
 208     }
 209   }
 210 }
 211
 212 =head2 compose_connection
 213
 214 =head3 Arguments: <target> <@db_info>
 215
 216 This is the most important method in this class. it takes a target namespace,
 217 as well as dbh connection info, and creates a L<DBIx::Class::DB> class as
 218 well as subclasses for each of your database classes in this namespace, using
 219 this connection.
 220
 221 It will also setup a ->class method on the target class, which lets you
 222 resolve database classes based on the schema component name, for example
 223
 224   MyApp::DB->class('Foo') # returns MyApp::DB::Foo,
 225                           # which ISA MyApp::Schema::Foo
 226
 227 This is the recommended API for accessing Schema generated classes, and
 228 using it might give you instant advantages with future versions of DBIC.
 229
 230 WARNING: Loading components into Schema classes after compose_connection
 231 may not cause them to be seen by the classes in your target namespace due
 232 to the dispatch table approach used by Class::C3. If you do this you may find
 233 you need to call Class::C3->reinitialize() afterwards to get the behaviour
 234 you expect.
 235
 236 =cut
 237
 238 sub compose_connection {
 239   my ($self, $target, @info) = @_;
 240   my $base = 'DBIx::Class::ResultSetProxy';
 241   eval "require ${base};";
 242   $self->throw_exception("No arguments to load_classes and couldn't load".
 243       " ${base} ($@)") if $@;
 244
 245   if ($self eq $target) {
 246     # Pathological case, largely caused by the docs on early C::M::DBIC::Plain
 247     foreach my $moniker ($self->sources) {
 248       my $source = $self->source($moniker);
 249       my $class = $source->result_class;
 250       $self->inject_base($class, $base);
 251       $class->mk_classdata(resultset_instance => $source->resultset);
 252       $class->mk_classdata(class_resolver => $self);
 253     }
 254     $self->connection(@info);
 255     return $self;
 256   }
 257
 258   my $schema = $self->compose_namespace($target, $base);
 259   {
 260     no strict 'refs';
 261     *{"${target}::schema"} = sub { $schema };
 262   }
 263
 264   $schema->connection(@info);
 265   foreach my $moniker ($schema->sources) {
 266     my $source = $schema->source($moniker);
 267     my $class = $source->result_class;
 268     #warn "$moniker $class $source ".$source->storage;
 269     $class->mk_classdata(result_source_instance => $source);
 270     $class->mk_classdata(resultset_instance => $source->resultset);
 271     $class->mk_classdata(class_resolver => $schema);
 272   }
 273   return $schema;
 274 }
 275
 276 sub compose_namespace {
 277   my ($self, $target, $base) = @_;
 278   my %reg = %{ $self->source_registrations };
 279   my %target;
 280   my %map;
 281   my $schema = $self->clone;
 282   foreach my $moniker ($schema->sources) {
 283     my $source = $schema->source($moniker);
 284     my $target_class = "${target}::${moniker}";
 285     $self->inject_base(
 286       $target_class => $source->result_class, ($base ? $base : ())
 287     );
 288     $source->result_class($target_class);
 289   }
 290   {
 291     no strict 'refs';
 292     foreach my $meth (qw/class source resultset/) {
 293       *{"${target}::${meth}"} =
 294         sub { shift->schema->$meth(@_) };
 295     }
 296   }
 297   return $schema;
 298 }
 299
 300 =head2 setup_connection_class
 301
 302 =head3 Arguments: <$target> <@info>
 303
 304 Sets up a database connection class to inject between the schema
 305 and the subclasses the schema creates.
 306
 307 =cut
 308
 309 sub setup_connection_class {
 310   my ($class, $target, @info) = @_;
 311   $class->inject_base($target => 'DBIx::Class::DB');
 312   #$target->load_components('DB');
 313   $target->connection(@info);
 314 }
 315
 316 =head2 connection
 317
 318 =head3 Arguments: (@args)
 319
 320 Instantiates a new Storage object of type storage_type and passes the
 321 arguments to $storage->connect_info. Sets the connection in-place on
 322 the schema.
 323
 324 =cut
 325
 326 sub connection {
 327   my ($self, @info) = @_;
 328   my $storage_class = $self->storage_type;
 329   $storage_class = 'DBIx::Class::Storage'.$storage_class
 330     if $storage_class =~ m/^::/;
 331   eval "require ${storage_class};";
 332   $self->throw_exception("No arguments to load_classes and couldn't load".
 333       " ${storage_class} ($@)") if $@;
 334   my $storage = $storage_class->new;
 335   $storage->connect_info(\@info);
 336   $self->storage($storage);
 337   return $self;
 338 }
 339
 340 =head2 connect
 341
 342 =head3 Arguments: (@info)
 343
 344 Conveneience method, equivalent to $schema->clone->connection(@info)
 345
 346 =cut
 347
 348 sub connect { shift->clone->connection(@_) }
 349
 350 =head2 txn_begin
 351
 352 Begins a transaction (does nothing if AutoCommit is off).
 353
 354 =cut
 355
 356 sub txn_begin { shift->storage->txn_begin }
 357
 358 =head2 txn_commit
 359
 360 Commits the current transaction.
 361
 362 =cut
 363
 364 sub txn_commit { shift->storage->txn_commit }
 365
 366 =head2 txn_rollback
 367
 368 Rolls back the current transaction.
 369
 370 =cut
 371
 372 sub txn_rollback { shift->storage->txn_rollback }
 373
 374 =head2 clone
 375
 376 Clones the schema and its associated result_source objects and returns the
 377 copy.
 378
 379 =cut
 380
 381 sub clone {
 382   my ($self) = @_;
 383   my $clone = bless({ (ref $self ? %$self : ()) }, ref $self || $self);
 384   foreach my $moniker ($self->sources) {
 385     my $source = $self->source($moniker);
 386     my $new = $source->new($source);
 387     $clone->register_source($moniker => $new);
 388   }
 389   return $clone;
 390 }
 391
 392 =head2 populate
 393
 394 =head3 Arguments: ($moniker, \@data);
 395
 396 Populates the source registered with the given moniker with the supplied data.
 397 @data should be a list of listrefs, the first containing column names, the
 398 second matching values - i.e.
 399
 400 $schema->populate('Foo', [
 401   [ qw/foo_id foo_string/ ],
 402   [ 1, 'One' ],
 403   [ 2, 'Two' ],
 404   ...
 405 ]);
 406
 407 =cut
 408
 409 sub populate {
 410   my ($self, $name, $data) = @_;
 411   my $rs = $self->resultset($name);
 412   my @names = @{shift(@$data)};
 413   foreach my $item (@$data) {
 414     my %create;
 415     @create{@names} = @$item;
 416     $rs->create(\%create);
 417   }
 418 }
 419
 420 =head2 throw_exception
 421
 422 Defaults to using Carp::Clan to report errors from user perspective.
 423
 424 =cut
 425
 426 sub throw_exception {
 427   my ($self) = shift;
 428   croak @_;
 429 }
 430
 431 =head2 deploy
 432
 433 Attempts to deploy the schema to the current storage
 434
 435 =cut
 436
 437 sub deploy {
 438   my ($self) = shift;
 439   $self->throw_exception("Can't deploy without storage") unless $self->storage;
 440   $self->storage->deploy($self);
 441 }
 442
 443 1;
 444
 445 =head1 AUTHORS
 446
 447 Matt S. Trout <mst@shadowcatsystems.co.uk>
 448
 449 =head1 LICENSE
 450
 451 You may distribute this code under the same terms as Perl itself.
 452
 453 =cut
 454