[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.
![](https://box.kancloud.cn/2015-09-10_55f11d05b8e67.gif)
![](https://box.kancloud.cn/2015-09-10_55f11d05bff5e.gif)
![](https://box.kancloud.cn/2015-09-10_55f11d05cac7e.gif)
- 权威指南
- 新手上路
- 最新主要变动
- 概述
- 关于 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 授权许可证