package SQL::Translator::Schema;
# ----------------------------------------------------------------------
-# $Id: Schema.pm,v 1.2 2003-05-03 04:07:38 kycl4rk Exp $
+# $Id: Schema.pm,v 1.16 2004-10-13 23:14:06 allenday Exp $
# ----------------------------------------------------------------------
-# Copyright (C) 2003 Ken Y. Clark <kclark@cpan.org>
+# Copyright (C) 2002-4 SQLFairy Authors
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License as
use strict;
use Class::Base;
+use SQL::Translator::Schema::Constants;
+use SQL::Translator::Schema::Procedure;
use SQL::Translator::Schema::Table;
+use SQL::Translator::Schema::Trigger;
use SQL::Translator::Schema::View;
+use SQL::Translator::Schema::Graph;
+use SQL::Translator::Utils 'parse_list_arg';
use base 'Class::Base';
-use vars qw[ $VERSION $TABLE_ORDER $VIEW_ORDER ];
+use vars qw[ $VERSION $TABLE_ORDER $VIEW_ORDER $TRIGGER_ORDER $PROC_ORDER ];
-$VERSION = 1.00;
+$VERSION = sprintf "%d.%02d", q$Revision: 1.16 $ =~ /(\d+)\.(\d+)/;
# ----------------------------------------------------------------------
sub init {
Object constructor.
- my $schema = SQL::Translator->new;
+ my $schema = SQL::Translator::Schema->new(
+ name => 'Foo',
+ database => 'MySQL',
+ );
=cut
my ( $self, $config ) = @_;
- # empty for now
+ $self->params( $config, qw[ name database ] ) || return undef;
return $self;
}
=head2 add_table
Add a table object. Returns the new SQL::Translator::Schema::Table object.
+The "name" parameter is required. If you try to create a table with the
+same name as an existing table, you will get an error and the table will
+not be created.
- my $table = $schema->add_table( name => 'foo' );
+ my $t1 = $schema->add_table( name => 'foo' ) or die $schema->error;
+ my $t2 = SQL::Translator::Schema::Table->new( name => 'bar' );
+ $t2 = $schema->add_table( $table_bar ) or die $schema->error;
=cut
- my $self = shift;
- my %args = @_;
- return $self->error('No table name') unless $args{'name'};
- my $table = SQL::Translator::Schema::Table->new( \%args ) or return
- SQL::Translator::Schema::Table->error;
+ my $self = shift;
+ my $table_class = 'SQL::Translator::Schema::Table';
+ my $table;
+
+ if ( UNIVERSAL::isa( $_[0], $table_class ) ) {
+ $table = shift;
+ $table->schema( $self );
+ }
+ else {
+ my %args = @_;
+ $args{'schema'} = $self;
+ $table = $table_class->new( \%args ) or return
+ $self->error( $table_class->error );
+ }
- $self->{'tables'}{ $table->name } = $table;
- $self->{'tables'}{ $table->name }{'order'} = ++$TABLE_ORDER;
+ $table->order( ++$TABLE_ORDER );
+ # We know we have a name as the Table->new above errors if none given.
+ my $table_name = $table->name;
+
+ if ( defined $self->{'tables'}{ $table_name } ) {
+ return $self->error(qq[Can't create table: "$table_name" exists]);
+ }
+ else {
+ $self->{'tables'}{ $table_name } = $table;
+ }
return $table;
}
# ----------------------------------------------------------------------
+sub add_procedure {
+
+=pod
+
+=head2 add_procedure
+
+Add a procedure object. Returns the new
+SQL::Translator::Schema::Procedure object. The "name" parameter is
+required. If you try to create a procedure with the same name as an
+existing procedure, you will get an error and the procedure will not
+be created.
+
+ my $p1 = $schema->add_procedure( name => 'foo' );
+ my $p2 = SQL::Translator::Schema::Procedure->new( name => 'bar' );
+ $p2 = $schema->add_procedure( $procedure_bar ) or die $schema->error;
+
+=cut
+
+ my $self = shift;
+ my $procedure_class = 'SQL::Translator::Schema::Procedure';
+ my $procedure;
+
+ if ( UNIVERSAL::isa( $_[0], $procedure_class ) ) {
+ $procedure = shift;
+ $procedure->schema( $self );
+ }
+ else {
+ my %args = @_;
+ $args{'schema'} = $self;
+ return $self->error('No procedure name') unless $args{'name'};
+ $procedure = $procedure_class->new( \%args ) or
+ return $self->error( $procedure_class->error );
+ }
+
+ $procedure->order( ++$PROC_ORDER );
+ my $procedure_name = $procedure->name or return
+ $self->error('No procedure name');
+
+ if ( defined $self->{'procedures'}{ $procedure_name } ) {
+ return $self->error(
+ qq[Can't create procedure: "$procedure_name" exists]
+ );
+ }
+ else {
+ $self->{'procedures'}{ $procedure_name } = $procedure;
+ }
+
+ return $procedure;
+}
+
+# ----------------------------------------------------------------------
+sub add_trigger {
+
+=pod
+
+=head2 add_trigger
+
+Add a trigger object. Returns the new SQL::Translator::Schema::Trigger object.
+The "name" parameter is required. If you try to create a trigger with the
+same name as an existing trigger, you will get an error and the trigger will
+not be created.
+
+ my $t1 = $schema->add_trigger( name => 'foo' );
+ my $t2 = SQL::Translator::Schema::Trigger->new( name => 'bar' );
+ $t2 = $schema->add_trigger( $trigger_bar ) or die $schema->error;
+
+=cut
+
+ my $self = shift;
+ my $trigger_class = 'SQL::Translator::Schema::Trigger';
+ my $trigger;
+
+ if ( UNIVERSAL::isa( $_[0], $trigger_class ) ) {
+ $trigger = shift;
+ $trigger->schema( $self );
+ }
+ else {
+ my %args = @_;
+ $args{'schema'} = $self;
+ return $self->error('No trigger name') unless $args{'name'};
+ $trigger = $trigger_class->new( \%args ) or
+ return $self->error( $trigger_class->error );
+ }
+
+ $trigger->order( ++$TRIGGER_ORDER );
+ my $trigger_name = $trigger->name or return $self->error('No trigger name');
+
+ if ( defined $self->{'triggers'}{ $trigger_name } ) {
+ return $self->error(qq[Can't create trigger: "$trigger_name" exists]);
+ }
+ else {
+ $self->{'triggers'}{ $trigger_name } = $trigger;
+ }
+
+ return $trigger;
+}
+
+# ----------------------------------------------------------------------
sub add_view {
=pod
=head2 add_view
Add a view object. Returns the new SQL::Translator::Schema::View object.
+The "name" parameter is required. If you try to create a view with the
+same name as an existing view, you will get an error and the view will
+not be created.
- my $view = $schema->add_view( name => 'foo' );
+ my $v1 = $schema->add_view( name => 'foo' );
+ my $v2 = SQL::Translator::Schema::View->new( name => 'bar' );
+ $v2 = $schema->add_view( $view_bar ) or die $schema->error;
=cut
- my $self = shift;
- my %args = @_;
- return $self->error('No view name') unless $args{'name'};
- my $view = SQL::Translator::Schema::View->new( @_ ) or return
- SQL::Translator::Schema::View->error;
+ my $self = shift;
+ my $view_class = 'SQL::Translator::Schema::View';
+ my $view;
- $self->{'views'}{ $view->name } = $view;
- $self->{'views'}{ $view->name }{'order'} = ++$VIEW_ORDER;
+ if ( UNIVERSAL::isa( $_[0], $view_class ) ) {
+ $view = shift;
+ $view->schema( $self );
+ }
+ else {
+ my %args = @_;
+ $args{'schema'} = $self;
+ return $self->error('No view name') unless $args{'name'};
+ $view = $view_class->new( \%args ) or return $view_class->error;
+ }
+
+ $view->order( ++$VIEW_ORDER );
+ my $view_name = $view->name or return $self->error('No view name');
+
+ if ( defined $self->{'views'}{ $view_name } ) {
+ return $self->error(qq[Can't create view: "$view_name" exists]);
+ }
+ else {
+ $self->{'views'}{ $view_name } = $view;
+ }
return $view;
}
# ----------------------------------------------------------------------
+sub database {
+
+=pod
+
+=head2 database
+
+Get or set the schema's database. (optional)
+
+ my $database = $schema->database('PostgreSQL');
+
+=cut
+
+ my $self = shift;
+ $self->{'database'} = shift if @_;
+ return $self->{'database'} || '';
+}
+
+# ----------------------------------------------------------------------
sub is_valid {
=pod
}
# ----------------------------------------------------------------------
+sub get_procedure {
+
+=pod
+
+=head2 get_procedure
+
+Returns a procedure by the name provided.
+
+ my $procedure = $schema->get_procedure('foo');
+
+=cut
+
+ my $self = shift;
+ my $procedure_name = shift or return $self->error('No procedure name');
+ return $self->error( qq[Table "$procedure_name" does not exist] ) unless
+ exists $self->{'procedures'}{ $procedure_name };
+ return $self->{'procedures'}{ $procedure_name };
+}
+
+# ----------------------------------------------------------------------
+sub get_procedures {
+
+=pod
+
+=head2 get_procedures
+
+Returns all the procedures as an array or array reference.
+
+ my @procedures = $schema->get_procedures;
+
+=cut
+
+ my $self = shift;
+ my @procedures =
+ map { $_->[1] }
+ sort { $a->[0] <=> $b->[0] }
+ map { [ $_->order, $_ ] }
+ values %{ $self->{'procedures'} };
+
+ if ( @procedures ) {
+ return wantarray ? @procedures : \@procedures;
+ }
+ else {
+ $self->error('No procedures');
+ return wantarray ? () : undef;
+ }
+}
+
+# ----------------------------------------------------------------------
sub get_table {
=pod
my $self = shift;
my $table_name = shift or return $self->error('No table name');
- return $self->error('Table "$table_name" does not exist') unless
+ return $self->error( qq[Table "$table_name" does not exist] ) unless
exists $self->{'tables'}{ $table_name };
return $self->{'tables'}{ $table_name };
}
my $self = shift;
my @tables =
- sort { $a->{'order'} <=> $b->{'order'} }
+ map { $_->[1] }
+ sort { $a->[0] <=> $b->[0] }
+ map { [ $_->order, $_ ] }
values %{ $self->{'tables'} };
if ( @tables ) {
}
# ----------------------------------------------------------------------
+sub get_trigger {
+
+=pod
+
+=head2 get_trigger
+
+Returns a trigger by the name provided.
+
+ my $trigger = $schema->get_trigger('foo');
+
+=cut
+
+ my $self = shift;
+ my $trigger_name = shift or return $self->error('No trigger name');
+ return $self->error( qq[Table "$trigger_name" does not exist] ) unless
+ exists $self->{'triggers'}{ $trigger_name };
+ return $self->{'triggers'}{ $trigger_name };
+}
+
+# ----------------------------------------------------------------------
+sub get_triggers {
+
+=pod
+
+=head2 get_triggers
+
+Returns all the triggers as an array or array reference.
+
+ my @triggers = $schema->get_triggers;
+
+=cut
+
+ my $self = shift;
+ my @triggers =
+ map { $_->[1] }
+ sort { $a->[0] <=> $b->[0] }
+ map { [ $_->order, $_ ] }
+ values %{ $self->{'triggers'} };
+
+ if ( @triggers ) {
+ return wantarray ? @triggers : \@triggers;
+ }
+ else {
+ $self->error('No triggers');
+ return wantarray ? () : undef;
+ }
+}
+
+# ----------------------------------------------------------------------
sub get_view {
=pod
my $self = shift;
my @views =
- sort { $a->{'order'} <=> $b->{'order'} } values %{ $self->{'views'} };
+ map { $_->[1] }
+ sort { $a->[0] <=> $b->[0] }
+ map { [ $_->order, $_ ] }
+ values %{ $self->{'views'} };
if ( @views ) {
return wantarray ? @views : \@views;
}
}
+# ----------------------------------------------------------------------
+sub make_natural_joins {
+
+=pod
+
+=head2 make_natural_joins
+
+Creates foriegn key relationships among like-named fields in different
+tables. Accepts the following arguments:
+
+=over 4
+
+=item * join_pk_only
+
+A True or False argument which determins whether or not to perform
+the joins from primary keys to fields of the same name in other tables
+
+=item * skip_fields
+
+A list of fields to skip in the joins
+
+=back 4
+
+ $schema->make_natural_joins(
+ join_pk_only => 1,
+ skip_fields => 'name,department_id',
+ );
+
+=cut
+
+ my $self = shift;
+ my %args = @_;
+ my $join_pk_only = $args{'join_pk_only'} || 0;
+ my %skip_fields = map { s/^\s+|\s+$//g; $_, 1 } @{
+ parse_list_arg( $args{'skip_fields'} )
+ };
+
+ my ( %common_keys, %pk );
+ for my $table ( $self->get_tables ) {
+ for my $field ( $table->get_fields ) {
+ my $field_name = $field->name or next;
+ next if $skip_fields{ $field_name };
+ $pk{ $field_name } = 1 if $field->is_primary_key;
+ push @{ $common_keys{ $field_name } }, $table->name;
+ }
+ }
+
+ for my $field ( keys %common_keys ) {
+ next if $join_pk_only and !defined $pk{ $field };
+
+ my @table_names = @{ $common_keys{ $field } };
+ next unless scalar @table_names > 1;
+
+ for my $i ( 0 .. $#table_names ) {
+ my $table1 = $self->get_table( $table_names[ $i ] ) or next;
+
+ for my $j ( 1 .. $#table_names ) {
+ my $table2 = $self->get_table( $table_names[ $j ] ) or next;
+ next if $table1->name eq $table2->name;
+
+ $table1->add_constraint(
+ type => FOREIGN_KEY,
+ fields => $field,
+ reference_table => $table2->name,
+ reference_fields => $field,
+ );
+ }
+ }
+ }
+
+ return 1;
+}
+
+# ----------------------------------------------------------------------
+sub name {
+
+=pod
+
+=head2 name
+
+Get or set the schema's name. (optional)
+
+ my $schema_name = $schema->name('Foo Database');
+
+=cut
+
+ my $self = shift;
+ $self->{'name'} = shift if @_;
+ return $self->{'name'} || '';
+}
+
+# ----------------------------------------------------------------------
+sub DESTROY {
+ my $self = shift;
+ undef $_ for values %{ $self->{'tables'} };
+ undef $_ for values %{ $self->{'views'} };
+}
+
1;
# ----------------------------------------------------------------------
projects / dbsrgits/SQL-Translator.git / blobdiff