use strict;
use warnings;
-use DBIx::Class::Cursor;
+use DBIx::Class::ResultSet;
-use base qw/Class::Data::Inheritable/;
+use Carp qw/croak/;
-__PACKAGE__->mk_classdata('_columns' => {});
+use base qw/DBIx::Class/;
+__PACKAGE__->load_components(qw/AccessorGroup/);
-__PACKAGE__->mk_classdata('_table_name');
-
-__PACKAGE__->mk_classdata('table_alias'); # FIXME: Doesn't actually do anything yet!
-
-__PACKAGE__->mk_classdata('_cursor_class' => 'DBIx::Class::Cursor');
+__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 new {
my ($class, $attrs) = @_;
$class = ref $class if ref $class;
- my $new = bless({ _column_data => { } }, $class);
- if ($attrs) {
- $new->throw("attrs must be a hashref" ) unless ref($attrs) eq 'HASH';
- while (my ($k, $v) = each %{$attrs}) {
- $new->store_column($k => $v);
- }
- }
+ 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;
- #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;
- $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 in_database {
- my ($self, $val) = @_;
- $self->{_in_database} = $val if @_ > 1;
- return $self->{_in_database};
-}
+*add_column = \&add_columns;
-sub create {
- my ($class, $attrs) = @_;
- $class->throw( "create needs a hashref" ) unless ref $attrs eq 'HASH';
- return $class->new($attrs)->insert;
-}
+=head2 add_columns
-sub update {
- my ($self) = @_;
- $self->throw( "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;
- if ($rows == 0) {
- $self->throw( "Can't update $self: row not found" );
- } elsif ($rows > 1) {
- $self->throw("Can't update $self: updated more than one row");
- }
- $self->{_dirty_columns} = {};
- return $self;
-}
+ $table->add_columns(qw/col1 col2 col3/);
-sub delete {
- my $self = shift;
- if (ref $self) {
- $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->in_database(undef);
- } 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;
- }
- return $self;
-}
+ $table->add_columns('col1' => \%col1_info, 'col2' => \%col2_info, ...);
-sub get_column {
- my ($self, $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;
-}
+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?);
-sub set_column {
+Convenience alias to add_columns
+
+=cut
+
+sub resultset {
my $self = shift;
- my ($column) = @_;
- my $ret = $self->store_column(@_);
- $self->{_dirty_columns}{$column} = 1;
- return $ret;
+ return $self->{resultset} ||= $self->resultset_class->new($self);
}
-sub store_column {
- my ($self, $column, $value) = @_;
- $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;
-}
+=head2 has_column
+
+ if ($obj->has_column($col)) { ... }
+
+Returns 1 if the table has a column of this name, 0 otherwise.
+
+=cut
-sub _register_columns {
- my ($class, @cols) = @_;
- my $names = { %{$class->_columns} };
- $names->{$_} ||= {} for @cols;
- $class->_columns($names);
+sub has_column {
+ my ($self, $column) = @_;
+ return exists $self->_columns->{$column};
}
-sub _mk_column_accessors {
- my ($class, @cols) = @_;
- $class->mk_group_accessors('column' => @cols);
-}
+=head2 column_info
+
+ my $info = $obj->column_info($col);
+
+Returns the column metadata hashref for a column.
+
+=cut
-sub add_columns {
- my ($class, @cols) = @_;
- $class->_register_columns(@cols);
- $class->_mk_column_accessors(@cols);
+sub column_info {
+ my ($self, $column) = @_;
+ croak "No such column $column" unless exists $self->_columns->{$column};
+ return $self->_columns->{$column};
}
-sub retrieve_from_sql {
- 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, { where => $cond });
-}
+=head2 columns
-sub sth_to_objects {
- my ($class, $sth, $args, $cols, $attrs) = @_;
- my @cols = ((ref $cols eq 'ARRAY') ? @$cols : @{$sth->{NAME_lc}} );
- my $cursor_class = $class->_cursor_class;
- eval "use $cursor_class;";
- my $cursor = $cursor_class->new($class, $sth, $args, \@cols, $attrs);
- return (wantarray ? $cursor->all : $cursor);
-}
+ my @column_names = $obj->columns;
+
+=cut
-sub _row_to_object { # WARNING: Destructive to @$row
- my ($class, $cols, $row) = @_;
- my $new = $class->new;
- $new->store_column($_, shift @$row) for @$cols;
- $new->in_database(1);
- return $new;
+sub columns {
+ croak "columns() is a read-only accessor, did you mean add_columns()?" if (@_ > 1);
+ return keys %{shift->_columns};
}
-sub search {
- my $class = shift;
- 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);
-}
+=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 search_like {
- my $class = shift;
- my $attrs = { };
- if (@_ > 1 && ref $_[$#_] eq 'HASH') {
- $attrs = pop(@_);
+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 $class->search(@_, { %$attrs, cmp => 'LIKE' });
+ $self->_primaries(\@cols);
}
-sub _select_columns {
- return keys %{$_[0]->_columns};
-}
+=head2 primary_columns
+
+Read-only accessor which returns the list of primary keys.
+
+=cut
-sub copy {
- my ($self, $changes) = @_;
- my $new = bless({ _column_data => { %{$self->{_column_data}}} }, ref $self);
- $new->set_column($_ => $changes->{$_}) for keys %$changes;
- return $new->insert;
+sub primary_columns {
+ return @{shift->_primaries||[]};
}
-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);
-}
+=head2 from
-sub table {
- shift->_table_name(@_);
-}
+Returns the FROM entry for the table (i.e. the table name)
-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);
-}
+=cut
-sub retrieve_all {
- my ($class) = @_;
- return $class->retrieve_from_sql( '1' );
-}
+sub from { return shift->name(@_); }
-1;
-=back
+1;
=head1 AUTHORS
-Matt S. Trout <perl-stuff@trout.me.uk>
+Matt S. Trout <mst@shadowcatsystems.co.uk>
=head1 LICENSE
projects / dbsrgits/DBIx-Class.git / blobdiff