use DBIx::Class::ResultSet;
-use base qw/DBIx::Class/;
-
-__PACKAGE__->mk_classdata('_columns' => {});
-
-__PACKAGE__->mk_classdata('_table_name');
+use Carp qw/croak/;
-__PACKAGE__->mk_classdata('table_alias'); # FIXME: Doesn't actually do anything yet!
-
-__PACKAGE__->mk_classdata('_resultset_class' => 'DBIx::Class::ResultSet');
+use base qw/DBIx::Class/;
+__PACKAGE__->load_components(qw/AccessorGroup/);
-sub iterator_class { shift->_resultset_class(@_) }
+__PACKAGE__->mk_group_accessors('simple' =>
+ qw/_columns _primaries name resultset_class result_class storage/);
=head1 NAME
-DBIx::Class::Table - Basic table methods
+DBIx::Class::Table - Table object
=head1 SYNOPSIS
=head1 DESCRIPTION
-This class is responsible for defining and doing basic operations on
-L<DBIx::Class> objects.
+This class is responsible for defining and doing table-level operations on
+L<DBIx::Class> classes.
=head1 METHODS
-=over 4
-
=cut
-sub _register_columns {
- my ($class, @cols) = @_;
- my $names = { %{$class->_columns} };
- while (my $col = shift @cols) {
- $names->{$col} = (ref $cols[0] ? shift : {});
- }
- $class->_columns($names);
-}
-
-sub _mk_column_accessors {
- my ($class, @cols) = @_;
- $class->mk_group_accessors('column' => @cols);
+sub new {
+ my ($class, $attrs) = @_;
+ $class = ref $class if ref $class;
+ my $new = bless({ %{$attrs || {}} }, $class);
+ $new->{resultset_class} ||= 'DBIx::Class::ResultSet';
+ $new->{_columns} ||= {};
+ $new->{name} ||= "!!NAME NOT SET!!";
+ return $new;
}
-=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);
-}
-
-=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 = shift;
- return $class->search_literal(@_)->count;
-}
-
-=item count
-
- my $count = $class->count({ foo => 3 });
-
-=cut
-
-sub count {
- my $class = shift;
- return $class->search(@_)->count;
-}
-
-=item search
-
- my @obj = $class->search({ foo => 3 }); # "... WHERE foo = 3"
- my $cursor = $class->search({ foo => 3 });
-
-To retrieve all rows, simply call C<search()> with no condition parameter,
-
- my @all = $class->search(); # equivalent to search({})
-
-If you need to pass in additional attributes (see
-L<DBIx::Class::ResultSet/Attributes> for details) an empty hash indicates
-no condition,
-
- my @all = $class->search({}, { cols => [qw/foo bar/] }); # "SELECT foo, bar FROM $class_table"
-
-=cut
-
-sub resultset {
- my $class = shift;
-
- my $rs_class = $class->_resultset_class;
- eval "use $rs_class;";
- my $rs = $rs_class->new($class, @_);
-}
-
-=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(@_);
+ my ($self, @cols) = @_;
+ while (my $col = shift @cols) {
+ $self->_columns->{$col} = (ref $cols[0] ? shift : {});
}
- 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};
-}
+*add_column = \&add_columns;
-=item table
+=head2 add_columns
- __PACKAGE__->table('tbl_name');
+ $table->add_columns(qw/col1 col2 col3/);
-=cut
+ $table->add_columns('col1' => \%col1_info, 'col2' => \%col2_info, ...);
-sub table {
- shift->_table_name(@_);
-}
+Adds columns to the table object. If supplied key => hashref pairs uses
+the hashref as the column_info for that column.
-=item find_or_create
+=head2 add_column
- $class->find_or_create({ key => $val, ... });
+ $table->add_column('col' => \%info?);
-Searches for a record matching the search condition; if it doesn't find one,
-creates one and returns that instead
+Convenience alias to add_columns
=cut
-sub find_or_create {
- my $class = shift;
- my $hash = ref $_[0] eq "HASH" ? shift: {@_};
- my $exists = $class->find($hash);
- return defined($exists) ? $exists : $class->create($hash);
+sub resultset {
+ my $self = shift;
+ return $self->{resultset} ||= $self->resultset_class->new($self);
}
-=item has_column
+=head2 has_column
if ($obj->has_column($col)) { ... }
-Returns 1 if the object has a column of this name, 0 otherwise
+Returns 1 if the table has a column of this name, 0 otherwise.
=cut
return exists $self->_columns->{$column};
}
-=item column_info
+=head2 column_info
my $info = $obj->column_info($col);
-Returns the column metadata hashref for the column
+Returns the column metadata hashref for a column.
=cut
sub column_info {
my ($self, $column) = @_;
- die "No such column $column" unless exists $self->_columns->{$column};
+ croak "No such column $column" unless exists $self->_columns->{$column};
return $self->_columns->{$column};
}
-=item columns
-
+=head2 columns
+
my @column_names = $obj->columns;
=cut
-sub columns { return keys %{shift->_columns}; }
+sub columns {
+ croak "columns() is a read-only accessor, did you mean add_columns()?" if (@_ > 1);
+ return keys %{shift->_columns};
+}
-1;
+=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($_);
+ }
+ $self->_primaries(\@cols);
+}
+
+=head2 primary_columns
+
+Read-only accessor which returns the list of primary keys.
+
+=cut
-=back
+sub primary_columns {
+ return @{shift->_primaries||[]};
+}
+
+=head2 from
+
+Returns the FROM entry for the table (i.e. the table name)
+
+=cut
+
+sub from { return shift->name(@_); }
+
+
+1;
=head1 AUTHORS
projects / dbsrgits/DBIx-Class.git / blobdiff