util.quest.html 4.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/html; charset=gbk" />
  5. <meta name="language" content="zh-cn" />
  6. <link rel="stylesheet" type="text/css" href="../api/css/style.css" />
  7. <link rel="stylesheet" type="text/css" href="../api/css/guide.css" />
  8. <link rel="stylesheet" type="text/css" href="../api/css/highlight.css" />
  9. <title>搜索测试工具</title>
  10. </head>
  11. <body>
  12. <div id="apiPage">
  13. <div id="apiHeader">
  14. <a href="http://www.xunsearch.com" target="_blank">Xunsearch PHP-SDK</a> v1.3.2 权威指南
  15. </div><!-- end of header -->
  16. <div id="content" class="markdown">
  17. <div class="toc"><ol><li><a href="#ch0">主要参数和选项</a></li><li><a href="#ch1">经典用法示例</a></li><li><a href="#ch2">查看同义词表</a></li></ol></div><h1 id="-">搜索测试工具</h1>
  18. <p><code>Quest</code> 是搜索测试工具,提供了搜索相关的各项功能,非常适合用于前期测试比较和纠错。
  19. 运行脚本工具的 --help 选项可查看内置的帮助和说明,如乱码可在选项后加入 -c gbk 试试。</p>
  20. <pre>$prefix/sdk/php/util/Quest.php --help
  21. </pre>
  22. <h2 id="ch0">1. 主要参数和选项<a name="ch0" class="anchor">?</a></h2>
  23. <p>和索引工具类似,使用前必须先指定的项目名称或配置文件,所有的操作都将是作用于该项目,
  24. 主要选项如下:</p>
  25. <ul>
  26. <li><p><em>-p|--project &lt;name|file></em> 指定项目名称或配置文件路径,参数名可以省略不写,
  27. 如果仅指定项目名称,那么将使用 $prefix/sdk/php/app/<name>.ini 文件。</p></li>
  28. <li><p><em>-c|--charset &lt;gbk|utf-8></em> 指定当前环境、查询语句的字符集,默认情况下,
  29. 搜索工具输出的字符集为 utf-8,并把搜索语句字符集视为项目的默认字符集。</p></li>
  30. <li><p><em>-q|--query &lt;..query..></em> 指定要搜索的查询语句,如果语句中包含空格请用使用双引号包围起来。</p></li>
  31. <li><p><em>--hot[=total|last|cur]</em> 用于显示指定项目的热门搜索词,此时 <em>query</em> 参数无意义。
  32. 选项值含义分别表示总搜索量、上周搜索量、本周搜索量,默认为总搜索量。</p></li>
  33. <li><p><em>--suggest</em>、<em>--correct</em>、<em>--related</em> 是搭配 <em>query</em> 的一些功能选项。</p></li>
  34. <li><p><em>--limit=&lt;..num..></em> 用于设置各种检索功能的返回数量最大上限,默认值均为 10 个。
  35. 对于普通搜索模式,还支持用 <em>--limit=offset,num</em> 来同时指定偏移量和上限。</p></li>
  36. <li><p><em>-d|--db &lt;name[,name2 ...]></em> 指定要搜索的数据库名称,默认是名为 db 的库,
  37. 多个库之间用逗号分隔。</p></li>
  38. <li><p><em>--show-query</em> 在搜索结果显示内部的 Xapian 结构的 query 语句用于调试</p></li>
  39. <li><p><em>--synonym</em> 启用自动同义词搜索,这依赖于您的同义词库设置</p></li>
  40. </ul>
  41. <h2 id="ch1">2. 经典用法示例<a name="ch1" class="anchor">?</a></h2>
  42. <p>以下是一些经典用法举例:</p>
  43. <pre># 搜索 demo 中包含 &quot;测试&quot; 的数据
  44. util/Quest.php demo 测试
  45. # 搜索 demo 中包含 &quot;测试&quot; 的数据,并限制最多返回 2 条结果
  46. util/Quest.php -p demo -q 测试 --limit=2
  47. # 列出 demo 项目中以 &quot;x&quot; 开头的搜索建议
  48. util/Quest.php --suggest demo x
  49. # 在 demo 项目中修正搜索词 &quot;xm&quot;
  50. util/Quest.php --correct demo xm
  51. # 在 demo 中列出和 &quot;测试&quot; 相关的搜索词
  52. util/Quest.php --related demo 测试
  53. # 查看 demo 项目上周的 5 条最热门搜索词
  54. util/Quest.php --hot=last --limit=5 demo
  55. </pre>
  56. <h2 id="ch2">3. 查看同义词表<a name="ch2" class="anchor">?</a></h2>
  57. <p>使用 <code>--list-synonyms</code> 可以列出当前库的全部同义词记录,此选项不需要带参数。
  58. 但特殊参数值 <em>stemmed</em> 表示同时列出隐藏的词根同义词。结合选项 <code>--limit</code>
  59. 可以设置返回的数量和偏移量,默认只返回前 100 个。例如:</p>
  60. <pre># 默认查看当前库的前 100 个同义词记录
  61. util/Quest.php demo --list-synonyms
  62. # 查看当前库第 6~10 条同义词记录
  63. util/Quest.php demo --list-synonyms --limit 5,5
  64. # 查看包含隐藏同义词根在内的记录
  65. util/Quest.php demo --list-synonyms=stemmed
  66. </pre>
  67. <blockquote class="tip">
  68. <p><strong>Tip:</strong> 同义词功能是 <em>1.3.0</em> 版本引入的新功能,详情参见<a href="special.synonym.html">同义词专题文档</a>。
  69. 添加、删除同义词的功能请参见 <a href="util.Indexer#ch8">Indexer 索引工具</a></p>
  70. <p>词根同义词是自动生成的,以大写字母 Z 开头,请勿试图进行删除</p>
  71. </blockquote>
  72. <div class="revision">$Id$</div>
  73. <div class="clear"></div>
  74. </div><!-- end of content -->
  75. <div id="guideNav">
  76. <div class="prev"><a href="util.indexer.html">&laquo; Indexer 索引管理器</a></div>
  77. <div class="next"><a href="util.skel.html">SearchSkel 生成搜索代码 &raquo;</a></div>
  78. <div class="clear"></div>
  79. </div><!-- end of nav -->
  80. <div id="apiFooter">
  81. Copyright &copy; 2008-2011 by <a href="http://www.xunsearch.com" target="_blank">杭州云圣网络科技有限公司</a><br/>
  82. All Rights Reserved.<br/>
  83. </div><!-- end of footer -->
  84. </div><!-- end of page -->
  85. <div style="display:none;">
  86. <img src="../api/css/info.gif" />
  87. <img src="../api/css/tip.gif" />
  88. <img src="../api/css/note.gif" />
  89. </div>
  90. </body>
  91. </html>