1 package SQL::Translator::Schema::Procedure;
7 SQL::Translator::Schema::Procedure - SQL::Translator procedure object
11 use SQL::Translator::Schema::Procedure;
12 my $procedure = SQL::Translator::Schema::Procedure->new(
14 sql => 'CREATE PROC foo AS SELECT * FROM bar',
15 parameters => 'foo,bar',
17 comments => 'blah blah blah',
23 C<SQL::Translator::Schema::Procedure> is a class for dealing with
24 stored procedures (and possibly other pieces of nameable SQL code?).
31 use SQL::Translator::Utils qw(parse_list_arg ex2err);
32 use SQL::Translator::Types qw(schema_obj);
33 use List::MoreUtils qw(uniq);
35 extends 'SQL::Translator::Schema::Object';
37 our $VERSION = '1.59';
43 my $schema = SQL::Translator::Schema::Procedure->new;
49 Gets and set the parameters of the stored procedure.
51 $procedure->parameters('id');
52 $procedure->parameters('id', 'name');
53 $procedure->parameters( 'id, name' );
54 $procedure->parameters( [ 'id', 'name' ] );
55 $procedure->parameters( qw[ id name ] );
57 my @parameters = $procedure->parameters;
63 default => sub { [] },
64 coerce => sub { [uniq @{parse_list_arg($_[0])}] },
67 around parameters => sub {
70 my $fields = parse_list_arg( @_ );
71 $self->$orig($fields) if @$fields;
73 return wantarray ? @{ $self->$orig } : $self->$orig;
78 Get or set the procedure's name.
80 $procedure->name('foo');
81 my $name = $procedure->name;
85 has name => ( is => 'rw', default => sub { '' } );
89 Get or set the procedure's SQL.
91 $procedure->sql('select * from foo');
92 my $sql = $procedure->sql;
96 has sql => ( is => 'rw', default => sub { '' } );
100 Get or set the order of the procedure.
102 $procedure->order( 3 );
103 my $order = $procedure->order;
107 has order => ( is => 'rw' );
112 Get or set the owner of the procedure.
114 $procedure->owner('nomar');
115 my $sql = $procedure->owner;
119 has owner => ( is => 'rw', default => sub { '' } );
123 Get or set the comments on a procedure.
125 $procedure->comments('foo');
126 $procedure->comments('bar');
127 print join( ', ', $procedure->comments ); # prints "foo, bar"
133 coerce => sub { ref($_[0]) eq 'ARRAY' ? $_[0] : [$_[0]] },
134 default => sub { [] },
137 around comments => sub {
140 my @comments = ref $_[0] ? @{ $_[0] } : @_;
142 for my $arg ( @comments ) {
143 $arg = $arg->[0] if ref $arg;
144 push @{ $self->$orig }, $arg if defined $arg && $arg;
147 return wantarray ? @{ $self->$orig } : join( "\n", @{ $self->$orig } );
152 Get or set the procedures's schema object.
154 $procedure->schema( $schema );
155 my $schema = $procedure->schema;
159 has schema => ( is => 'rw', isa => schema_obj('Schema'), weak_ref => 1 );
161 around schema => \&ex2err;
165 Determines if this procedure is the same as another
167 my $isIdentical = $procedure1->equals( $procedure2 );
171 around equals => sub {
175 my $case_insensitive = shift;
176 my $ignore_sql = shift;
178 return 0 unless $self->$orig($other);
179 return 0 unless $case_insensitive ? uc($self->name) eq uc($other->name) : $self->name eq $other->name;
181 unless ($ignore_sql) {
182 my $selfSql = $self->sql;
183 my $otherSql = $other->sql;
185 $selfSql =~ s/--.*$//mg;
186 $otherSql =~ s/--.*$//mg;
187 # Collapse whitespace to space to avoid whitespace comparison issues
188 $selfSql =~ s/\s+/ /sg;
189 $otherSql =~ s/\s+/ /sg;
190 return 0 unless $selfSql eq $otherSql;
193 return 0 unless $self->_compare_objects(scalar $self->parameters, scalar $other->parameters);
194 # return 0 unless $self->comments eq $other->comments;
195 # return 0 unless $case_insensitive ? uc($self->owner) eq uc($other->owner) : $self->owner eq $other->owner;
196 return 0 unless $self->_compare_objects(scalar $self->extra, scalar $other->extra);
200 # Must come after all 'has' declarations
201 around new => \&ex2err;
209 Ken Youens-Clark E<lt>kclark@cshl.orgE<gt>,
210 Paul Harrington E<lt>Paul-Harrington@deshaw.comE<gt>.