1 package SQL::Translator::Schema;
3 # ----------------------------------------------------------------------
4 # $Id: Schema.pm,v 1.5 2003-06-06 00:11:06 kycl4rk Exp $
5 # ----------------------------------------------------------------------
6 # Copyright (C) 2003 Ken Y. Clark <kclark@cpan.org>
8 # This program is free software; you can redistribute it and/or
9 # modify it under the terms of the GNU General Public License as
10 # published by the Free Software Foundation; version 2.
12 # This program is distributed in the hope that it will be useful, but
13 # WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 # General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with this program; if not, write to the Free Software
19 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
21 # -------------------------------------------------------------------
27 SQL::Translator::Schema - SQL::Translator schema object
31 use SQL::Translator::Schema;
32 my $schema = SQL::Translator::Schema->new;
33 my $table = $schema->add_table( name => 'foo' );
34 my $view = $schema->add_view( name => 'bar', sql => '...' );
38 C<SQL::Translator::Schema> is the object that accepts, validates, and
39 returns the database structure.
47 use SQL::Translator::Schema::Table;
48 use SQL::Translator::Schema::View;
50 use base 'Class::Base';
51 use vars qw[ $VERSION $TABLE_ORDER $VIEW_ORDER ];
55 # ----------------------------------------------------------------------
64 my $schema = SQL::Translator->new(
71 my ( $self, $config ) = @_;
72 $self->params( $config, qw[ name database ] ) || return undef;
76 # ----------------------------------------------------------------------
83 Add a table object. Returns the new SQL::Translator::Schema::Table object.
84 The "name" parameter is required. If you try to create a table with the
85 same name as an existing table, you will get an error and the table will
88 my $t1 = $schema->add_table( name => 'foo' ) or die $schema->error;
89 my $t2 = SQL::Translator::Schema::Table->new( name => 'bar' );
90 $t2 = $schema->add_table( $table_bar ) or die $schema->error;
95 my $table_class = 'SQL::Translator::Schema::Table';
98 if ( UNIVERSAL::isa( $_[0], $table_class ) ) {
100 $table->schema( $self );
104 $args{'schema'} = $self;
105 $table = $table_class->new( \%args ) or return
106 $self->error( $table_class->error );
109 $table->order( ++$TABLE_ORDER );
110 my $table_name = $table->name or return $self->error('No table name');
112 if ( defined $self->{'tables'}{ $table_name } ) {
113 return $self->error(qq[Can't create table: "$table_name" exists]);
116 $self->{'tables'}{ $table_name } = $table;
122 # ----------------------------------------------------------------------
129 Add a view object. Returns the new SQL::Translator::Schema::View object.
130 The "name" parameter is required. If you try to create a view with the
131 same name as an existing view, you will get an error and the view will
134 my $v1 = $schema->add_view( name => 'foo' );
135 my $v2 = SQL::Translator::Schema::View->new( name => 'bar' );
136 $v2 = $schema->add_view( $view_bar ) or die $schema->error;
141 my $view_class = 'SQL::Translator::Schema::View';
144 if ( UNIVERSAL::isa( $_[0], $view_class ) ) {
149 return $self->error('No view name') unless $args{'name'};
150 $view = $view_class->new( \%args ) or return $view_class->error;
153 $view->order( ++$VIEW_ORDER );
154 my $view_name = $view->name or return $self->error('No view name');
156 if ( defined $self->{'views'}{ $view_name } ) {
157 return $self->error(qq[Can't create view: "$view_name" exists]);
160 $self->{'views'}{ $view_name } = $view;
166 # ----------------------------------------------------------------------
173 Get or set the schema's database. (optional)
175 my $database = $schema->database('PostgreSQL');
180 $self->{'database'} = shift if @_;
181 return $self->{'database'} || '';
184 # ----------------------------------------------------------------------
191 Returns true if all the tables and views are valid.
193 my $ok = $schema->is_valid or die $schema->error;
199 return $self->error('No tables') unless $self->get_tables;
201 for my $object ( $self->get_tables, $self->get_views ) {
202 return $object->error unless $object->is_valid;
208 # ----------------------------------------------------------------------
215 Returns a table by the name provided.
217 my $table = $schema->get_table('foo');
222 my $table_name = shift or return $self->error('No table name');
223 return $self->error( qq[Table "$table_name" does not exist] ) unless
224 exists $self->{'tables'}{ $table_name };
225 return $self->{'tables'}{ $table_name };
228 # ----------------------------------------------------------------------
235 Returns all the tables as an array or array reference.
237 my @tables = $schema->get_tables;
244 sort { $a->[0] <=> $b->[0] }
245 map { [ $_->order, $_ ] }
246 values %{ $self->{'tables'} };
249 return wantarray ? @tables : \@tables;
252 $self->error('No tables');
253 return wantarray ? () : undef;
257 # ----------------------------------------------------------------------
264 Returns a view by the name provided.
266 my $view = $schema->get_view('foo');
271 my $view_name = shift or return $self->error('No view name');
272 return $self->error('View "$view_name" does not exist') unless
273 exists $self->{'views'}{ $view_name };
274 return $self->{'views'}{ $view_name };
277 # ----------------------------------------------------------------------
284 Returns all the views as an array or array reference.
286 my @views = $schema->get_views;
293 sort { $a->[0] <=> $b->[0] }
294 map { [ $_->order, $_ ] }
295 values %{ $self->{'views'} };
298 return wantarray ? @views : \@views;
301 $self->error('No views');
302 return wantarray ? () : undef;
306 # ----------------------------------------------------------------------
313 Get or set the schema's name. (optional)
315 my $schema_name = $schema->name('Foo Database');
320 $self->{'name'} = shift if @_;
321 return $self->{'name'} || '';
324 # ----------------------------------------------------------------------
327 undef $_ for values %{ $self->{'tables'} };
328 undef $_ for values %{ $self->{'views'} };
333 # ----------------------------------------------------------------------
339 Ken Y. Clark E<lt>kclark@cpan.orgE<gt>