Главная Обзор Помощь
Вход
S.H.I.E.L.D.
/
wenda-php
2
0
Ответвить 0
Файлы Задачи 0 Запросы на слияние 0 Вики
Ветка: master
Ветки Метки
wenda-php
/
protected
/
plugin
/
xsearch
/
doc
/
guide
/
index.overview.html

index.overview.html 6.4 KB
Постоянная ссылка История Исходник

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103 
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    2. 

  2. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
    3. 

  3. <head>
    4. 

  4. <meta http-equiv="Content-Type" content="text/html; charset=gbk" />
    5. 

  5. <meta name="language" content="zh-cn" />
    6. 

  6. <link rel="stylesheet" type="text/css" href="../api/css/style.css" />
    7. 

  7. <link rel="stylesheet" type="text/css" href="../api/css/guide.css" />
    8. 

  8. <link rel="stylesheet" type="text/css" href="../api/css/highlight.css" />
    9. 

  9. <title>索引概述</title>
    10. 

  10. </head>
    11. 

  11. 

  12. <body>
    13. 

  13. <div id="apiPage">
    14. 

  14. 

  15. <div id="apiHeader">
    16. 

  16. <a href="http://www.xunsearch.com" target="_blank">Xunsearch PHP-SDK</a> v1.3.2 权威指南
    17. 

  17. </div><!-- end of header -->
    18. 

  18. 

  19. <div id="content" class="markdown">
    20. 

  20. 	<div class="toc"><ol><li><a href="#ch0">什么是索引？</a></li><li><a href="#ch1">如何开始使用索引？</a></li><li><a href="#ch2">如何更换索引库？</a></li><li><a href="#ch3">索引更新是异步行为</a></li></ol></div><h1 id="-">索引概述</h1>
    21. 

  21. 

  22. <h2 id="ch0">1. 什么是索引？<a name="ch0" class="anchor">?</a></h2>
    23. 

  23. 

  24. <p>索引在 <code>Xunsearch</code> 中泛指用于检索的数据库文件总称。每一次检索数据均为访问和读取
    25. 

  25. 索引文件，每一次更新数据则是对索引文件的修改。</p>
    26. 

  26. 

  27. <p><code>Xunsearch</code> 每个搜索项目的索引数据是分开单独存放的，索引本质上是一系列预设计文件，
    28. 

  28. 内部都是特别设计的 <code>Tree</code> 结构，但这些东西不是这份指南所关注的。假设一个项目的名称
    29. 

  29. 为 <code>demo</code> (即 <code>INI</code> 文件中 <code>project.name</code> 的值)，那么它在服务端的索引数据的存储
    30. 

  30. 路径为：</p>
    31. 

  31. 

  32. <pre>$prefix/data/demo
    33. 

  33. </pre>
    34. 

  34. 

  35. <p>该目录底下包含 2 个主要索引数据库，分别是</p>
    36. 

  36. 

  37. <ul>
    38. 

  38. <li><code>db</code> 默认的主索引数据库，各种检索数据均存放在此</li>
    39. 

  39. <li><code>log_db</code> 搜索日志数据库，用于存放搜索日志相关，用于实现相关搜索、搜索建议、拼音搜索等</li>
    40. 

  40. </ul>
    41. 

  41. 

  42. <h2 id="ch1">2. 如何开始使用索引？<a name="ch1" class="anchor">?</a></h2>
    43. 

  43. 

  44. <p>在 <code>PHP-SDK</code> 中，索引管理由类型为 <a href="../api/XSIndex.html">XSIndex</a> 的对象所维护。在 <a href="../api/XS.html">XS</a> 项目中，通过读取
    45. 

  45. <a href="../api/XS.html#index">XS::index</a> 属性来获取索引管理对象，然后展开各种操作，而不是自行创建对象。后面章节中
    46. 

  46. 的相关测试代码如果没有特别编写，其中的 <code>$index</code> 均为通过类似以下的方式获取的索引对象：</p>
    47. 

  47. 

  48. <div class="hl-code"><div class="php-hl-main"><pre><span class="php-hl-reserved">require</span> <span class="php-hl-quotes">'</span><span class="php-hl-string">$prefix/sdk/php/lib/XS.php</span><span class="php-hl-quotes">'</span><span class="php-hl-code">;
    49. 

  49. </span><span class="php-hl-var">$xs</span><span class="php-hl-code"> = </span><span class="php-hl-reserved">new</span> <span class="php-hl-identifier">XS</span><span class="php-hl-brackets">(</span><span class="php-hl-quotes">'</span><span class="php-hl-string">demo</span><span class="php-hl-quotes">'</span><span class="php-hl-brackets">)</span><span class="php-hl-code">; </span><span class="php-hl-comment">//</span><span class="php-hl-comment"> 建立 XS 对象，项目名称为：demo</span>
    50. 

  50. <span class="php-hl-var">$index</span><span class="php-hl-code"> = </span><span class="php-hl-var">$xs</span><span class="php-hl-code">-&gt;</span><span class="php-hl-identifier">index</span><span class="php-hl-code">; </span><span class="php-hl-comment">//</span><span class="php-hl-comment"> 获取 索引对象</span></pre></div></div>
    51. 

  51. 

  52. <p>索引的维护包括数据修改/更新、数据删除、添加数据等操作，由后面的篇幅分开详细讲解。</p>
    53. 

  53. 

  54. <h2 id="ch2">3. 如何更换索引库？<a name="ch2" class="anchor">?</a></h2>
    55. 

  55. 

  56. <p>默认使用的索引库名称为 <code>db</code>，对应到服务端的 <code>$prefix/data/$name/db</code>，一般开发时不需要
    57. 

  57. 关注这个本质。但如果您的索引数据库相当大，希望对索引库进行适当的分割，可以自命名新的索引库。
    58. 

  58. 在搜索时可以使用 <a href="../api/XSSearch.html#addDb">XSSearch::addDb</a> 进行多库并行搜索。</p>
    59. 

  59. 

  60. <div class="hl-code"><div class="php-hl-main"><pre><span class="php-hl-comment">//</span><span class="php-hl-comment"> 比如把当前索引更新到名称为 db2 的库中</span>
    61. 

  61. <span class="php-hl-var">$index</span><span class="php-hl-code">-&gt;</span><span class="php-hl-identifier">setDb</span><span class="php-hl-brackets">(</span><span class="php-hl-quotes">'</span><span class="php-hl-string">db2</span><span class="php-hl-quotes">'</span><span class="php-hl-brackets">)</span><span class="php-hl-code">;
    62. 

  62.  
    63. 

  63. </span><span class="php-hl-comment">//</span><span class="php-hl-comment"> 在检索时同时搜索 db, db2 的作法，具体参考搜索的有关章节</span><span class="php-hl-code">
    64. 

  64. ...
    65. 

  65. </span><span class="php-hl-var">$search</span><span class="php-hl-code">-&gt;</span><span class="php-hl-identifier">addDb</span><span class="php-hl-brackets">(</span><span class="php-hl-quotes">'</span><span class="php-hl-string">db2</span><span class="php-hl-quotes">'</span><span class="php-hl-brackets">)</span><span class="php-hl-code">-&gt;</span><span class="php-hl-identifier">setQuery</span><span class="php-hl-brackets">(</span><span class="php-hl-code">...</span><span class="php-hl-brackets">)</span><span class="php-hl-code">-&gt;</span><span class="php-hl-identifier">search</span><span class="php-hl-brackets">(</span><span class="php-hl-brackets">)</span><span class="php-hl-code">;</span></pre></div></div>
    66. 

  66. 

  67. <h2 id="ch3">4. 索引更新是异步行为<a name="ch3" class="anchor">?</a></h2>
    68. 

  68. 

  69. <p>有必要指出的是，出于性能优化设计，所有的索引操作（包含添加、删除、修改文档）均是异步的
    70. 

  70. 行为。也就是说在 <code>PHP-SDK</code> 的相关 <code>API</code> 返回后，只是说明已经将索引变动提交到操作队列中，
    71. 

  71. 而并不是已经立即更新到磁盘上的索引数据库文件。因此，搜索结果将不能立即体现出您的变动。</p>
    72. 

  72. 

  73. <p>但请放心，这个时间差我们已经控制在非常合理的范围内，通常是若干秒。</p>
    74. 

  74. 

  75. <blockquote class="note">
    76. 

  76. <p><strong>Note:</strong> 特别说明，索引清空是同步操作，立即生效。如果确实有必要，您可以以使用 
    77. 

  77.   <a href="util.indexer.html">Indexer</a>的  <code>--flush</code> 选项来强制刷新索引。</p>
    78. 

  78. </blockquote>
    79. 

  79. 

  80. <div class="revision">$Id$</div>
    81. 

  81. 	<div class="clear"></div>
    82. 

  82. </div><!-- end of content -->
    83. 

  83. <div id="guideNav">
    84. 

  84. 		<div class="prev"><a href="ini.first.html">&laquo; 编写第一个配置文件</a></div>
    85. 

  85. 			<div class="next"><a href="index.add.html">添加文档 &raquo;</a></div>
    86. 

  86. 		<div class="clear"></div>
    87. 

  87. </div><!-- end of nav -->
    88. 

  88. 

  89. <div id="apiFooter">
    90. 

  90. Copyright &copy; 2008-2011 by <a href="http://www.xunsearch.com" target="_blank">杭州云圣网络科技有限公司</a><br/>
    91. 

  91. All Rights Reserved.<br/>
    92. 

  92. </div><!-- end of footer -->
    93. 

  93. 

  94. </div><!-- end of page -->
    95. 

  95. 

  96. <div style="display:none;">
    97. 

  97. 	<img src="../api/css/info.gif" />
    98. 

  98. 	<img src="../api/css/tip.gif" />
    99. 

  99. 	<img src="../api/css/note.gif" />
    100. 

  100. </div>
    101. 

  101. 

  102. </body>
    103. 

  103. </html>
    104.