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

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

<table>
  <base>CRM/Core</base>
  <class>UFJoin</class>
  <name>civicrm_uf_join</name>
  <comment>User framework join table. This links various internal civicrm object with a profile. Initial use cases are the donation object and the user module</comment>
  <add>1.3</add>
  <log>true</log>
  <field>
    <name>id</name>
    <title>UF Join ID</title>
    <type>int unsigned</type>
    <required>true</required>
    <comment>Unique table ID</comment>
    <add>1.3</add>
  </field>
  <primaryKey>
    <name>id</name>
    <autoincrement>true</autoincrement>
  </primaryKey>
  <field>
    <name>is_active</name>
    <title>Profile Use is active</title>
    <type>boolean</type>
    <default>1</default>
    <comment>Is this join currently active?</comment>
    <add>1.3</add>
  </field>
  <field>
    <name>module</name>
    <title>Profile Module</title>
    <type>varchar</type>
    <length>64</length>
    <required>true</required>
    <comment>Module which owns this uf_join instance, e.g. User Registration, CiviDonate, etc.</comment>
    <add>1.3</add>
  </field>
  <field>
    <name>entity_table</name>
    <title>Profile Entity Table</title>
    <type>varchar</type>
    <length>64</length>
    <comment>Name of table where item being referenced is stored. Modules which only need a single collection of uf_join instances may choose not to populate entity_table and entity_id.</comment>
    <add>1.3</add>
  </field>
  <field>
    <name>entity_id</name>
    <title>Profile Entity ID</title>
    <type>int unsigned</type>
    <comment>Foreign key to the referenced item.</comment>
    <add>1.3</add>
  </field>
  <dynamicForeignKey>
    <idColumn>entity_id</idColumn>
    <typeColumn>entity_table</typeColumn>
    <add>1.3</add>
  </dynamicForeignKey>
  <index>
    <name>index_entity</name>
    <add>1.3</add>
    <fieldName>entity_table</fieldName>
    <fieldName>entity_id</fieldName>
    <add>1.3</add>
  </index>
  <field>
    <name>weight</name>
    <title>Order</title>
    <type>int</type>
    <required>true</required>
    <default>1</default>
    <comment>Controls display order when multiple user framework groups are setup for concurrent display.</comment>
    <add>1.3</add>
  </field>
  <field>
    <name>uf_group_id</name>
    <title>Profile ID</title>
    <type>int unsigned</type>
    <required>true</required>
    <comment>Which form does this field belong to.</comment>
    <add>1.3</add>
    <pseudoconstant>
      <table>civicrm_uf_group</table>
      <keyColumn>id</keyColumn>
      <labelColumn>title</labelColumn>
    </pseudoconstant>
    <html>
      <type>Select</type>
    </html>
  </field>
  <foreignKey>
    <name>uf_group_id</name>
    <table>civicrm_uf_group</table>
    <key>id</key>
    <add>1.3</add>
  </foreignKey>
  <field>
    <name>module_data</name>
    <title>Profile Use Data</title>
    <type>longtext</type>
    <comment>Json serialized array of data used by the ufjoin.module</comment>
    <add>4.5</add>
  </field>
</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>UFJoin</class>
	6	<name>civicrm_uf_join</name>
	7	<comment>User framework join table. This links various internal civicrm object with a profile. Initial use cases are the donation object and the user module</comment>
	8	<add>1.3</add>
	9	<log>true</log>
	10	<field>
8f069c03 EM	11	<name>id</name>
	12	<title>UF Join ID</title>
	13	<type>int unsigned</type>
	14	<required>true</required>
	15	<comment>Unique table ID</comment>
	16	<add>1.3</add>
6a488035 TO	17	</field>
6a488035 TO	18	<primaryKey>
8f069c03 EM	19	<name>id</name>
8f069c03 EM	20	<autoincrement>true</autoincrement>
6a488035 TO	21	</primaryKey>
6a488035 TO	22	<field>
8f069c03 EM	23	<name>is_active</name>
	24	<title>Profile Use is active</title>
	25	<type>boolean</type>
	26	<default>1</default>
	27	<comment>Is this join currently active?</comment>
	28	<add>1.3</add>
6a488035	29	</field>
3c7d2158	30	<field>
8f069c03 EM	31	<name>module</name>
	32	<title>Profile Module</title>
	33	<type>varchar</type>
	34	<length>64</length>
	35	<required>true</required>
	36	<comment>Module which owns this uf_join instance, e.g. User Registration, CiviDonate, etc.</comment>
	37	<add>1.3</add>
3c7d2158	38	</field>
3c7d2158	39	<field>
8f069c03 EM	40	<name>entity_table</name>
	41	<title>Profile Entity Table</title>
	42	<type>varchar</type>
	43	<length>64</length>
	44	<comment>Name of table where item being referenced is stored. Modules which only need a single collection of uf_join instances may choose not to populate entity_table and entity_id.</comment>
	45	<add>1.3</add>
3c7d2158	46	</field>
3c7d2158	47	<field>
8f069c03 EM	48	<name>entity_id</name>
	49	<title>Profile Entity ID</title>
	50	<type>int unsigned</type>
	51	<comment>Foreign key to the referenced item.</comment>
	52	<add>1.3</add>
6a488035	53	</field>
71e5aa5c	54	<dynamicForeignKey>
8f069c03 EM	55	<idColumn>entity_id</idColumn>
	56	<typeColumn>entity_table</typeColumn>
	57	<add>1.3</add>
71e5aa5c	58	</dynamicForeignKey>
3c7d2158	59	<index>
8f069c03 EM	60	<name>index_entity</name>
	61	<add>1.3</add>
	62	<fieldName>entity_table</fieldName>
	63	<fieldName>entity_id</fieldName>
	64	<add>1.3</add>
6a488035 TO	65	</index>
6a488035 TO	66	<field>
8f069c03	67	<name>weight</name>
7ecddde4	68	<title>Order</title>
8f069c03 EM	69	<type>int</type>
	70	<required>true</required>
	71	<default>1</default>
	72	<comment>Controls display order when multiple user framework groups are setup for concurrent display.</comment>
	73	<add>1.3</add>
6a488035	74	</field>
3c7d2158	75	<field>
8f069c03 EM	76	<name>uf_group_id</name>
	77	<title>Profile ID</title>
	78	<type>int unsigned</type>
	79	<required>true</required>
	80	<comment>Which form does this field belong to.</comment>
	81	<add>1.3</add>
	82	<pseudoconstant>
	83	<table>civicrm_uf_group</table>
	84	<keyColumn>id</keyColumn>
	85	<labelColumn>title</labelColumn>
	86	</pseudoconstant>
	87	<html>
	88	<type>Select</type>
	89	</html>
3c7d2158	90	</field>
3c7d2158	91	<foreignKey>
8f069c03 EM	92	<name>uf_group_id</name>
	93	<table>civicrm_uf_group</table>
	94	<key>id</key>
	95	<add>1.3</add>
3c7d2158	96	</foreignKey>
133e2c99	97	<field>
8f069c03 EM	98	<name>module_data</name>
	99	<title>Profile Use Data</title>
	100	<type>longtext</type>
	101	<comment>Json serialized array of data used by the ufjoin.module</comment>
	102	<add>4.5</add>
133e2c99	103	</field>
6a488035	104	</table>