Commit | Line | Data |
a02675cd |
1 | package DBIx::Class::Schema; |
2 | |
3 | use strict; |
4 | use warnings; |
63e9583a |
5 | use DBIx::Class::DB; |
a02675cd |
6 | |
41a6f8c0 |
7 | use base qw/DBIx::Class/; |
a02675cd |
8 | |
42a1aaa1 |
9 | __PACKAGE__->load_components(qw/Exception/); |
74b92d9a |
10 | __PACKAGE__->mk_classdata('class_registrations' => {}); |
a02675cd |
11 | |
c2da098a |
12 | =head1 NAME |
13 | |
14 | DBIx::Class::Schema - composable schemas |
15 | |
16 | =head1 SYNOPSIS |
17 | |
03312470 |
18 | in My/Schema.pm |
c2da098a |
19 | |
20 | package My::Schema; |
21 | |
22 | use base qw/DBIx::Class::Schema/; |
23 | |
24 | __PACKAGE__->load_classes(qw/Foo Bar Baz/); |
25 | |
03312470 |
26 | in My/Schema/Foo.pm |
c2da098a |
27 | |
28 | package My::Schema::Foo; |
29 | |
03312470 |
30 | use base qw/DBIx::Class/; |
c2da098a |
31 | |
03312470 |
32 | __PACKAGE__->load_components(qw/Core PK::Auto::Pg/); # for example |
c2da098a |
33 | __PACKAGE__->table('foo'); |
34 | ... |
35 | |
03312470 |
36 | in My/DB.pm |
c2da098a |
37 | |
38 | use My::Schema; |
39 | |
40 | My::Schema->compose_connection('My::DB', $dsn, $user, $pass, $attrs); |
41 | |
03312470 |
42 | then in app code |
c2da098a |
43 | |
656796f2 |
44 | my @obj = My::DB::Foo->search({}); # My::DB::Foo isa My::Schema::Foo My::DB |
c2da098a |
45 | |
46 | =head1 DESCRIPTION |
47 | |
429bd4f1 |
48 | Creates database classes based on a schema. This allows you to have more than |
49 | one concurrent connection using the same database classes, by making |
50 | subclasses under a new namespace for each connection. If you only need one |
51 | class, you should probably use L<DBIx::Class::DB> directly instead. |
52 | |
03312470 |
53 | NB: If you're used to L<Class::DBI> it's worth reading the L</SYNOPSIS> |
54 | carefully as DBIx::Class does things a little differently. Note in |
55 | particular which module inherits off which. |
56 | |
c2da098a |
57 | =head1 METHODS |
58 | |
59 | =over 4 |
60 | |
076652e8 |
61 | =item register_class <component> <component_class> |
62 | |
63 | Registers the class in the schema's class_registrations. This is a hash |
429bd4f1 |
64 | containing database classes, keyed by their monikers. It's used by |
076652e8 |
65 | compose_connection to create/modify all the existing database classes. |
66 | |
c2da098a |
67 | =cut |
68 | |
a02675cd |
69 | sub register_class { |
70 | my ($class, $name, $to_register) = @_; |
74b92d9a |
71 | my %reg = %{$class->class_registrations}; |
a02675cd |
72 | $reg{$name} = $to_register; |
74b92d9a |
73 | $class->class_registrations(\%reg); |
74 | } |
75 | |
076652e8 |
76 | =item registered_classes |
77 | |
78 | Simple read-only accessor for the schema's registered classes. See |
79 | register_class above if you want to modify it. |
80 | |
81 | |
82 | =cut |
83 | |
74b92d9a |
84 | sub registered_classes { |
85 | return values %{shift->class_registrations}; |
a02675cd |
86 | } |
87 | |
5ce32fc1 |
88 | =item load_classes [<classes>, (<class>, <class>), {<namespace> => [<classes>]}] |
076652e8 |
89 | |
429bd4f1 |
90 | Uses L<Module::Find> to find all classes under the database class' namespace, |
91 | or uses the classes you select. Then it loads the component (using L<use>), |
92 | and registers them (using B<register_class>); |
076652e8 |
93 | |
5ce32fc1 |
94 | It is possible to comment out classes with a leading '#', but note that perl |
95 | will think it's a mistake (trying to use a comment in a qw list) so you'll |
96 | need to add "no warnings 'qw';" before your load_classes call. |
97 | |
076652e8 |
98 | =cut |
99 | |
a02675cd |
100 | sub load_classes { |
5ce32fc1 |
101 | my ($class, @params) = @_; |
102 | |
103 | my %comps_for; |
104 | |
105 | if (@params) { |
106 | foreach my $param (@params) { |
107 | if (ref $param eq 'ARRAY') { |
108 | # filter out commented entries |
109 | my @modules = grep { $_ !~ /^#/ } @$param; |
110 | |
111 | push (@{$comps_for{$class}}, @modules); |
112 | } |
113 | elsif (ref $param eq 'HASH') { |
114 | # more than one namespace possible |
115 | for my $comp ( keys %$param ) { |
116 | # filter out commented entries |
117 | my @modules = grep { $_ !~ /^#/ } @{$param->{$comp}}; |
118 | |
119 | push (@{$comps_for{$comp}}, @modules); |
120 | } |
121 | } |
122 | else { |
123 | # filter out commented entries |
124 | push (@{$comps_for{$class}}, $param) if $param !~ /^#/; |
125 | } |
126 | } |
127 | } else { |
41a6f8c0 |
128 | eval "require Module::Find;"; |
129 | $class->throw("No arguments to load_classes and couldn't load". |
130 | " Module::Find ($@)") if $@; |
5ce32fc1 |
131 | my @comp = map { substr $_, length "${class}::" } Module::Find::findallmod($class); |
132 | $comps_for{$class} = \@comp; |
41a6f8c0 |
133 | } |
5ce32fc1 |
134 | |
135 | foreach my $prefix (keys %comps_for) { |
136 | foreach my $comp (@{$comps_for{$prefix}||[]}) { |
137 | my $comp_class = "${prefix}::${comp}"; |
138 | print "$comp_class\n"; |
139 | eval "use $comp_class"; # If it fails, assume the user fixed it |
140 | $class->register_class($comp => $comp_class); |
141 | } |
a02675cd |
142 | } |
143 | } |
144 | |
429bd4f1 |
145 | =item compose_connection <target> <@db_info> |
146 | |
147 | This is the most important method in this class. it takes a target namespace, |
148 | as well as dbh connection info, and creates a L<DBIx::Class::DB> class as |
149 | well as subclasses for each of your database classes in this namespace, using |
150 | this connection. |
076652e8 |
151 | |
8c130052 |
152 | It will also setup a ->table method on the target class, which lets you |
153 | resolve database classes based on the schema component name, for example |
154 | |
155 | MyApp::DB->table('Foo') # returns MyApp::DB::Foo, |
156 | # which ISA MyApp::Schema::Foo |
157 | |
158 | This is the recommended API for accessing Schema generated classes, and |
159 | using it might give you instant advantages with future versions of DBIC. |
160 | |
076652e8 |
161 | =cut |
162 | |
a02675cd |
163 | sub compose_connection { |
164 | my ($class, $target, @info) = @_; |
11b78bd6 |
165 | my $conn_class = "${target}::_db"; |
166 | $class->setup_connection_class($conn_class, @info); |
74b92d9a |
167 | my %reg = %{ $class->class_registrations }; |
11b78bd6 |
168 | my %target; |
169 | my %map; |
a02675cd |
170 | while (my ($comp, $comp_class) = each %reg) { |
171 | my $target_class = "${target}::${comp}"; |
63e9583a |
172 | $class->inject_base($target_class, $comp_class, $conn_class); |
227d4dee |
173 | $target_class->table($comp_class->table); |
11b78bd6 |
174 | @map{$comp, $comp_class} = ($target_class, $target_class); |
b7951443 |
175 | } |
11b78bd6 |
176 | { |
177 | no strict 'refs'; |
178 | *{"${target}::class"} = |
179 | sub { |
180 | my ($class, $to_map) = @_; |
181 | return $map{$to_map}; |
182 | }; |
d3dec624 |
183 | *{"${target}::classes"} = sub { return \%map; }; |
11b78bd6 |
184 | } |
aa698961 |
185 | $conn_class->class_resolver($target); |
b7951443 |
186 | } |
187 | |
076652e8 |
188 | =item setup_connection_class <$target> <@info> |
189 | |
429bd4f1 |
190 | Sets up a database connection class to inject between the schema |
191 | and the subclasses the schema creates. |
192 | |
076652e8 |
193 | =cut |
194 | |
b7951443 |
195 | sub setup_connection_class { |
196 | my ($class, $target, @info) = @_; |
63e9583a |
197 | $class->inject_base($target => 'DBIx::Class::DB'); |
198 | #$target->load_components('DB'); |
b7951443 |
199 | $target->connection(@info); |
200 | } |
201 | |
a02675cd |
202 | 1; |
c2da098a |
203 | |
204 | =back |
205 | |
206 | =head1 AUTHORS |
207 | |
daec44b8 |
208 | Matt S. Trout <mst@shadowcatsystems.co.uk> |
c2da098a |
209 | |
210 | =head1 LICENSE |
211 | |
212 | You may distribute this code under the same terms as Perl itself. |
213 | |
214 | =cut |
215 | |