HELP

描述

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

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

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

  HELP 'contents';
  

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

  HELP 'data_types';
  

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

  HELP 'create table'
  

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

  • name：主题名称。

  • description：该主题的描述性帮助文本。

语法

HELP 'search_string';

search_string:
   contents | data_types | theme

参数解释

示例

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

  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 包含哪些数据类型。

  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 语句的使用方法。

  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 语句的语法。

  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];