Xunsearch

https://github.com/hightman/xunsearch
Admin
Xunsearch is a free and open-source professional Chinese full-text search solution that provides...
Tokens:10,213
Snippets:122
Trust Score:7.2
Update:5 months ago
Show doc for...
Tokens:
Raw
### Discuz Search Project Configuration Example

Source: https://github.com/hightman/xunsearch/blob/master/sdk/php/doc/guide/ini.guide.txt

A comprehensive example configuration file for a Discuz search project, demonstrating various field types, indexing options, and tokenizers.

```ini
project.name = sample
project.default_charset = GBK
;server.index = 8383
;server.search = 8384

[pid]
type = id

[subject]
type = title

[message]
type = body

[dateline]
type = numeric

[author]
index = both

[authorid]

[tid]
index = self
tokenizer = full

[fid]
index = self
tokenizer = full

[flag]
```

--------------------------------

### Basic Logger Usage Examples

Source: https://github.com/hightman/xunsearch/blob/master/sdk/php/doc/guide/util.logger.txt

Demonstrates fundamental operations of the Logger tool, including viewing hot search terms, querying related terms, importing logs, and cleaning logs.

```bash
util/Logger.php demo
```

```bash
util/Logger.php demo --hot=cur
```

```bash
util/Logger.php demo word
```

```bash
util/Logger.php demo word --limit 5
```

```bash
util/Logger.php --import=words.txt demo
```

```bash
util/Logger.php --clean demo
```

--------------------------------

### Import Search Log File

Source: https://github.com/hightman/xunsearch/blob/master/sdk/php/doc/guide/util.logger.txt

Import search log terms from a file into a project. Each line in the file represents a term, optionally followed by a tab and its count. Lines starting with ';' or '#' are comments. Ensure the file is UTF-8 encoded.

```bash
util/Logger.php --import=/path/to/words.txt demo
```

--------------------------------

### Custom Data Filter Example

Source: https://github.com/hightman/xunsearch/blob/master/sdk/php/doc/guide/util.indexer.txt

Example of a custom data filter implementing the XSDataFilter interface. The process method handles data pre-processing, and processDoc handles index document adjustments.

```php
class XSXyzFilter implements XSDataFilter
{
	public function process($data, $cs)
	{
		print_r($data);
		return $data;
	}
	public function processDoc($doc)
	{
		// $doc->addTerm('subject', '特殊词');
	}
}
```

--------------------------------

### XSDocument Field Access Methods

Source: https://github.com/hightman/xunsearch/blob/master/sdk/php/doc/guide/class.document.txt

Demonstrates various ways to set and get field values for an XSDocument object using property access, array-like access, and dedicated methods.

```php
$doc = new XSDocument;
$doc->name = 'value'; // 用对象属性方式进行赋值、取值
$doc['name'] = 'value'; // 用数组下标方式进行赋值、取值
$value = $doc->f('name'); // 用函数方式进行取值
$doc->setField('name', 'value'); // 用函数方式进行赋值
$doc->setFields(array('name' => 'value', 'name2' => 'value2')); // 用数组进行批量赋值

// 迭代方式取所有字段值
foreach($doc as $name => $value) 
{
    echo "$name: $value\n";  
}
```

--------------------------------

### Field Definition Example

Source: https://github.com/hightman/xunsearch/blob/master/sdk/php/doc/guide/ini.guide.txt

Defines a field within a Xunsearch project. The name enclosed in square brackets is the field name. Each project can have multiple fields based on search requirements.

```ini
[field_name]
```

--------------------------------

### Get Search Count Only

Source: https://github.com/hightman/xunsearch/blob/master/sdk/php/doc/guide/search.overview.txt

Retrieve only the estimated count of search results without fetching the documents. Useful when only the number of matches is needed.

```php
$count = $search->count(); // 获取搜索结果的匹配总数估算值
```

--------------------------------

### PHP Spelling Correction

Source: https://github.com/hightman/xunsearch/blob/master/sdk/php/doc/guide/search.fix.txt

Corrects spelling errors in user queries based on indexed terms and search logs. Call getCorrectedQuery() after a search to get suggestions. It's recommended to use this feature when search results are scarce.

```php
// Assume in the demo project, the intention was to search for "测试" but it was mistyped as "侧试"
$search->setQuery('侧试');
$docs = $search->search();  

// Due to the spelling error, the data returned might be very little or none, so try to correct it using the following method
$corrected = $search->getCorrectedQuery();
if (count($corrected) !== 0)
{
   // If there are correction suggestions, list them; this case would yield the suggestion "测试"
   echo "您是不是要找：\n";
   foreach ($corrected as $word)
   {
      echo $word . "\n";
   }
}

/** 
 * The following spelling examples are simplified and directly pass the Query statement for testing 
 * You can also test using `util/Quest.php demo --correct <word>`
 */

$search->getCorrectedQuery('cs');  // Get suggestions via initial letters: "测试"
$search->getCorrectedQuery('ceshi');  // Get suggestions via full pinyin abbreviation: "测试"
$search->getCorrectedQuery('yunsearch'); // Get correction via spelling error: xunsearch
$search->getCorrectedQuery('xunseach 侧试'); // Mixed correction: xunsearch测试
```

--------------------------------

### Field Value Range Filtering

Source: https://github.com/hightman/xunsearch/blob/master/sdk/php/doc/guide/search.query.txt

Shows how to filter search results based on a range of values for a specific field using the addRange API. This method supports one-way comparisons by setting either the start or end value to null.

```php
$from = strtotime("2011-1-1"); // 起始时间 2011年1月1日
$to = strtotime("2011-9-1"); // 结束时间 2011年9月1日

// 1. <= $to: 要求结果的时间必须在 2011-9-1 之前，并且包含 2011-9-1
$docs = $search->setQuery('杭州')->addRange('chrono', null, $to)->search();

// 2. >= $from: 要求结果的时间必须在 2011-1-1 之后，并且包含 2011-1-1
$docs = $search->setQuery('杭州')->addRange('chrono', $from, null)->search();

// 3. > $from && <= $to: 要求结果的时间必须在 2011-1-1 之后  并且 2011-9-1 之前
$docs = $search->setQuery('杭州')->addRange('chrono', $from, $to)->search();
```

--------------------------------

### Display Indexer Help

Source: https://github.com/hightman/xunsearch/blob/master/sdk/php/doc/guide/util.indexer.txt

Run the Indexer script with the --help option to view built-in help and instructions. If you encounter garbled characters, try adding -c gbk after the options.

```bash
$prefix/sdk/php/util/Indexer.php --help
```

--------------------------------

### Display Logger Help

Source: https://github.com/hightman/xunsearch/blob/master/sdk/php/doc/guide/util.logger.txt

View built-in help and instructions for the Logger script. Use the -c gbk option if character encoding issues arise.

```bash
$prefix/sdk/php/util/Logger.php --help
```

--------------------------------

### Perform a Typical Search

Source: https://github.com/hightman/xunsearch/blob/master/sdk/php/doc/guide/search.overview.txt

Demonstrates a typical search workflow: setting a query, adding optional conditions, setting limits, and executing the search. Use this for complex search requirements.

```php
$query = '项目测试'; // 这里的搜索语句很简单，就一个短语

$search->setQuery($query); // 设置搜索语句
$search->addWeight('subject', 'xunsearch'); // 增加附加条件：提升标题中包含 'xunsearch' 的记录的权重
$search->setLimit(5, 10); // 设置返回结果最多为 5 条，并跳过前 10 条

$docs = $search->search(); // 执行搜索，将搜索结果文档保存在 $docs 数组中
$count = $search->count(); // 获取搜索结果的匹配总数估算值
```

--------------------------------

### View Project Information

Source: https://github.com/hightman/xunsearch/blob/master/sdk/php/doc/guide/util.indexer.txt

Retrieves and displays relevant information about the specified project on the server.

```bash
util/Indexer.php --info -p demo
```

--------------------------------

### Initialize Search Object

Source: https://github.com/hightman/xunsearch/blob/master/sdk/php/doc/guide/search.overview.txt

Obtain a search object from an XS instance. This is the standard way to access search functionality.

```php
require '$prefix/sdk/php/lib/XS.php';
$xs = new XS('demo'); // 建立 XS 对象，项目名称为：demo
$search = $xs->search; // 获取 搜索对象
```

--------------------------------

### Creating XSDocument with Character Set

Source: https://github.com/hightman/xunsearch/blob/master/sdk/php/doc/guide/class.document.txt

Shows how to instantiate an XSDocument object, specifying the character set either by default or explicitly. It also illustrates initializing the document with an array of data.

```php
$doc = new XSDocument;  // 使用默认字符集
$doc = new XSDocument('gbk'); // 指定文档为 GBK 编码
$doc = new XSDocument($data); // 数组 $data 为初始字段数据, 编码则为默认编码
$doc = new XSDocument($data, 'gbk'); // 数组 $data 为字段数据, 编码为 GBK
```

--------------------------------

### Basic and Fielded Search Queries

Source: https://github.com/hightman/xunsearch/blob/master/sdk/php/doc/guide/search.query.txt

Demonstrates basic keyword searches and how to target specific fields. Use spaces to separate keywords for AND logic, or enable fuzzy search for OR logic. Fielded search requires the format 'fieldname:keyword'.

```php
$search->search('上海人民公园'); // 检索 body 型字段及混合区
$search->search('上海 人民公园'); // 用空格连接 2 个关键词, 这种情况比上面的用法更明确
$search->search('subject:上海 人民公园'); // 特别要求 subject 字段包含 "上海"
$search->setFuzzy()->search('上海公园'); // 开启模糊搜索，搜索 "上海" 或 "公园"
```

--------------------------------

### Xunsearch INI Configuration for Discuz! Posts

Source: https://github.com/hightman/xunsearch/blob/master/sdk/php/doc/guide/ini.first.txt

A complete Xunsearch INI configuration file for indexing Discuz! forum posts. It defines field types, indexing, and tokenizers for searching titles, content, authors, and filtering by board and post type.

```ini
[php]
project.name = discuz
project.default_charset = GBK
;服务端用默认值
;server.index = 8383
;server.search = 8384

[pid]
type = id

[fid]
index = self
tokenizer = full

[tid]

[first]
index = self
tokenizer = full

[author]
index = both

[authorid]

[subject]
type = title

[message]
type = body

[dateline]
type = numeric

```

--------------------------------

### Server Connection Parameters

Source: https://github.com/hightman/xunsearch/blob/master/sdk/php/doc/guide/ini.guide.txt

Configures the connection parameters for Xunsearch index and search servers. Supports connection via port number (localhost), address:port, or a Unix socket file path. Multiple server addresses can be specified using a semicolon separator.

```ini
; Index server configuration, default value is 8383
server.index = 8383
; Search server configuration, default value is 8384
server.search = 8384
```

--------------------------------

### Import SQLite Data Source

Source: https://github.com/hightman/xunsearch/blob/master/sdk/php/doc/guide/util.indexer.txt

Imports data from an SQLite database. Specify the data source connection string (path to the .db file) and the SQL query to select the data.

```bash
util/Indexer.php --source=sqlite:///tmp/test.db --sql="select * from tbl_post"
```

--------------------------------

### Import MySQL Data Source

Source: https://github.com/hightman/xunsearch/blob/master/sdk/php/doc/guide/util.indexer.txt

Imports data from a MySQL database. Specify the data source connection string and the SQL query to select the data.

```bash
util/Indexer.php --source=mysql://root@localhost/test --sql="select * from tbl_post"
```

--------------------------------

### Import MySQL Data with Rebuild

Source: https://github.com/hightman/xunsearch/blob/master/sdk/php/doc/guide/util.indexer.txt

Imports data from a MySQL table into the specified project using a smooth rebuild process. It requires specifying the database connection details, the SQL query, and the project name.

```bash
util/Indexer.php --rebuild --source=mysql://root:pass@localhost/dbname --sql="SELECT * FROM tbl_post" --project=demo
```

--------------------------------

### PHP Search Suggestions

Source: https://github.com/hightman/xunsearch/blob/master/sdk/php/doc/guide/search.fix.txt

Provides keyword suggestions as users type, similar to Baidu's search suggestions. Use getExpandedQuery() to retrieve a list of related popular keywords. This enhances user experience by saving typing time.

```php
/** 
 * The following examples can also be tested using `util/Quest.php demo --suggest <word>`
 */
$search->getExpandedQuery('x'); // Returns: 项目, xunsearch, 行为, 项目测试
$search->getExpandedQuery('xm'); // Returns: 项目, 项目测试
$search->getExpandedQuery('项'); // Returns: 项目, 项目测试
$search->getExpandedQuery('项目'); // Returns: 项目测试
```

--------------------------------

### Extending XSDocument for Pre/Post Submit Operations

Source: https://github.com/hightman/xunsearch/blob/master/sdk/php/doc/guide/class.document.txt

Illustrates how to extend the XSDocument class to implement custom logic before and after submitting a document to the index using beforeSubmit and afterSubmit methods.

```php
class MyDocument extends XSDocument
{
    public function beforeSubmit(XSIndex $index)
    {
        // 在此编写您的代码，如需要中断添加请提前返回 false
        // ...
        return parent::beforeSubmit($index);
    }

    public function afterSubmit(XSIndex $index)
    {
        // 在此编写您的代码，只有加入索引成功后才会执行
        // ...
    }    
}

$doc = new MyDocument('gbk');
$doc->pid = 123;
$doc->subject = 'Hello, 测试';
$doc->message = '测试的内容在此';
$xs->index->add($doc);
```

--------------------------------

### Perform a Shortcut Search

Source: https://github.com/hightman/xunsearch/blob/master/sdk/php/doc/guide/search.overview.txt

Use shortcut methods to perform count or search operations by directly passing the query string. This method has limitations compared to the typical search.

```php
$count = $search->count('项目测试'); 
$docs = $search->search('项目测试');
```

--------------------------------

### Field Indexing Configuration (None)

Source: https://github.com/hightman/xunsearch/blob/master/sdk/php/doc/guide/ini.guide.txt

Specifies how a field should be indexed for searching. 'none' means the field is not indexed for search matching but can be used for sorting or display. Other options are 'self', 'mixed', and 'both'.

```ini
index = none
```

--------------------------------

### Import JSON Data

Source: https://github.com/hightman/xunsearch/blob/master/sdk/php/doc/guide/util.indexer.txt

Imports data from a JSON file into the specified project. The --source=json option indicates the data format, followed by the project name and the file path.

```bash
util/Indexer.php --source=json demo file.json
```

--------------------------------

### Field Tokenizer Configuration (Default)

Source: https://github.com/hightman/xunsearch/blob/master/sdk/php/doc/guide/ini.guide.txt

Defines the tokenizer used for a field. 'default' uses the built-in SCWS tokenizer. Other options like 'full', 'none', 'split', 'xlen', and 'xstep' allow for custom tokenization strategies.

```ini
tokenizer = default
```

--------------------------------

### Complex Boolean Queries with Parentheses

Source: https://github.com/hightman/xunsearch/blob/master/sdk/php/doc/guide/search.query.txt

Shows how to use parentheses to group conditions and create complex search logic, similar to mathematical expressions. Field searches can be embedded within these expressions.

```php
// 要求结果包含 “杭州+西湖” 或 “杭州 + 西溪湿地”，并且不能包含 “汽车 火车”
$search->search('((杭州 AND 西湖) OR (杭州 AND 西溪湿地)) NOT (汽车 火车)');
```

--------------------------------

### Field Type Configuration (String)

Source: https://github.com/hightman/xunsearch/blob/master/sdk/php/doc/guide/ini.guide.txt

Sets the data type for a field. 'string' is the default and suitable for most cases. Other types include 'numeric', 'date', 'id', 'title', and 'body', each with specific use cases and constraints.

```ini
type = string
```

--------------------------------

### Project Name Configuration

Source: https://github.com/hightman/xunsearch/blob/master/sdk/php/doc/guide/ini.guide.txt

Sets the name of the Xunsearch project. This name is used as the directory name for storing index data on the server. It must consist of lowercase letters and hyphens, with a length between 2 and 31 characters. Project names must be unique within a single Xunsearch server.

```ini
project.name = AppName
```

--------------------------------

### Logger Script with Project Argument

Source: https://github.com/hightman/xunsearch/blob/master/sdk/php/doc/guide/util.logger.txt

Execute the Logger script specifying the project name directly. This is a common way to interact with the tool for various operations.

```bash
util/Logger.php demo
```

--------------------------------

### Import CSV with Custom Delimiter (Tab)

Source: https://github.com/hightman/xunsearch/blob/master/sdk/php/doc/guide/util.indexer.txt

Imports data from a CSV file using a tab (\t) as the delimiter. The project name is specified after the options.

```bash
util/Indexer.php --source=csv --csv-delimiter="\t" demo
```

--------------------------------

### Force Refresh Search Log

Source: https://github.com/hightman/xunsearch/blob/master/sdk/php/doc/guide/util.indexer.txt

Forces a refresh of the search log for the specified project.

```bash
util/Indexer.php --flush-log --project demo
```

--------------------------------

### View Hot Search Terms

Source: https://github.com/hightman/xunsearch/blob/master/sdk/php/doc/guide/util.logger.txt

List popular search terms for a project. Specify 'cur' for current period, 'last' for previous, or 'total' for cumulative counts. Limit the number of results with the --limit option.

```bash
util/Logger.php demo --hot=cur
```

```bash
util/Logger.php demo --hot=cur --limit 5
```

--------------------------------

### Exact Phrase Matching

Source: https://github.com/hightman/xunsearch/blob/master/sdk/php/doc/guide/search.query.txt

Demonstrates how to perform exact phrase matching by enclosing the search query in double quotes. This ensures that the terms appear in the specified order and are not split by the system's tokenizer.

```php
$search->search('上海科技大学');
// 这时内部把搜索语句切割为：上海+科技+大学，要求搜索结果同时包含这三个词即可，
// 但不要求它们的出现顺序，有可能先出现”科技“再出现”上海“，也有可能这三个词离得很远。

$search->search('"上海科技大学"');
// 加上引号后，要求搜索结果必须依次出现”上海+科技+大学“，要显得精准很多。
```

--------------------------------

### Exact Phrase Search Configuration (No)

Source: https://github.com/hightman/xunsearch/blob/master/sdk/php/doc/guide/ini.guide.txt

Determines if a field supports exact phrase searching (using quotes). 'no' is the default for most fields, while 'title' and 'body' default to 'yes'. Enabling this increases index size and is only supported by the default tokenizer.

```ini
phrase = no
```

--------------------------------

### Discuz! Forum Post Table Structure

Source: https://github.com/hightman/xunsearch/blob/master/sdk/php/doc/guide/ini.first.txt

The SQL structure for the `cdb_posts` table in Discuz! forums, which serves as the data source for the search index.

```sql
-- 
-- 表的结构 `cdb_posts`
-- 
CREATE TABLE `cdb_posts` (
  `pid` int(10) unsigned NOT NULL auto_increment,
  `fid` smallint(6) unsigned NOT NULL default '0',
  `tid` mediumint(8) unsigned NOT NULL default '0',
  `first` tinyint(1) NOT NULL default '0',
  `author` varchar(15) NOT NULL default '',
  `authorid` mediumint(8) unsigned NOT NULL default '0',
  `subject` varchar(80) NOT NULL default '',
  `dateline` int(10) unsigned NOT NULL default '0',
  `message` mediumtext NOT NULL,
  `useip` varchar(15) NOT NULL default '',
  `invisible` tinyint(1) NOT NULL default '0',
  `anonymous` tinyint(1) NOT NULL default '0',
  `usesig` tinyint(1) NOT NULL default '0',
  `htmlon` tinyint(1) NOT NULL default '0',
  `bbcodeoff` tinyint(1) NOT NULL default '0',
  `smileyoff` tinyint(1) NOT NULL default '0',
  `parseurloff` tinyint(1) NOT NULL default '0',
  `attachment` tinyint(1) NOT NULL default '0',
  `rate` smallint(6) NOT NULL default '0',
  `ratetimes` tinyint(3) unsigned NOT NULL default '0',
  `status` tinyint(1) NOT NULL default '0',
  PRIMARY KEY  (`pid`),
  KEY `fid` (`fid`),
  KEY `authorid` (`authorid`),
  KEY `dateline` (`dateline`),
  KEY `invisible` (`invisible`),
  KEY `displayorder` (`tid`,`invisible`,`dateline`),
  KEY `first` (`tid`,`first`)
) ENGINE=MyISAM  DEFAULT CHARSET=utf8;

```

--------------------------------

### Boolean Indexing Configuration (Yes)

Source: https://github.com/hightman/xunsearch/blob/master/sdk/php/doc/guide/ini.guide.txt

Forces a field to be a boolean index. Boolean indexed fields do not participate in ranking calculations. This is typically 'yes' for custom tokenizers when you want the field to be searchable but not ranked.

```ini
non_bool = yes
```

--------------------------------

### Add Database for Multi-Database Search

Source: https://github.com/hightman/xunsearch/blob/master/sdk/php/doc/guide/search.overview.txt

Configure the search object to include additional databases for searching across multiple indexes. This is useful for managing large datasets.

```php
$search->addDb('database_name');
```

--------------------------------

### Chained Search Operations

Source: https://github.com/hightman/xunsearch/blob/master/sdk/php/doc/guide/search.overview.txt

Perform search operations using method chaining for a more fluent syntax. This approach combines multiple search configurations into a single statement.

```php
$docs = $search->setQuery('项目测试')->addWeight('subject', 'xunsearch')->setLimit(5, 10)->search();
```

--------------------------------

### Boolean Search Operators

Source: https://github.com/hightman/xunsearch/blob/master/sdk/php/doc/guide/search.query.txt

Illustrates the use of boolean operators AND, OR, and XOR to define relationships between search terms. These keywords must be in uppercase. The NOT operator or a hyphen can be used to exclude terms.

```php
$search->search('杭州 西湖');
$search->search('杭州 AND 西湖'); // 这两者效果是相同的

$search->setFuzzy()->search('杭州 西湖');
$search->search('杭州 OR 西湖');  // 这两者效果相同，都是只要求匹配其中一个

$search->search('杭州 XOR 西湖'); // 表示必须包含其中一个词，并且不允许同时包含这两个词。
```

```php
$search->search('神雕侠侣 -电视剧'); // 正确用法1
$search->search('神雕侠侣 NOT 电视剧'); // 正确用法2

$search->search('神雕侠侣-电视剧'); // 不符合预期目的
$search->search('神雕侠侣 - 电视剧'); // 不符合预期目的
```

--------------------------------

### Mixed Zone Search Weight Configuration

Source: https://github.com/hightman/xunsearch/blob/master/sdk/php/doc/guide/ini.guide.txt

Assigns a weight to a field for mixed zone search ranking. A weight of 0 means the field does not participate in ranking calculations. Default weights vary by field type ('title' is 5, 'body' is 1).

```ini
weight = 1
```

--------------------------------

### Import CSV with Custom Delimiter (Backslash)

Source: https://github.com/hightman/xunsearch/blob/master/sdk/php/doc/guide/util.indexer.txt

Imports data from a CSV file using a backslash (\\) as the delimiter. Use quotes to handle shell parsing conflicts.

```bash
util/Indexer.php --source=csv --csv-delimiter="\\\\" demo
```

--------------------------------

### Proximity and Adjacent Search

Source: https://github.com/hightman/xunsearch/blob/master/sdk/php/doc/guide/search.query.txt

Explains how to use NEAR and ADJ operators to find terms within a specified distance or in a specific order. NEAR finds terms within a default distance of 10, which can be customized with '/n'. ADJ requires terms to appear in the input order.

```php
$search->search('杭州 NEAR 西湖'); // 要求结果中出现 "杭州" 和 "西湖"，并且距离不超过 10 个词
$search->search('杭州 NEAR/5 西湖'); // 要求它们距离不超过 5个词
```

```php
$search->search('杭州 ADJ 西湖'); // 要求结果中先出现 "杭州" 再出现 "西湖"，并且距离不超过 10 个词
$search->search('杭州 ADJ/3 西湖'); // 要求它们距离不超过 3个词
```

--------------------------------

### Add or Update Search Terms

Source: https://github.com/hightman/xunsearch/blob/master/sdk/php/doc/guide/util.logger.txt

Quickly add or update a few search terms in the logs. Specify the term and optionally its count, separated by a colon. Multiple terms can be added by separating them with commas. Terms with spaces should be enclosed in quotes. Note that these operations are asynchronous and may take time to take effect.

```bash
util/Logger.php --put=word demo
```

```bash
util/Logger.php --put="word:123,word1 word2:456" demo
```

--------------------------------

### Clear All Search Logs

Source: https://github.com/hightman/xunsearch/blob/master/sdk/php/doc/guide/util.logger.txt

Empty all search log indexes for a project. This is typically used when rebuilding a search project or if log data becomes corrupted.

```bash
util/Logger.php --clean demo
```

--------------------------------

### Default Character Set Configuration

Source: https://github.com/hightman/xunsearch/blob/master/sdk/php/doc/guide/ini.guide.txt

Specifies the default character set for server interactions, including input and output data. Individual documents or search queries can override this setting.

```ini
project.default_charset = UTF-8
```

--------------------------------

### Search Result Snippet Length Configuration

Source: https://github.com/hightman/xunsearch/blob/master/sdk/php/doc/guide/ini.guide.txt

Sets the length for automatically truncating search result snippets, especially for long content fields like 'body'. The length is in bytes. A value of 0 disables truncation.

```ini
cutlen = 0
```

--------------------------------

### Query Related Search Terms

Source: https://github.com/hightman/xunsearch/blob/master/sdk/php/doc/guide/util.logger.txt

Find search terms related to a given keyword in a project. Control the number of returned results using the --limit option.

```bash
util/Logger.php demo word
```

```bash
util/Logger.php demo word --limit 5
```

--------------------------------

### Force Stop Rebuild Task

Source: https://github.com/hightman/xunsearch/blob/master/sdk/php/doc/guide/util.indexer.txt

Forces the termination of an interrupted or abnormal rebuild task for the specified project.

```bash
util/Indexer.php --stop-rebuild demo
```

--------------------------------

### Clean Index Data

Source: https://github.com/hightman/xunsearch/blob/master/sdk/php/doc/guide/util.indexer.txt

Clears all index data for the specified project. This operation can be performed independently.

```bash
util/Indexer.php --clean demo
```

--------------------------------

### Delete Search Terms

Source: https://github.com/hightman/xunsearch/blob/master/sdk/php/doc/guide/util.logger.txt

Remove specific terms from the search logs. Multiple terms can be deleted by separating them with commas. If a term contains spaces, enclose the entire term in quotes.

```bash
util/Logger.php --del=word demo
```

```bash
util/Logger.php --del "word,word1 word2" demo
```
Tokens:
Raw