HELP

説明

ヘルプテーブルの検索結果を返します。検索文字列にはワイルドカードであるパーセント記号（%）とアンダースコア（_）を含めることができます。

検索文字列は、1つのカテゴリ、複数のトピック、または単一のトピックと一致することができます：

• トップレベルのヘルプカテゴリのリストを表示します：

  HELP 'contents';
  

• データ型data typesなど、各ヘルプカテゴリのトピックを表示します。

  HELP 'data_types';
  

• 特定のヘルプトピックについては、関連する1つ以上のキーワードを使用できます。

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