xml/schema/Batch/Batch.xml

   1 <?xml version="1.0" encoding="iso-8859-1" ?>
   2
   3 <table>
   4   <base>CRM/Batch</base>
   5   <class>Batch</class>
   6   <name>civicrm_batch</name>
   7   <comment>Stores the details of a batch operation Used primarily when doing batch operations with an external system.</comment>
   8   <add>3.3</add>
   9   <field>
  10     <name>id</name>
  11     <type>int unsigned</type>
  12     <required>true</required>
  13     <comment>Unique Address ID</comment>
  14     <add>3.3</add>
  15   </field>
  16   <primaryKey>
  17     <name>id</name>
  18     <autoincrement>true</autoincrement>
  19   </primaryKey>
  20   <field>
  21     <name>name</name>
  22     <type>varchar</type>
  23     <length>64</length>
  24     <comment>Variable name/programmatic handle for this batch.</comment>
  25     <add>3.3</add>
  26   </field>
  27   <index>
  28     <name>UI_name</name>
  29     <fieldName>name</fieldName>
  30     <unique>true</unique>
  31     <add>4.2</add>
  32   </index>
  33   <field>
  34     <name>label</name>
  35     <type>varchar</type>
  36     <length>64</length>
  37     <localizable>true</localizable>
  38     <comment>Friendly Name.</comment>
  39     <add>3.3</add>
  40     <drop>4.2</drop>
  41   </field>
  42   <field>
  43     <name>title</name>
  44     <type>varchar</type>
  45     <length>64</length>
  46     <localizable>true</localizable>
  47     <comment>Friendly Name.</comment>
  48     <add>4.2</add>
  49   </field>
  50   <field>
  51     <name>description</name>
  52     <type>text</type>
  53     <comment>Description of this batch set.</comment>
  54     <localizable>true</localizable>
  55     <htmlType>textarea</htmlType>
  56     <rows>4</rows>
  57     <cols>80</cols>
  58     <add>3.3</add>
  59   </field>
  60   <field>
  61     <name>created_id</name>
  62     <type>int unsigned</type>
  63     <comment>FK to Contact ID</comment>
  64     <add>3.3</add>
  65   </field>
  66   <foreignKey>
  67     <name>created_id</name>
  68     <table>civicrm_contact</table>
  69     <key>id</key>
  70     <add>3.3</add>
  71     <onDelete>SET NULL</onDelete>
  72   </foreignKey>
  73   <field>
  74     <name>created_date</name>
  75     <type>datetime</type>
  76     <comment>When was this item created</comment>
  77     <add>3.3</add>
  78   </field>
  79   <field>
  80     <name>modified_id</name>
  81     <type>int unsigned</type>
  82     <comment>FK to Contact ID</comment>
  83     <add>3.3</add>
  84   </field>
  85   <field>
  86     <name>modified_date</name>
  87     <type>datetime</type>
  88     <comment>When was this item created</comment>
  89     <add>3.3</add>
  90   </field>
  91   <foreignKey>
  92     <name>modified_id</name>
  93     <table>civicrm_contact</table>
  94     <key>id</key>
  95     <add>3.3</add>
  96     <onDelete>SET NULL</onDelete>
  97   </foreignKey>
  98   <field>
  99     <name>saved_search_id</name>
 100     <type>int unsigned</type>
 101     <comment>FK to Saved Search ID</comment>
 102     <add>4.1</add>
 103   </field>
 104   <foreignKey>
 105     <name>saved_search_id</name>
 106     <table>civicrm_saved_search</table>
 107     <key>id</key>
 108     <add>4.2</add>
 109     <onDelete>SET NULL</onDelete>
 110   </foreignKey>
 111   <field>
 112     <name>status_id</name>
 113     <type>int unsigned</type>
 114     <required>true</required>
 115     <comment>fk to Batch Status options in civicrm_option_values</comment>
 116     <add>4.2</add>
 117     <pseudoconstant>
 118       <optionGroupName>batch_status</optionGroupName>
 119     </pseudoconstant>
 120   </field>
 121   <field>
 122     <name>type_id</name>
 123     <type>int unsigned</type>
 124     <comment>fk to Batch Type options in civicrm_option_values</comment>
 125     <add>4.2</add>
 126     <pseudoconstant>
 127       <optionGroupName>batch_type</optionGroupName>
 128     </pseudoconstant>
 129   </field>
 130   <field>
 131     <name>mode_id</name>
 132     <type>int unsigned</type>
 133     <comment>fk to Batch mode options in civicrm_option_values</comment>
 134     <add>4.2</add>
 135     <pseudoconstant>
 136       <optionGroupName>batch_mode</optionGroupName>
 137     </pseudoconstant>
 138   </field>
 139   <field>
 140     <name>total</name>
 141     <type>decimal</type>
 142     <comment>Total amount for this batch.</comment>
 143     <add>4.2</add>
 144   </field>
 145   <field>
 146     <name>item_count</name>
 147     <type>int unsigned</type>
 148     <comment>Number of items in a batch.</comment>
 149     <add>4.2</add>
 150   </field>
 151   <field>
 152     <name>payment_instrument_id</name>
 153     <type>int unsigned</type>
 154     <comment>fk to Payment Instrument options in civicrm_option_values</comment>
 155     <pseudoconstant>
 156       <optionGroupName>payment_instrument</optionGroupName>
 157     </pseudoconstant>
 158     <add>4.3</add>
 159   </field>
 160   <field>
 161     <name>exported_date</name>
 162     <type>datetime</type>
 163     <add>4.3</add>
 164   </field>
 165   <field>
 166     <name>data</name>
 167     <type>longtext</type>
 168     <comment>cache entered data</comment>
 169     <add>4.4</add>
 170   </field>
 171 </table>