---
title: "HELP - OceanBase 数据库 V4.2.0 | OceanBase 文档中心"
description: HELP 描述 返回帮助表中的搜索结果，搜索字符串可以包含通配符百分号（ % ）与下划线（ _ ）。 说明 HELP 功能需要加载 help tables 才能正常使用，步骤如下： 复制 fill_help_tables-ob.sql 文件至客户端机器 tmp 目录下。 登录 sys 租户执行语句 source /t…
image: https://mdn.alipayobjects.com/huamei_22khvb/afts/img/A*OSPzQ6GUQF4AAAAAQHAAAAgAeiGDAQ/original
---
切换语言

- 中文站 - 简体中文
- International - English
- 日本站 - 日本語

文档反馈![](https://mdn.alipayobjects.com/huamei_22khvb/afts/img/A*P8CuR4UJ_FkAAAAAAAAAAAAADiGDAQ/original) OceanBase 数据库分布式版 - V 4.2.0

# HELP

更新时间：2023-08-01 14:14:04

[编辑](https://github.com/oceanbase/oceanbase-doc/edit/V4.2.0/zh-CN/700.reference/500.sql-reference/100.sql-syntax/200.common-tenant-of-mysql-mode/600.sql-statement-of-mysql-mode/5600.help-of-mysql-mode.md)  

## 描述

返回帮助表中的搜索结果，搜索字符串可以包含通配符百分号（`%`）与下划线（`_`）。

#### 说明

`HELP` 功能需要加载 `help tables` 才能正常使用，步骤如下：

1. 复制 `fill_help_tables-ob.sql` 文件至客户端机器 `tmp` 目录下。
 2. 登录 sys 租户执行语句 `source /tmp/fill_help_tables-ob.sql` 。

搜索字符串可以匹配一个类别、多个主题或单个主题：

- 查看顶级帮助类别的列表：

  ```sql
  HELP 'contents';

  ```
 - 查看各帮助类别主题，例如搜索数据类型 `data types`：

  ```sql
  HELP 'data_types';

  ```
 - 对于特定的帮助主题，可以使用关联的一个或多个关键字：

  ```sql
  HELP 'create table'

  ```

  返回的主题包含以下信息：

     - `name`：主题名称。
     - `description`：该主题的描述性帮助文本。

## 语法

```sql
HELP 'search_string';

search_string:
   contents | data_types | theme

```

## 参数解释

| 参数 | 描述 |
| --- | --- |
| contents | 查看所有帮助信息的目录，您可以按目录名称继续查找帮助信息。 |
| data_types | 查看指定数据类型的帮助信息。 |
| theme | 查看指定主题的帮助信息。 |

## 示例

- 查看所有帮助信息的目录。

  ```sql
  obclient> HELP 'contents';
  You asked for help about help category: "Contents"
  For more information, type 'help <item>', where <item> is one of the following
  categories:
     Data Types
     Functions
     Operator
     Escape character
     Data Definition
     Data Manipulation
     Transaction Statements
     Prepared Statements
     Compound Statements
     Administration
     Utility

  ```
 - 查看 Numeric Type 包含哪些数据类型。

  ```sql
  obclient> HELP 'Numeric Types';
  You asked for help about help category: "Numeric Types"
  For more information, type 'help <item>', where <item> is one of the following
  topics:
     TINYINT
     BOOL,BOOLEAN
     SMALLINT
     MEDIUMINT
     INT
     INTEGER
     BIGINT
     FLOAT
     DOUBLE
     DOUBLE PRECISION
     FLOAT(p)
     DECIMAL
     NUMERIC

  ```
 - 查看 `KILL` 语句的使用方法。

  ```sql
  obclient> HELP 'KILL';
  Name: 'KILL'
  Description:

    语法：

    KILL [GLOBAL | LOCAL] [CONNECTION | QUERY] 'sessionid'

    每个与OceanBase的连接都在一个独立的线程里运行，您可以使用SHOW PROCESSLIST;语句查看哪些线程正在运行，并使用KILL thread_id语句 终止一个线程。

  • KILL CONNECTION与不含修改符的KILL一样：它会终止与给定的thread_id。

  • KILL QUERY会终止连接当前正在执行的语句，但是会保持连接的原状。
  如果您拥有PROCESS权限，则您可以查看所有线程。如果您拥有SUPER权限，您可以终止所有线程和语句。否则，您只能查看和终止您自己的线程 和语句。

  ```
 - 查看 `SELECT` 语句的语法。

  ```sql
  obclient> HELP SELECT
  Name: 'SELECT'
  Description:

    该语句用于查询表中的内容。

    基本查询

    语法：

    SELECT
      [ALL | DISTINCT]
        selectexpr [AS othername] [, selectexpr ...]
        [FROM table_references]
          [WHERE where_conditions]
      [GROUP BY group_by_list]
      [HAVING search_confitions]
      [ORDER BY order_list]
      [LIMIT {[offset,] rowcount | rowcount OFFSET offset}]
          [FOR UPDATE];

  ```

 上一篇 下一篇 ![有帮助](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*y6ocSqN8cqsAAAAAAAAAAAAAARQnAQ)![无帮助](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*BG9IQJyLHF8AAAAAAAAAAAAAARQnAQ)![反馈](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*eTWdQKCRKHwAAAAAAAAAAAAAARQnAQ)[AI](https://www.oceanbase.com/obi) 咨询热线