Merge pull request #20556 from ixiam/dev#2642
[civicrm-core.git] / xml / schema / Mailing / MailingJob.xml
CommitLineData
6a488035
TO
1<?xml version="1.0" encoding="iso-8859-1" ?>
2
3<table>
4 <base>CRM/Mailing</base>
9da8dc8c 5 <class>MailingJob</class>
6a488035
TO
6 <name>civicrm_mailing_job</name>
7 <comment>Stores information about the job that executes this mailing</comment>
8 <archive>true</archive>
d31fb4e3 9 <component>CiviMail</component>
6a488035 10 <field>
5435b737 11 <name>id</name>
210af83a 12 <title>Mailing Job ID</title>
5435b737
EM
13 <type>int unsigned</type>
14 <required>true</required>
0481e12c
A
15 <html>
16 <type>Number</type>
17 </html>
6a488035
TO
18 </field>
19 <primaryKey>
5435b737
EM
20 <name>id</name>
21 <autoincrement>true</autoincrement>
6a488035
TO
22 </primaryKey>
23 <field>
5435b737 24 <name>mailing_id</name>
57e94608 25 <title>Mailing ID</title>
5435b737
EM
26 <type>int unsigned</type>
27 <required>true</required>
28 <comment>The ID of the mailing this Job will send.</comment>
57e94608
A
29 <html>
30 <label>Mailing</label>
31 </html>
6a488035
TO
32 </field>
33 <foreignKey>
5435b737
EM
34 <name>mailing_id</name>
35 <table>civicrm_mailing</table>
36 <key>id</key>
37 <onDelete>CASCADE</onDelete>
6a488035
TO
38 </foreignKey>
39 <field>
5435b737 40 <name>scheduled_date</name>
0d94665e 41 <title>Mailing Scheduled Date</title>
4387c66f 42 <type>timestamp</type>
43 <default>NULL</default>
44 <required>false</required>
5435b737 45 <comment>date on which this job was scheduled.</comment>
2c2c4aa4 46 <html>
47 <type>Select Date</type>
48 <formatType>activityDateTime</formatType>
49 </html>
6a488035
TO
50 </field>
51 <field>
5435b737 52 <name>start_date</name>
de866a86 53 <uniqueName>mailing_job_start_date</uniqueName>
54 <uniqueTitle>Mailing Start Date</uniqueTitle>
0d94665e 55 <title>Mailing Job Start Date</title>
4387c66f 56 <type>timestamp</type>
57 <default>NULL</default>
58 <required>false</required>
5435b737 59 <comment>date on which this job was started.</comment>
2c2c4aa4 60 <html>
61 <type>Select Date</type>
62 <formatType>activityDateTime</formatType>
63 </html>
6a488035
TO
64 </field>
65 <field>
5435b737 66 <name>end_date</name>
0d94665e 67 <title>Mailing Job End Date</title>
4387c66f 68 <type>timestamp</type>
69 <default>NULL</default>
70 <required>false</required>
5435b737 71 <comment>date on which this job ended.</comment>
2c2c4aa4 72 <html>
73 <type>Select Date</type>
74 <formatType>activityDateTime</formatType>
75 </html>
6a488035
TO
76 </field>
77 <field>
5435b737 78 <name>status</name>
08d08c03 79 <uniqueName>mailing_job_status</uniqueName>
0d94665e 80 <title>Mailing Job Status</title>
5435b737
EM
81 <type>varchar</type>
82 <length>12</length>
83 <comment>The state of this job</comment>
84 <pseudoconstant>
85 <callback>CRM_Core_SelectValues::getMailingJobStatus</callback>
86 </pseudoconstant>
87 <html>
88 <type>Select</type>
89 </html>
6a488035
TO
90 </field>
91 <field>
5435b737 92 <name>is_test</name>
0d94665e 93 <title>Mailing Job Is Test?</title>
5435b737
EM
94 <type>boolean</type>
95 <default>0</default>
96 <comment>Is this job for a test mail?</comment>
97 <add>1.9</add>
6a488035
TO
98 </field>
99 <field>
5435b737 100 <name>job_type</name>
0d94665e 101 <title>Mailing Job Type</title>
5435b737
EM
102 <type>varchar</type>
103 <length>255</length>
104 <comment>Type of mailling job: null | child </comment>
105 <add>3.3</add>
6a488035
TO
106 </field>
107 <field>
5435b737 108 <name>parent_id</name>
047c5009 109 <title>Parent ID</title>
5435b737
EM
110 <type>int unsigned</type>
111 <comment>Parent job id</comment>
112 <default>NULL</default>
57e94608 113 <html>
047c5009 114 <label>Parent</label>
57e94608 115 </html>
5435b737 116 <add>3.3</add>
6a488035
TO
117 </field>
118 <foreignKey>
5435b737
EM
119 <name>parent_id</name>
120 <table>civicrm_mailing_job</table>
121 <key>id</key>
122 <onDelete>CASCADE</onDelete>
6a488035
TO
123 </foreignKey>
124 <field>
5435b737 125 <name>job_offset</name>
0d94665e 126 <title>Mailing Job Offset</title>
5435b737
EM
127 <type>int</type>
128 <comment>Offset of the child job</comment>
129 <default>0</default>
130 <add>3.3</add>
6a488035
TO
131 </field>
132 <field>
5435b737 133 <name>job_limit</name>
0d94665e 134 <title>Mailing Job Limit</title>
5435b737
EM
135 <type>int</type>
136 <comment>Queue size limit for each child job</comment>
137 <default>0</default>
138 <add>3.3</add>
6a488035
TO
139 </field>
140</table>