xml/schema/Contact/SavedSearch.xml

   1 <?xml version="1.0" encoding="iso-8859-1" ?>
   2
   3 <table>
   4   <base>CRM/Contact</base>
   5   <class>SavedSearch</class>
   6   <name>civicrm_saved_search</name>
   7   <comment>Users can save their complex SQL queries and use them later.</comment>
   8   <add>1.1</add>
   9   <field>
  10     <name>id</name>
  11     <type>int unsigned</type>
  12     <title>Saved Search ID</title>
  13     <required>true</required>
  14     <comment>Saved Search ID</comment>
  15     <add>1.1</add>
  16   </field>
  17   <primaryKey>
  18     <name>id</name>
  19     <autoincrement>false</autoincrement>
  20   </primaryKey>
  21
  22   <field>
  23     <name>name</name>
  24     <title>Saved Search Name</title>
  25     <type>varchar</type>
  26     <length>255</length>
  27     <default>NULL</default>
  28     <comment>Unique name of saved search</comment>
  29     <html>
  30       <type>Text</type>
  31     </html>
  32     <add>1.0</add>
  33   </field>
  34   <index>
  35     <name>UI_name</name>
  36     <fieldName>name</fieldName>
  37     <unique>true</unique>
  38     <add>5.32</add>
  39   </index>
  40
  41   <field>
  42     <name>label</name>
  43     <title>Saved Search Label</title>
  44     <type>varchar</type>
  45     <length>255</length>
  46     <default>NULL</default>
  47     <comment>Administrative label for search</comment>
  48     <html>
  49       <type>Text</type>
  50     </html>
  51     <add>5.32</add>
  52   </field>
  53
  54   <field>
  55     <name>form_values</name>
  56     <title>Submitted Form Values</title>
  57     <type>text</type>
  58     <import>true</import>
  59     <comment>Submitted form values for this search</comment>
  60     <serialize>PHP</serialize>
  61     <add>1.1</add>
  62   </field>
  63
  64   <field>
  65     <name>mapping_id</name>
  66     <type>int unsigned</type>
  67     <title>Mapping ID</title>
  68     <comment>Foreign key to civicrm_mapping used for saved search-builder searches.</comment>
  69     <add>1.5</add>
  70   </field>
  71   <foreignKey>
  72     <name>mapping_id</name>
  73     <table>civicrm_mapping</table>
  74     <key>id</key>
  75     <onDelete>SET NULL</onDelete>
  76     <add>1.5</add>
  77   </foreignKey>
  78
  79   <field>
  80     <name>search_custom_id</name>
  81     <type>int unsigned</type>
  82     <title>Option Value ID</title>
  83     <comment>Foreign key to civicrm_option value table used for saved custom searches.</comment>
  84     <add>2.0</add>
  85   </field>
  86
  87   <field>
  88     <name>where_clause</name>
  89     <type>text</type>
  90     <title>Where Clause</title>
  91     <comment>the sql where clause if a saved search acl</comment>
  92     <add>1.6</add>
  93     <drop>5.24</drop>
  94   </field>
  95
  96   <field>
  97     <name>select_tables</name>
  98     <type>text</type>
  99     <title>Select Tables</title>
 100     <comment>the tables to be included in a select data</comment>
 101     <serialize>PHP</serialize>
 102     <add>1.6</add>
 103     <drop>5.24</drop>
 104   </field>
 105
 106   <field>
 107     <name>where_tables</name>
 108     <type>text</type>
 109     <title>Where Tables</title>
 110     <comment>the tables to be included in the count statement</comment>
 111     <serialize>PHP</serialize>
 112     <add>1.6</add>
 113     <drop>5.24</drop>
 114   </field>
 115
 116   <field>
 117     <name>api_entity</name>
 118     <type>varchar</type>
 119     <title>Entity Name</title>
 120     <length>255</length>
 121     <comment>Entity name for API based search</comment>
 122     <add>5.24</add>
 123   </field>
 124
 125   <field>
 126     <name>api_params</name>
 127     <type>text</type>
 128     <title>API Parameters</title>
 129     <comment>Parameters for API based search</comment>
 130     <serialize>JSON</serialize>
 131     <add>5.24</add>
 132   </field>
 133 </table>