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 uniq);
33 use SQL::Translator::Types qw(schema_obj enum);
34 use Sub::Quote qw(quote_sub);
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 => quote_sub(q{ defined $_[0] ? lc $_[0] : $_[0] }),
75 isa => enum([qw(before after)], {
76 msg => "Invalid argument '%s' to perform_action_when",
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 => quote_sub(q{ [ 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 => quote_sub(q{ '' }) );
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 => quote_sub(q{ '' }) );
255 Get or set the trigger's order.
257 my $order = $trigger->order(3);
261 has order => ( is => 'rw', default => quote_sub(q{ 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');
283 isa => enum([qw(row statement)], {
284 msg => "Invalid scope '%s'", icase => 1, allow_undef => 1,
288 around scope => \&ex2err;
293 Get or set the trigger's schema object.
295 $trigger->schema( $schema );
296 my $schema = $trigger->schema;
300 has schema => (is => 'rw', isa => schema_obj('Schema'), weak_ref => 1 );
302 around schema => \&ex2err;
308 =head2 compare_arrays
314 my ($first, $second) = @_;
315 no warnings; # silence spurious -w undef complaints
317 return 0 unless (ref $first eq 'ARRAY' and ref $second eq 'ARRAY' ) ;
319 return 0 unless @$first == @$second;
321 my @first = sort @$first;
323 my @second = sort @$second;
325 for (my $i = 0; $i < scalar @first; $i++) {
326 return 0 if @first[$i] ne @second[$i];
334 Determines if this trigger is the same as another
336 my $is_identical = $trigger1->equals( $trigger2 );
340 around equals => sub {
344 my $case_insensitive = shift;
346 return 0 unless $self->$orig($other);
349 for my $name ( $self->name, $other->name ) {
350 $name = lc $name if $case_insensitive;
354 if ( keys %names > 1 ) {
355 return $self->error('Names not equal');
358 if ( !$self->perform_action_when eq $other->perform_action_when ) {
359 return $self->error('perform_action_when differs');
363 !compare_arrays( [$self->database_events], [$other->database_events] )
365 return $self->error('database_events differ');
368 if ( $self->on_table ne $other->on_table ) {
369 return $self->error('on_table differs');
372 if ( $self->action ne $other->action ) {
373 return $self->error('action differs');
377 !$self->_compare_objects( scalar $self->extra, scalar $other->extra )
379 return $self->error('extras differ');
385 # Must come after all 'has' declarations
386 around new => \&ex2err;
395 Ken Youens-Clark E<lt>kclark@cpan.orgE<gt>.