use strict;
use warnings;
-use base qw/Class::Data::Inheritable DBIx::Class::SQL/;
+use DBIx::Class::ResultSet;
+
+use base qw/Class::Data::Inheritable/;
__PACKAGE__->mk_classdata('_columns' => {});
__PACKAGE__->mk_classdata('table_alias'); # FIXME: Doesn't actually do anything yet!
+__PACKAGE__->mk_classdata('_resultset_class' => 'DBIx::Class::ResultSet');
+
+sub iterator_class { shift->_resultset_class(@_) }
+
=head1 NAME
DBIx::Class::Table - Basic table methods
=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 {
$class = ref $class if ref $class;
my $new = bless({ _column_data => { } }, $class);
if ($attrs) {
- die "attrs must be a hashref" unless ref($attrs) eq 'HASH';
+ $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 if $self->in_database;
+ return $self if $self->in_database;
#use Data::Dumper; warn Dumper($self);
- my $sth = $self->_get_sth('insert', [ keys %{$self->{_column_data}} ],
- $self->_table_name, undef);
- $sth->execute(values %{$self->{_column_data}});
- $sth->finish;
+ 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_database(1);
$self->{_dirty_columns} = {};
return $self;
}
+=item in_database
+
+ $obj->in_database; # Get value
+ $obj->in_database(1); # Set value
+
+Indicated whether the object exists as a row in the database or not
+
+=cut
+
sub in_database {
my ($self, $val) = @_;
$self->{_in_database} = $val if @_ > 1;
return $self->{_in_database};
}
+=item create
+
+ my $new = My::Class->create($attrs);
+
+A shortcut for My::Class->new($attrs)->insert;
+
+=cut
+
sub create {
my ($class, $attrs) = @_;
- die "create needs a hashref" unless ref $attrs eq 'HASH';
+ $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) = @_;
- die "Not in database" unless $self->in_database;
- my @to_update = keys %{$self->{_dirty_columns} || {}};
- return -1 unless @to_update;
- my $sth = $self->_get_sth('update', \@to_update,
- $self->_table_name, $self->_ident_cond);
- my $rows = $sth->execute( (map { $self->{_column_data}{$_} } @to_update),
- $self->_ident_values );
- $sth->finish;
+ my ($self, $upd) = @_;
+ $self->throw( "Not in database" ) unless $self->in_database;
+ 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) {
- die "Can't update $self: row not found";
+ $self->throw( "Can't update ${self}: row not found" );
} elsif ($rows > 1) {
- die "Can't update $self: updated more than one row";
+ $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_database 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) {
- die "Not in database" unless $self->in_database;
+ $self->throw( "Not in database" ) unless $self->in_database;
#warn $self->_ident_cond.' '.join(', ', $self->_ident_values);
- my $sth = $self->_get_sth('delete', undef,
- $self->_table_name, $self->_ident_cond);
- $sth->execute($self->_ident_values);
- $sth->finish;
+ $self->storage->delete($self->_table_name, $self->ident_condition);
$self->in_database(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] : {@_});
- my ($cond, @param) = $self->_cond_resolve($query, $attrs);
- my $sth = $self->_get_sth('delete', undef, $self->_table_name, $cond);
- $sth->execute(@param);
- $sth->finish;
+ $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) = @_;
- die "Can't fetch data as class method" unless ref $self;
- die "No such column '${column}'" unless $self->_columns->{$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;
+ $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) = @_;
- die "No such column '${column}'" unless $self->_columns->{$column};
- die "set_column called for ${column} without value" if @_ < 3;
+ $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;
}
$class->mk_group_accessors('column' => @cols);
}
+=item add_columns
+
+ __PACKAGE__->add_columns(qw/col1 col2 col3/);
+
+Adds columns to the current package, and creates accessors for them
+
+=cut
+
sub add_columns {
my ($class, @cols) = @_;
$class->_register_columns(@cols);
$class->_mk_column_accessors(@cols);
}
-sub retrieve_from_sql {
+=item search_literal
+
+ my @obj = $class->search_literal($literal_where_cond, @bind);
+ my $cursor = $class->search_literal($literal_where_cond, @bind);
+
+=cut
+
+sub search_literal {
+ my ($class, $cond, @vals) = @_;
+ $cond =~ s/^\s*WHERE//i;
+ my $attrs = (ref $vals[$#vals] eq 'HASH' ? { %{ pop(@vals) } } : {});
+ $attrs->{bind} = \@vals;
+ return $class->search(\$cond, $attrs);
+}
+
+=item count_literal
+
+ my $count = $class->count_literal($literal_where_cond);
+
+=cut
+
+sub count_literal {
my ($class, $cond, @vals) = @_;
$cond =~ s/^\s*WHERE//i;
my $attrs = (ref $vals[$#vals] eq 'HASH' ? pop(@vals) : {});
- my @cols = $class->_select_columns($attrs);
- my $sth = $class->_get_sth( 'select', \@cols, $class->_table_name, $cond);
- #warn "$cond @vals";
- return $class->sth_to_objects($sth, \@vals, \@cols);
-}
-
-sub sth_to_objects {
- my ($class, $sth, $args, $cols) = @_;
- my @cols = ((ref $cols eq 'ARRAY') ? @$cols : @{$sth->{NAME_lc}} );
- $sth->execute(@$args);
- my @found;
- while (my @row = $sth->fetchrow_array) {
- push(@found, $class->_row_to_object(\@cols, \@row));
+ $attrs->{bind} = [ @vals ];
+ return $class->count($cond, $attrs);
+}
+
+=item count
+
+ my $count = $class->count({ foo => 3 });
+
+=cut
+
+sub count {
+ my $class = shift;
+ my $attrs = { };
+ if (@_ > 1 && ref $_[$#_] eq 'HASH') {
+ $attrs = { %{ pop(@_) } };
}
- $sth->finish;
- return @found;
+ my $query = ref $_[0] eq "HASH" || (@_ == 1) ? 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
return $new;
}
+=item search
+
+ my @obj = $class->search({ foo => 3 });
+ my $cursor = $class->search({ foo => 3 });
+
+=cut
+
sub search {
my $class = shift;
+ #warn "@_";
my $attrs = { };
if (@_ > 1 && ref $_[$#_] eq 'HASH') {
$attrs = { %{ pop(@_) } };
}
- my $query = ref $_[0] eq "HASH" ? shift: {@_};
- my ($cond, @param) = $class->_cond_resolve($query, $attrs);
- return $class->retrieve_from_sql($cond, @param, $attrs);
+ 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 });
}
+=item search_like
+
+Identical to search except defaults to 'LIKE' instead of '=' in condition
+
+=cut
+
sub search_like {
my $class = shift;
my $attrs = { };
if (@_ > 1 && ref $_[$#_] eq 'HASH') {
$attrs = pop(@_);
}
- return $class->search(@_, { %$attrs, cmp => 'LIKE' });
+ my $query = ref $_[0] eq "HASH" ? { %{shift()} }: {@_};
+ $query->{$_} = { 'like' => $query->{$_} } for keys %$query;
+ return $class->search($query, { %$attrs });
}
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);
return $new->insert;
}
-sub _cond_resolve {
- my ($self, $query, $attrs) = @_;
- return '1 = 1' unless keys %$query;
- my $op = $attrs->{'cmp'} || '=';
- my $cond = join(' AND ',
- map { (defined $query->{$_}
- ? "$_ $op ?"
- : (do { delete $query->{$_}; "$_ IS NULL"; }));
- } keys %$query);
- return ($cond, values %$query);
-}
+#sub _cond_resolve {
+# my ($self, $query, $attrs) = @_;
+# return '1 = 1' unless keys %$query;
+# my $op = $attrs->{'cmp'} || '=';
+# my $cond = join(' AND ',
+# map { (defined $query->{$_}
+# ? "$_ $op ?"
+# : (do { delete $query->{$_}; "$_ IS NULL"; }));
+# } keys %$query);
+# return ($cond, values %$query);
+#}
+
+=item table
+
+ __PACKAGE__->table('tbl_name');
+
+=cut
sub table {
shift->_table_name(@_);
}
+=item find_or_create
+
+ $class->find_or_create({ key => $val, ... });
+
+Searches for a record matching the search condition; if it doesn't find one,
+creates one and returns that instead
+
+=cut
+
+sub find_or_create {
+ my $class = shift;
+ my $hash = ref $_[0] eq "HASH" ? shift: {@_};
+ my ($exists) = $class->search($hash);
+ 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_database ? $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;
=back
projects / dbsrgits/DBIx-Class.git / blobdiff