1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml">
7 <title>DBIx::Class (aka DBIC)</title>
9 <meta name="contributor" content="youcan[64]netzgesta[46]de" />
10 <meta name="publisher" content="s5.netzgesta.de" />
11 <meta name="description" content="S5 1.3 is a very flexible and lightweight slide show system available for anyone to use (including transitions and scalable fonts and images)" />
12 <meta name="keywords" content="S5, version 1.3, slide show, presentation-mode, projection-mode, powerpoint-like, scala-like, keynote-like, incremental display, scalable fonts, scalable images, transitions, notes, osf, xoxo, css, javascript, xhtml, public domain" />
14 <meta name="generator" content="S5" />
15 <meta name="version" content="1" />
16 <meta name="subject" content="DBIx::Class" />
17 <meta name="author" content="See first slide" />
18 <meta name="company" content="N/A" />
19 <meta name="robots" content="index, follow" />
20 <meta name="revisit-after" content="7 days" />
21 <!-- meta additionally -->
22 <meta http-equiv="content-type" content="text/html; charset=utf-8" />
23 <meta http-equiv="Content-Script-Type" content="text/javascript" />
24 <meta http-equiv="Content-Style-Type" content="text/css" /><!-- configuration parameters -->
25 <meta name="defaultView" content="slideshow" />
26 <meta name="controlVis" content="hidden" />
27 <!-- configuration transition extension -->
28 <meta name="tranSitions" content="true" />
29 <meta name="fadeDuration" content="500" />
30 <meta name="incrDuration" content="250" />
31 <!-- configuration autoplay extension -->
32 <meta name="autoMatic" content="false" />
33 <meta name="playLoop" content="true" />
34 <meta name="playDelay" content="10" />
35 <!-- configuration audio extension -->
36 <meta name="audioSupport" content="false" />
37 <meta name="audioVolume" content="0" />
38 <meta name="audioError" content="false" />
39 <!-- configuration audio debug -->
40 <meta name="audioDebug" content="false" />
41 <!-- style sheet links -->
42 <link rel="stylesheet" href="ui/scala_utf/slides.css" type="text/css" media="projection" id="slideProj" />
43 <link rel="stylesheet" href="ui/scala_utf/outline.css" type="text/css" media="screen" id="outlineStyle" />
44 <link rel="stylesheet" href="ui/scala_utf/print.css" type="text/css" media="print" id="slidePrint" />
45 <link rel="stylesheet" href="ui/scala_utf/opera.css" type="text/css" media="projection" id="operaFix" />
46 <!-- embedded styles -->
47 <style type="text/css" media="all">
48 .imgcon {width: 100%; margin: 0 auto; padding: 0; text-align: center;}
49 #anim {width: 33%; height: 320px; position: relative;}
50 #anim img {position: absolute; top: 0px; left: 0px;}
55 <script src="ui/scala_utf/slides.js" type="text/javascript"></script>
60 <div id="controls"><!-- DO NOT EDIT --></div>
61 <div id="currentSlide"><!-- DO NOT EDIT --></div>
62 <div id="header"></div>
64 <h1>DBIx::Class Introduction</h1>
65 <h2>YAPC::NA 2010</h2>
69 <div class="presentation">
72 <h1>DBIX::Class (aka DBIC)</h1>
73 <h3>for (advanced) beginners</h3>
79 <li>IRC: irc.perl.org #dbix-class</li>
80 <li>ML: <a href="http://lists.scsys.co.uk/mailman/listinfo/dbix-class">http://lists.scsys.co.uk/mailman/listinfo/dbix-class</a></li>
81 <li><a href="http://search.cpan.org/perldoc?DBIx::Class">DBIx::Class</a> yo</li>
87 <h4>Originally Leo Lapworth @ LPW 2009</h4>
88 <h4>Amiri Barksdale</h4>
89 <h4>Justin D. Hunter</h4>
90 <h4>Arthur Axel "fREW" Schmidt</h4>
94 <h1>What's up guys?</h1>
95 <ul class="incremental">
96 <li>How many people have used any ORM?</li><ul class="incremental">
97 <li>In Perl?<ul class="incremental">
105 <li>(N)Hibernate?</li>
112 <p>The purpose of this talk is to show you as many features of
113 DBIx::Class in 40 minutes so that when you need to do something with
114 it later you will know what's possible</p>
115 <ul class="incremental">
116 <li>Note: links in slides are so you can find docs for what I'm talking about later</li>
121 <h1>DBIx::Class?</h1>
123 <li>ORM (object relational mapper)</li>
124 <li>SQL <-> OO (using objects instead of SQL)</li>
125 <li>There are many ORMs, DBIx::Class just happens to be the best in Perl (personal opinion)</li>
131 <p>These are reasons that are not technical or inherent to
132 the code of DBIC, but are totally awesome things about it.</p>
136 <h1>Large Community</h1>
137 <p>Currently there are 88 people listed as contributors to DBIC. That
138 ranges from documentation help, to test help, to added features,
139 to entire database support.</p>
143 <h1>Active Community</h1>
144 <p>Currently (June 9, 2010) 6 active branches (commited to in the last two weeks) in git. Last release (0.08122) had 14 new features, and 16 bug fixes. Of course that <a href="http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=dbsrgits/DBIx-Class.git;a=blob;f=Changes">ebbs and flows</a>.</p>
148 <h1>Responsive Community</h1>
149 <ul class="incremental">
150 <li>needed MSSQL order-by support, they helped me add support</li>
151 <li>generally very welcoming of people willing to help</li>
157 <p>These are things that are in most other ORMs, but are still reasons
158 to use DBIC over raw SQL.</p>
163 <p>The vast majority of code should run on all databases without needing tweaking</p>
168 <ul class="incremental">
169 <li><strong>C</strong> - Create</li>
170 <li><strong>R</strong> - Read</li>
171 <li><strong>U</strong> - Update</li>
172 <li><strong>D</strong> - Delete</li>
178 <pre>my $sth = $dbh->prepare('
185 'A book title', $author_id
190 <h1>DBIC: Create</h1>
191 <pre>my $book = $book_rs-><a href="http://search.cpan.org/perldoc?DBIx::Class::ResultSet#create">create</a>({
192 title => 'A book title',
193 author_id => $author_id,
195 <ul class="incremental">
196 <li>No need to pair placeholders and values</li>
197 <li>Automatically gets autoincremented id for you</li>
198 <li>Transparently uses INSERT ... RETURNING for databases that support it</li>
204 <pre>my $sth = $dbh->prepare('
206 authors.name as author_name
208 WHERE books.author = authors.id
211 while( my $book = $sth->fetchrow_hashref() ) {
215 . $book->{author_name}
222 <pre>my $book = $book_rs-><a href="http://search.cpan.org/perldoc?DBIx::Class::ResultSet#find">find</a>($book_id);
224 my $book = $book_rs-><a href="http://search.cpan.org/perldoc?DBIx::Class::ResultSet#search">search</a>({
225 title => 'A book title',
226 }, { rows => 1 })-><a href="http://search.cpan.org/perldoc?DBIx::Class::ResultSet#next">next</a>;
228 my @books = $book_rs->search({
229 author => $author_id,
230 })-><a href="http://search.cpan.org/perldoc?DBIx::Class::ResultSet#all">all</a>;
232 while( my $book = $books_rs->next ) {
236 . $book->author->name
240 <ul class="incremental">
247 <pre>my $update = $dbh->prepare('
254 'New title',<strong>$book_id</strong>
259 <h1>DBIC: Update</h1>
260 <pre>$book-><a href="http://search.cpan.org/perldoc?DBIx::Class::Row#update">update</a>({
261 title => 'New title',
263 <ul class="incremental">
264 <li>Won't update unless value changes</li>
270 <pre>my $delete = $dbh->prepare('
275 $delete->execute(<strong>$book_id</strong>);</pre>
279 <h1>DBIC: Delete</h1>
280 <pre>$book-><a href="http://search.cpan.org/perldoc?DBIx::Class::Row#delete">delete</a>;</pre>
284 <h1>OO Overidability</h1>
285 <ul class="incremental">
286 <li>Override new if you want to do validation</li>
287 <li>Override delete if you want to disable deletion</li>
288 <li>and on and on</li>
291 <p>I got yelled at about this before by people, so
292 we don't get EVERYTHING from OO, but we do get a lot
298 <h1>Convenience Methods</h1>
299 <ul class="incremental">
300 <li><a href="http://search.cpan.org/perldoc?DBIx::Class::ResultSet#find_or_create">find_or_create</a></li>
301 <li><a href="http://search.cpan.org/perldoc?DBIx::Class::ResultSet#update_or_create">update_or_create</a></li>
306 <h1>Non-column methods</h1>
307 <p>Need a method to get a user's gravatar URL? Add a
308 gravatar_url method to their Result class</p>
312 <h1>RELATIONSHIPS</h1>
313 <ul class="incremental">
314 <li><a href="http://search.cpan.org/perldoc?DBIx::Class::Relationship#belongs_to">belongs_to</a></li>
315 <li><a href="http://search.cpan.org/perldoc?DBIx::Class::Relationship#has_many">has_many</a></li>
316 <li><a href="http://search.cpan.org/perldoc?DBIx::Class::Relationship#might_have">might_have</a></li>
317 <li><a href="http://search.cpan.org/perldoc?DBIx::Class::Relationship#has_one">has_one</a></li>
318 <li><a href="http://search.cpan.org/perldoc?DBIx::Class::Relationship#many_to_many">many_to_many</a> (technically not a relationship)</li>
319 <li>SET AND FORGET</li>
324 <h1>DBIx::Class Specific Features</h1>
325 <p>These things may be in other ORM's, but they are very specific, so doubtful</p>
331 <pre>my $schema = Foo::Schema->connect(
334 $schema-><a href="http://search.cpan.org/perldoc?DBIx::Class::Schema#deploy">deploy</a>
336 <p>See also: <a href="http://search.cpan.org/perldoc?DBIx::Class::DeploymentHandler">DBIx::Class::DeploymentHandler</a></p>
340 <h1>Schema::Loader</h1>
342 <pre>package Foo::Schema;
343 use strict; use warnings;
344 use base '<a href="http://search.cpan.org/perldoc?DBIx::Class::Schema::Loader">DBIx::Class::Schema::Loader</a>';
345 __PACKAGE__-><a href="http://search.cpan.org/perldoc?DBIx::Class::Schema::Loader::Base#CONSTRUCTOR_OPTIONS">loader_options</a>({
347 debug => $ENV{DBIC_TRACE},
353 my $schema = Foo::Schema->connect(
361 <p>Made for inserting lots of rows very quicky into database</p>
362 <pre>$schema-><a href="http://search.cpan.org/perldoc?DBIx::Class::Schema#populate">populate</a>([ Users =>
363 [qw( username password )],
364 [qw( frew >=4char$ )],
369 <ul class="incremental">
370 <li>I use this to <a href="http://blog.afoolishmanifesto.com/archives/1255">export our whole (200M~) db to SQLite</a></li>
376 <p>Create an object and all of it's related objects all at once</p>
377 <pre>$schema->resultset('Author')-><a href="http://search.cpan.org/perldoc?DBIx::Class::ResultSet#create">create</a>({
378 name => 'Stephen King',
379 books => [{ title => 'The Dark Tower' }],
381 street => '123 Turtle Back Lane',
382 state => { abbreviation => 'ME' },
383 city => { name => 'Lowell' },
389 <li>books is a has_many</li>
390 <li>address is a belongs_to which in turn belongs to state and city each</li>
391 <li>for this to work right state and city must mark abbreviation and name as unique</li>
398 <p>DBIx::Class helped pioneer fast MI in Perl 5 with Class::C3, so it is made
399 to allow extensions to nearly every part of it.</p>
403 <h1>Extensible: DBIC::Helpers</h1>
404 <ul class="incremental">
405 <li><a href="http://search.cpan.org/perldoc?DBIx::Class::Helper::ResultSet::IgnoreWantarray">DBIC::Helper::ResultSet::IgnoreWantarray</a></li>
406 <li><a href="http://search.cpan.org/perldoc?DBIx::Class::Helper::ResultSet::Random">DBIC::Helper::ResultSet::Random</a></li>
407 <li><a href="http://search.cpan.org/perldoc?DBIx::Class::Helper::ResultSet::SetOperations">DBIC::Helper::ResultSet::SetOperations</a></li>
408 <li><a href="http://search.cpan.org/perldoc?DBIx::Class::Helper::ResultSet::JoinTable">DBIC::Helper::Row::JoinTable</a></li>
409 <li><a href="http://search.cpan.org/perldoc?DBIx::Class::Helper::ResultSet::NumifyGet">DBIC::Helper::Row::NumifyGet</a></li>
410 <li><a href="http://search.cpan.org/perldoc?DBIx::Class::Helper::ResultSet::SubClass">DBIC::Helper::Row::SubClass</a></li>
411 <li><a href="http://search.cpan.org/perldoc?DBIx::Class::Helper::ResultSet::ToJSON">DBIC::Helper::Row::ToJSON</a></li>
416 <h1>Extensible: <a href="http://search.cpan.org/perldoc?DBIx::Class::TimeStamp">DBIC::TimeStamp</a></h1>
417 <ul class="incremental">
419 <li>set_on_create</li>
420 <li>set_on_update</li>
425 <h1>Extensible: Kioku</h1>
426 <ul class="incremental">
427 <li><a href="http://search.cpan.org/perldoc?DBIx::Class::Schema::KiokuDB">DBIx::Class::Schema::KiokuDB</a></li>
428 <li>Kioku is the new hotness</li>
429 <li>Mix RDBMS with Object DB</li>
430 <li>beta ( == sexy )</li>
435 <h1><a href="http://search.cpan.org/perldoc?SQL::Abstract">SQL::Abstract</a></h1>
436 <pre>my $resultset = $book_rs->search({
437 name => { -like => "%$nick%" },
439 <ul class="incremental">
440 <li>(kinda) introspectible</li>
441 <li>Prettier than SQL</li>
446 <h1>Result vs ResultSet</h1>
447 <ul class="incremental">
448 <li>Result == Row</li>
449 <li>ResultSet == Query Plan<ul class="incremental">
450 <li>Internal Join Optimizer for all DB's (!!!)</li>
452 <li>(less important but...)</li>
453 <li>ResultSource == Table</li>
454 <li>Storage == Database</li>
459 <h1><a href="http://search.cpan.org/perldoc?DBIx::Class::Manual::Cookbook#Predefined_searches">ResultSet methods</a></h1>
460 <pre>package MyApp::Schema::ResultSet::Book;
461 use base 'DBIx::Class::ResultSet';
465 $self->current_source_alias .
466 '.rating' => { '>=' => 4 },
472 $self->current_source_alias .
473 '.price' => { '<=' => 5}
482 <h1>ResultSet method notes</h1>
483 <ul class="incremental">
484 <li>All searches should be ResultSet methods</li>
485 <li>Name has obvious meaning</li>
486 <li><a href="http://search.cpan.org/perldoc?DBIx::Class::ResultSet#current_source_alias">current_source_alias</a> helps things to work no matter what</li>
491 <h1>ResultSet method in Action</h1>
492 <pre>$schema->resultset('Book')->good</pre>
496 <h1>ResultSet Chaining</h1>
497 <pre>$schema->resultset('Book')
505 <h1>search_related</h1>
506 <pre>my $score = $schema->resultset('User')
507 ->search({'me.userid' => 'frew'})
508 -><a href="http://search.cpan.org/perldoc?DBIx::Class::ResultSet#related_resultset">related_resultset</a>('access')
509 ->related_resultset('mgmt')
510 ->related_resultset('orders')
512 -><a href="http://search.cpan.org/perldoc?DBIx::Class::ResultSet#search_related">search_related</a>( shops => {
513 'shops.datecompleted' => {
514 -between => ['2009-10-01','2009-10-08']
517 ->related_resultset('rpt_score')
518 -><a href="http://search.cpan.org/perldoc?DBIx::Class::ResultSet#get_column">get_column</a>('raw_scores')
524 <h1>bonus rel methods</h1>
525 <pre>my $book = $author-><a href="http://search.cpan.org/perldoc?DBIx::Class::Relationship::Base#create_related">create_related</a>(
526 <strong>books</strong> => {
527 title => 'Another Discworld book',
531 my $book2 = $pratchett-><a href="http://search.cpan.org/perldoc?DBIx::Class::Relationship::Base#add_to_$rel">add_to_<strong>books</strong></a>({
532 title => 'MOAR Discworld book',
534 <ul class="incremental">
535 <li>Automaticaly fills in foreign key for you</li>
540 <h1>Excellent Transaction Support</h1>
541 <pre>$schema-><a href="http://search.cpan.org/perldoc?DBIx::Class::Schema#txn_do">txn_do</a>(sub {
545 my $guard = $schema-><a href="http://search.cpan.org/perldoc?DBIx::Class::Schema#txn_scope_guard">txn_scope_guard</a>;
549 $schema-><a href="http://search.cpan.org/perldoc?DBIx::Class::Schema#txn_begin">txn_begin</a>; # <-- low level
551 $schema-><a href="http://search.cpan.org/perldoc?DBIx::Class::Schema#txn_commit">txn_commit</a>;
556 <h1>InflateColumn</h1>
557 <pre>package Foo::Schema::Result::Book;
558 use base 'DBIx::Class::Core';
559 use DateTime::Format::MySQL;
561 __PACKAGE__->load_components('<a href="http://search.cpan.org/perldoc?DBIx::Class::InflateColumn">InflateColumn</a>');
562 __PACKAGE__-><strong><a href="http://search.cpan.org/perldoc?DBIx::Class::InflateColumn#inflate_column">inflate_column</a></strong>(
563 <strong>date_published</strong> => {
565 DateTime::Format::MySQL->parse_date(
569 deflate => sub { shift->ymd },
572 # Automatic see: DBIC::InflateColumn::DateTime</pre>
576 <h1>InflateColumn: deflation</h1>
577 <pre>$book->date_published(DateTime->now);
578 $book->update;</pre>
582 <h1>InflateColumn: inflation</h1>
583 <pre>say $book->date_published->month_abbr;</pre>
585 <strong><em>Nov</em></strong>
589 <h1>FilterColumn</h1>
590 <pre>package Foo::Schema::Result::Book;
591 use base 'DBIx::Class::Core';
593 __PACKAGE__->load_components('<a href="http://search.cpan.org/perldoc?DBIx::Class::FilterColumn">FilterColumn</a>');
595 __PACKAGE__-><strong><a href="http://search.cpan.org/perldoc?DBIx::Class::FilterColumn#filter_column">filter_column</a></strong>(
596 <strong>length</strong> => {
597 to_storage => 'to_metric',
598 from_storage => 'to_imperial',
602 sub to_metric { $_[1] * .305 }
603 sub to_imperial { $_[1] * 3.28 }
607 <h1><a href="http://search.cpan.org/perldoc?DBIx::Class::ResultSetColumn">ResultSetColumn</a></h1>
608 <pre>my $rsc = $schema->resultset('Book')
609 ->get_column('price');
620 <pre>my @res = $rs->search({}, {
621 <a href="http://search.cpan.org/perldoc?DBIx::Class::ResultSet#select">select</a> => [
627 <a href="http://search.cpan.org/perldoc?DBIx::Class::ResultSet#as">as</a> => [
628 qw(price genre max_price avg_price)
630 <a href="http://search.cpan.org/perldoc?DBIx::Class::ResultSet#group_by">group_by</a> => [qw(price genre)],
633 say $_->price . ' ' . $_->genre;
634 say $_->get_column('max_price');
635 say $_->get_column('min_price');
640 <h1>Aggregates Notes</h1>
641 <ul class="incremental">
642 <li>Careful, get_column can basicaly mean THREE things</li>
643 <li>private for get what you should use an accessor for</li>
644 <li>public for what there is no accessor for</li>
645 <li>public for get resultset column (prev slide)</li>
651 <pre>$rs->search({}, {
652 <a href="http://search.cpan.org/perldoc?DBIx::Class::ResultSet#result_class">result_class</a> =>
653 '<a href="http://search.cpan.org/perldoc?DBIx::Class::ResultClass::HashRefInflator">DBIx::Class::ResultClass::HashRefInflator</a>',
655 <ul class="incremental">
656 <li>Easy on memory</li>
658 <li>Great for quick debugging</li>
659 <li>Great for performance tuning (we went from 2m to < 3s)</li>
664 <h1><a href="http://search.cpan.org/perldoc?DBIx::Class::Manual::Cookbook#Subqueries">Subquery</a> Support</h1>
665 <pre>my $inside_query = $schema->resultset('Artist')
667 name => [ 'Billy Joel', 'Brittany Spears' ],
668 })->get_column('id')->as_query;
670 my $rs = $schema->resultset('CD')->search({
671 artist_id => { -in => $inside_query },
676 <h1><a href="http://search.cpan.org/perldoc?SQL::Abstract#Literal_SQL_with_placeholders_and_bind_values_(subqueries)">Bare SQL w/ Placeholders</a></h1>
677 <pre>$rs->update({
678 # !!! SQL INJECTION VECTOR
679 price => \"price + $inc",
683 price => \['price + ?', [inc => $inc]],