1 package SQL::Translator::Schema::Trigger;
7 SQL::Translator::Schema::Trigger - SQL::Translator trigger object
11 use SQL::Translator::Schema::Trigger;
12 my $trigger = SQL::Translator::Schema::Trigger->new(
14 perform_action_when => 'before', # or after
15 database_events => [qw/update insert/], # also update, update_on, delete
16 fields => [], # if event is "update"
17 on_table => 'foo', # table name
18 action => '...', # text of trigger
19 schema => $schema, # Schema object
20 scope => 'row', # or statement
25 C<SQL::Translator::Schema::Trigger> is the trigger object.
32 use SQL::Translator::Utils qw(parse_list_arg ex2err throw);
33 use SQL::Translator::Types qw(schema_obj);
34 use List::MoreUtils qw(uniq);
36 extends 'SQL::Translator::Schema::Object';
38 our $VERSION = '1.59';
44 my $schema = SQL::Translator::Schema::Trigger->new;
48 around BUILDARGS => sub {
49 my ($orig, $self, @args) = @_;
50 my $args = $self->$orig(@args);
51 if (exists $args->{on_table}) {
52 my $arg = delete $args->{on_table};
53 my $table = $args->{schema}->get_table($arg)
54 or die "Table named $arg doesn't exist";
55 $args->{table} = $table;
57 if (exists $args->{database_event}) {
58 $args->{database_events} = delete $args->{database_event};
63 =head2 perform_action_when
65 Gets or sets whether the event happens "before" or "after" the
68 $trigger->perform_action_when('after');
72 has perform_action_when => (
74 coerce => sub { defined $_[0] ? lc $_[0] : $_[0] },
76 throw("Invalid argument '$_[0]' to perform_action_when")
77 if defined $_[0] and $_[0] !~ m/^(before|after)$/i;
81 around perform_action_when => \&ex2err;
89 Obsolete please use database_events!
95 return $self->database_events( @_ );
98 =head2 database_events
100 Gets or sets the events that triggers the trigger.
102 my $ok = $trigger->database_events('insert');
106 has database_events => (
108 coerce => sub { [ map { lc } ref $_[0] eq 'ARRAY' ? @{$_[0]} : ($_[0]) ] },
111 my %valid = map { $_, 1 } qw[ insert update update_on delete ];
112 my @invalid = grep { !defined $valid{ $_ } } @args;
116 sprintf("Invalid events '%s' in database_events",
124 around database_events => sub {
125 my ($orig,$self) = (shift, shift);
128 ex2err($orig, $self, ref $_[0] eq 'ARRAY' ? $_[0] : \@_)
133 ? @{ $self->$orig || [] }
139 Gets and set which fields to monitor for C<database_event>.
142 $view->fields('id', 'name');
143 $view->fields( 'id, name' );
144 $view->fields( [ 'id', 'name' ] );
145 $view->fields( qw[ id name ] );
147 my @fields = $view->fields;
154 my @fields = uniq @{parse_list_arg($_[0])};
155 @fields ? \@fields : undef;
159 around fields => sub {
162 my $fields = parse_list_arg( @_ );
163 $self->$orig($fields) if @$fields;
165 return wantarray ? @{ $self->$orig || [] } : $self->$orig;
170 Gets or set the table on which the trigger works, as a L<SQL::Translator::Schema::Table> object.
171 $trigger->table($triggered_table);
175 has table => ( is => 'rw', isa => schema_obj('Table'), weak_ref => 1 );
177 around table => \&ex2err;
185 Gets or set the table name on which the trigger works, as a string.
186 $trigger->on_table('foo');
190 my ($self, $arg) = @_;
192 my $table = $self->schema->get_table($arg);
193 die "Table named $arg doesn't exist"
195 $self->table($table);
197 return $self->table->name;
202 Gets or set the action of the trigger.
215 has action => ( is => 'rw', default => sub { '' } );
223 Determine whether the trigger is valid or not.
225 my $ok = $trigger->is_valid;
232 qw[ name perform_action_when database_events on_table action ]
234 return $self->error("Invalid: missing '$attr'") unless $self->$attr();
237 return $self->error("Missing fields for UPDATE ON") if
238 $self->database_event eq 'update_on' && !$self->fields;
245 Get or set the trigger's name.
247 my $name = $trigger->name('foo');
251 has name => ( is => 'rw', default => sub { '' } );
255 Get or set the trigger's order.
257 my $order = $trigger->order(3);
261 has order => ( is => 'rw', default => sub { 0 } );
263 around order => sub {
264 my ( $orig, $self, $arg ) = @_;
266 if ( defined $arg && $arg =~ /^\d+$/ ) {
267 return $self->$orig($arg);
275 Get or set the trigger's scope (row or statement).
277 my $scope = $trigger->scope('statement');
285 throw( "Invalid scope '$arg'" )
286 if defined $arg and $arg !~ /^(row|statement)$/i;
290 around scope => \&ex2err;
295 Get or set the trigger's schema object.
297 $trigger->schema( $schema );
298 my $schema = $trigger->schema;
302 has schema => (is => 'rw', isa => schema_obj('Schema'), weak_ref => 1 );
304 around schema => \&ex2err;
310 =head2 compare_arrays
316 my ($first, $second) = @_;
317 no warnings; # silence spurious -w undef complaints
319 return 0 unless (ref $first eq 'ARRAY' and ref $second eq 'ARRAY' ) ;
321 return 0 unless @$first == @$second;
323 my @first = sort @$first;
325 my @second = sort @$second;
327 for (my $i = 0; $i < scalar @first; $i++) {
328 return 0 if @first[$i] ne @second[$i];
336 Determines if this trigger is the same as another
338 my $is_identical = $trigger1->equals( $trigger2 );
342 around equals => sub {
346 my $case_insensitive = shift;
348 return 0 unless $self->$orig($other);
351 for my $name ( $self->name, $other->name ) {
352 $name = lc $name if $case_insensitive;
356 if ( keys %names > 1 ) {
357 return $self->error('Names not equal');
360 if ( !$self->perform_action_when eq $other->perform_action_when ) {
361 return $self->error('perform_action_when differs');
365 !compare_arrays( [$self->database_events], [$other->database_events] )
367 return $self->error('database_events differ');
370 if ( $self->on_table ne $other->on_table ) {
371 return $self->error('on_table differs');
374 if ( $self->action ne $other->action ) {
375 return $self->error('action differs');
379 !$self->_compare_objects( scalar $self->extra, scalar $other->extra )
381 return $self->error('extras differ');
387 # Must come after all 'has' declarations
388 around new => \&ex2err;
397 Ken Youens-Clark E<lt>kclark@cpan.orgE<gt>.