[Xunsearch PHP-SDK](http://www.xunsearch.com) v1.4.8 權威指南
1. [主要參數和選項](#)
1. [經典用法示例](#)
1. [導入搜索日志文件](#)
1. [刪除搜索詞](#)
1. [添加/更新搜索詞](#)
# 搜索日志管理
`Logger` 是搜索日志管理工具,針對搜索日志關鍵詞提供查詢、刪除、更新、刷新、清空等功能。
> **Tip:** 熱門搜索、相關搜索、拼音搜索、搜索糾錯和建議這些功能都是基于搜索日志來實現的。 搜索日志是后臺自動分析和生成的,所以可能存在一些偏差和錯誤,您可借助本工具處理。
運行腳本工具的 --help 選項可查看內置的幫助和說明,如亂碼可在選項后加入 -c gbk 試試。
~~~
$prefix/sdk/php/util/Logger.php --help
~~~
### 1. 主要參數和選項[?]()
要使用日志工具,必須先指定的項目名稱或配置文件,所有的操作都將是作用于該項目,主要選項如下:
-
*-p|--project <name|file>* 指定項目名稱或配置文件路徑,參數名可以省略不寫,如果僅指定項目名稱,那么將使用 $prefix/sdk/php/app/.ini 文件。
-
*-c|--charset <gbk|utf-8>* 指定當前環境、數據源的字符集,默認情況下,索引工具輸出的字符集為 utf-8,并把數據源字符集視為項目的默認字符集。
-
*--import=<..file..>* 導入搜索日志文件,每行一個詞,每行的數據中可以用\t(Tab鍵)分開指定次數,沒有次數默認為1。
-
*--put=<word1[:wdf1][,word2[:wdf2]]...>* 添加、更新搜索日志詞匯,詞與次數之間用半角冒號分隔,默認為 1 次。多個詞之間用,(半角)分隔,詞之間如果包含空格,請將參數用引號包圍起來。
-
*--del=<word1[,word2...]>* 刪除搜索日志中的關鍵詞記錄,刪除多個詞匯用半角逗號分隔,若不存在則會提示相關詞
-
*--query=<..word..>* 以 word 為關鍵詞列出相關搜索詞,可用 limit 選項設置個數,默認 6 個
-
*--hot=<total|last|cur>* 列出熱門搜索詞,參數依次表示總次數、上期次數、本期次數,可用 limit 指定個數,默認 10 個。
-
*--limit=<..num..>* 用于控制 query 和 hot 選項的返回記錄數量
-
*--flush* 強制提交搜索日志變動
-
*--clean* 清空搜索日志全部內容
### 2. 經典用法示例[?]()
以下是一些常見用法舉例:
~~~
# 查看 demo 項目中 熱門搜索詞
util/Logger.php demo
util/Logger.php demo --hot=cur
# 查詢 demo 項目中 "word" 相關搜索詞匯
util/Logger.php demo word
util/Logger.php demo word --limit 5
# 把日志文件 words.txt 導入 dmeo 項目中
util/Logger.php --import=words.txt demo
# 清空 demo 項目中 全部搜索日志索引,通常在重建搜索項目或日志數據過于混亂時才需調用
util/Logger.php --clean demo
~~~
### 3. 導入搜索日志文件[?]()
當您有大批搜索日志詞匯需要一并更新時,用 `--put` 可能力不從心了,我們特別提供了`--import` 選項用于導入搜索日志文件。
搜索日志文件必須是 `UTF-8` 編碼,如果不是請在使用前轉換好。文件格式為一行一個詞,每個詞后面可以用制表符 `\t` 隔開寫上搜索次數,默認則為 1 次。以半角的 `;` 和 `#` 開頭的行表示注釋。以下為示范文件內容:
~~~
# 這行表示注釋,被忽略
更新詞
更新詞2 123
~~~
導入的用法很簡單,只要用 `--import` 指定路徑即可,導入過程中會依次打印每個詞的情況,命令如下:
~~~
util/Logger.php --import=/path/to/words.txt demo
~~~
### 4. 刪除搜索詞[?]()
熱門搜索、相關搜索通常是自動處理的,但如果你不希望出現某些詞,可以用 `--del` 選項刪除這些詞。選項的值表示要刪除的詞,多個詞之間用半角的逗號分隔,如果搜索詞包含空格,請使用半角引號包圍選項值。用法如下:
~~~
# 刪除 demo 項目中 搜索日志詞 word
util/Logger.php --del=word demo
# 刪除 demo 項目中 搜索日志詞 word 和 "word1 word2"
util/Logger.php --del "word,word1 word2" demo
~~~
### 5. 添加/更新搜索詞[?]()
您可以用 `--put` 選項快速添加、更新少量幾個搜索詞,常用于替換熱門搜索詞。選項的值表示要更新或添加的詞,詞后面可以用半角的冒號連接搜索次數,若不指定默認為 1 次。多個詞之間用半角的逗號分隔,詞匯中包含空格則注意采用引號包圍。用法舉例:
~~~
# 在 demo 項目中 添加搜索詞 word 次數為 1
util/Logger.php --put=word demo
# 在 demo 項目中 添加搜索詞 word 次數為 123,添加搜索詞 "word1 word2" 次數為 456
util/Logger.php --put="word:123,word1 word2:456" demo
~~~
> **Note:** 刪除、更新、導入搜索詞都是異步行為,也就是說執行完命令后需要等待一段時間才能生效。
$Id$
[? IniWizzard 配置文件向導](#)
[同義詞搜索功能 ?](#)
Copyright ? 2008-2011 by [杭州云圣網絡科技有限公司](http://www.xunsearch.com)
All Rights Reserved.



- 權威指南
- 新手上路
- 最新主要變動
- 概述
- 關于 Xunsearch PHP-SDK
- 安裝、升級
- 體驗 demo 項目
- 開發規范
- 開發流程
- 了解基礎對象
- 基礎對象概述
- XS 項目
- XSException 異常
- XSDocument 文檔
- XSIndex 索引管理
- XSSearch 搜索
- XSTokenizer 分詞接口
- 編寫項目配置文件
- 項目配置詳解
- 自定義分詞器
- 編寫第一個配置文件
- 管理索引
- 索引概述
- 添加文檔
- 更新、修改文檔
- 刪除文檔
- 清空索引
- 平滑重建索引
- 使用索引緩沖區
- 自定義SCWS詞庫
- 使用搜索
- 搜索概述
- 構建搜索語句
- 獲取搜索匹配結果
- 獲取搜索匹配數量
- 獲取熱門搜索詞
- 獲取相關搜索詞
- 搜索建議和糾錯
- 按字段值分面搜索
- 使用輔助工具
- RequiredCheck 運行檢測
- Indexer 索引管理器
- Quest 搜索測試工具
- SearchSkel 生成搜索代碼
- IniWizzard 配置文件向導
- Logger 搜索日志管理
- 專題
- 同義詞搜索功能
- 在SDK中使用SCWS分詞
- API 指南
- XS
- XS
- XSCommand
- XSComponent
- XSDocument
- XSErrorException
- XSException
- XSFieldMeta
- XSFieldScheme
- XSIndex
- XSSearch
- XSServer
- XS.tokenizer
- XSTokenizer
- XSTokenizerFull
- XSTokenizerNone
- XSTokenizerScws
- XSTokenizerSplit
- XSTokenizerXlen
- XSTokenizerXstep
- XS.util
- XSCsvDataSource
- XSDataFilter
- XSDatabaseDataSource
- XSDebugFilter
- XSJsonDataSource
- XSUtil
- XS.util.db
- XSDatabase
- XSDatabaseMySQL
- XSDatabaseMySQLI
- XSDatabasePDO
- XSDatabasePDO_MySQL
- XSDatabasePDO_PgSQL
- XSDatabasePDO_SQLite
- XSDatabasePgSQL
- XSDatabaseSQLite
- XSDatabaseSQLite3
- XS.utilf
- XSDataSource
- 其它文檔
- 關于 xunsearch
- 特色和優勢
- Xunsearch 架構簡圖
- 下載 Xunsearch
- 商業服務與支持
- XunSearch 授權許可證