1 package Catalyst::Helper::Model::DBIC::Schema;
9 use UNIVERSAL::require;
13 Catalyst::Helper::Model::DBIC::Schema - Helper for DBIC Schema Models
17 script/create.pl model CatalystModelName DBIC::Schema MyApp::SchemaClass [ create=dynamic | create=static ] [ connect_info arguments ]
21 Helper for the DBIC Schema Models.
25 C<CatalystModelName> is the short name for the Catalyst Model class
26 being generated (i.e. callable with C<$c-E<gt>model('CatalystModelName')>).
28 C<MyApp::SchemaClass> is the fully qualified classname of your Schema,
29 which might or might not yet exist. Note that you should have a good
30 reason to create this under a new global namespace, otherwise use an
31 existing top level namespace for your schema class.
33 C<create=dynamic> instructs this Helper to generate the named Schema
34 class for you, basing it on L<DBIx::Class::Schema::Loader> (which
35 means the table information will always be dynamically loaded at
36 runtime from the database).
38 C<create=static> instructs this Helper to generate the named Schema
39 class for you, using L<DBIx::Class::Schema::Loader> in "one shot"
40 mode to create a standard, manually-defined L<DBIx::Class::Schema>
41 setup, based on what the Loader sees in your database at this moment.
42 A Schema/Model pair generated this way will not require
43 L<DBIx::Class::Schema::Loader> at runtime, and will not automatically
44 adapt itself to changes in your database structure. You can edit
45 the generated classes by hand to refine them.
47 C<connect_info> arguments are the same as what
48 DBIx::Class::Schema::connect expects, and are storage_type-specific.
49 For DBI-based storage, these arguments are the dsn, username,
50 password, and connect options, respectively. These are optional for
51 existing Schemas, but required if you use either of the C<create=>
54 Use of either of the C<create=> options requires L<DBIx::Class::Schema::Loader>.
56 =head1 TYPICAL EXAMPLES
58 # Use DBIx::Class::Schema::Loader to create a static DBIx::Class::Schema,
59 # and a Model which references it:
60 script/myapp_create.pl model CatalystModelName DBIC::Schema MyApp::SchemaClass create=static dbi:mysql:foodb myuname mypass
62 # Create a dynamic DBIx::Class::Schema::Loader-based Schema,
63 # and a Model which references it:
64 script/myapp_create.pl model CatalystModelName DBIC::Schema MyApp::SchemaClass create=dynamic dbi:mysql:foodb myuname mypass
66 # Reference an existing Schema of any kind, and provide some connection information for ->config:
67 script/myapp_create.pl model CatalystModelName DBIC::Schema MyApp::SchemaClass dbi:mysql:foodb myuname mypass
69 # Same, but don't supply connect information yet (you'll need to do this
70 # in your app config, or [not recommended] in the schema itself).
71 script/myapp_create.pl model ModelName DBIC::Schema My::SchemaClass
80 my ( $self, $helper, $schema_class, @connect_info) = @_;
82 $helper->{schema_class} = $schema_class
83 or croak "Must supply schema class name";
86 if($connect_info[0] && $connect_info[0] =~ /^create=(dynamic|static)$/) {
92 $helper->{setup_connect_info} = 1;
93 my @helper_connect_info = @connect_info;
94 for(@helper_connect_info) {
95 $_ = qq{'$_'} if $_ !~ /^\s*[[{]/;
97 $helper->{connect_info} = \@helper_connect_info;
100 if($create eq 'dynamic') {
101 my @schema_parts = split(/\:\:/, $helper->{schema_class});
102 my $schema_file_part = pop @schema_parts;
104 my $schema_dir = File::Spec->catfile( $helper->{base}, 'lib', @schema_parts );
105 my $schema_file = File::Spec->catfile( $schema_dir, $schema_file_part . '.pm' );
107 $helper->mk_dir($schema_dir);
108 $helper->render_file( 'schemaclass', $schema_file );
110 elsif($create eq 'static') {
111 my $schema_dir = File::Spec->catfile( $helper->{base}, 'lib' );
112 DBIx::Class::Schema::Loader->use("dump_to_dir:$schema_dir", 'make_schema_at')
113 or croak "Cannot load DBIx::Class::Schema::Loader: $@";
115 my @loader_connect_info = @connect_info;
116 my $num = 6; # argument number on the commandline for "dbi:..."
117 for(@loader_connect_info) {
120 croak "Perl syntax error in commandline argument $num: $@" if $@;
125 # Check if we need to be backward-compatible.
128 my @schema_pm = split '::', $schema_class;
129 $schema_pm[-1] .= '.pm';
130 my $schema_file = File::Spec->catfile($helper->{base}, 'lib', @schema_pm);
132 if (-f $schema_file) {
133 my $schema_code = do { local (@ARGV, $/) = $schema_file; <> };
134 $compatible = 1 if $schema_code =~ /->load_classes/;
140 { relationships => 1 },
141 \@loader_connect_info,
143 } else { # use some saner defaults
149 components => ['InflateColumn::DateTime']
151 \@loader_connect_info,
156 my $file = $helper->{file};
157 $helper->render_file( 'compclass', $file );
162 General Catalyst Stuff:
164 L<Catalyst::Manual>, L<Catalyst::Test>, L<Catalyst::Request>,
165 L<Catalyst::Response>, L<Catalyst::Helper>, L<Catalyst>,
167 Stuff related to DBIC and this Model style:
169 L<DBIx::Class>, L<DBIx::Class::Schema>,
170 L<DBIx::Class::Schema::Loader>, L<Catalyst::Model::DBIC::Schema>
174 Brandon L Black, C<blblack@gmail.com>
178 This library is free software, you can redistribute it and/or modify
179 it under the same terms as Perl itself.
190 package [% schema_class %];
193 use base qw/DBIx::Class::Schema::Loader/;
195 __PACKAGE__->loader_options(
202 [% schema_class %] - DBIx::Class::Schema::Loader class
210 Generated by L<Catalyst::Model::DBIC::Schema> for use in L<[% class %]>
218 This library is free software, you can redistribute it and/or modify
219 it under the same terms as Perl itself.
229 use base 'Catalyst::Model::DBIC::Schema';
232 schema_class => '[% schema_class %]',
233 [% IF setup_connect_info %]connect_info => [
234 [% FOREACH arg = connect_info %][% arg %],
241 [% class %] - Catalyst DBIC Schema Model
248 L<Catalyst::Model::DBIC::Schema> Model using schema L<[% schema_class %]>
256 This library is free software, you can redistribute it and/or modify
257 it under the same terms as Perl itself.