use strict;
use warnings;
-use base qw/Class::Data::Inheritable Class::Accessor DBIx::Class::SQL/;
+use DBIx::Class::ResultSet;
-__PACKAGE__->mk_classdata('_columns' => {});
+use Carp qw/croak/;
-__PACKAGE__->mk_classdata('_table_name');
+use base qw/DBIx::Class/;
+__PACKAGE__->load_components(qw/AccessorGroup/);
+
+__PACKAGE__->mk_group_accessors('simple' =>
+ qw/_columns _primaries name resultset_class result_class storage/);
+
+=head1 NAME
+
+DBIx::Class::Table - Table object
+
+=head1 SYNOPSIS
+
+=head1 DESCRIPTION
+
+This class is responsible for defining and doing table-level operations on
+L<DBIx::Class> classes.
+
+=head1 METHODS
+
+=cut
sub new {
my ($class, $attrs) = @_;
$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';
- while (my ($k, $v) = each %{$attrs}) {
- $new->set($k => $v);
- }
- }
- $new->{_dirty_columns} = {};
+ my $new = bless({ %{$attrs || {}} }, $class);
+ $new->{resultset_class} ||= 'DBIx::Class::ResultSet';
+ $new->{_columns} ||= {};
+ $new->{name} ||= "!!NAME NOT SET!!";
return $new;
}
-sub insert {
- my ($self) = @_;
- return if $self->{_in_database};
- my $sth = $self->_get_sth('insert', [ keys %{$self->{_column_data}} ],
- $self->_table_name, undef);
- $sth->execute(values %{$self->{_column_data}});
- $self->{_in_database} = 1;
- $self->{_dirty_columns} = {};
- return $self;
+sub add_columns {
+ my ($self, @cols) = @_;
+ while (my $col = shift @cols) {
+ $self->_columns->{$col} = (ref $cols[0] ? shift : {});
+ }
}
-sub create {
- my ($class, $attrs) = @_;
- die "create needs a hashref" unless ref $attrs eq 'HASH';
- return $class->new($attrs)->insert;
-}
+*add_column = \&add_columns;
-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 );
- if ($rows == 0) {
- die "Can't update $self: row not found";
- } elsif ($rows > 1) {
- die "Can't update $self: updated more than one row";
- }
- $self->{_dirty_columns} = {};
- return $self;
-}
+=head2 add_columns
+
+ $table->add_columns(qw/col1 col2 col3/);
+
+ $table->add_columns('col1' => \%col1_info, 'col2' => \%col2_info, ...);
+
+Adds columns to the table object. If supplied key => hashref pairs uses
+the hashref as the column_info for that column.
+
+=head2 add_column
+
+ $table->add_column('col' => \%info?);
+
+Convenience alias to add_columns
+
+=cut
-sub delete {
+sub resultset {
my $self = shift;
- if (ref $self) {
- my $sth = $self->_get_sth('delete', undef,
- $self->_table_name, $self->_ident_cond);
- $sth->execute($self->_ident_values);
- $sth->finish;
- delete $self->{_in_database};
- } else {
- my $query = (ref $_[0] eq 'HASH' ? $_[0] : {@_});
- my ($cond, $param) = $self->_where_from_hash($query);
- my $sth = $self->_get_sth('delete', undef, $self->_table_name, $cond);
- $sth->execute(@$param);
- $sth->finish;
- }
- return $self;
+ return $self->{resultset} ||= $self->resultset_class->new($self);
}
-sub discard_changes {
- my ($self) = @_;
- $_[0] = $self->retrieve($self->id);
-}
+=head2 has_column
+
+ if ($obj->has_column($col)) { ... }
+
+Returns 1 if the table has a column of this name, 0 otherwise.
+
+=cut
-sub get {
+sub has_column {
my ($self, $column) = @_;
- die "Can't fetch data as class method" unless ref $self;
- #die "No such column '${column}'" unless $self->_columns->{$column};
- return $self->{_column_data}{$column} if $self->_columns->{$column};
- return shift->SUPER::get(@_);
+ return exists $self->_columns->{$column};
}
-sub set {
- my ($self, $column, $value) = @_;
- #die "No such column '${column}'" unless $self->_columns->{$column};
- #die "set_column called for ${column} without value" if @_ < 3;
- if ($self->_columns->{$column}) {
- $self->{_dirty_columns}{$column} = 1;
- return $self->{_column_data}{$column} = $value;
- }
- return shift->SUPER::set(@_);
-}
+=head2 column_info
+
+ my $info = $obj->column_info($col);
+
+Returns the column metadata hashref for a column.
+
+=cut
-sub _register_columns {
- my ($class, @cols) = @_;
- my $names = { %{$class->_columns} };
- $names->{$_} ||= {} for @cols;
- $class->_columns($names);
+sub column_info {
+ my ($self, $column) = @_;
+ croak "No such column $column" unless exists $self->_columns->{$column};
+ return $self->_columns->{$column};
}
-sub _mk_column_accessors {
- my ($class, @cols) = @_;
- $class->mk_accessors(@cols);
-}
+=head2 columns
+
+ my @column_names = $obj->columns;
+
+=cut
-sub set_columns {
- my ($class, @cols) = @_;
- $class->_register_columns(@cols);
- $class->_mk_column_accessors(@cols);
+sub columns {
+ croak "columns() is a read-only accessor, did you mean add_columns()?" if (@_ > 1);
+ return keys %{shift->_columns};
}
-sub retrieve_from_sql {
- my ($class, $cond, @vals) = @_;
- $cond =~ s/^\s*WHERE//i;
- my @cols = $class->_select_columns;
- my $sth = $class->_get_sth( 'select', \@cols, $class->_table_name, $cond);
- $sth->execute(@vals);
- my @found;
- while (my @row = $sth->fetchrow_array) {
- my $new = $class->new;
- $new->set($_, shift @row) for @cols;
- $new->{_in_database} = 1;
- $new->{_dirty_columns} = {};
- push(@found, $new);
+=head2 set_primary_key(@cols)
+
+Defines one or more columns as primary key for this table. Should be
+called after C<add_columns>.
+
+=cut
+
+sub set_primary_key {
+ my ($self, @cols) = @_;
+ # check if primary key columns are valid columns
+ for (@cols) {
+ $self->throw("No such column $_ on table ".$self->name)
+ unless $self->has_column($_);
}
- return @found;
+ $self->_primaries(\@cols);
}
-sub search {
- my $class = shift;
- my $where = ref $_[0] eq "HASH" ? shift: {@_};
- my ($cond, $param) = $class->_where_from_hash($where);
- return $class->retrieve_from_sql($cond, @{$param});
-}
+=head2 primary_columns
+
+Read-only accessor which returns the list of primary keys.
+
+=cut
-sub search_like {
- my $class = shift;
- my $where = ref $_[0] eq "HASH" ? shift: {@_};
- my ($cond, $param) = $class->_where_from_hash($where, { cmp => 'like' });
- return $class->retrieve_from_sql($cond, @{$param});
+sub primary_columns {
+ return @{shift->_primaries||[]};
}
-sub _select_columns {
- return keys %{$_[0]->_columns};
-}
+=head2 from
-sub copy {
- my ($self, $changes) = @_;
- my $new = bless({ _column_data => { %{$self->{_column_data}}} }, ref $self);
- $new->set($_ => $changes->{$_}) for keys %$changes;
- return $new->insert;
-}
+Returns the FROM entry for the table (i.e. the table name)
+
+=cut
+
+sub from { return shift->name(@_); }
-sub _where_from_hash {
- my ($self, $query, $opts) = @_;
- my $op = $opts->{'cmp'} || '=';
- my $cond = join(' AND ',
- map { (defined $query->{$_}
- ? "$_ $op ?"
- : (do { delete $query->{$_}; "$_ IS NULL"; }));
- } keys %$query);
- return ($cond, [ values %$query ]);
-}
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
+
projects / dbsrgits/DBIx-Class.git / blobdiff