From: Matt S Trout Date: Mon, 8 Aug 2005 20:23:54 +0000 (+0000) Subject: More refactoring, created PK::Auto::MySQL X-Git-Tag: v0.03001~54 X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=7624b19f7173b34800a973f281f6a5d4344f67e6;p=dbsrgits%2FDBIx-Class.git More refactoring, created PK::Auto::MySQL --- diff --git a/lib/DBIx/Class/Core.pm b/lib/DBIx/Class/Core.pm index ff3c023..1cff2cf 100644 --- a/lib/DBIx/Class/Core.pm +++ b/lib/DBIx/Class/Core.pm @@ -11,6 +11,7 @@ __PACKAGE__->load_components(qw/ InflateColumn SQL::Abstract PK + Row Table Exception AccessorGroup/); diff --git a/lib/DBIx/Class/PK/Auto.pm b/lib/DBIx/Class/PK/Auto.pm index f4ee81c..4b95f7c 100644 --- a/lib/DBIx/Class/PK/Auto.pm +++ b/lib/DBIx/Class/PK/Auto.pm @@ -14,6 +14,9 @@ DBIx::Class::PK::Auto - Automatic Primary Key class 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 + =head1 METHODS =over 4 diff --git a/lib/DBIx/Class/PK/Auto/MySQL.pm b/lib/DBIx/Class/PK/Auto/MySQL.pm new file mode 100644 index 0000000..bd253f0 --- /dev/null +++ b/lib/DBIx/Class/PK/Auto/MySQL.pm @@ -0,0 +1,35 @@ +package DBIx::Class::PK::Auto::MySQL; + +use strict; +use warnings; + +use base qw/DBIx::Class/; + +__PACKAGE__->load_components(qw/PK::Auto/); + +sub last_insert_id { + return $_[0]->storage->dbh->{mysql_insertid}; +} + +1; + +=head1 NAME + +DBIx::Class::PK::Auto::MySQL - Automatic Primary Key class for MySQL + +=head1 SYNOPSIS + +=head1 DESCRIPTION + +This class implements autoincrements for MySQL. + +=head1 AUTHORS + +Matt S. Trout + +=head1 LICENSE + +You may distribute this code under the same terms as Perl itself. + +=cut + diff --git a/lib/DBIx/Class/ResultSet.pm b/lib/DBIx/Class/ResultSet.pm index 68317a3..e7cbd88 100644 --- a/lib/DBIx/Class/ResultSet.pm +++ b/lib/DBIx/Class/ResultSet.pm @@ -7,20 +7,17 @@ use overload fallback => 1; sub new { - my ($it_class, $db_class, $cursor, $args, $cols, $attrs) = @_; + my ($it_class, $db_class, $attrs) = @_; #use Data::Dumper; warn Dumper(@_); $it_class = ref $it_class if ref $it_class; $attrs = { %{ $attrs || {} } }; - unless ($cursor) { - $attrs->{bind} = $args; - $cursor = $db_class->storage->select($db_class->_table_name,$cols, + my $cols = [ $db_class->_select_columns ]; + my $cursor = $db_class->storage->select($db_class->_table_name,$cols, $attrs->{where},$attrs); - } my $new = { class => $db_class, cursor => $cursor, cols => $cols, - args => $args, cond => $attrs->{where}, attrs => $attrs }; return bless ($new, $it_class); @@ -32,8 +29,7 @@ sub slice { $self->{class}->throw("Can't slice without where") unless $attrs->{where}; $attrs->{offset} = $min; $attrs->{rows} = ($max ? ($max - $min + 1) : 1); - my $slice = $self->new($self->{class}, undef, $self->{args}, - $self->{cols}, $attrs); + my $slice = $self->new($self->{class}, $attrs); return (wantarray ? $slice->all : $slice); } @@ -47,7 +43,14 @@ sub next { sub count { my ($self) = @_; return $self->{attrs}{rows} if $self->{attrs}{rows}; - return $self->{class}->count($self->{cond}, { bind => $self->{args} }); + # This is a hack, and will break on the last page of a paged set. + # Once we have limit support in Storage, kill it. + + my $db_class = $self->{class}; + my @cols = 'COUNT(*)'; + my $cursor = $db_class->storage->select($db_class->_table_name, \@cols, + $self->{cond}, $self->{attrs}); + return ($cursor->next)[0]; } sub all { diff --git a/lib/DBIx/Class/Row.pm b/lib/DBIx/Class/Row.pm new file mode 100644 index 0000000..5f4cb17 --- /dev/null +++ b/lib/DBIx/Class/Row.pm @@ -0,0 +1,268 @@ +package DBIx::Class::Row; + +use strict; +use warnings; + +=head1 NAME + +DBIx::Class::Row - Basic row methods + +=head1 SYNOPSIS + +=head1 DESCRIPTION + +This class is responsible for defining and doing basic operations on rows +derived from L objects. + +=head1 METHODS + +=over 4 + +=item new + + my $obj = My::Class->new($attrs); + +Creates a new row object from column => value mappings passed as a hash ref + +=cut + +sub new { + my ($class, $attrs) = @_; + $class = ref $class if ref $class; + my $new = bless({ _column_data => { } }, $class); + if ($attrs) { + $new->throw("attrs must be a hashref" ) unless ref($attrs) eq 'HASH'; + while (my ($k, $v) = each %{$attrs}) { + $new->store_column($k => $v); + } + } + return $new; +} + +=item insert + + $obj->insert; + +Inserts an object into the database if it isn't already in there. Returns +the object itself. + +=cut + +sub insert { + my ($self) = @_; + return $self if $self->in_storage; + #use Data::Dumper; warn Dumper($self); + my %in; + $in{$_} = $self->get_column($_) + for grep { defined $self->get_column($_) } $self->columns; + my %out = %{ $self->storage->insert($self->_table_name, \%in) }; + $self->store_column($_, $out{$_}) + for grep { $self->get_column($_) ne $out{$_} } keys %out; + $self->in_storage(1); + $self->{_dirty_columns} = {}; + return $self; +} + +=item in_storage + + $obj->in_storage; # Get value + $obj->in_storage(1); # Set value + +Indicated whether the object exists as a row in the database or not + +=cut + +sub in_storage { + my ($self, $val) = @_; + $self->{_in_storage} = $val if @_ > 1; + return $self->{_in_storage}; +} + +=item create + + my $new = My::Class->create($attrs); + +A shortcut for My::Class->new($attrs)->insert; + +=cut + +sub create { + my ($class, $attrs) = @_; + $class->throw( "create needs a hashref" ) unless ref $attrs eq 'HASH'; + return $class->new($attrs)->insert; +} + +=item update + + $obj->update; + +Must be run on an object that is already in the database; issues an SQL +UPDATE query to commit any changes to the object to the db if required. + +=cut + +sub update { + my ($self, $upd) = @_; + $self->throw( "Not in database" ) unless $self->in_storage; + my %to_update = %{$upd || {}}; + $to_update{$_} = $self->get_column($_) for $self->is_changed; + return -1 unless keys %to_update; + my $rows = $self->storage->update($self->_table_name, \%to_update, + $self->ident_condition); + if ($rows == 0) { + $self->throw( "Can't update ${self}: row not found" ); + } elsif ($rows > 1) { + $self->throw("Can't update ${self}: updated more than one row"); + } + $self->{_dirty_columns} = {}; + return $self; +} + +sub ident_condition { + my ($self) = @_; + my %cond; + $cond{$_} = $self->get_column($_) for keys %{$self->_primaries}; + return \%cond; +} + +=item delete + + $obj->delete + +Deletes the object from the database. The object is still perfectly usable +accessor-wise etc. but ->in_storage will now return 0 and the object must +be re ->insert'ed before it can be ->update'ed + +=cut + +sub delete { + my $self = shift; + if (ref $self) { + $self->throw( "Not in database" ) unless $self->in_storage; + #warn $self->_ident_cond.' '.join(', ', $self->_ident_values); + $self->storage->delete($self->_table_name, $self->ident_condition); + $self->in_storage(undef); + #$self->store_column($_ => undef) for $self->primary_columns; + # Should probably also arrange to trash PK if auto + # but if we do, post-delete cascade triggers fail :/ + } else { + my $attrs = { }; + if (@_ > 1 && ref $_[$#_] eq 'HASH') { + $attrs = { %{ pop(@_) } }; + } + my $query = (ref $_[0] eq 'HASH' ? $_[0] : {@_}); + $self->storage->delete($self->_table_name, $query); + } + return $self; +} + +=item get_column + + my $val = $obj->get_column($col); + +Fetches a column value + +=cut + +sub get_column { + my ($self, $column) = @_; + $self->throw( "Can't fetch data as class method" ) unless ref $self; + $self->throw( "No such column '${column}'" ) unless $self->_columns->{$column}; + return $self->{_column_data}{$column} + if exists $self->{_column_data}{$column}; + return undef; +} + +=item set_column + + $obj->set_column($col => $val); + +Sets a column value; if the new value is different to the old the column +is marked as dirty for when you next call $obj->update + +=cut + +sub set_column { + my $self = shift; + my ($column) = @_; + my $old = $self->get_column($column); + my $ret = $self->store_column(@_); + $self->{_dirty_columns}{$column} = 1 unless defined $old && $old eq $ret; + return $ret; +} + +=item store_column + + $obj->store_column($col => $val); + +Sets a column value without marking it as dirty + +=cut + +sub store_column { + my ($self, $column, $value) = @_; + $self->throw( "No such column '${column}'" ) + unless $self->_columns->{$column}; + $self->throw( "set_column called for ${column} without value" ) + if @_ < 3; + return $self->{_column_data}{$column} = $value; +} + +sub _row_to_object { # WARNING: Destructive to @$row + my ($class, $cols, $row) = @_; + my $new = $class->new; + $new->store_column($_, shift @$row) for @$cols; + $new->in_storage(1); + return $new; +} + +=item copy + + my $copy = $orig->copy({ change => $to, ... }); + +=cut + +sub copy { + my ($self, $changes) = @_; + my $new = bless({ _column_data => { %{$self->{_column_data}}} }, ref $self); + $new->set_column($_ => $changes->{$_}) for keys %$changes; + return $new->insert; +} + +=item insert_or_update + + $obj->insert_or_update + +Updates the object if it's already in the db, else inserts it + +=cut + +sub insert_or_update { + my $self = shift; + return ($self->in_storage ? $self->update : $self->insert); +} + +=item is_changed + + my @changed_col_names = $obj->is_changed + +=cut + +sub is_changed { + return keys %{shift->{_dirty_columns} || {}}; +} + +1; + +=back + +=head1 AUTHORS + +Matt S. Trout + +=head1 LICENSE + +You may distribute this code under the same terms as Perl itself. + +=cut + diff --git a/lib/DBIx/Class/Table.pm b/lib/DBIx/Class/Table.pm index 6301259..32f101d 100644 --- a/lib/DBIx/Class/Table.pm +++ b/lib/DBIx/Class/Table.pm @@ -32,196 +32,8 @@ L objects. =over 4 -=item new - - my $obj = My::Class->new($attrs); - -Creates a new object from column => value mappings passed as a hash ref - -=cut - -sub new { - my ($class, $attrs) = @_; - $class = ref $class if ref $class; - my $new = bless({ _column_data => { } }, $class); - if ($attrs) { - $new->throw("attrs must be a hashref" ) unless ref($attrs) eq 'HASH'; - while (my ($k, $v) = each %{$attrs}) { - $new->store_column($k => $v); - } - } - return $new; -} - -=item insert - - $obj->insert; - -Inserts an object into the database if it isn't already in there. Returns -the object itself. - -=cut - -sub insert { - my ($self) = @_; - return $self if $self->in_storage; - #use Data::Dumper; warn Dumper($self); - my %in; - $in{$_} = $self->get_column($_) - for grep { defined $self->get_column($_) } $self->columns; - my %out = %{ $self->storage->insert($self->_table_name, \%in) }; - $self->store_column($_, $out{$_}) - for grep { $self->get_column($_) ne $out{$_} } keys %out; - $self->in_storage(1); - $self->{_dirty_columns} = {}; - return $self; -} - -=item in_storage - - $obj->in_storage; # Get value - $obj->in_storage(1); # Set value - -Indicated whether the object exists as a row in the database or not - -=cut - -sub in_storage { - my ($self, $val) = @_; - $self->{_in_storage} = $val if @_ > 1; - return $self->{_in_storage}; -} - -=item create - - my $new = My::Class->create($attrs); - -A shortcut for My::Class->new($attrs)->insert; - -=cut - -sub create { - my ($class, $attrs) = @_; - $class->throw( "create needs a hashref" ) unless ref $attrs eq 'HASH'; - return $class->new($attrs)->insert; -} - -=item update - - $obj->update; - -Must be run on an object that is already in the database; issues an SQL -UPDATE query to commit any changes to the object to the db if required. - -=cut - -sub update { - my ($self, $upd) = @_; - $self->throw( "Not in database" ) unless $self->in_storage; - my %to_update = %{$upd || {}}; - $to_update{$_} = $self->get_column($_) for $self->is_changed; - return -1 unless keys %to_update; - my $rows = $self->storage->update($self->_table_name, \%to_update, - $self->ident_condition); - if ($rows == 0) { - $self->throw( "Can't update ${self}: row not found" ); - } elsif ($rows > 1) { - $self->throw("Can't update ${self}: updated more than one row"); - } - $self->{_dirty_columns} = {}; - return $self; -} - -sub ident_condition { - my ($self) = @_; - my %cond; - $cond{$_} = $self->get_column($_) for keys %{$self->_primaries}; - return \%cond; -} - -=item delete - - $obj->delete - -Deletes the object from the database. The object is still perfectly usable -accessor-wise etc. but ->in_storage will now return 0 and the object must -be re ->insert'ed before it can be ->update'ed - -=cut - -sub delete { - my $self = shift; - if (ref $self) { - $self->throw( "Not in database" ) unless $self->in_storage; - #warn $self->_ident_cond.' '.join(', ', $self->_ident_values); - $self->storage->delete($self->_table_name, $self->ident_condition); - $self->in_storage(undef); - #$self->store_column($_ => undef) for $self->primary_columns; - # Should probably also arrange to trash PK if auto - # but if we do, post-delete cascade triggers fail :/ - } else { - my $attrs = { }; - if (@_ > 1 && ref $_[$#_] eq 'HASH') { - $attrs = { %{ pop(@_) } }; - } - my $query = (ref $_[0] eq 'HASH' ? $_[0] : {@_}); - $self->storage->delete($self->_table_name, $query); - } - return $self; -} - -=item get_column - - my $val = $obj->get_column($col); - -Fetches a column value - -=cut - -sub get_column { - my ($self, $column) = @_; - $self->throw( "Can't fetch data as class method" ) unless ref $self; - $self->throw( "No such column '${column}'" ) unless $self->_columns->{$column}; - return $self->{_column_data}{$column} - if exists $self->{_column_data}{$column}; - return undef; -} - -=item set_column - - $obj->set_column($col => $val); - -Sets a column value; if the new value is different to the old the column -is marked as dirty for when you next call $obj->update - -=cut - -sub set_column { - my $self = shift; - my ($column) = @_; - my $old = $self->get_column($column); - my $ret = $self->store_column(@_); - $self->{_dirty_columns}{$column} = 1 unless defined $old && $old eq $ret; - return $ret; -} - -=item store_column - - $obj->store_column($col => $val); - -Sets a column value without marking it as dirty - =cut -sub store_column { - my ($self, $column, $value) = @_; - $self->throw( "No such column '${column}'" ) - unless $self->_columns->{$column}; - $self->throw( "set_column called for ${column} without value" ) - if @_ < 3; - return $self->{_column_data}{$column} = $value; -} - sub _register_columns { my ($class, @cols) = @_; my $names = { %{$class->_columns} }; @@ -270,11 +82,8 @@ sub search_literal { =cut sub count_literal { - my ($class, $cond, @vals) = @_; - $cond =~ s/^\s*WHERE//i; - my $attrs = (ref $vals[$#vals] eq 'HASH' ? pop(@vals) : {}); - $attrs->{bind} = [ @vals ]; - return $class->count($cond, $attrs); + my $class = shift; + return $class->search_literal(@_)->count; } =item count @@ -285,31 +94,7 @@ sub count_literal { sub count { my $class = shift; - my $attrs = { }; - if (@_ > 1 && ref $_[$#_] eq 'HASH') { - $attrs = { %{ pop(@_) } }; - } - my $query = (@_ == 1 || ref $_[0] eq "HASH" ? shift: {@_}); - my @cols = 'COUNT(*)'; - my $cursor = $class->storage->select($class->_table_name, \@cols, - $query, $attrs); - return ($cursor->next)[0]; -} - -sub cursor_to_resultset { - my ($class, $sth, $args, $cols, $attrs) = @_; - my $rs_class = $class->_resultset_class; - eval "use $rs_class;"; - my $rs = $rs_class->new($class, $sth, $args, $cols, $attrs); - return (wantarray ? $rs->all : $rs); -} - -sub _row_to_object { # WARNING: Destructive to @$row - my ($class, $cols, $row) = @_; - my $new = $class->new; - $new->store_column($_, shift @$row) for @$cols; - $new->in_storage(1); - return $new; + return $class->search(@_)->count; } =item search @@ -326,10 +111,19 @@ sub search { if (@_ > 1 && ref $_[$#_] eq 'HASH') { $attrs = { %{ pop(@_) } }; } - my $query = (@_ == 1 || ref $_[0] eq "HASH" ? shift: {@_}); - my @cols = $class->_select_columns; - return $class->cursor_to_resultset(undef, $attrs->{bind}, \@cols, - { where => $query, %$attrs }); + $attrs->{where} = (@_ == 1 || ref $_[0] eq "HASH" ? shift: {@_}); + + my $rs = $class->resultset($attrs); + + return (wantarray ? $rs->all : $rs); +} + +sub resultset { + my $class = shift; + + my $rs_class = $class->_resultset_class; + eval "use $rs_class;"; + my $rs = $rs_class->new($class, @_); } =item search_like @@ -353,19 +147,6 @@ sub _select_columns { return keys %{$_[0]->_columns}; } -=item copy - - my $copy = $orig->copy({ change => $to, ... }); - -=cut - -sub copy { - my ($self, $changes) = @_; - my $new = bless({ _column_data => { %{$self->{_column_data}}} }, ref $self); - $new->set_column($_ => $changes->{$_}) for keys %$changes; - return $new->insert; -} - =item table __PACKAGE__->table('tbl_name'); @@ -392,29 +173,6 @@ sub find_or_create { return defined($exists) ? $exists : $class->create($hash); } -=item insert_or_update - - $obj->insert_or_update - -Updates the object if it's already in the db, else inserts it - -=cut - -sub insert_or_update { - my $self = shift; - return ($self->in_storage ? $self->update : $self->insert); -} - -=item is_changed - - my @changed_col_names = $obj->is_changed - -=cut - -sub is_changed { - return keys %{shift->{_dirty_columns} || {}}; -} - sub columns { return keys %{shift->_columns}; } 1;