1 package DBIx::Class::Table;
6 use DBIx::Class::Cursor;
8 use base qw/Class::Data::Inheritable/;
10 __PACKAGE__->mk_classdata('_columns' => {});
12 __PACKAGE__->mk_classdata('_table_name');
14 __PACKAGE__->mk_classdata('table_alias'); # FIXME: Doesn't actually do anything yet!
16 __PACKAGE__->mk_classdata('_cursor_class' => 'DBIx::Class::Cursor');
20 DBIx::Class::Table - Basic table methods
26 This class is responsible for defining and doing basic operations on
27 L<DBIx::Class> objects.
36 my ($class, $attrs) = @_;
37 $class = ref $class if ref $class;
38 my $new = bless({ _column_data => { } }, $class);
40 $new->throw("attrs must be a hashref" ) unless ref($attrs) eq 'HASH';
41 while (my ($k, $v) = each %{$attrs}) {
42 $new->store_column($k => $v);
50 return if $self->in_database;
51 #use Data::Dumper; warn Dumper($self);
52 my $sth = $self->_get_sth('insert', [ keys %{$self->{_column_data}} ],
53 $self->_table_name, undef);
54 $sth->execute(values %{$self->{_column_data}});
56 $self->in_database(1);
57 $self->{_dirty_columns} = {};
62 my ($self, $val) = @_;
63 $self->{_in_database} = $val if @_ > 1;
64 return $self->{_in_database};
68 my ($class, $attrs) = @_;
69 $class->throw( "create needs a hashref" ) unless ref $attrs eq 'HASH';
70 return $class->new($attrs)->insert;
75 $self->throw( "Not in database" ) unless $self->in_database;
76 my @to_update = keys %{$self->{_dirty_columns} || {}};
77 return -1 unless @to_update;
78 my $sth = $self->_get_sth('update', \@to_update,
79 $self->_table_name, $self->_ident_cond);
80 my $rows = $sth->execute( (map { $self->{_column_data}{$_} } @to_update),
81 $self->_ident_values );
84 $self->throw( "Can't update $self: row not found" );
86 $self->throw("Can't update $self: updated more than one row");
88 $self->{_dirty_columns} = {};
95 $self->throw( "Not in database" ) unless $self->in_database;
96 #warn $self->_ident_cond.' '.join(', ', $self->_ident_values);
97 my $sth = $self->_get_sth('delete', undef,
98 $self->_table_name, $self->_ident_cond);
99 $sth->execute($self->_ident_values);
101 $self->in_database(undef);
104 if (@_ > 1 && ref $_[$#_] eq 'HASH') {
105 $attrs = { %{ pop(@_) } };
107 my $query = (ref $_[0] eq 'HASH' ? $_[0] : {@_});
108 my ($cond, @param) = $self->_cond_resolve($query, $attrs);
109 my $sth = $self->_get_sth('delete', undef, $self->_table_name, $cond);
110 $sth->execute(@param);
117 my ($self, $column) = @_;
118 $self->throw( "Can't fetch data as class method" ) unless ref $self;
119 $self->throw( "No such column '${column}'" ) unless $self->_columns->{$column};
120 return $self->{_column_data}{$column}
121 if exists $self->{_column_data}{$column};
128 my $ret = $self->store_column(@_);
129 $self->{_dirty_columns}{$column} = 1;
134 my ($self, $column, $value) = @_;
135 $self->throw( "No such column '${column}'" )
136 unless $self->_columns->{$column};
137 $self->throw( "set_column called for ${column} without value" )
139 return $self->{_column_data}{$column} = $value;
142 sub _register_columns {
143 my ($class, @cols) = @_;
144 my $names = { %{$class->_columns} };
145 $names->{$_} ||= {} for @cols;
146 $class->_columns($names);
149 sub _mk_column_accessors {
150 my ($class, @cols) = @_;
151 $class->mk_group_accessors('column' => @cols);
155 my ($class, @cols) = @_;
156 $class->_register_columns(@cols);
157 $class->_mk_column_accessors(@cols);
160 sub retrieve_from_sql {
161 my ($class, $cond, @vals) = @_;
162 $cond =~ s/^\s*WHERE//i;
163 my $attrs = (ref $vals[$#vals] eq 'HASH' ? pop(@vals) : {});
164 my @cols = $class->_select_columns($attrs);
165 my $sth = $class->_get_sth( 'select', \@cols, $class->_table_name, $cond);
167 return $class->sth_to_objects($sth, \@vals, \@cols, { where => $cond });
171 my ($class, $sth, $args, $cols, $attrs) = @_;
172 my @cols = ((ref $cols eq 'ARRAY') ? @$cols : @{$sth->{NAME_lc}} );
173 my $cursor_class = $class->_cursor_class;
174 eval "use $cursor_class;";
175 my $cursor = $cursor_class->new($class, $sth, $args, \@cols, $attrs);
176 return (wantarray ? $cursor->all : $cursor);
179 sub _row_to_object { # WARNING: Destructive to @$row
180 my ($class, $cols, $row) = @_;
181 my $new = $class->new;
182 $new->store_column($_, shift @$row) for @$cols;
183 $new->in_database(1);
190 if (@_ > 1 && ref $_[$#_] eq 'HASH') {
191 $attrs = { %{ pop(@_) } };
193 my $query = ref $_[0] eq "HASH" ? shift: {@_};
194 my ($cond, @param) = $class->_cond_resolve($query, $attrs);
195 return $class->retrieve_from_sql($cond, @param, $attrs);
201 if (@_ > 1 && ref $_[$#_] eq 'HASH') {
204 return $class->search(@_, { %$attrs, cmp => 'LIKE' });
207 sub _select_columns {
208 return keys %{$_[0]->_columns};
212 my ($self, $changes) = @_;
213 my $new = bless({ _column_data => { %{$self->{_column_data}}} }, ref $self);
214 $new->set_column($_ => $changes->{$_}) for keys %$changes;
219 my ($self, $query, $attrs) = @_;
220 return '1 = 1' unless keys %$query;
221 my $op = $attrs->{'cmp'} || '=';
222 my $cond = join(' AND ',
223 map { (defined $query->{$_}
225 : (do { delete $query->{$_}; "$_ IS NULL"; }));
227 return ($cond, values %$query);
231 shift->_table_name(@_);
236 my $hash = ref $_[0] eq "HASH" ? shift: {@_};
237 my ($exists) = $class->search($hash);
238 return defined($exists) ? $exists : $class->create($hash);
243 return $class->retrieve_from_sql( '1' );
252 Matt S. Trout <perl-stuff@trout.me.uk>
256 You may distribute this code under the same terms as Perl itself.