die() if the user inadvertently tries to set the column list using
[dbsrgits/DBIx-Class-Historic.git] / lib / DBIx / Class / Table.pm
CommitLineData
ea2e61bf 1package DBIx::Class::Table;
2
3use strict;
4use warnings;
5
223b8fe3 6use DBIx::Class::ResultSet;
2a21de92 7use Data::Page;
95a70f01 8
1edd1722 9use base qw/DBIx::Class/;
ea2e61bf 10
11__PACKAGE__->mk_classdata('_columns' => {});
12
ea2e61bf 13__PACKAGE__->mk_classdata('_table_name');
14
34d52be2 15__PACKAGE__->mk_classdata('table_alias'); # FIXME: Doesn't actually do anything yet!
16
223b8fe3 17__PACKAGE__->mk_classdata('_resultset_class' => 'DBIx::Class::ResultSet');
95a70f01 18
223b8fe3 19sub iterator_class { shift->_resultset_class(@_) }
525035fb 20
34d52be2 21=head1 NAME
22
23DBIx::Class::Table - Basic table methods
24
25=head1 SYNOPSIS
26
27=head1 DESCRIPTION
28
29This class is responsible for defining and doing basic operations on
30L<DBIx::Class> objects.
31
32=head1 METHODS
33
34=over 4
35
39fe0e65 36=cut
37
ea2e61bf 38sub _register_columns {
39 my ($class, @cols) = @_;
40 my $names = { %{$class->_columns} };
41 $names->{$_} ||= {} for @cols;
42 $class->_columns($names);
43}
44
45sub _mk_column_accessors {
46 my ($class, @cols) = @_;
510ca912 47 $class->mk_group_accessors('column' => @cols);
ea2e61bf 48}
49
39fe0e65 50=item add_columns
51
52 __PACKAGE__->add_columns(qw/col1 col2 col3/);
53
54Adds columns to the current package, and creates accessors for them
55
56=cut
57
510ca912 58sub add_columns {
8fe001e1 59 my ($class, @cols) = @_;
60 $class->_register_columns(@cols);
61 $class->_mk_column_accessors(@cols);
62}
63
656796f2 64=item search_literal
39fe0e65 65
656796f2 66 my @obj = $class->search_literal($literal_where_cond, @bind);
67 my $cursor = $class->search_literal($literal_where_cond, @bind);
39fe0e65 68
69=cut
70
656796f2 71sub search_literal {
8fe001e1 72 my ($class, $cond, @vals) = @_;
a3018bd3 73 $cond =~ s/^\s*WHERE//i;
8da9889b 74 my $attrs = (ref $vals[$#vals] eq 'HASH' ? { %{ pop(@vals) } } : {});
75 $attrs->{bind} = \@vals;
76 return $class->search(\$cond, $attrs);
510ca912 77}
78
656796f2 79=item count_literal
39fe0e65 80
656796f2 81 my $count = $class->count_literal($literal_where_cond);
39fe0e65 82
83=cut
84
656796f2 85sub count_literal {
7624b19f 86 my $class = shift;
87 return $class->search_literal(@_)->count;
fcbc5f29 88}
89
39fe0e65 90=item count
91
92 my $count = $class->count({ foo => 3 });
93
94=cut
95
06d90c6b 96sub count {
97 my $class = shift;
7624b19f 98 return $class->search(@_)->count;
c1d23573 99}
100
39fe0e65 101=item search
102
20f67ac7 103 my @obj = $class->search({ foo => 3 }); # "... WHERE foo = 3"
39fe0e65 104 my $cursor = $class->search({ foo => 3 });
105
20f67ac7 106To retrieve all rows, simply call C<search()> with no condition parameter,
107
108 my @all = $class->search(); # equivalent to search({})
109
110If you need to pass in additional attributes (see
111L<DBIx::Class::ResultSet/Attributes> for details) an empty hash indicates
112no condition,
113
114 my @all = $class->search({}, { cols => [qw/foo bar/] }); # "SELECT foo, bar FROM $class_table"
115
39fe0e65 116=cut
117
8fe001e1 118sub search {
12bbb339 119 my $class = shift;
8b445e33 120 #warn "@_";
12bbb339 121 my $attrs = { };
122 if (@_ > 1 && ref $_[$#_] eq 'HASH') {
123 $attrs = { %{ pop(@_) } };
124 }
7624b19f 125 $attrs->{where} = (@_ == 1 || ref $_[0] eq "HASH" ? shift: {@_});
2a21de92 126
7624b19f 127 my $rs = $class->resultset($attrs);
2a21de92 128
7624b19f 129 return (wantarray ? $rs->all : $rs);
130}
131
132sub resultset {
133 my $class = shift;
134
135 my $rs_class = $class->_resultset_class;
136 eval "use $rs_class;";
137 my $rs = $rs_class->new($class, @_);
a3018bd3 138}
139
39fe0e65 140=item search_like
141
142Identical to search except defaults to 'LIKE' instead of '=' in condition
143
144=cut
145
a3018bd3 146sub search_like {
147 my $class = shift;
12bbb339 148 my $attrs = { };
149 if (@_ > 1 && ref $_[$#_] eq 'HASH') {
150 $attrs = pop(@_);
151 }
223b8fe3 152 my $query = ref $_[0] eq "HASH" ? { %{shift()} }: {@_};
153 $query->{$_} = { 'like' => $query->{$_} } for keys %$query;
154 return $class->search($query, { %$attrs });
8fe001e1 155}
156
157sub _select_columns {
158 return keys %{$_[0]->_columns};
159}
160
39fe0e65 161=item table
162
163 __PACKAGE__->table('tbl_name');
164
165=cut
166
510ca912 167sub table {
168 shift->_table_name(@_);
169}
170
39fe0e65 171=item find_or_create
172
173 $class->find_or_create({ key => $val, ... });
174
175Searches for a record matching the search condition; if it doesn't find one,
176creates one and returns that instead
177
178=cut
179
95a70f01 180sub find_or_create {
181 my $class = shift;
182 my $hash = ref $_[0] eq "HASH" ? shift: {@_};
1a14aa3f 183 my $exists = $class->find($hash);
95a70f01 184 return defined($exists) ? $exists : $class->create($hash);
185}
186
103647d5 187=item has_column
188
189 if ($obj->has_column($col)) { ... }
190
191Returns 1 if the object has a column of this name, 0 otherwise
192
193=cut
194
195sub has_column {
196 my ($self, $column) = @_;
197 return exists $self->_columns->{$column};
198}
199
200=item column_info
201
202 my $info = $obj->column_info($col);
203
204Returns the column metadata hashref for the column
205
206=cut
207
208sub column_info {
209 my ($self, $column) = @_;
210 die "No such column $column" unless exists $self->_columns->{$column};
211 return $self->_columns->{$column};
212}
213
214=item columns
215
216 my @column_names = $obj->columns;
217
218=cut
219
e7513319 220sub columns {
221 die "columns() is a read-only accessor, did you mean add_columns()?" if (@_ > 1);
222 return keys %{shift->_columns};
223}
8b445e33 224
ea2e61bf 2251;
34d52be2 226
227=back
228
229=head1 AUTHORS
230
daec44b8 231Matt S. Trout <mst@shadowcatsystems.co.uk>
34d52be2 232
233=head1 LICENSE
234
235You may distribute this code under the same terms as Perl itself.
236
237=cut
238