index.html 7.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171
  1. <html>
  2. <h1>Solr Search</h1>
  3. <p>The Solr Search application, which is based on <a href="http://lucene.apache.org/solr/">Apache Solr</a>, allows you to perform keyword searches across Hadoop data. A wizard lets you style the result snippets, specify facets to group the results, sort the results, and highlight result fields.</p>
  4. <h2>Solr Search Installation and Configuration</h2>
  5. <p>Solr Search is one of the applications installed as part of Hue. For information about installing and configuring Hue, see the Hue Installation
  6. manual.</p>
  7. <h2>Starting Solr Search</h2>
  8. <p>Click the <strong> Solr Search</strong> icon
  9. (<img alt="image" src="/search/static/art/icon_search_24.png" />) in the navigation bar at the top of
  10. the Hue browser page. <strong>Solr Search</strong> opens to the <a href="#collectionManager">Collection Manager</a>. If there are no collections, the <a href="#importCollection">Import Collections and Cores</a> dialog displays.</p>
  11. <p><a id="collectionManager"></a></p>
  12. <h2>Collection Manager</h2>
  13. <p>In Collection Manager you import, copy, and delete <a href="http://wiki.apache.org/solr/SolrCloud#A_little_about_SolrCores_and_Collections">collections</a>.</p>
  14. <h3>Displaying the Collection Manager</h3>
  15. <p>When you start Solr Search, the Collection Manager displays. You navigate to the Collection Manager by clicking <strong>Collection manager</strong> in the Search page or the Template Editor.</p>
  16. <h3>Filtering Collections</h3>
  17. <p>When you type in the Filter field, the list of collections is dynamically filtered to display only those rows
  18. containing text that matches the specified substring.</p>
  19. <p><a id="importCollection"></a></p>
  20. <h3>Importing Collections</h3>
  21. <ol>
  22. <li>If there are existing collections, click the <i class="icon-plus-sign"></i> <strong>Import</strong> button at the top right. The Import Collections and Cores dialog displays.</li>
  23. <li>Check the checkboxes next to the collections to import.</li>
  24. <li>Click <strong>Import Selected</strong>. The collection is added to the Collection Manager.</li>
  25. </ol>
  26. <h3>Editing Collection Properties</h3>
  27. <ol>
  28. <li>In the Collection Manager, click a collection.</li>
  29. <li>In the <strong>COLLECTION</strong> area on the left, click <strong>Properties</strong>.</li>
  30. <li>Edit a property and click <strong>Save</strong>.</li>
  31. </ol>
  32. <h3>Searching a Collection</h3>
  33. <ol>
  34. <li>In the Collection Manager, click <strong>Search page</strong> or click <strong>Search it</strong> in the Collection area on the left. The Search page displays.</li>
  35. <li>Select a collection from the <strong>Search in</strong> drop-down list.</li>
  36. <li>Type a search string in the <strong>Search...</strong> text box.</li>
  37. <li>
  38. <p>Press <strong>Enter</strong> or click the <i class="icon-search"></i> icon.</p>
  39. </li>
  40. <li>
  41. <p>If you have defined <a href="#facets">facets</a>, click a facet to display only those results in the group defined by the facet.</p>
  42. </li>
  43. <li>If you have defined <a href="#sorting">sorting fields</a>, select from the <strong>Sort by</strong> drop-down list to sort the results.</li>
  44. <li>Click 'X' to clear the search string.</li>
  45. </ol>
  46. <h2>Styling Search Results</h2>
  47. <p>Do one of the following:</p>
  48. <ul>
  49. <li>In the Collection Manager, click a collection.</li>
  50. <li>In the Search page, select a collection from the <strong>Search in</strong> drop-down list and click <strong> Customize this collection</strong>. The Template Editor displays.</li>
  51. </ul>
  52. <h3>Template Editor</h3>
  53. <p>The Template Editor provides four features:</p>
  54. <ul>
  55. <li><a href="#snippetEditor">Snippet editor</a> - Specify the layout of the search result snippet, which fields appear in the snippet, and style the results.</li>
  56. <li><a href="#facetEditor">Facet editor</a> - Define buckets in which to group results.</li>
  57. <li><a href="#sortEditor">Sort editor</a> - Specify on which fields and order the results are sorted. </li>
  58. <li><a href="#highlightingEditor">Highlighting editor</a> - Enable highlighting of search fields. </li>
  59. </ul>
  60. <p><a id="snippetEditor"></a></p>
  61. <h4>Snippet Editor</h4>
  62. <ol>
  63. <li>In the Snippet Editor, click a tab to choose the method for editing the search snippet fields and styling:</li>
  64. <li>
  65. <ul>
  66. <li><strong>Visual editor</strong> - Click <img alt="image" src="images/layoutChooser.png" /> to choose an overall layout for the snippet.</li>
  67. </ul>
  68. </li>
  69. <li>
  70. <ul>
  71. <li>
  72. <ul>
  73. <li>Select the fields and functions from the drop-down lists on the right and click <img alt="image" src="images/add.png" />. </li>
  74. </ul>
  75. </li>
  76. </ul>
  77. </li>
  78. <li>
  79. <ul>
  80. <li>
  81. <ul>
  82. <li>Select fields, right-click, and select <strong>Cut</strong> and <strong>Paste</strong> to place the fields on the canvas. </li>
  83. </ul>
  84. </li>
  85. </ul>
  86. </li>
  87. <li>
  88. <ul>
  89. <li>
  90. <ul>
  91. <li>Select fields and apply styling using the buttons on top.</li>
  92. </ul>
  93. </li>
  94. </ul>
  95. </li>
  96. <li>
  97. <ul>
  98. <li><strong>Source</strong> - </li>
  99. </ul>
  100. </li>
  101. <li>
  102. <ul>
  103. <li>
  104. <ul>
  105. <li>Select the data fields and functions from the drop-down lists on the right.</li>
  106. </ul>
  107. </li>
  108. </ul>
  109. </li>
  110. <li>
  111. <ul>
  112. <li>
  113. <ul>
  114. <li>Specify layout and styling using HTML tags.</li>
  115. </ul>
  116. </li>
  117. </ul>
  118. </li>
  119. <li>
  120. <ul>
  121. <li><strong>Preview</strong> - Preview the snippet.</li>
  122. </ul>
  123. </li>
  124. <li>
  125. <ul>
  126. <li><strong>Advanced</strong> - Specify styles for CSS classes specified in the Source tab.</li>
  127. </ul>
  128. </li>
  129. <li>Click <strong>Save</strong>.</li>
  130. </ol>
  131. <p><a id="facetEditor"></a></p>
  132. <h4>Facet Editor</h4>
  133. <p>By default, faceting search result fields is disabled. Click <strong>Enabled</strong> to enable faceting.</p>
  134. <ol>
  135. <li>In the Template Editor, click <strong>2. Facets</strong>. You can move between the facet tabs by clicking each <strong>Step</strong> tab, or by clicking <strong>Back</strong> and <strong>Next</strong>.</li>
  136. <li>In the General tab, specify </li>
  137. <li>
  138. <ul>
  139. <li><strong>Limit</strong> - the maximum number of values for each facet.</li>
  140. </ul>
  141. </li>
  142. <li>
  143. <ul>
  144. <li><strong>Mincount</strong> - the minimum number of search results that fall into a group for the facet to display on the Search page.</li>
  145. </ul>
  146. </li>
  147. <li>In the Field, Range, and Date Facet tabs, specify the facet properties and click <img alt="image" src="images/add.png" /> <strong>Add</strong>.</li>
  148. <li>In the Facets Order tab, drag and drop the facet to specify the order in they appear in the Search page.</li>
  149. <li>Click <strong>Save</strong>. When you display the Search page, the facets display on the left.</li>
  150. </ol>
  151. <p><a id="sortEditor"></a></p>
  152. <h4>Sorting Editor</h4>
  153. <p>By default, sorting on search result fields is disabled. Click <strong>Enabled</strong> to enable sorting.</p>
  154. <ol>
  155. <li>In the Template Editor, click <strong>3. Sorting</strong>. </li>
  156. <li>In the Field drop-down, select a field. Optionally specify a label for the field. </li>
  157. <li>The default order is ascending. Click the arrows to change the order.</li>
  158. <li>Click <img alt="image" src="images/add.png" /> <strong>Add</strong>.</li>
  159. <li>Click <strong>Save</strong>. When you display search results, the results are sorted by the fields in the order that they appear left to right. </li>
  160. </ol>
  161. <p><a id="highlightingEditor"></a></p>
  162. <h4>Highlighting Editor</h4>
  163. <p>By default,highlighting search result fields is disabled. Click <strong>Enabled</strong> to enable highlighting.</p>
  164. <ol>
  165. <li>In the Template Editor, click <strong>3. Highlighting</strong>. </li>
  166. <li>Select the fields to be highlighted.</li>
  167. <li>Click <strong>Save</strong>. When you display search results, the selected fields are displayed with the style of the <strong>em</strong> class defined in the Advanced tab of the <a href="#snippetEditor">Snippet editor</a>. </li>
  168. </ol>
  169. </html>