[civicrm-core.git] / xml / schema / Mailing / MailingJob.xml

<?xml version="1.0" encoding="iso-8859-1" ?>

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