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=98e3b8911e3871b4258b6c97712dad26f5d4c9fd;hpb=c1d2357300903fa0f4ec7d85c132f04547c4ccba;p=dbsrgits%2FDBIx-Class-Historic.git

diff --git a/lib/DBIx/Class/PK/Auto.pm b/lib/DBIx/Class/PK/Auto.pm
index 98e3b89..c2bb440 100644
--- a/lib/DBIx/Class/PK/Auto.pm
+++ b/lib/DBIx/Class/PK/Auto.pm
@@ -1,25 +1,96 @@
 package DBIx::Class::PK::Auto;
 
+#use base qw/DBIx::Class::PK/;
+use base qw/DBIx::Class/;
 use strict;
 use warnings;
 
+=head1 NAME 
+
+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.
+
+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:
+
+  __PACKAGE__->load_components(qw/PK::Auto::SQLite Core/);
+
+Note that C<PK::Auto::SQLite> is specified as the leftmost argument.
+
+Alternatively, you can load the components separately:
+
+  __PACKAGE__->load_components(qw/Core/);
+  __PACKAGE__->load_components(qw/PK::Auto::SQLite/);
+
+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
+
 sub insert {
   my ($self, @rest) = @_;
-  my $ret = $self->NEXT::ACTUAL::insert(@rest);
+  my $ret = $self->next::method(@rest);
+
+  # if all primaries are already populated, skip auto-inc
+  my $populated = 0;
+  map { $populated++ if defined $self->get_column($_) } $self->primary_columns;
+  return $ret if ( $populated == scalar $self->primary_columns );
+
   my ($pri, $too_many) =
-    (grep { $self->_primaries->{$_}{'auto_increment'} }
-       keys %{ $self->_primaries })
-    || (keys %{ $self->_primaries });
-  die "More than one possible key found for auto-inc on ".ref $self
+    (grep { $self->column_info($_)->{'auto_increment'} }
+       $self->primary_columns)
+    || $self->primary_columns;
+  $self->throw_exception( "More than one possible key found for auto-inc on ".ref $self )
     if $too_many;
   unless (defined $self->get_column($pri)) {
-    die "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;
-    die "Can't get last insert id" unless $id;
+    $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_exception( "Can't get last insert id" ) unless $id;
     $self->store_column($pri => $id);
   }
   return $ret;
 }
 
+=head2 sequence
+
+Manually define the correct sequence for your table, to avoid the overhead
+associated with looking up the sequence automatically.
+
+=cut
+
+__PACKAGE__->mk_classdata('sequence');
+
 1;
+
+=head1 AUTHORS
+
+Matt S. Trout <mst@shadowcatsystems.co.uk>
+
+=head1 LICENSE
+
+You may distribute this code under the same terms as Perl itself.
+
+=cut