summaryrefslogtreecommitdiff
path: root/FS/FS/queue_depend.pm
blob: f21ed994649ffaeb47dfa8665622cb273c98a2ec (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
package FS::queue_depend;
use base qw( FS::Record );

use strict;
use FS::Record qw( dbh );

=head1 NAME

FS::queue_depend - Object methods for queue_depend records

=head1 SYNOPSIS

  use FS::queue_depend;

  $record = new FS::queue_depend \%hash;
  $record = new FS::queue_depend { 'column' => 'value' };

  $error = $record->insert;

  $error = $new_record->replace($old_record);

  $error = $record->delete;

  $error = $record->check;

=head1 DESCRIPTION

An FS::queue_depend object represents an job dependancy.  FS::queue_depend
inherits from FS::Record.  The following fields are currently supported:

=over 4

=item dependnum - primary key

=item jobnum - source jobnum (see L<FS::queue>).

=item depend_jobnum - dependancy jobnum (see L<FS::queue>)

=back

The job specified by B<jobnum> depends on the job specified B<depend_jobnum> -
the B<jobnum> job will not be run until the B<depend_jobnum> job has completed
successfully (or manually removed).

=head1 METHODS

=over 4

=item new HASHREF

Creates a new dependancy.  To add the dependancy to the database, see
L<"insert">.

Note that this stores the hash reference, not a distinct copy of the hash it
points to.  You can ask the object for a copy with the I<hash> method.

=cut

# the new method can be inherited from FS::Record, if a table method is defined

sub table { 'queue_depend'; }

=item insert

Adds this record to the database.  If there is an error, returns the error,
otherwise returns false.

=cut

# the insert method can be inherited from FS::Record

=item delete

Delete this record from the database.

=cut

# the delete method can be inherited from FS::Record

=item replace OLD_RECORD

Replaces the OLD_RECORD with this one in the database.  If there is an error,
returns the error, otherwise returns false.

=cut

# the replace method can be inherited from FS::Record

=item check

Checks all fields to make sure this is a valid dependancy.  If there is
an error, returns the error, otherwise returns false.  Called by the insert
and replace methods.

=cut

sub check {
  my $self = shift;

  $self->ut_numbern('dependnum')
    || $self->ut_foreign_key('jobnum',        'queue', 'jobnum')
    || $self->ut_foreign_key('depend_jobnum', 'queue', 'jobnum')
    || $self->SUPER::check
  ;
}

=back

=cut

sub _upgrade_schema {
  my ($class, %opts) = @_;

  my $sql = '
    DELETE FROM queue_depend WHERE NOT EXISTS
      ( SELECT 1 FROM queue WHERE queue.jobnum = queue_depend.jobnum )
  ';

  my $sth = dbh->prepare($sql) or die dbh->errstr;
  $sth->execute or die $sth->errstr;
  '';
}

=head1 BUGS

=head1 SEE ALSO

L<FS::queue>, L<FS::Record>, schema.html from the base documentation.

=cut

1;