X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FManual%2FCookbook.pod;h=678e173cacf7d516c4f5498c3a3a98bbe942855c;hb=6ffb5be522e752ea1ad2a99d36648535fe30a43b;hp=70e645cac577fd4e8277dee95d55634fceba135a;hpb=e60dc79fcd4d6318e83584b826526e65048b86a9;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class/Manual/Cookbook.pod b/lib/DBIx/Class/Manual/Cookbook.pod index 70e645c..678e173 100644 --- a/lib/DBIx/Class/Manual/Cookbook.pod +++ b/lib/DBIx/Class/Manual/Cookbook.pod @@ -2,14 +2,12 @@ DBIx::Class::Manual::Cookbook - Miscellaneous recipes -=head1 RECIPES +=head1 SEARCHING -=head2 Searching - -=head3 Paged results +=head2 Paged results When you expect a large number of results, you can ask L for a -paged resultset, which will fetch only a small number of records at a time: +paged resultset, which will fetch only a defined number of records at a time: my $rs = $schema->resultset('Artist')->search( undef, @@ -32,12 +30,12 @@ The C attribute does not have to be specified in your search: return $rs->page(1); # DBIx::Class::ResultSet containing first 10 records -In either of the above cases, you can return a L object for the +In either of the above cases, you can get a L object for the resultset (suitable for use in e.g. a template) using the C method: return $rs->pager(); -=head3 Complex WHERE clauses +=head2 Complex WHERE clauses Sometimes you need to formulate a query using specific operators: @@ -70,7 +68,42 @@ This results in the following C clause: For more information on generating complex queries, see L. -=head3 Arbitrary SQL through a custom ResultSource +=head2 Retrieve one and only one row from a resultset + +Sometimes you need only the first "top" row of a resultset. While this can be +easily done with L<< $rs->first|DBIx::Class::ResultSet/first >>, it is suboptimal, +as a full blown cursor for the resultset will be created and then immediately +destroyed after fetching the first row object. +L<< $rs->single|DBIx::Class::ResultSet/single >> is +designed specifically for this case - it will grab the first returned result +without even instantiating a cursor. + +Before replacing all your calls to C with C please observe the +following CAVEATS: + +=over + +=item * +While single() takes a search condition just like search() does, it does +_not_ accept search attributes. However one can always chain a single() to +a search(): + + my $top_cd = $cd_rs -> search({}, { order_by => 'rating' }) -> single; + + +=item * +Since single() is the engine behind find(), it is designed to fetch a +single row per database query. Thus a warning will be issued when the +underlying SELECT returns more than one row. Sometimes however this usage +is valid: i.e. we have an arbitrary number of cd's but only one of them is +at the top of the charts at any given time. If you know what you are doing, +you can silence the warning by explicitly limiting the resultset size: + + my $top_cd = $cd_rs -> search ({}, { order_by => 'rating', rows => 1 }) -> single; + +=back + +=head2 Arbitrary SQL through a custom ResultSource Sometimes you have to run arbitrary SQL because your query is too complex (e.g. it contains Unions, Sub-Selects, Stored Procedures, etc.) or has to @@ -108,7 +141,7 @@ you have to add to your User class: SQL # Finally, register your new ResultSource with your Schema - My::Schema->register_source( 'UserFriendsComplex' => $new_source ); + My::Schema->register_extra_source( 'UserFriendsComplex' => $new_source ); Next, you can execute your complex query using bind parameters like this: @@ -118,9 +151,38 @@ Next, you can execute your complex query using bind parameters like this: } ) ]; -... and you'll get back a perfect L. +... and you'll get back a perfect L (except, of course, +that you cannot modify the rows it contains, ie. cannot call L, +L, ... on it). + +If you prefer to have the definitions of these custom ResultSources in separate +files (instead of stuffing all of them into the same resultset class), you can +achieve the same with subclassing the resultset class and defining the +ResultSource there: + + package My::Schema::UserFriendsComplex; + + use My::Schema::User; + use base qw/My::Schema::User/; + + __PACKAGE__->table('dummy'); # currently must be called before anything else -=head3 Using specific columns + # Hand in your query as a scalar reference + # It will be added as a sub-select after FROM, + # so pay attention to the surrounding brackets! + __PACKAGE__->name( \< to specify which ones you need. This is useful to avoid @@ -140,7 +202,7 @@ use anyway: This is a shortcut for C and C. -=head3 Using database functions or stored procedures +=head2 Using database functions or stored procedures The combination of C to @@ -184,7 +246,7 @@ any of your aliases using either of these: # Or use DBIx::Class::AccessorGroup: __PACKAGE__->mk_group_accessors('column' => 'name_length'); -=head3 SELECT DISTINCT with multiple columns +=head2 SELECT DISTINCT with multiple columns my $rs = $schema->resultset('Foo')->search( {}, @@ -196,9 +258,7 @@ any of your aliases using either of these: } ); - my $count = $rs->next->get_column('count'); - -=head3 SELECT COUNT(DISTINCT colname) +=head2 SELECT COUNT(DISTINCT colname) my $rs = $schema->resultset('Foo')->search( {}, @@ -210,7 +270,9 @@ any of your aliases using either of these: } ); -=head3 Grouping results + my $count = $rs->next->get_column('count'); + +=head2 Grouping results L supports C as follows: @@ -218,22 +280,71 @@ L supports C as follows: {}, { join => [qw/ cds /], - select => [ 'name', { count => 'cds.cdid' } ], + select => [ 'name', { count => 'cds.id' } ], as => [qw/ name cd_count /], group_by => [qw/ name /] } ); # Equivalent SQL: - # SELECT name, COUNT( cds.cdid ) FROM artist me - # LEFT JOIN cd cds ON ( cds.artist = me.artistid ) + # SELECT name, COUNT( cd.id ) FROM artist + # LEFT JOIN cd ON artist.id = cd.artist # GROUP BY name Please see L documentation if you are in any way unsure about the use of the attributes above (C< join >, C< select >, C< as > and C< group_by >). -=head3 Predefined searches +=head2 Subqueries + +You can write subqueries relatively easily in DBIC. + + my $inside_rs = $schema->resultset('Artist')->search({ + name => [ 'Billy Joel', 'Brittany Spears' ], + }); + + my $rs = $schema->resultset('CD')->search({ + artist_id => { 'IN' => $inside_rs->get_column('id')->as_query }, + }); + +The usual operators ( =, !=, IN, NOT IN, etc) are supported. + +B: You have to explicitly use '=' when doing an equality comparison. +The following will B work: + + my $rs = $schema->resultset('CD')->search({ + artist_id => $inside_rs->get_column('id')->as_query, + }); + +=head3 Correlated subqueries + + my $cdrs = $schema->resultset('CD'); + my $rs = $cdrs->search({ + year => { + '=' => $cdrs->search( + { artistid => { '=' => \'me.artistid' } }, + { alias => 'inner' } + )->get_column('year')->max_rs->as_query, + }, + }); + +That creates the following SQL: + + SELECT me.cdid, me.artist, me.title, me.year, me.genreid, me.single_track + FROM cd me + WHERE year = ( + SELECT MAX(inner.year) + FROM cd inner + WHERE artistid = me.artistid + ) + +=head2 Where subqueries will work + +Currently, subqueries will B work in the where-clause of a search. In +other words, in the first hashref of a search() method. Work is being done +to make them work as part of the second hashref (from, select, +select, etc). + +=head2 Predefined searches You can write your own L class by inheriting from it and define often used searches as methods: @@ -257,12 +368,52 @@ and define often used searches as methods: To use your resultset, first tell DBIx::Class to create an instance of it for you, in your My::DBIC::Schema::CD class: + # class definition as normal + __PACKAGE__->load_components(qw/ Core /); + __PACKAGE__->table('cd'); + + # tell DBIC to use the custom ResultSet class __PACKAGE__->resultset_class('My::DBIC::ResultSet::CD'); +Note that C must be called after C and C, or you will get errors about missing methods. + Then call your new method in your code: my $ordered_cds = $schema->resultset('CD')->search_cds_ordered(); +=head2 Using SQL functions on the left hand side of a comparison + +Using SQL functions on the left hand side of a comparison is generally +not a good idea since it requires a scan of the entire table. However, +it can be accomplished with C when necessary. + +If you do not have quoting on, simply include the function in your search +specification as you would any column: + + $rs->search({ 'YEAR(date_of_birth)' => 1979 }); + +With quoting on, or for a more portable solution, use the C +attribute: + + $rs->search({}, { where => \'YEAR(date_of_birth) = 1979' }); + +=begin hidden + +(When the bind args ordering bug is fixed, this technique will be better +and can replace the one above.) + +With quoting on, or for a more portable solution, use the C and +C attributes: + + $rs->search({}, { + where => \'YEAR(date_of_birth) = ?', + bind => [ 1979 ] + }); + +=end hidden + +=head1 JOINS AND PREFETCHING + =head2 Using joins and prefetch You can use the C attribute to allow searching on, or sorting your @@ -274,7 +425,7 @@ a particular artist name: 'artist.name' => 'Bob Marley' }, { - join => [qw/artist/], # join the artist table + join => 'artist', # join the artist table } ); @@ -291,10 +442,10 @@ it in your C attribute: 'artist.name' => 'Bob Marley' }, { - join => [qw/ artist /], + join => 'artist', order_by => [qw/ artist.name /] } - }; + ); # Equivalent SQL: # SELECT cd.* FROM cd @@ -332,9 +483,9 @@ This allows you to fetch results from related tables in advance: 'artist.name' => 'Bob Marley' }, { - join => [qw/ artist /], + join => 'artist', order_by => [qw/ artist.name /], - prefetch => [qw/ artist /] # return artist data too! + prefetch => 'artist' # return artist data too! } ); @@ -361,7 +512,35 @@ Also note that C should only be used when you know you will definitely use data from a related table. Pre-fetching related tables when you only need columns from the main table will make performance worse! -=head3 Multi-step joins +=head2 Multiple joins + +In the examples above, the C attribute was a scalar. If you +pass an array reference instead, you can join to multiple tables. In +this example, we want to limit the search further, using +C: + + # Relationships defined elsewhere: + # CD->belongs_to('artist' => 'Artist'); + # CD->has_one('liner_notes' => 'LinerNotes', 'cd'); + my $rs = $schema->resultset('CD')->search( + { + 'artist.name' => 'Bob Marley' + 'liner_notes.notes' => { 'like', '%some text%' }, + }, + { + join => [qw/ artist liner_notes /], + order_by => [qw/ artist.name /], + } + ); + + # Equivalent SQL: + # SELECT cd.*, artist.*, liner_notes.* FROM cd + # JOIN artist ON cd.artist = artist.id + # JOIN liner_notes ON cd.id = liner_notes.cd + # WHERE artist.name = 'Bob Marley' + # ORDER BY artist.name + +=head2 Multi-step joins Sometimes you want to join more than one relationship deep. In this example, we want to find all C objects who have Cs whose C @@ -384,8 +563,8 @@ contain a specific string: # Equivalent SQL: # SELECT artist.* FROM artist - # JOIN ( cd ON artist.id = cd.artist ) - # JOIN ( liner_notes ON cd.id = liner_notes.cd ) + # LEFT JOIN cd ON artist.id = cd.artist + # LEFT JOIN liner_notes ON cd.id = liner_notes.cd # WHERE liner_notes.notes LIKE '%some text%' Joins can be nested to an arbitrary level. So if we decide later that we @@ -411,12 +590,39 @@ notes: # Equivalent SQL: # SELECT artist.* FROM artist - # JOIN ( cd ON artist.id = cd.artist ) - # JOIN ( liner_notes ON cd.id = liner_notes.cd ) - # JOIN ( author ON author.id = liner_notes.author ) + # LEFT JOIN cd ON artist.id = cd.artist + # LEFT JOIN liner_notes ON cd.id = liner_notes.cd + # LEFT JOIN author ON author.id = liner_notes.author # WHERE liner_notes.notes LIKE '%some text%' # AND author.name = 'A. Writer' +=head2 Multi-step and multiple joins + +With various combinations of array and hash references, you can join +tables in any combination you desire. For example, to join Artist to +CD and Concert, and join CD to LinerNotes: + + # Relationships defined elsewhere: + # Artist->has_many('concerts' => 'Concert', 'artist'); + + my $rs = $schema->resultset('Artist')->search( + { }, + { + join => [ + { + cds => 'liner_notes' + }, + 'concerts' + ], + } + ); + + # Equivalent SQL: + # SELECT artist.* FROM artist + # LEFT JOIN cd ON artist.id = cd.artist + # LEFT JOIN liner_notes ON cd.id = liner_notes.cd + # LEFT JOIN concert ON artist.id = concert.artist + =head2 Multi-step prefetch From 0.04999_05 onwards, C can be nested more than one relationship @@ -433,8 +639,8 @@ deep using the same syntax as a multi-step join: # Equivalent SQL: # SELECT tag.*, cd.*, artist.* FROM tag - # JOIN cd ON tag.cd = cd.cdid - # JOIN artist ON cd.artist = artist.artistid + # JOIN cd ON tag.cd = cd.id + # JOIN artist ON cd.artist = artist.id Now accessing our C and C relationships does not need additional SQL statements: @@ -442,179 +648,32 @@ SQL statements: my $tag = $rs->first; print $tag->cd->artist->name; -=head2 Columns of data - -If you want to find the sum of a particular column there are several -ways, the obvious one is to use search: - - my $rs = $schema->resultset('Items')->search( - {}, - { - select => [ { sum => 'Cost' } ], - as => [ 'total_cost' ], # remember this 'as' is for DBIx::Class::ResultSet not SQL - } - ); - my $tc = $rs->first->get_column('total_cost'); - -Or, you can use the L, which gets -returned when you ask the C for a column using -C: - - my $cost = $schema->resultset('Items')->get_column('Cost'); - my $tc = $cost->sum; - -With this you can also do: - - my $minvalue = $cost->min; - my $maxvalue = $cost->max; - -Or just iterate through the values of this column only: - - while ( my $c = $cost->next ) { - print $c; - } - - foreach my $c ($cost->all) { - print $c; - } - -C only has a limited number of built-in functions, if -you need one that it doesn't have, then you can use the C method -instead: - - my $avg = $cost->func('AVERAGE'); - -This will cause the following SQL statement to be run: - - SELECT AVERAGE(Cost) FROM Items me - -Which will of course only work if your database supports this function. -See L for more documentation. - -=head2 Using relationships - -=head3 Create a new row in a related table - - my $book->create_related('author', { name => 'Fred'}); - -=head3 Search in a related table - -Only searches for books named 'Titanic' by the author in $author. - - my $author->search_related('books', { name => 'Titanic' }); - -=head3 Delete data in a related table - -Deletes only the book named Titanic by the author in $author. - - my $author->delete_related('books', { name => 'Titanic' }); - -=head3 Ordering a relationship result set - -If you always want a relation to be ordered, you can specify this when you -create the relationship. - -To order C<< $book->pages >> by descending page_number. - - Book->has_many('pages' => 'Page', 'book', { order_by => \'page_number DESC'} ); - - - -=head2 Transactions - -As of version 0.04001, there is improved transaction support in -L and L. Here is an -example of the recommended way to use it: - - my $genus = $schema->resultset('Genus')->find(12); - - my $coderef2 = sub { - $genus->extinct(1); - $genus->update; - }; - - my $coderef1 = sub { - $genus->add_to_species({ name => 'troglodyte' }); - $genus->wings(2); - $genus->update; - $schema->txn_do($coderef2); # Can have a nested transaction - return $genus->species; - }; - - my $rs; - eval { - $rs = $schema->txn_do($coderef1); - }; - - if ($@) { # Transaction failed - die "the sky is falling!" # - if ($@ =~ /Rollback failed/); # Rollback failed - - deal_with_failed_transaction(); - } - -Nested transactions will work as expected. That is, only the outermost -transaction will actually issue a commit to the $dbh, and a rollback -at any level of any transaction will cause the entire nested -transaction to fail. Support for savepoints and for true nested -transactions (for databases that support them) will hopefully be added -in the future. - -=head2 Many-to-many relationships - -This is straightforward using L: - - package My::DB; - # ... set up connection ... - - package My::User; - use base 'My::DB'; - __PACKAGE__->table('user'); - __PACKAGE__->add_columns(qw/id name/); - __PACKAGE__->set_primary_key('id'); - __PACKAGE__->has_many('user_address' => 'My::UserAddress', 'user'); - __PACKAGE__->many_to_many('addresses' => 'user_address', 'address'); - - package My::UserAddress; - use base 'My::DB'; - __PACKAGE__->table('user_address'); - __PACKAGE__->add_columns(qw/user address/); - __PACKAGE__->set_primary_key(qw/user address/); - __PACKAGE__->belongs_to('user' => 'My::User'); - __PACKAGE__->belongs_to('address' => 'My::Address'); - - package My::Address; - use base 'My::DB'; - __PACKAGE__->table('address'); - __PACKAGE__->add_columns(qw/id street town area_code country/); - __PACKAGE__->set_primary_key('id'); - __PACKAGE__->has_many('user_address' => 'My::UserAddress', 'address'); - __PACKAGE__->many_to_many('users' => 'user_address', 'user'); +=head1 ROW-LEVEL OPERATIONS - $rs = $user->addresses(); # get all addresses for a user - $rs = $address->users(); # get all users for an address +=head2 Retrieving a row object's Schema -=head2 Setting default values for a row +It is possible to get a Schema object from a row object like so: -It's as simple as overriding the C method. Note the use of -C. + my $schema = $cd->result_source->schema; + # use the schema as normal: + my $artist_rs = $schema->resultset('Artist'); - sub new { - my ( $self, $attrs ) = @_; +This can be useful when you don't want to pass around a Schema object to every +method. - $attrs->{foo} = 'bar' unless defined $attrs->{foo}; +=head2 Getting the value of the primary key for the last database insert - my $new = $class->next::method($attrs); +AKA getting last_insert_id - return $new; - } +If you are using PK::Auto (which is a core component as of 0.07), this is +straightforward: -For more information about C, look in the L -documentation. See also L for more -ways to write your own base classes to do this. + my $foo = $rs->create(\%blah); + # do more stuff + my $id = $foo->id; # foo->my_primary_key_field will also work. -People looking for ways to do "triggers" with DBIx::Class are probably -just looking for this. +If you are not using autoincrementing primary keys, this will probably +not work, but then you already know the value of the last primary key anyway. =head2 Stringification @@ -656,75 +715,548 @@ method to the class defining the Category table: return $self->Description; }, fallback => 1; -=head2 Disconnecting cleanly +=head2 Want to know if find_or_create found or created a row? -If you find yourself quitting an app with Control-C a lot during -development, you might like to put the following signal handler in -your main database class to make sure it disconnects cleanly: +Just use C instead, then check C: - $SIG{INT} = sub { - __PACKAGE__->storage->disconnect; - }; - -=head2 Schema import/export + my $obj = $rs->find_or_new({ blah => 'blarg' }); + unless ($obj->in_storage) { + $obj->insert; + # do whatever else you wanted if it was a new row + } -This functionality requires you to have L (also known as -"SQL Fairy") installed. +=head2 Dynamic Sub-classing DBIx::Class proxy classes -To create a DBIx::Class schema from an existing database: +AKA multi-class object inflation from one table + +L classes are proxy classes, therefore some different +techniques need to be employed for more than basic subclassing. In +this example we have a single user table that carries a boolean bit +for admin. We would like like to give the admin users +objects(L) the same methods as a regular user but +also special admin only methods. It doesn't make sense to create two +seperate proxy-class files for this. We would be copying all the user +methods into the Admin class. There is a cleaner way to accomplish +this. - sqlt --from DBI - --to DBIx::Class::File - --prefix "MySchema" > MySchema.pm +Overriding the C method within the User proxy-class +gives us the effect we want. This method is called by +L when inflating a result from storage. So we +grab the object being returned, inspect the values we are looking for, +bless it if it's an admin object, and then return it. See the example +below: + +B + + package DB::Schema; + + use base qw/DBIx::Class::Schema/; + + __PACKAGE__->load_classes(qw/User/); + + +B + + package DB::Schema::User; + + use strict; + use warnings; + use base qw/DBIx::Class/; + + ### Defined what our admin class is for ensure_class_loaded + my $admin_class = __PACKAGE__ . '::Admin'; + + __PACKAGE__->load_components(qw/Core/); + + __PACKAGE__->table('users'); + + __PACKAGE__->add_columns(qw/user_id email password + firstname lastname active + admin/); + + __PACKAGE__->set_primary_key('user_id'); + + sub inflate_result { + my $self = shift; + my $ret = $self->next::method(@_); + if( $ret->admin ) {### If this is an admin rebless for extra functions + $self->ensure_class_loaded( $admin_class ); + bless $ret, $admin_class; + } + return $ret; + } + + sub hello { + print "I am a regular user.\n"; + return ; + } + + + package DB::Schema::User::Admin; + + use strict; + use warnings; + use base qw/DB::Schema::User/; + + sub hello + { + print "I am an admin.\n"; + return; + } + + sub do_admin_stuff + { + print "I am doing admin stuff\n"; + return ; + } + +B test.pl + + use warnings; + use strict; + use DB::Schema; + + my $user_data = { email => 'someguy@place.com', + password => 'pass1', + admin => 0 }; + + my $admin_data = { email => 'someadmin@adminplace.com', + password => 'pass2', + admin => 1 }; + + my $schema = DB::Schema->connection('dbi:Pg:dbname=test'); + + $schema->resultset('User')->create( $user_data ); + $schema->resultset('User')->create( $admin_data ); + + ### Now we search for them + my $user = $schema->resultset('User')->single( $user_data ); + my $admin = $schema->resultset('User')->single( $admin_data ); + + print ref $user, "\n"; + print ref $admin, "\n"; + + print $user->password , "\n"; # pass1 + print $admin->password , "\n";# pass2; inherited from User + print $user->hello , "\n";# I am a regular user. + print $admin->hello, "\n";# I am an admin. + + ### The statement below will NOT print + print "I can do admin stuff\n" if $user->can('do_admin_stuff'); + ### The statement below will print + print "I can do admin stuff\n" if $admin->can('do_admin_stuff'); -To create a MySQL database from an existing L schema, convert the -schema to MySQL's dialect of SQL: +=head2 Skip row object creation for faster results - sqlt --from SQL::Translator::Parser::DBIx::Class - --to MySQL - --DBIx::Class "MySchema.pm" > Schema1.sql +DBIx::Class is not built for speed, it's built for convenience and +ease of use, but sometimes you just need to get the data, and skip the +fancy objects. -And import using the mysql client: +To do this simply use L. + + my $rs = $schema->resultset('CD'); + + $rs->result_class('DBIx::Class::ResultClass::HashRefInflator'); + + my $hash_ref = $rs->find(1); - mysql -h "host" -D "database" -u "user" -p < Schema1.sql +Wasn't that easy? -=head2 Easy migration from class-based to schema-based setup +=head2 Get raw data for blindingly fast results -You want to start using the schema-based approach to L -(see L), but have an established class-based setup with lots -of existing classes that you don't want to move by hand. Try this nifty script +If the L solution +above is not fast enough for you, you can use a DBIx::Class to return values +exactly as they come out of the data base with none of the convenience methods +wrapped round them. + +This is used like so: + + my $cursor = $rs->cursor + while (my @vals = $cursor->next) { + # use $val[0..n] here + } + +You will need to map the array offsets to particular columns (you can +use the I +and C instead of C + + my $rs = $schema->resultset('Dual')->search(undef, + { select => [ 'sydate' ], + as => [ 'now' ] + }, + ); + +All you have to do now is be careful how you access your resultset, the below +will not work because there is no column called 'now' in the Dual table class + + while (my $dual = $rs->next) { + print $dual->now."\n"; + } + # Can't locate object method "now" via package "MyAppDB::Dual" at headshot.pl line 23. + +You could of course use 'dummy' in C instead of 'now', or C to +your Dual class for whatever you wanted to select from dual, but that's just +silly, instead use C + + while (my $dual = $rs->next) { + print $dual->get_column('now')."\n"; + } + +Or use C + + my $cursor = $rs->cursor; + while (my @vals = $cursor->next) { + print $vals[0]."\n"; + } + +Or use L + + $rs->result_class('DBIx::Class::ResultClass::HashRefInflator'); + while ( my $dual = $rs->next ) { + print $dual->{now}."\n"; + } + +Here are some example C attribute of C to force ordering). +=head2 Statically Define Your Schema -=head2 Want to know if find_or_create found or created a row? +If you are using +L to build the +classes dynamically based on the database schema then there will be a +significant startup delay. -Just use C instead, then check C: +For production use a statically defined schema (which can be generated +using L to dump +the database schema once - see +L and +L for more +details on creating static schemas from a database). - my $obj = $rs->find_or_new({ blah => 'blarg' }); - unless ($obj->in_storage) { - $obj->insert; - # do whatever else you wanted if it was a new row - } +=head2 Move Common Startup into a Base Class -=head3 Wrapping/overloading a column accessor +Typically L result classes start off with -Problem: Say you have a table "Camera" and want to associate a description -with each camera. For most cameras, you'll be able to generate the description from -the other columns. However, in a few special cases you may want to associate a -custom description with a camera. + use base qw/DBIx::Class/; + __PACKAGE__->load_components(qw/InflateColumn::DateTime Core/); -Solution: +If this preamble is moved into a common base class:- -In your database schema, define a description field in the "Camera" table that -can contain text and null values. + package MyDBICbase; + + use base qw/DBIx::Class/; + __PACKAGE__->load_components(qw/InflateColumn::DateTime Core/); + 1; -In DBIC, we'll overload the column accessor to provide a sane default if no -custom description is defined. The accessor will either return or generate the -description, depending on whether the field is null or not. +and each result class then uses this as a base:- -First, in your "Camera" schema class, define the description field as follows: + use base qw/MyDBICbase/; - __PACKAGE__->add_columns(description => { accessor => '_description' }); +then the load_components is only performed once, which can result in a +considerable startup speedup for schemas with many classes. -Next, we'll define the accessor-wrapper subroutine: +=head2 Explicitly List Schema Result Classes - sub description { - my $self = shift; +The schema class will normally contain - # If there is an update to the column, we'll let the original accessor - # deal with it. - return $self->_description(@_) if @_; + __PACKAGE__->load_classes(); - # Fetch the column value. - my $description = $self->_description; +to load the result classes. This will use L +to find and load the appropriate modules. Explicitly defining the +classes you wish to load will remove the overhead of +L and the related directory operations:- - # If there's something in the description field, then just return that. - return $description if defined $description && length $descripton; + __PACKAGE__->load_classes(qw/ CD Artist Track /); - # Otherwise, generate a description. - return $self->generate_description; - } +If you are instead using the L +syntax to load the appropriate classes there is not a direct alternative +avoiding L. =cut