X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FPK%2FAuto.pm;h=c2bb440399247959af390c8128d9b5483d528ee7;hb=f0750722cda0ea1e7a6588075c6518642d1e48fc;hp=6928ba77e9decc78186e60425bd746a9145a67f8;hpb=773e30151b762903af9584a7943093170fdae91c;p=dbsrgits%2FDBIx-Class-Historic.git

diff --git a/lib/DBIx/Class/PK/Auto.pm b/lib/DBIx/Class/PK/Auto.pm
index 6928ba7..c2bb440 100644
--- a/lib/DBIx/Class/PK/Auto.pm
+++ b/lib/DBIx/Class/PK/Auto.pm
@@ -7,26 +7,45 @@ use warnings;
 
 =head1 NAME 
 
-DBIx::Class::PK::Auto - Automatic Primary Key class
+DBIx::Class::PK::Auto - Automatic primary key class
 
 =head1 SYNOPSIS
 
+  # In your table classes (replace PK::Auto::SQLite with your database)
+  __PACKAGE__->load_components(qw/PK::Auto::SQLite Core/);
+  __PACKAGE__->set_primary_key('id');
+
 =head1 DESCRIPTION
 
-This class overrides the insert method to get automatically
-incremented primary keys.
+This class overrides the insert method to get automatically incremented primary
+keys.
 
-You don't want to be using this directly - instead load the appropriate
-one for your database, e.g. PK::Auto::SQLite
+You don't want to be using this directly - instead load the appropriate one for
+your database, e.g. C<PK::Auto::SQLite>, in your table classes:
 
-=head1 METHODS
+  __PACKAGE__->load_components(qw/PK::Auto::SQLite Core/);
+
+Note that C<PK::Auto::SQLite> is specified as the leftmost argument.
 
-=over 4
+Alternatively, you can load the components separately:
 
-=item insert
+  __PACKAGE__->load_components(qw/Core/);
+  __PACKAGE__->load_components(qw/PK::Auto::SQLite/);
 
-Overrides insert so that it will get the value of autoincremented
-primary keys.
+This can be used, for example, if you have different databases and need to
+determine the appropriate C<PK::Auto> class at runtime.
+
+=head1 LOGIC
+
+C<PK::Auto> does this by letting the database assign the primary key field and
+fetching the assigned value afterwards.
+
+=head1 METHODS
+
+=head2 insert
+
+Overrides C<insert> so that it will get the value of autoincremented primary
+keys.
 
 =cut
 
@@ -43,19 +62,19 @@ sub insert {
     (grep { $self->column_info($_)->{'auto_increment'} }
        $self->primary_columns)
     || $self->primary_columns;
-  $self->throw( "More than one possible key found for auto-inc on ".ref $self )
+  $self->throw_exception( "More than one possible key found for auto-inc on ".ref $self )
     if $too_many;
   unless (defined $self->get_column($pri)) {
-    $self->throw( "Can't auto-inc for $pri on ".ref $self.": no _last_insert_id method" )
+    $self->throw_exception( "Can't auto-inc for $pri on ".ref $self.": no _last_insert_id method" )
       unless $self->can('last_insert_id');
     my $id = $self->last_insert_id;
-    $self->throw( "Can't get last insert id" ) unless $id;
+    $self->throw_exception( "Can't get last insert id" ) unless $id;
     $self->store_column($pri => $id);
   }
   return $ret;
 }
 
-=item sequence
+=head2 sequence
 
 Manually define the correct sequence for your table, to avoid the overhead
 associated with looking up the sequence automatically.
@@ -66,8 +85,6 @@ __PACKAGE__->mk_classdata('sequence');
 
 1;
 
-=back
-
 =head1 AUTHORS
 
 Matt S. Trout <mst@shadowcatsystems.co.uk>
@@ -77,4 +94,3 @@ Matt S. Trout <mst@shadowcatsystems.co.uk>
 You may distribute this code under the same terms as Perl itself.
 
 =cut
-