CRM-13497 - Move rows and cols

[civicrm-core.git] / xml / schema / Member / Membership.xml

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

<table>
  <base>CRM/Member</base>
  <class>Membership</class>
  <name>civicrm_membership</name>
  <comment>Contact Membership records.</comment>
  <add>1.5</add>
  <log>true</log>
  <field>
      <name>id</name>
      <uniqueName>membership_id</uniqueName>
      <type>int unsigned</type>
      <required>true</required>
      <import>true</import>
      <title>Membership ID</title>
      <headerPattern>/^(m(embership\s)?id)$/i</headerPattern>
      <comment>Membership Id</comment>
      <add>1.5</add>
  </field>
  <primaryKey>
      <name>id</name>
      <autoincrement>true</autoincrement>
  </primaryKey>

  <field>
      <name>contact_id</name>
      <uniqueName>membership_contact_id</uniqueName>
      <type>int unsigned</type>
      <required>true</required>
      <title>Contact ID</title>
      <headerPattern>/contact(.?id)?/i</headerPattern>
      <dataPattern>/^\d+$/</dataPattern>
      <import>true</import>
      <comment>FK to Contact ID</comment>
      <add>1.5</add>
  </field>
  <foreignKey>
      <name>contact_id</name>
      <table>civicrm_contact</table>
      <key>id</key>
      <add>1.5</add>
      <onDelete>CASCADE</onDelete>
  </foreignKey>
  <field>
      <name>membership_type_id</name>
      <type>int unsigned</type>
      <title>Membership Type Id</title>
      <import>true</import>
      <headerPattern>/^(m(embership\s)?type)$/i</headerPattern>
      <export>false</export>
      <required>true</required>
      <comment>FK to Membership Type</comment>
      <pseudoconstant>
        <table>civicrm_membership_type</table>
        <keyColumn>id</keyColumn>
        <labelColumn>name</labelColumn>
      </pseudoconstant>
      <add>1.5</add>
  </field>
  <foreignKey>
      <name>membership_type_id</name>
      <table>civicrm_membership_type</table>
      <key>id</key>
      <add>1.5</add>
      <onDelete>CASCADE</onDelete>
  </foreignKey>
  <field>
      <name>join_date</name>
      <title>Member Since</title>
      <type>date</type>
      <import>true</import>
      <headerPattern>/^join|(j(oin\s)?date)$/i</headerPattern>
      <dataPattern>/\d{4}-?\d{2}-?\d{2}/</dataPattern>
      <comment>Beginning of initial membership period (member since...).</comment>
      <add>1.5</add>
  </field>
  <field>
      <name>start_date</name>
      <uniqueName>membership_start_date</uniqueName>
      <title>Membership Start Date</title>
      <type>date</type>
      <import>true</import>
      <headerPattern>/(member(ship)?.)?start(s)?(.date$)?/i</headerPattern>
      <dataPattern>/\d{4}-?\d{2}-?\d{2}/</dataPattern>
      <comment>Beginning of current uninterrupted membership period.</comment>
      <add>1.5</add>
  </field>
  <field>
      <name>end_date</name>
      <uniqueName>membership_end_date</uniqueName>
      <title>Membership Expiration Date</title>
      <type>date</type>
      <import>true</import>
      <headerPattern>/(member(ship)?.)?end(s)?(.date$)?/i</headerPattern>
      <dataPattern>/\d{4}-?\d{2}-?\d{2}/</dataPattern>
      <comment>Current membership period expire date.</comment>
      <add>1.5</add>
  </field>
  <field>
      <name>source</name>
      <uniqueName>membership_source</uniqueName>
      <title>Source</title>
      <import>true</import>
       <headerPattern>/^(member(ship?))?source$/i</headerPattern>
      <type>varchar</type>
      <length>128</length>
      <add>1.5</add>
  </field>
  <field>
      <name>status_id</name>
      <title>Membership Status Id</title>
      <import>true</import>
      <headerPattern>/(member(ship|).)?(status)$/i</headerPattern>
      <type>int unsigned</type>
      <export>false</export>
      <required>true</required>
      <comment>FK to Membership Status</comment>
      <pseudoconstant>
        <table>civicrm_membership_status</table>
        <keyColumn>id</keyColumn>
        <labelColumn>label</labelColumn>
      </pseudoconstant>
      <add>1.5</add>
  </field>
  <foreignKey>
      <name>status_id</name>
      <table>civicrm_membership_status</table>
      <key>id</key>
      <add>1.5</add>
      <onDelete>CASCADE</onDelete>
  </foreignKey>
  <field>
      <name>is_override</name>
      <title>Status Override</title>
      <import>true</import>
      <headerPattern>/override$/i</headerPattern>
      <type>boolean</type>
      <comment>Admin users may set a manual status which overrides the calculated status. When this flag is true, automated status update scripts should NOT modify status for the record.</comment>
      <add>1.5</add>
  </field>
  <field>
      <name>owner_membership_id</name>
      <type>int unsigned</type>
    <title>Primary Member ID</title>
      <comment>Optional FK to Parent Membership.</comment>
      <export>true</export>
      <add>1.7</add>
  </field>
  <foreignKey>
       <name>owner_membership_id</name>
       <table>civicrm_membership</table>
       <key>id</key>
       <add>1.7</add>
       <onDelete>SET NULL</onDelete>
  </foreignKey>
  <index>
    <name>index_owner_membership_id</name>
    <fieldName>owner_membership_id</fieldName>
    <add>1.7</add>
  </index>
  <field>
      <name>max_related</name>
      <type>int</type>
      <comment>Maximum number of related memberships (membership_type override).</comment>
      <add>4.3</add>
  </field>
  <field>
      <name>is_test</name>
      <title>Test</title>
      <uniqueName>member_is_test</uniqueName>
      <type>boolean</type>
      <default>0</default>
      <import>true</import>
      <headerPattern>/(is.)?test(.member(ship)?)?/i</headerPattern>
  </field>
  <field>
      <name>is_pay_later</name>
      <uniqueName>member_is_pay_later</uniqueName>
      <title>Is Pay Later</title>
      <type>boolean</type>
      <default>0</default>
      <import>true</import>
      <headerPattern>/(is.)?(pay(.)?later)$/i</headerPattern>
      <add>2.1</add>
  </field>
  <field>
    <name>contribution_recur_id</name>
    <type>int unsigned</type>
    <comment>Conditional foreign key to civicrm_contribution_recur id. Each membership in connection with a recurring contribution carries a foreign key to the recurring contribution record. This assumes we can track these processor initiated events.</comment>
    <add>3.3</add>
  </field>
  <foreignKey>
    <name>contribution_recur_id</name>
    <table>civicrm_contribution_recur</table>
    <key>id</key>
    <add>3.3</add>
    <onDelete>SET NULL</onDelete>
  </foreignKey>
  <field>
    <name>campaign_id</name>
    <uniqueName>member_campaign_id</uniqueName>
    <type>int unsigned</type>
    <title>Campaign ID</title>
    <import>true</import>
    <comment>The campaign for which this membership is attached.</comment>
    <add>3.4</add>
  </field>
  <foreignKey>
    <name>campaign_id</name>
    <table>civicrm_campaign</table>
    <key>id</key>
    <onDelete>SET NULL</onDelete>
  </foreignKey>
</table>