1 package DBIx::Class::Schema;
6 use DBIx::Class::Exception;
7 use Carp::Clan qw/^DBIx::Class/;
8 use Scalar::Util qw/weaken/;
12 use base qw/DBIx::Class/;
14 __PACKAGE__->mk_classdata('class_mappings' => {});
15 __PACKAGE__->mk_classdata('source_registrations' => {});
16 __PACKAGE__->mk_classdata('storage_type' => '::DBI');
17 __PACKAGE__->mk_classdata('storage');
18 __PACKAGE__->mk_classdata('exception_action');
19 __PACKAGE__->mk_classdata('stacktrace' => $ENV{DBIC_TRACE} || 0);
20 __PACKAGE__->mk_classdata('default_resultset_attributes' => {});
24 DBIx::Class::Schema - composable schemas
28 package Library::Schema;
29 use base qw/DBIx::Class::Schema/;
31 # load Library::Schema::CD, Library::Schema::Book, Library::Schema::DVD
32 __PACKAGE__->load_classes(qw/CD Book DVD/);
34 package Library::Schema::CD;
35 use base qw/DBIx::Class/;
36 __PACKAGE__->load_components(qw/PK::Auto Core/); # for example
37 __PACKAGE__->table('cd');
39 # Elsewhere in your code:
40 my $schema1 = Library::Schema->connect(
47 my $schema2 = Library::Schema->connect($coderef_returning_dbh);
49 # fetch objects using Library::Schema::DVD
50 my $resultset = $schema1->resultset('DVD')->search( ... );
51 my @dvd_objects = $schema2->resultset('DVD')->search( ... );
55 Creates database classes based on a schema. This is the recommended way to
56 use L<DBIx::Class> and allows you to use more than one concurrent connection
59 NB: If you're used to L<Class::DBI> it's worth reading the L</SYNOPSIS>
60 carefully, as DBIx::Class does things a little differently. Note in
61 particular which module inherits off which.
69 =item Arguments: $moniker, $component_class
73 Registers a class which isa DBIx::Class::ResultSourceProxy. Equivalent to
76 $schema->register_source($moniker, $component_class->result_source_instance);
81 my ($self, $moniker, $to_register) = @_;
82 $self->register_source($moniker => $to_register->result_source_instance);
85 =head2 register_source
89 =item Arguments: $moniker, $result_source
93 Registers the L<DBIx::Class::ResultSource> in the schema with the given
99 my ($self, $moniker, $source) = @_;
101 %$source = %{ $source->new( { %$source, source_name => $moniker }) };
103 my %reg = %{$self->source_registrations};
104 $reg{$moniker} = $source;
105 $self->source_registrations(\%reg);
107 $source->schema($self);
109 weaken($source->{schema}) if ref($self);
110 if ($source->result_class) {
111 my %map = %{$self->class_mappings};
112 $map{$source->result_class} = $moniker;
113 $self->class_mappings(\%map);
117 sub _unregister_source {
118 my ($self, $moniker) = @_;
119 my %reg = %{$self->source_registrations};
121 my $source = delete $reg{$moniker};
122 $self->source_registrations(\%reg);
123 if ($source->result_class) {
124 my %map = %{$self->class_mappings};
125 delete $map{$source->result_class};
126 $self->class_mappings(\%map);
134 =item Arguments: $moniker
136 =item Return Value: $classname
140 Retrieves the result class name for the given moniker. For example:
142 my $class = $schema->class('CD');
147 my ($self, $moniker) = @_;
148 return $self->source($moniker)->result_class;
155 =item Arguments: $moniker
157 =item Return Value: $result_source
161 my $source = $schema->source('Book');
163 Returns the L<DBIx::Class::ResultSource> object for the registered moniker.
168 my ($self, $moniker) = @_;
169 my $sreg = $self->source_registrations;
170 return $sreg->{$moniker} if exists $sreg->{$moniker};
172 # if we got here, they probably passed a full class name
173 my $mapped = $self->class_mappings->{$moniker};
174 $self->throw_exception("Can't find source for ${moniker}")
175 unless $mapped && exists $sreg->{$mapped};
176 return $sreg->{$mapped};
183 =item Return Value: @source_monikers
187 Returns the source monikers of all source registrations on this schema.
190 my @source_monikers = $schema->sources;
194 sub sources { return keys %{shift->source_registrations}; }
198 my $storage = $schema->storage;
200 Returns the L<DBIx::Class::Storage> object for this Schema.
206 =item Arguments: $moniker
208 =item Return Value: $result_set
212 my $rs = $schema->resultset('DVD');
214 Returns the L<DBIx::Class::ResultSet> object for the registered moniker.
219 my ($self, $moniker) = @_;
220 return $self->source($moniker)->resultset;
227 =item Arguments: @classes?, { $namespace => [ @classes ] }+
231 With no arguments, this method uses L<Module::Find> to find all classes under
232 the schema's namespace. Otherwise, this method loads the classes you specify
233 (using L<use>), and registers them (using L</"register_class">).
235 It is possible to comment out classes with a leading C<#>, but note that perl
236 will think it's a mistake (trying to use a comment in a qw list), so you'll
237 need to add C<no warnings 'qw';> before your load_classes call.
241 My::Schema->load_classes(); # loads My::Schema::CD, My::Schema::Artist,
242 # etc. (anything under the My::Schema namespace)
244 # loads My::Schema::CD, My::Schema::Artist, Other::Namespace::Producer but
245 # not Other::Namespace::LinerNotes nor My::Schema::Track
246 My::Schema->load_classes(qw/ CD Artist #Track /, {
247 Other::Namespace => [qw/ Producer #LinerNotes /],
253 my ($class, @params) = @_;
258 foreach my $param (@params) {
259 if (ref $param eq 'ARRAY') {
260 # filter out commented entries
261 my @modules = grep { $_ !~ /^#/ } @$param;
263 push (@{$comps_for{$class}}, @modules);
265 elsif (ref $param eq 'HASH') {
266 # more than one namespace possible
267 for my $comp ( keys %$param ) {
268 # filter out commented entries
269 my @modules = grep { $_ !~ /^#/ } @{$param->{$comp}};
271 push (@{$comps_for{$comp}}, @modules);
275 # filter out commented entries
276 push (@{$comps_for{$class}}, $param) if $param !~ /^#/;
280 my @comp = map { substr $_, length "${class}::" }
281 Module::Find::findallmod($class);
282 $comps_for{$class} = \@comp;
287 no warnings qw/redefine/;
288 local *Class::C3::reinitialize = sub { };
289 foreach my $prefix (keys %comps_for) {
290 foreach my $comp (@{$comps_for{$prefix}||[]}) {
291 my $comp_class = "${prefix}::${comp}";
292 { # try to untaint module name. mods where this fails
293 # are left alone so we don't have to change the old behavior
294 no locale; # localized \w doesn't untaint expression
295 if ( $comp_class =~ m/^( (?:\w+::)* \w+ )$/x ) {
299 $class->ensure_class_loaded($comp_class);
301 $comp = $comp_class->source_name || $comp;
303 push(@to_register, [ $comp, $comp_class ]);
307 Class::C3->reinitialize;
309 foreach my $to (@to_register) {
310 $class->register_class(@$to);
311 # if $class->can('result_source_instance');
315 =head2 load_namespaces
319 =item Arguments: %options?
323 This is an alternative to L</load_classes> above which assumes an alternative
324 layout for automatic class loading. It assumes that all result
325 classes are underneath a sub-namespace of the schema called C<Result>, any
326 corresponding ResultSet classes are underneath a sub-namespace of the schema
329 Both of the sub-namespaces are configurable if you don't like the defaults,
330 via the options C<result_namespace> and C<resultset_namespace>.
332 If (and only if) you specify the option C<default_resultset_class>, any found
333 Result classes for which we do not find a corresponding
334 ResultSet class will have their C<resultset_class> set to
335 C<default_resultset_class>.
337 C<load_namespaces> takes care of calling C<resultset_class> for you where
338 neccessary if you didn't do it for yourself.
340 All of the namespace and classname options to this method are relative to
341 the schema classname by default. To specify a fully-qualified name, prefix
342 it with a literal C<+>.
346 # load My::Schema::Result::CD, My::Schema::Result::Artist,
347 # My::Schema::ResultSet::CD, etc...
348 My::Schema->load_namespaces;
350 # Override everything to use ugly names.
351 # In this example, if there is a My::Schema::Res::Foo, but no matching
352 # My::Schema::RSets::Foo, then Foo will have its
353 # resultset_class set to My::Schema::RSetBase
354 My::Schema->load_namespaces(
355 result_namespace => 'Res',
356 resultset_namespace => 'RSets',
357 default_resultset_class => 'RSetBase',
360 # Put things in other namespaces
361 My::Schema->load_namespaces(
362 result_namespace => '+Some::Place::Results',
363 resultset_namespace => '+Another::Place::RSets',
366 If you'd like to use multiple namespaces of each type, simply use an arrayref
367 of namespaces for that option. In the case that the same result
368 (or resultset) class exists in multiple namespaces, the latter entries in
369 your list of namespaces will override earlier ones.
371 My::Schema->load_namespaces(
372 # My::Schema::Results_C::Foo takes precedence over My::Schema::Results_B::Foo :
373 result_namespace => [ 'Results_A', 'Results_B', 'Results_C' ],
374 resultset_namespace => [ '+Some::Place::RSets', 'RSets' ],
379 # Pre-pends our classname to the given relative classname or
380 # class namespace, unless there is a '+' prefix, which will
382 sub _expand_relative_name {
383 my ($class, $name) = @_;
385 $name = $class . '::' . $name if ! ($name =~ s/^\+//);
389 # returns a hash of $shortname => $fullname for every package
390 # found in the given namespaces ($shortname is with the $fullname's
391 # namespace stripped off)
392 sub _map_namespaces {
393 my ($class, @namespaces) = @_;
396 foreach my $namespace (@namespaces) {
399 map { (substr($_, length "${namespace}::"), $_) }
400 Module::Find::findallmod($namespace)
407 sub load_namespaces {
408 my ($class, %args) = @_;
410 my $result_namespace = delete $args{result_namespace} || 'Result';
411 my $resultset_namespace = delete $args{resultset_namespace} || 'ResultSet';
412 my $default_resultset_class = delete $args{default_resultset_class};
414 $class->throw_exception('load_namespaces: unknown option(s): '
415 . join(q{,}, map { qq{'$_'} } keys %args))
416 if scalar keys %args;
418 $default_resultset_class
419 = $class->_expand_relative_name($default_resultset_class);
421 for my $arg ($result_namespace, $resultset_namespace) {
422 $arg = [ $arg ] if !ref($arg) && $arg;
424 $class->throw_exception('load_namespaces: namespace arguments must be '
425 . 'a simple string or an arrayref')
426 if ref($arg) ne 'ARRAY';
428 $_ = $class->_expand_relative_name($_) for (@$arg);
431 my %results = $class->_map_namespaces(@$result_namespace);
432 my %resultsets = $class->_map_namespaces(@$resultset_namespace);
436 no warnings 'redefine';
437 local *Class::C3::reinitialize = sub { };
438 use warnings 'redefine';
440 foreach my $result (keys %results) {
441 my $result_class = $results{$result};
442 $class->ensure_class_loaded($result_class);
443 $result_class->source_name($result) unless $result_class->source_name;
445 my $rs_class = delete $resultsets{$result};
446 my $rs_set = $result_class->resultset_class;
447 if($rs_set && $rs_set ne 'DBIx::Class::ResultSet') {
448 if($rs_class && $rs_class ne $rs_set) {
449 warn "We found ResultSet class '$rs_class' for '$result', but it seems "
450 . "that you had already set '$result' to use '$rs_set' instead";
453 elsif($rs_class ||= $default_resultset_class) {
454 $class->ensure_class_loaded($rs_class);
455 $result_class->resultset_class($rs_class);
458 push(@to_register, [ $result_class->source_name, $result_class ]);
462 foreach (sort keys %resultsets) {
463 warn "load_namespaces found ResultSet class $_ with no "
464 . 'corresponding Result class';
467 Class::C3->reinitialize;
468 $class->register_class(@$_) for (@to_register);
473 =head2 compose_connection (DEPRECATED)
477 =item Arguments: $target_namespace, @db_info
479 =item Return Value: $new_schema
483 DEPRECATED. You probably wanted compose_namespace.
485 Actually, you probably just wanted to call connect.
489 (hidden due to deprecation)
491 Calls L<DBIx::Class::Schema/"compose_namespace"> to the target namespace,
492 calls L<DBIx::Class::Schema/connection> with @db_info on the new schema,
493 then injects the L<DBix::Class::ResultSetProxy> component and a
494 resultset_instance classdata entry on all the new classes, in order to support
495 $target_namespaces::$class->search(...) method calls.
497 This is primarily useful when you have a specific need for class method access
498 to a connection. In normal usage it is preferred to call
499 L<DBIx::Class::Schema/connect> and use the resulting schema object to operate
500 on L<DBIx::Class::ResultSet> objects with L<DBIx::Class::Schema/resultset> for
510 sub compose_connection {
511 my ($self, $target, @info) = @_;
513 warn "compose_connection deprecated as of 0.08000"
514 unless ($INC{"DBIx/Class/CDBICompat.pm"} || $warn++);
516 my $base = 'DBIx::Class::ResultSetProxy';
517 eval "require ${base};";
518 $self->throw_exception
519 ("No arguments to load_classes and couldn't load ${base} ($@)")
522 if ($self eq $target) {
523 # Pathological case, largely caused by the docs on early C::M::DBIC::Plain
524 foreach my $moniker ($self->sources) {
525 my $source = $self->source($moniker);
526 my $class = $source->result_class;
527 $self->inject_base($class, $base);
528 $class->mk_classdata(resultset_instance => $source->resultset);
529 $class->mk_classdata(class_resolver => $self);
531 $self->connection(@info);
535 my $schema = $self->compose_namespace($target, $base);
538 *{"${target}::schema"} = sub { $schema };
541 $schema->connection(@info);
542 foreach my $moniker ($schema->sources) {
543 my $source = $schema->source($moniker);
544 my $class = $source->result_class;
545 #warn "$moniker $class $source ".$source->storage;
546 $class->mk_classdata(result_source_instance => $source);
547 $class->mk_classdata(resultset_instance => $source->resultset);
548 $class->mk_classdata(class_resolver => $schema);
554 =head2 compose_namespace
558 =item Arguments: $target_namespace, $additional_base_class?
560 =item Return Value: $new_schema
564 For each L<DBIx::Class::ResultSource> in the schema, this method creates a
565 class in the target namespace (e.g. $target_namespace::CD,
566 $target_namespace::Artist) that inherits from the corresponding classes
567 attached to the current schema.
569 It also attaches a corresponding L<DBIx::Class::ResultSource> object to the
570 new $schema object. If C<$additional_base_class> is given, the new composed
571 classes will inherit from first the corresponding classe from the current
572 schema then the base class.
574 For example, for a schema with My::Schema::CD and My::Schema::Artist classes,
576 $schema->compose_namespace('My::DB', 'Base::Class');
577 print join (', ', @My::DB::CD::ISA) . "\n";
578 print join (', ', @My::DB::Artist::ISA) ."\n";
580 will produce the output
582 My::Schema::CD, Base::Class
583 My::Schema::Artist, Base::Class
587 sub compose_namespace {
588 my ($self, $target, $base) = @_;
589 my $schema = $self->clone;
591 no warnings qw/redefine/;
592 local *Class::C3::reinitialize = sub { };
593 foreach my $moniker ($schema->sources) {
594 my $source = $schema->source($moniker);
595 my $target_class = "${target}::${moniker}";
597 $target_class => $source->result_class, ($base ? $base : ())
599 $source->result_class($target_class);
600 $target_class->result_source_instance($source)
601 if $target_class->can('result_source_instance');
604 Class::C3->reinitialize();
607 no warnings 'redefine';
608 foreach my $meth (qw/class source resultset/) {
609 *{"${target}::${meth}"} =
610 sub { shift->schema->$meth(@_) };
616 sub setup_connection_class {
617 my ($class, $target, @info) = @_;
618 $class->inject_base($target => 'DBIx::Class::DB');
619 #$target->load_components('DB');
620 $target->connection(@info);
627 =item Arguments: $storage_type
629 =item Return Value: $storage_type
633 Set the storage class that will be instantiated when L</connect> is called.
634 If the classname starts with C<::>, the prefix C<DBIx::Class::Storage> is
635 assumed by L</connect>. Defaults to C<::DBI>,
636 which is L<DBIx::Class::Storage::DBI>.
638 You want to use this to hardcoded subclasses of L<DBIx::Class::Storage::DBI>
639 in cases where the appropriate subclass is not autodetected, such as when
640 dealing with MSSQL via L<DBD::Sybase>, in which case you'd set it to
641 C<::DBI::Sybase::MSSQL>.
647 =item Arguments: @args
649 =item Return Value: $new_schema
653 Instantiates a new Storage object of type
654 L<DBIx::Class::Schema/"storage_type"> and passes the arguments to
655 $storage->connect_info. Sets the connection in-place on the schema.
657 See L<DBIx::Class::Storage::DBI/"connect_info"> for DBI-specific syntax,
658 or L<DBIx::Class::Storage> in general.
663 my ($self, @info) = @_;
664 return $self if !@info && $self->storage;
665 my $storage_class = $self->storage_type;
666 $storage_class = 'DBIx::Class::Storage'.$storage_class
667 if $storage_class =~ m/^::/;
668 eval "require ${storage_class};";
669 $self->throw_exception(
670 "No arguments to load_classes and couldn't load ${storage_class} ($@)"
672 my $storage = $storage_class->new($self);
673 $storage->connect_info(\@info);
674 $self->storage($storage);
682 =item Arguments: @info
684 =item Return Value: $new_schema
688 This is a convenience method. It is equivalent to calling
689 $schema->clone->connection(@info). See L</connection> and L</clone> for more
694 sub connect { shift->clone->connection(@_) }
700 =item Arguments: C<$coderef>, @coderef_args?
702 =item Return Value: The return value of $coderef
706 Executes C<$coderef> with (optional) arguments C<@coderef_args> atomically,
707 returning its result (if any). Equivalent to calling $schema->storage->txn_do.
708 See L<DBIx::Class::Storage/"txn_do"> for more information.
710 This interface is preferred over using the individual methods L</txn_begin>,
711 L</txn_commit>, and L</txn_rollback> below.
718 $self->storage or $self->throw_exception
719 ('txn_do called on $schema without storage');
721 $self->storage->txn_do(@_);
724 =head2 txn_scope_guard
726 Runs C<txn_scope_guard> on the schema's storage.
730 sub txn_scope_guard {
733 $self->storage or $self->throw_exception
734 ('txn_scope_guard called on $schema without storage');
736 $self->storage->txn_scope_guard(@_);
741 Begins a transaction (does nothing if AutoCommit is off). Equivalent to
742 calling $schema->storage->txn_begin. See
743 L<DBIx::Class::Storage::DBI/"txn_begin"> for more information.
750 $self->storage or $self->throw_exception
751 ('txn_begin called on $schema without storage');
753 $self->storage->txn_begin;
758 Commits the current transaction. Equivalent to calling
759 $schema->storage->txn_commit. See L<DBIx::Class::Storage::DBI/"txn_commit">
760 for more information.
767 $self->storage or $self->throw_exception
768 ('txn_commit called on $schema without storage');
770 $self->storage->txn_commit;
775 Rolls back the current transaction. Equivalent to calling
776 $schema->storage->txn_rollback. See
777 L<DBIx::Class::Storage::DBI/"txn_rollback"> for more information.
784 $self->storage or $self->throw_exception
785 ('txn_rollback called on $schema without storage');
787 $self->storage->txn_rollback;
792 Creates a new savepoint (does nothing outside a transaction).
793 Equivalent to calling $schema->storage->svp_begin. See
794 L<DBIx::Class::Storage::DBI/"svp_begin"> for more information.
799 my ($self, $name) = @_;
801 $self->storage or $self->throw_exception
802 ('svp_begin called on $schema without storage');
804 $self->storage->svp_begin($name);
809 Releases a savepoint (does nothing outside a transaction).
810 Equivalent to calling $schema->storage->svp_release. See
811 L<DBIx::Class::Storage::DBI/"svp_release"> for more information.
816 my ($self, $name) = @_;
818 $self->storage or $self->throw_exception
819 ('svp_release called on $schema without storage');
821 $self->storage->svp_release($name);
826 Rollback to a savepoint (does nothing outside a transaction).
827 Equivalent to calling $schema->storage->svp_rollback. See
828 L<DBIx::Class::Storage::DBI/"svp_rollback"> for more information.
833 my ($self, $name) = @_;
835 $self->storage or $self->throw_exception
836 ('svp_rollback called on $schema without storage');
838 $self->storage->svp_rollback($name);
845 =item Return Value: $new_schema
849 Clones the schema and its associated result_source objects and returns the
856 my $clone = { (ref $self ? %$self : ()) };
857 bless $clone, (ref $self || $self);
859 foreach my $moniker ($self->sources) {
860 my $source = $self->source($moniker);
861 my $new = $source->new($source);
862 $clone->register_source($moniker => $new);
864 $clone->storage->set_schema($clone) if $clone->storage;
872 =item Arguments: $source_name, \@data;
876 Pass this method a resultsource name, and an arrayref of
877 arrayrefs. The arrayrefs should contain a list of column names,
878 followed by one or many sets of matching data for the given columns.
880 In void context, C<insert_bulk> in L<DBIx::Class::Storage::DBI> is used
881 to insert the data, as this is a fast method. However, insert_bulk currently
882 assumes that your datasets all contain the same type of values, using scalar
883 references in a column in one row, and not in another will probably not work.
885 Otherwise, each set of data is inserted into the database using
886 L<DBIx::Class::ResultSet/create>, and a arrayref of the resulting row
891 $schema->populate('Artist', [
892 [ qw/artistid name/ ],
893 [ 1, 'Popular Band' ],
898 Since wantarray context is basically the same as looping over $rs->create(...)
899 you won't see any performance benefits and in this case the method is more for
900 convenience. Void context sends the column information directly to storage
901 using <DBI>s bulk insert method. So the performance will be much better for
902 storages that support this method.
904 Because of this difference in the way void context inserts rows into your
905 database you need to note how this will effect any loaded components that
906 override or augment insert. For example if you are using a component such
907 as L<DBIx::Class::UUIDColumns> to populate your primary keys you MUST use
908 wantarray context if you want the PKs automatically created.
913 my ($self, $name, $data) = @_;
914 my $rs = $self->resultset($name);
915 my @names = @{shift(@$data)};
916 if(defined wantarray) {
918 foreach my $item (@$data) {
920 @create{@names} = @$item;
921 push(@created, $rs->create(\%create));
925 my @results_to_create;
926 foreach my $datum (@$data) {
927 my %result_to_create;
928 foreach my $index (0..$#names) {
929 $result_to_create{$names[$index]} = $$datum[$index];
931 push @results_to_create, \%result_to_create;
933 $rs->populate(\@results_to_create);
936 =head2 exception_action
940 =item Arguments: $code_reference
944 If C<exception_action> is set for this class/object, L</throw_exception>
945 will prefer to call this code reference with the exception as an argument,
946 rather than its normal C<croak> or C<confess> action.
948 Your subroutine should probably just wrap the error in the exception
949 object/class of your choosing and rethrow. If, against all sage advice,
950 you'd like your C<exception_action> to suppress a particular exception
951 completely, simply have it return true.
956 use base qw/DBIx::Class::Schema/;
957 use My::ExceptionClass;
958 __PACKAGE__->exception_action(sub { My::ExceptionClass->throw(@_) });
959 __PACKAGE__->load_classes;
962 my $schema_obj = My::Schema->connect( .... );
963 $schema_obj->exception_action(sub { My::ExceptionClass->throw(@_) });
965 # suppress all exceptions, like a moron:
966 $schema_obj->exception_action(sub { 1 });
972 =item Arguments: boolean
976 Whether L</throw_exception> should include stack trace information.
977 Defaults to false normally, but defaults to true if C<$ENV{DBIC_TRACE}>
980 =head2 throw_exception
984 =item Arguments: $message
988 Throws an exception. Defaults to using L<Carp::Clan> to report errors from
989 user's perspective. See L</exception_action> for details on overriding
990 this method's behavior. If L</stacktrace> is turned on, C<throw_exception>'s
991 default behavior will provide a detailed stack trace.
995 sub throw_exception {
998 DBIx::Class::Exception->throw($_[0], $self->stacktrace)
999 if !$self->exception_action || !$self->exception_action->(@_);
1006 =item Arguments: $sqlt_args, $dir
1010 Attempts to deploy the schema to the current storage using L<SQL::Translator>.
1012 See L<SQL::Translator/METHODS> for a list of values for C<$sqlt_args>. The most
1013 common value for this would be C<< { add_drop_table => 1, } >> to have the SQL
1014 produced include a DROP TABLE statement for each table created.
1016 Additionally, the DBIx::Class parser accepts a C<sources> parameter as a hash
1017 ref or an array ref, containing a list of source to deploy. If present, then
1018 only the sources listed will get deployed. Furthermore, you can use the
1019 C<add_fk_index> parser parameter to prevent the parser from creating an index for each
1025 my ($self, $sqltargs, $dir) = @_;
1026 $self->throw_exception("Can't deploy without storage") unless $self->storage;
1027 $self->storage->deploy($self, undef, $sqltargs, $dir);
1030 =head2 deployment_statements
1034 =item Arguments: $rdbms_type
1038 Returns the SQL statements used by L</deploy> and L<DBIx::Class::Schema/deploy>.
1039 C<$rdbms_type> provides the DBI database driver name for which the SQL
1040 statements are produced. If not supplied, the type of the current schema storage
1045 sub deployment_statements {
1046 my ($self, $rdbms_type) = @_;
1048 $self->throw_exception("Can't generate deployment statements without a storage")
1049 if not $self->storage;
1051 $self->storage->deployment_statements($self, $rdbms_type);
1054 =head2 create_ddl_dir (EXPERIMENTAL)
1058 =item Arguments: \@databases, $version, $directory, $preversion, $sqlt_args
1062 Creates an SQL file based on the Schema, for each of the specified
1063 database types, in the given directory. Given a previous version number,
1064 this will also create a file containing the ALTER TABLE statements to
1065 transform the previous schema into the current one. Note that these
1066 statements may contain DROP TABLE or DROP COLUMN statements that can
1067 potentially destroy data.
1069 The file names are created using the C<ddl_filename> method below, please
1070 override this method in your schema if you would like a different file
1071 name format. For the ALTER file, the same format is used, replacing
1072 $version in the name with "$preversion-$version".
1074 See L<DBIx::Class::Schema/deploy> for details of $sqlt_args.
1076 If no arguments are passed, then the following default values are used:
1080 =item databases - ['MySQL', 'SQLite', 'PostgreSQL']
1082 =item version - $schema->VERSION
1084 =item directory - './'
1086 =item preversion - <none>
1090 Note that this feature is currently EXPERIMENTAL and may not work correctly
1091 across all databases, or fully handle complex relationships.
1093 WARNING: Please check all SQL files created, before applying them.
1097 sub create_ddl_dir {
1100 $self->throw_exception("Can't create_ddl_dir without storage") unless $self->storage;
1101 $self->storage->create_ddl_dir($self, @_);
1108 =item Arguments: $database-type, $version, $directory, $preversion
1112 my $filename = $table->ddl_filename($type, $version, $dir, $preversion)
1114 This method is called by C<create_ddl_dir> to compose a file name out of
1115 the supplied directory, database type and version number. The default file
1116 name format is: C<$dir$schema-$version-$type.sql>.
1118 You may override this method in your schema if you wish to use a different
1124 my ($self, $type, $version, $dir, $preversion) = @_;
1126 my $filename = ref($self);
1127 $filename =~ s/::/-/g;
1128 $filename = File::Spec->catfile($dir, "$filename-$version-$type.sql");
1129 $filename =~ s/$version/$preversion-$version/ if($preversion);
1134 =head2 sqlt_deploy_hook($sqlt_schema)
1136 An optional sub which you can declare in your own Schema class that will get
1137 passed the L<SQL::Translator::Schema> object when you deploy the schema via
1138 L</create_ddl_dir> or L</deploy>.
1140 For an example of what you can do with this, see
1141 L<DBIx::Class::Manual::Cookbook/Adding Indexes And Functions To Your SQL>.
1145 Provided as the recommened way of thawing schema objects. You can call
1146 C<Storable::thaw> directly if you wish, but the thawed objects will not have a
1147 reference to any schema, so are rather useless
1152 my ($self, $obj) = @_;
1153 local $DBIx::Class::ResultSourceHandle::thaw_schema = $self;
1154 return Storable::thaw($obj);
1159 This doesn't actualy do anything more than call L<Storable/freeze>, it is just
1160 provided here for symetry.
1165 return Storable::freeze($_[1]);
1170 Recommeneded way of dcloning objects. This is needed to properly maintain
1171 references to the schema object (which itself is B<not> cloned.)
1176 my ($self, $obj) = @_;
1177 local $DBIx::Class::ResultSourceHandle::thaw_schema = $self;
1178 return Storable::dclone($obj);
1181 =head2 schema_version
1183 Returns the current schema class' $VERSION
1187 sub schema_version {
1189 my $class = ref($self)||$self;
1191 # does -not- use $schema->VERSION
1192 # since that varies in results depending on if version.pm is installed, and if
1193 # so the perl or XS versions. If you want this to change, bug the version.pm
1194 # author to make vpp and vxs behave the same.
1199 $version = ${"${class}::VERSION"};
1208 Matt S. Trout <mst@shadowcatsystems.co.uk>
1212 You may distribute this code under the same terms as Perl itself.