indexer_merged.xsd 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!--
  3. /**
  4. * Copyright © Magento, Inc. All rights reserved.
  5. * See COPYING.txt for license details.
  6. */
  7. -->
  8. <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
  9. <xs:complexType name="indexerType" mixed="true">
  10. <xs:annotation>
  11. <xs:documentation>
  12. Indexer declaration.
  13. </xs:documentation>
  14. </xs:annotation>
  15. <xs:sequence>
  16. <xs:choice minOccurs="0" maxOccurs="unbounded">
  17. <xs:element name="title" type="translatableType" />
  18. <xs:element name="description" type="translatableType" />
  19. <xs:element name="saveHandler" type="saveHandlerType" />
  20. <xs:element name="structure" type="structureType" />
  21. <xs:group ref="fieldset"/>
  22. </xs:choice>
  23. <xs:group ref="dependencies"/>
  24. </xs:sequence>
  25. <xs:attribute name="id" type="xs:string" use="required" />
  26. <xs:attribute name="primary" type="nameType" use="optional" />
  27. <xs:attribute name="view_id" type="viewIdType" use="required" />
  28. <xs:attribute name="class" type="classType" use="required" />
  29. <xs:attribute name="shared_index" type="xs:string" use="optional" />
  30. </xs:complexType>
  31. <xs:group name="fieldset">
  32. <xs:choice>
  33. <xs:element name="fieldset" type="fieldsetType"/>
  34. </xs:choice>
  35. </xs:group>
  36. <xs:complexType name="translatableType">
  37. <xs:simpleContent>
  38. <xs:extension base="xs:string">
  39. <xs:attribute name="translate" use="optional" fixed="true" type="xs:boolean"/>
  40. </xs:extension>
  41. </xs:simpleContent>
  42. </xs:complexType>
  43. <xs:simpleType name="viewIdType">
  44. <xs:annotation>
  45. <xs:documentation>
  46. View ID can contain only [a-zA-Z0-9_].
  47. </xs:documentation>
  48. </xs:annotation>
  49. <xs:restriction base="xs:string">
  50. <xs:pattern value="[a-zA-Z0-9_]+" />
  51. </xs:restriction>
  52. </xs:simpleType>
  53. <xs:simpleType name="classType">
  54. <xs:annotation>
  55. <xs:documentation>
  56. Class name can contain only [a-zA-Z\].
  57. </xs:documentation>
  58. </xs:annotation>
  59. <xs:restriction base="xs:string">
  60. <xs:pattern value="[a-zA-Z\\]+" />
  61. </xs:restriction>
  62. </xs:simpleType>
  63. <xs:simpleType name="fromType">
  64. <xs:annotation>
  65. <xs:documentation>
  66. From attribute can contain only [a-zA-Z0-9_].
  67. </xs:documentation>
  68. </xs:annotation>
  69. <xs:restriction base="xs:string">
  70. <xs:pattern value="[a-zA-Z0-9_]+" />
  71. </xs:restriction>
  72. </xs:simpleType>
  73. <xs:simpleType name="toType">
  74. <xs:annotation>
  75. <xs:documentation>
  76. To attribute can contain only [a-zA-Z0-9_].
  77. </xs:documentation>
  78. </xs:annotation>
  79. <xs:restriction base="xs:string">
  80. <xs:pattern value="[a-zA-Z0-9_]+" />
  81. </xs:restriction>
  82. </xs:simpleType>
  83. <xs:simpleType name="originType">
  84. <xs:annotation>
  85. <xs:documentation>
  86. To attribute can contain only [a-zA-Z0-9_].
  87. </xs:documentation>
  88. </xs:annotation>
  89. <xs:restriction base="xs:string">
  90. <xs:pattern value="[a-zA-Z0-9_]+" />
  91. </xs:restriction>
  92. </xs:simpleType>
  93. <xs:simpleType name="nameType">
  94. <xs:annotation>
  95. <xs:documentation>
  96. Class name can contain only [a-zA-Z\].
  97. </xs:documentation>
  98. </xs:annotation>
  99. <xs:restriction base="xs:string">
  100. <xs:pattern value="[a-zA-Z0-9_]+" />
  101. </xs:restriction>
  102. </xs:simpleType>
  103. <xs:complexType name="fieldTypeAbstract" abstract="true">
  104. <xs:annotation>
  105. <xs:documentation>
  106. Index field declaration.
  107. </xs:documentation>
  108. </xs:annotation>
  109. <xs:attribute name="name" type="nameType" use="required"/>
  110. <xs:attribute name="handler" type="classType" use="optional"/>
  111. <xs:attribute name="origin" type="originType" use="optional"/>
  112. </xs:complexType>
  113. <xs:complexType name="fieldsetType" mixed="true">
  114. <xs:annotation>
  115. <xs:documentation>
  116. Fieldset of field declaration.
  117. </xs:documentation>
  118. </xs:annotation>
  119. <xs:sequence minOccurs="0">
  120. <xs:element type="referenceType" name="reference" minOccurs="0" maxOccurs="unbounded" />
  121. <xs:element name="field" type="fieldType" minOccurs="0" maxOccurs="unbounded"/>
  122. </xs:sequence>
  123. <xs:attribute name="source" type="classType" use="required"/>
  124. <xs:attribute name="provider" type="classType" use="optional"/>
  125. <xs:attribute name="name" type="nameType" use="required"/>
  126. </xs:complexType>
  127. <xs:complexType name="fieldType">
  128. <xs:complexContent>
  129. <xs:extension base="fieldTypeAbstract">
  130. <xs:choice>
  131. <xs:element type="filterType" name="filter" minOccurs="0" maxOccurs="1" />
  132. </xs:choice>
  133. <xs:attribute type="dataType" name="dataType" use="optional" />
  134. </xs:extension>
  135. </xs:complexContent>
  136. </xs:complexType>
  137. <xs:complexType name="filterType">
  138. <xs:annotation>
  139. <xs:documentation>
  140. Index field filter.
  141. </xs:documentation>
  142. </xs:annotation>
  143. <xs:attribute name="class" type="classType" use="required"/>
  144. </xs:complexType>
  145. <xs:complexType name="structureType">
  146. <xs:annotation>
  147. <xs:documentation>
  148. Structure type.
  149. </xs:documentation>
  150. </xs:annotation>
  151. <xs:attribute name="class" type="classType" use="required"/>
  152. </xs:complexType>
  153. <xs:complexType name="saveHandlerType">
  154. <xs:annotation>
  155. <xs:documentation>
  156. SaveHandler type.
  157. </xs:documentation>
  158. </xs:annotation>
  159. <xs:attribute name="class" type="classType" use="required"/>
  160. </xs:complexType>
  161. <xs:complexType name="referenceType">
  162. <xs:annotation>
  163. <xs:documentation>
  164. Index field reference.
  165. </xs:documentation>
  166. </xs:annotation>
  167. <xs:attribute name="fieldset" type="nameType" use="required"/>
  168. <xs:attribute name="from" type="fromType" use="required"/>
  169. <xs:attribute name="to" type="toType" use="required"/>
  170. </xs:complexType>
  171. <xs:simpleType name="dataType">
  172. <xs:restriction base="xs:string">
  173. <xs:enumeration value="int" />
  174. <xs:enumeration value="float" />
  175. <xs:enumeration value="varchar" />
  176. <xs:enumeration value="text" />
  177. <xs:enumeration value="mediumtext" />
  178. <xs:enumeration value="timestamp" />
  179. <xs:enumeration value="datetime" />
  180. <xs:enumeration value="date" />
  181. </xs:restriction>
  182. </xs:simpleType>
  183. <xs:complexType name="searchable">
  184. <xs:complexContent>
  185. <xs:extension base="fieldType"/>
  186. </xs:complexContent>
  187. </xs:complexType>
  188. <xs:complexType name="filterable">
  189. <xs:complexContent>
  190. <xs:extension base="fieldType"/>
  191. </xs:complexContent>
  192. </xs:complexType>
  193. <xs:element name="config" type="configType">
  194. <xs:unique name="uniqueIndexerId">
  195. <xs:annotation>
  196. <xs:documentation>
  197. Indexer Id must be unique.
  198. </xs:documentation>
  199. </xs:annotation>
  200. <xs:selector xpath="indexer" />
  201. <xs:field xpath="@id" />
  202. </xs:unique>
  203. <xs:unique name="uniqueViewId">
  204. <xs:annotation>
  205. <xs:documentation>
  206. Indexer Id must be unique.
  207. </xs:documentation>
  208. </xs:annotation>
  209. <xs:selector xpath="indexer" />
  210. <xs:field xpath="@view_id" />
  211. </xs:unique>
  212. </xs:element>
  213. <xs:complexType name="configType">
  214. <xs:sequence>
  215. <xs:element ref="indexer" minOccurs="1" maxOccurs="unbounded"/>
  216. </xs:sequence>
  217. </xs:complexType>
  218. <xs:element name="indexer" type="indexerType">
  219. <xs:unique name="fieldsetKey">
  220. <xs:annotation>
  221. <xs:documentation>
  222. Fieldset name must be unique.
  223. </xs:documentation>
  224. </xs:annotation>
  225. <xs:selector xpath=".//fieldset"/>
  226. <xs:field xpath="@name"/>
  227. </xs:unique>
  228. <xs:keyref name="fieldsetReference" refer="fieldsetKey">
  229. <xs:annotation>
  230. <xs:documentation>
  231. Field fieldset key must exists.
  232. </xs:documentation>
  233. </xs:annotation>
  234. <xs:selector xpath=".//fieldset/reference"/>
  235. <xs:field xpath="@fieldset"/>
  236. </xs:keyref>
  237. </xs:element>
  238. <xs:group name="dependencies">
  239. <xs:choice>
  240. <xs:element minOccurs="0" maxOccurs="1" name="dependencies" type="indexerDependencies">
  241. <xs:unique name="uniqueIndexerDependency">
  242. <xs:annotation>
  243. <xs:documentation>
  244. Related indexer id must be unique.
  245. </xs:documentation>
  246. </xs:annotation>
  247. <xs:selector xpath="indexer" />
  248. <xs:field xpath="@id" />
  249. </xs:unique>
  250. </xs:element>
  251. </xs:choice>
  252. </xs:group>
  253. <xs:complexType name="indexerDependencies">
  254. <xs:annotation>
  255. <xs:documentation>
  256. Root element of the indexer dependencies.
  257. </xs:documentation>
  258. </xs:annotation>
  259. <xs:sequence maxOccurs="unbounded">
  260. <xs:element minOccurs="0" maxOccurs="unbounded" name="indexer">
  261. <xs:complexType>
  262. <xs:annotation>
  263. <xs:documentation>
  264. Indexer dependency that represents another indexer.
  265. </xs:documentation>
  266. </xs:annotation>
  267. <xs:attribute name="id" type="xs:string" use="required" />
  268. </xs:complexType>
  269. </xs:element>
  270. </xs:sequence>
  271. </xs:complexType>
  272. </xs:schema>