xml/schema/Mailing/MailingJob.xml

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