[Xunsearch PHP-SDK](http://www.xunsearch.com) v1.4.8 API 参考文档
# XSDatabase
[All Packages](#)| [方法(函数)](#)
| 包 | [XS.util.db](#) |
|-----|-----|
| 继承关系 | abstract class XSDatabase |
| 子类 | [XSDatabaseMySQL](#), [XSDatabaseMySQLI](#), [XSDatabasePDO](#), [XSDatabasePgSQL](#), [XSDatabaseSQLite](#), [XSDatabaseSQLite3](#) |
| 版本 | 1.0.0 |
| 源代码 | [sdk/php/util/XSDataSource.class.php](https://github.com/hightman/xunsearch/blob/master/sdk/php/util/XSDataSource.class.php) |
数据库操作基类定义了 SQL 数据库源的四个基本操作: connect/query/close/setUtf8
### Public 方法
[隐去继承来的方法](#)
| 名称 | 描述 | 定义于 |
|-----|-----|-----|
| [close()](#) | 关闭数据库连接 | XSDatabase |
| [connect()](#) | 连接数据库 | XSDatabase |
| [query()](#) | 查询 SQL 语句 | XSDatabase |
| [query1()](#) | 查询数据库首行 | XSDatabase |
| [setUtf8()](#) | 设置数据库字符集为 UTF-8 | XSDatabase |
### 方法明细
close()方法
<table class="summaryTable"><tr><td colspan="3"><div class="signature2">abstract public void <b>close</b>()</div></td></tr></table>
**源码:**[sdk/php/util/XSDataSource.class.php#L433](https://github.com/hightman/xunsearch/blob/master/sdk/php/util/XSDataSource.class.php#L433) (**[显示](#)**)
`abstract public function close();`
关闭数据库连接
connect()方法
<table class="summaryTable"><tr><td colspan="3"><div class="signature2">abstract public void <b>connect</b>(array $param)</div></td></tr><tr><td class="paramNameCol">$param</td> <td class="paramTypeCol">array</td> <td class="paramDescCol">连接参数, 采用 parse_url 解析, 可能包含: scheme,user,pass,host,path,table,dbname ...</td></tr></table>
**源码:**[sdk/php/util/XSDataSource.class.php#L428](https://github.com/hightman/xunsearch/blob/master/sdk/php/util/XSDataSource.class.php#L428) (**[显示](#)**)
`abstract public function connect($param);`
连接数据库
query()方法
<table class="summaryTable"><tr><td colspan="3"><div class="signature2">abstract public mixed <b>query</b>($sql)</div></td></tr><tr><td class="paramNameCol">$sql</td> <td class="paramTypeCol"></td> <td class="paramDescCol"></td></tr><tr><td class="paramNameCol">{return}</td> <td class="paramTypeCol">mixed</td> <td class="paramDescCol">非 SELECT 语句返回执行结果(true/false), SELECT 语句返回所有结果行的数组</td></tr></table>
**源码:**[sdk/php/util/XSDataSource.class.php#L439](https://github.com/hightman/xunsearch/blob/master/sdk/php/util/XSDataSource.class.php#L439) (**[显示](#)**)
`abstract public function query($sql);`
查询 SQL 语句
query1()方法
<table class="summaryTable"><tr><td colspan="3"><div class="signature2">public 查询结果首行, <b>query1</b>(string $sql)</div></td></tr><tr><td class="paramNameCol">$sql</td> <td class="paramTypeCol">string</td> <td class="paramDescCol"></td></tr><tr><td class="paramNameCol">{return}</td> <td class="paramTypeCol">查询结果首行,</td> <td class="paramDescCol">失败或无数据则返回 false</td></tr></table>
**源码:**[sdk/php/util/XSDataSource.class.php#L455](https://github.com/hightman/xunsearch/blob/master/sdk/php/util/XSDataSource.class.php#L455) (**[显示](#)**)
`public function query1($sql)
{
$sql = preg_replace('/ limit\s+(\d+)(?:\s*,\s*(\d+)|\s+offset\s+(\d+))?\s*$/i', '', $sql);
$sql .= ' LIMIT 1';
$res = $this->query($sql);
return (is_array($res) && isset($res[0])) ? $res[0] : false;
}`
查询数据库首行
setUtf8()方法
<table class="summaryTable"><tr><td colspan="3"><div class="signature2">public bool <b>setUtf8</b>()</div></td></tr><tr><td class="paramNameCol">{return}</td> <td class="paramTypeCol">bool</td> <td class="paramDescCol">如果数据库能直接输出 UTF-8 编码则返回 true 否则返回 false</td></tr></table>
**源码:**[sdk/php/util/XSDataSource.class.php#L445](https://github.com/hightman/xunsearch/blob/master/sdk/php/util/XSDataSource.class.php#L445) (**[显示](#)**)
`public function setUtf8()
{
return false;
}`
设置数据库字符集为 UTF-8
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 授权许可证