[civicrm-core.git] / xml / schema / Core / OptionGroup.xml

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

<table>
  <base>CRM/Core</base>
  <class>OptionGroup</class>
  <name>civicrm_option_group</name>
  <add>1.5</add>
  <log>true</log>
  <field>
    <name>id</name>
    <title>Option Group ID</title>
    <type>int unsigned</type>
    <required>true</required>
    <comment>Option Group ID</comment>
    <html>
      <type>Number</type>
    </html>
    <add>1.5</add>
  </field>
  <primaryKey>
    <name>id</name>
    <autoincrement>true</autoincrement>
  </primaryKey>
  <field>
    <name>name</name>
    <title>Option Group Name</title>
    <type>varchar</type>
    <length>64</length>
    <required>true</required>
    <comment>Option group name. Used as selection key by class properties which lookup options in civicrm_option_value.</comment>
    <add>1.5</add>
  </field>
  <field>
    <name>title</name>
    <title>Option Group title</title>
    <type>varchar</type>
    <length>255</length>
    <localizable>true</localizable>
    <comment>Option Group title.</comment>
    <add>1.5</add>
  </field>
  <field>
    <name>description</name>
    <title>Option Group Description</title>
    <type>varchar</type>
    <length>255</length>
    <localizable>true</localizable>
    <comment>Option group description.</comment>
    <add>1.5</add>
  </field>
  <field>
    <name>data_type</name>
    <title>Data Type</title>
    <type>varchar</type>
    <length>128</length>
    <comment>Type of data stored by this option group.</comment>
    <pseudoconstant>
      <callback>CRM_Utils_Type::dataTypes</callback>
    </pseudoconstant>
    <add>4.7</add>
  </field>
  <field>
    <name>is_reserved</name>
    <title>Option Group Is Reserved?</title>
    <type>boolean</type>
    <default>1</default>
    <required>true</required>
    <comment>Is this a predefined system option group (i.e. it can not be deleted)?</comment>
    <add>1.5</add>
  </field>
  <field>
    <name>is_active</name>
    <title>Option Group Is Active?</title>
    <type>boolean</type>
    <default>1</default>
    <required>true</required>
    <comment>Is this option group active?</comment>
    <add>1.5</add>
  </field>
  <field>
    <name>is_locked</name>
    <title>Option Group Is Locked</title>
    <default>0</default>
    <type>boolean</type>
    <required>true</required>
    <comment>A lock to remove the ability to add new options via the UI.</comment>
    <add>4.5</add>
  </field>
  <field>
    <name>option_value_fields</name>
    <title>Option Value Fields</title>
    <type>varchar</type>
    <length>128</length>
    <default>"name,label,description"</default>
    <comment>Which optional columns from the option_value table are in use by this group.</comment>
    <pseudoconstant>
      <callback>CRM_Core_SelectValues::optionValueFields</callback>
    </pseudoconstant>
    <serialize>COMMA</serialize>
    <add>5.49</add>
  </field>
  <index>
    <name>UI_name</name>
    <fieldName>name</fieldName>
    <unique>true</unique>
    <add>2.1</add>
  </index>
</table>
Commit	Line	Data
6a488035 TO	1	<?xml version="1.0" encoding="iso-8859-1" ?>
	2
	3	<table>
	4	<base>CRM/Core</base>
	5	<class>OptionGroup</class>
	6	<name>civicrm_option_group</name>
	7	<add>1.5</add>
	8	<log>true</log>
	9	<field>
455cfd16	10	<name>id</name>
0d94665e	11	<title>Option Group ID</title>
455cfd16 EM	12	<type>int unsigned</type>
	13	<required>true</required>
	14	<comment>Option Group ID</comment>
0481e12c A	15	<html>
	16	<type>Number</type>
	17	</html>
455cfd16	18	<add>1.5</add>
6a488035 TO	19	</field>
6a488035 TO	20	<primaryKey>
455cfd16 EM	21	<name>id</name>
455cfd16 EM	22	<autoincrement>true</autoincrement>
6a488035 TO	23	</primaryKey>
6a488035 TO	24	<field>
455cfd16 EM	25	<name>name</name>
	26	<title>Option Group Name</title>
	27	<type>varchar</type>
	28	<length>64</length>
	29	<required>true</required>
	30	<comment>Option group name. Used as selection key by class properties which lookup options in civicrm_option_value.</comment>
	31	<add>1.5</add>
6a488035 TO	32	</field>
6a488035 TO	33	<field>
455cfd16	34	<name>title</name>
0d94665e	35	<title>Option Group title</title>
455cfd16 EM	36	<type>varchar</type>
	37	<length>255</length>
	38	<localizable>true</localizable>
	39	<comment>Option Group title.</comment>
	40	<add>1.5</add>
6a488035 TO	41	</field>
6a488035 TO	42	<field>
455cfd16	43	<name>description</name>
0d94665e	44	<title>Option Group Description</title>
455cfd16 EM	45	<type>varchar</type>
	46	<length>255</length>
	47	<localizable>true</localizable>
	48	<comment>Option group description.</comment>
	49	<add>1.5</add>
6a488035	50	</field>
eaecfa20 SL	51	<field>
eaecfa20 SL	52	<name>data_type</name>
c9ae8a39	53	<title>Data Type</title>
eaecfa20 SL	54	<type>varchar</type>
eaecfa20 SL	55	<length>128</length>
c9ae8a39	56	<comment>Type of data stored by this option group.</comment>
eaecfa20 SL	57	<pseudoconstant>
	58	<callback>CRM_Utils_Type::dataTypes</callback>
	59	</pseudoconstant>
	60	<add>4.7</add>
	61	</field>
6a488035	62	<field>
455cfd16	63	<name>is_reserved</name>
0d94665e	64	<title>Option Group Is Reserved?</title>
455cfd16 EM	65	<type>boolean</type>
455cfd16 EM	66	<default>1</default>
25a8e8c2	67	<required>true</required>
455cfd16 EM	68	<comment>Is this a predefined system option group (i.e. it can not be deleted)?</comment>
455cfd16 EM	69	<add>1.5</add>
6a488035 TO	70	</field>
6a488035 TO	71	<field>
455cfd16	72	<name>is_active</name>
0d94665e	73	<title>Option Group Is Active?</title>
455cfd16	74	<type>boolean</type>
25a8e8c2	75	<default>1</default>
25a8e8c2	76	<required>true</required>
455cfd16 EM	77	<comment>Is this option group active?</comment>
455cfd16 EM	78	<add>1.5</add>
6a488035	79	</field>
cede6590	80	<field>
455cfd16	81	<name>is_locked</name>
0d94665e	82	<title>Option Group Is Locked</title>
25a8e8c2	83	<default>0</default>
455cfd16	84	<type>boolean</type>
c1e814c7	85	<required>true</required>
455cfd16 EM	86	<comment>A lock to remove the ability to add new options via the UI.</comment>
455cfd16 EM	87	<add>4.5</add>
cede6590	88	</field>
c9ae8a39 CW	89	<field>
	90	<name>option_value_fields</name>
	91	<title>Option Value Fields</title>
	92	<type>varchar</type>
	93	<length>128</length>
	94	<default>"name,label,description"</default>
	95	<comment>Which optional columns from the option_value table are in use by this group.</comment>
	96	<pseudoconstant>
	97	<callback>CRM_Core_SelectValues::optionValueFields</callback>
	98	</pseudoconstant>
	99	<serialize>COMMA</serialize>
	100	<add>5.49</add>
	101	</field>
6a488035 TO	102	<index>
	103	<name>UI_name</name>
	104	<fieldName>name</fieldName>
	105	<unique>true</unique>
	106	<add>2.1</add>
	107	</index>
	108	</table>