lib/DBIx/Class/PK/Auto.pm

   1 package DBIx::Class::PK::Auto;
   2
   3 #use base qw/DBIx::Class::PK/;
   4 use base qw/DBIx::Class/;
   5 use strict;
   6 use warnings;
   7
   8 =head1 NAME
   9
  10 DBIx::Class::PK::Auto - Automatic Primary Key class
  11
  12 =head1 SYNOPSIS
  13
  14 =head1 DESCRIPTION
  15
  16 This class overrides the insert method to get automatically
  17 incremented primary keys.
  18
  19 You don't want to be using this directly - instead load the appropriate
  20 one for your database, e.g. PK::Auto::SQLite
  21
  22 =head1 METHODS
  23
  24 =over 4
  25
  26 =item insert
  27
  28 Overrides insert so that it will get the value of autoincremented
  29 primary keys.
  30
  31 =cut
  32
  33 sub insert {
  34   my ($self, @rest) = @_;
  35   my $ret = $self->next::method(@rest);
  36
  37   # if all primaries are already populated, skip auto-inc
  38   my $populated = 0;
  39   map { $populated++ if defined $self->get_column($_) } $self->primary_columns;
  40   return $ret if ( $populated == scalar $self->primary_columns );
  41
  42   my ($pri, $too_many) =
  43     (grep { $self->column_info($_)->{'auto_increment'} }
  44        $self->primary_columns)
  45     || $self->primary_columns;
  46   $self->throw( "More than one possible key found for auto-inc on ".ref $self )
  47     if $too_many;
  48   unless (defined $self->get_column($pri)) {
  49     $self->throw( "Can't auto-inc for $pri on ".ref $self.": no _last_insert_id method" )
  50       unless $self->can('last_insert_id');
  51     my $id = $self->last_insert_id;
  52     $self->throw( "Can't get last insert id" ) unless $id;
  53     $self->store_column($pri => $id);
  54   }
  55   return $ret;
  56 }
  57
  58 =item sequence
  59
  60 Manually define the correct sequence for your table, to avoid the overhead
  61 associated with looking up the sequence automatically.
  62
  63 =cut
  64
  65 __PACKAGE__->mk_classdata('sequence');
  66
  67 1;
  68
  69 =back
  70
  71 =head1 AUTHORS
  72
  73 Matt S. Trout <mst@shadowcatsystems.co.uk>
  74
  75 =head1 LICENSE
  76
  77 You may distribute this code under the same terms as Perl itself.
  78
  79 =cut
  80