HELP语句
HELP 'search_string'
该HELP
语句从MySQL参考手册返回在线信息。它的正确操作要求mysql
使用帮助主题信息初始化数据库中的帮助表(请参见“服务器端帮助支持”)。
该HELP
语句在帮助表中搜索给定的搜索字符串,并显示搜索结果。搜索字符串不区分大小写。
搜索字符串可以包含通配符%
和_
。这些具有与操作员执行的模式匹配操作相同的含义LIKE
。例如,HELP 'rep%'
返回以开头的主题列表rep
。
HELP语句了解几种类型的搜索字符串:
在最一般的级别,用于
contents
检索顶级帮助类别的列表:HELP 'contents'有关给定帮助类别(例如)的主题列表
Data Types
,请使用类别名称:HELP 'data types'要获得有关特定帮助主题(例如
ASCII()
函数或CREATE TABLE
语句)的帮助,请使用关联的一个或多个关键字:HELP 'ascii'HELP 'create table'
换句话说,搜索字符串匹配类别,许多主题或单个主题。您不必事先告知给定的搜索字符串是否将返回项目列表或单个帮助主题的帮助信息。但是,您可以HELP
通过检查结果集中的行数和列数来判断返回的响应类型。
以下描述指示结果集可以采用的形式。示例语句的输出使用熟悉的“表格”或“垂直”格式显示,在使用mysql客户端时会看到这种格式,但请注意,mysql本身HELP
以不同的方式重新格式化结果集。
空结果集
找不到匹配的搜索字符串。
结果集包含一行包含三列
这意味着搜索字符串对帮助主题产生了影响。结果包含三列:
name
:主题名称。description
:主题的描述性帮助文本。example
:一个或多个用法示例。该列可能为空白。
例:
HELP 'replace'
产量:
name: REPLACE description: Syntax: REPLACE(str,from_str,to_str) Returns the string str with all occurrences of the string from_str replaced by the string to_str. REPLACE() performs a case-sensitive match when searching for from_str. example: mysql> SELECT REPLACE('www.mysql.com', 'w', 'Ww'); -> 'WwWwWw.mysql.com'
结果集包含两行多行
这意味着搜索字符串匹配许多帮助主题。结果集指示帮助主题名称:
name
:帮助主题名称。is_it_category
:Y
如果名称代表帮助类别,N
则名称不代表。如果不是,则将该name
值指定为HELP
语句的参数时,应产生包含指定项目描述的单行结果集。
例:
HELP 'status'
产量:
+-----------------------+----------------+ | name | is_it_category | +-----------------------+----------------+ | SHOW | N | | SHOW ENGINE | N | | SHOW MASTER STATUS | N | | SHOW PROCEDURE STATUS | N | | SHOW SLAVE STATUS | N | | SHOW STATUS | N | | SHOW TABLE STATUS | N | +-----------------------+----------------+
结果集包含三列的多行
这意味着搜索字符串与类别匹配。结果集包含类别条目:
source_category_name
:帮助类别名称。name
:类别或主题名称is_it_category
:Y
如果名称代表帮助类别,N
则名称不代表。如果不是,则将该name
值指定为HELP
语句的参数时,应产生包含指定项目描述的单行结果集。
例:
HELP 'functions'
产量:
+----------------------+-------------------------+----------------+ | source_category_name | name | is_it_category | +----------------------+-------------------------+----------------+ | Functions | CREATE FUNCTION | N | | Functions | DROP FUNCTION | N | | Functions | Bit Functions | Y | | Functions | Comparison operators | Y | | Functions | Control flow functions | Y | | Functions | Date and Time Functions | Y | | Functions | Encryption Functions | Y | | Functions | Information Functions | Y | | Functions | Logical operators | Y | | Functions | Miscellaneous Functions | Y | | Functions | Numeric Functions | Y | | Functions | String Functions | Y | +----------------------+-------------------------+----------------+