[civicrm-core.git] / xml / schema / Queue / Queue.xml

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

<table>
  <base>CRM/Queue</base>
  <class>Queue</class>
  <name>civicrm_queue</name>
  <comment>Stores a list of persistent queues</comment>
  <add>5.47</add>
  <field>
    <name>id</name>
    <title>System Queue ID</title>
    <type>int unsigned</type>
    <required>true</required>
    <html>
      <type>Number</type>
    </html>
    <add>5.47</add>
  </field>
  <primaryKey>
    <name>id</name>
    <autoincrement>true</autoincrement>
  </primaryKey>
  <field>
    <name>name</name>
    <title>Name</title>
    <type>varchar</type>
    <length>64</length>
    <comment>Name of the queue</comment>
    <required>true</required>
    <html>
      <type>Text</type>
    </html>
    <add>5.47</add>
  </field>
  <index>
    <name>UI_name</name>
    <fieldName>name</fieldName>
    <unique>true</unique>
    <add>5.47</add>
  </index>
  <field>
    <name>type</name>
    <title>Type</title>
    <type>varchar</type>
    <length>64</length>
    <comment>Type of the queue</comment>
    <required>true</required>
    <html>
      <type>Text</type>
    </html>
    <add>5.47</add>
    <pseudoconstant>
      <callback>CRM_Queue_BAO_Queue::getTypes</callback>
    </pseudoconstant>
  </field>
  <field>
    <name>is_autorun</name>
    <title>Enable Autorun</title>
    <type>boolean</type>
    <comment>Should the standard background attempt to autorun tasks in this queue?</comment>
    <html>
      <type>CheckBox</type>
      <label>Auto Run</label>
    </html>
    <drop>5.48</drop>
  </field>
  <field>
    <name>runner</name>
    <title>Runner</title>
    <type>varchar</type>
    <length>64</length>
    <required>false</required>
    <comment>Name of the task runner</comment>
    <html>
      <type>Text</type>
    </html>
    <add>5.48</add>
  </field>
  <field>
    <name>batch_limit</name>
    <title>Batch Limit</title>
    <type>int unsigned</type>
    <required>true</required>
    <default>1</default>
    <comment>Maximum number of items in a batch.</comment>
    <add>5.48</add>
    <html>
      <type>Text</type>
    </html>
  </field>
  <field>
    <name>lease_time</name>
    <title>Lease Time</title>
    <type>int unsigned</type>
    <required>true</required>
    <default>3600</default>
    <comment>When claiming an item (or batch of items) for work, how long should the item(s) be reserved. (Seconds)</comment>
    <add>5.48</add>
    <html>
      <type>Text</type>
    </html>
  </field>
  <field>
    <name>retry_limit</name>
    <title>Retry Limit</title>
    <comment>Number of permitted retries. Set to zero (0) to disable.</comment>
    <type>int</type>
    <required>true</required>
    <default>0</default>
    <html>
      <type>Text</type>
    </html>
    <add>5.48</add>
  </field>
  <field>
    <name>retry_interval</name>
    <title>Retry Interval</title>
    <comment>Number of seconds to wait before retrying a failed execution.</comment>
    <type>int</type>
    <required>false</required>
    <html>
      <type>Text</type>
    </html>
    <add>5.48</add>
  </field>
</table>
Commit	Line	Data
f828381a TO	1	<?xml version="1.0" encoding="iso-8859-1" ?>
	2
	3	<table>
f828381a TO	4	<base>CRM/Queue</base>
	5	<class>Queue</class>
	6	<name>civicrm_queue</name>
	7	<comment>Stores a list of persistent queues</comment>
	8	<add>5.47</add>
	9	<field>
	10	<name>id</name>
	11	<title>System Queue ID</title>
	12	<type>int unsigned</type>
	13	<required>true</required>
	14	<html>
	15	<type>Number</type>
	16	</html>
	17	<add>5.47</add>
	18	</field>
	19	<primaryKey>
	20	<name>id</name>
	21	<autoincrement>true</autoincrement>
	22	</primaryKey>
	23	<field>
	24	<name>name</name>
	25	<title>Name</title>
	26	<type>varchar</type>
	27	<length>64</length>
	28	<comment>Name of the queue</comment>
	29	<required>true</required>
	30	<html>
	31	<type>Text</type>
	32	</html>
	33	<add>5.47</add>
	34	</field>
	35	<index>
	36	<name>UI_name</name>
	37	<fieldName>name</fieldName>
	38	<unique>true</unique>
	39	<add>5.47</add>
	40	</index>
	41	<field>
	42	<name>type</name>
	43	<title>Type</title>
	44	<type>varchar</type>
	45	<length>64</length>
	46	<comment>Type of the queue</comment>
	47	<required>true</required>
	48	<html>
	49	<type>Text</type>
	50	</html>
	51	<add>5.47</add>
a7069ee8 TO	52	<pseudoconstant>
	53	<callback>CRM_Queue_BAO_Queue::getTypes</callback>
	54	</pseudoconstant>
f828381a TO	55	</field>
	56	<field>
	57	<name>is_autorun</name>
	58	<title>Enable Autorun</title>
	59	<type>boolean</type>
	60	<comment>Should the standard background attempt to autorun tasks in this queue?</comment>
	61	<html>
	62	<type>CheckBox</type>
	63	<label>Auto Run</label>
	64	</html>
19a1c852 TO	65	<drop>5.48</drop>
	66	</field>
	67	<field>
	68	<name>runner</name>
	69	<title>Runner</title>
	70	<type>varchar</type>
	71	<length>64</length>
	72	<required>false</required>
	73	<comment>Name of the task runner</comment>
	74	<html>
	75	<type>Text</type>
	76	</html>
	77	<add>5.48</add>
	78	</field>
	79	<field>
	80	<name>batch_limit</name>
	81	<title>Batch Limit</title>
	82	<type>int unsigned</type>
	83	<required>true</required>
	84	<default>1</default>
c7920734	85	<comment>Maximum number of items in a batch.</comment>
19a1c852 TO	86	<add>5.48</add>
	87	<html>
	88	<type>Text</type>
	89	</html>
	90	</field>
	91	<field>
	92	<name>lease_time</name>
	93	<title>Lease Time</title>
	94	<type>int unsigned</type>
	95	<required>true</required>
	96	<default>3600</default>
	97	<comment>When claiming an item (or batch of items) for work, how long should the item(s) be reserved. (Seconds)</comment>
	98	<add>5.48</add>
	99	<html>
	100	<type>Text</type>
	101	</html>
	102	</field>
	103	<field>
	104	<name>retry_limit</name>
	105	<title>Retry Limit</title>
f0297973	106	<comment>Number of permitted retries. Set to zero (0) to disable.</comment>
19a1c852	107	<type>int</type>
f0297973 TO	108	<required>true</required>
f0297973 TO	109	<default>0</default>
19a1c852 TO	110	<html>
	111	<type>Text</type>
	112	</html>
	113	<add>5.48</add>
	114	</field>
	115	<field>
	116	<name>retry_interval</name>
	117	<title>Retry Interval</title>
	118	<comment>Number of seconds to wait before retrying a failed execution.</comment>
	119	<type>int</type>
	120	<required>false</required>
	121	<html>
	122	<type>Text</type>
	123	</html>
	124	<add>5.48</add>
f828381a	125	</field>
f828381a	126	</table>