15.8.3 HELP Statement

15.8.3 HELP Statement

1HELP 'search_string'

HELP statement는 MySQL Reference Manual에 있는 온라인 정보를 반환합니다. 이 statement가 올바르게 동작하려면 mysql 데이터베이스에 있는 help 테이블이 help 토픽 정보로 초기화되어 있어야 합니다(참고: Section 7.1.17, “Server-Side Help Support”).

HELP statement는 help 테이블에서 주어진 검색 문자열을 검색하고 그 결과를 표시합니다. 검색 문자열에는 대소문자가 구분되지 않습니다.

검색 문자열에는 와일드카드 문자 % 및 _를 포함할 수 있습니다. 이 문자들은 LIKE 연산자를 사용하여 수행되는 패턴 매칭 연산에서와 동일한 의미를 갖습니다. 예를 들어, HELP 'rep%'는 rep으로 시작하는 토픽 목록을 반환합니다.

HELP statement에는 ; 또는 \G와 같은 종결자가 필요하지 않습니다.

HELP statement는 여러 유형의 검색 문자열을 이해합니다:

• 가장 일반적인 수준에서는 contents를 사용하여 최상위 help 카테고리 목록을 가져옵니다:

1HELP 'contents'

• Data Types와 같은 특정 help 카테고리에 있는 토픽 목록을 보려면 카테고리 이름을 사용합니다:

1HELP 'data types'

• ASCII() 함수나 CREATE TABLE statement와 같은 특정 help 토픽에 대한 도움말을 보려면 관련된 키워드 또는 키워드들을 사용합니다:

1HELP 'ascii'
2HELP 'create table'

즉, 검색 문자열은 하나의 카테고리, 여러 토픽, 또는 단일 토픽과 일치합니다. 다음 설명은 결과 집합이 가질 수 있는 형태를 나타냅니다.

• 비어 있는 결과

  검색 문자열과 일치하는 항목을 찾을 수 없습니다.

  예: HELP 'fake'

  결과:

1Nothing found
2Please try to run 'help contents' for a list of all accessible topics

• 단일 row를 포함하는 결과 집합

  이는 검색 문자열이 help 토픽에 대해 일치를 찾았음을 의미합니다. 결과에는 다음 항목이 포함됩니다:

  • name: 토픽 이름.

  • description: 해당 토픽에 대한 설명 help 텍스트.

  • example: 하나 이상의 사용 예. (비어 있을 수 있음.)

  예: HELP 'log'

  결과:

1Name: 'LOG'
2Description:
3Syntax:
4LOG(X), LOG(B,X)
5
6If called with one parameter, this function returns the natural
7logarithm of X. If X is less than or equal to 0.0E0, the function
8returns NULL and a warning "Invalid argument for logarithm" is
9reported. Returns NULL if X or B is NULL.
10
11The inverse of this function (when called with a single argument) is
12the EXP() function.
13
14URL: https://dev.mysql.com/doc/refman/8.4/en/mathematical-functions.html
15
16Examples:
17mysql> SELECT LOG(2);
18        -> 0.69314718055995
19mysql> SELECT LOG(-2);
20        -> NULL

• 토픽 목록

  이는 검색 문자열이 여러 help 토픽과 일치함을 의미합니다.

  예: HELP 'status'

  결과:

1Many help items for your request exist.
2To make a more specific request, please type 'help <item>',
3where <item> is one of the following topics:
4     FLUSH
5     SHOW
6     SHOW BINARY LOG STATUS
7     SHOW ENGINE
8     SHOW FUNCTION STATUS
9     SHOW PROCEDURE STATUS
10     SHOW REPLICA STATUS
11     SHOW STATUS
12     SHOW TABLE STATUS

• 토픽 목록

  검색 문자열이 카테고리와 일치하는 경우에도 목록이 표시됩니다.

  예: HELP 'functions'

  결과:

1You asked for help about help category: "Functions"
2For more information, type 'help <item>', where <item> is one of the following
3categories:
4     Aggregate Functions and Modifiers
5     Bit Functions
6     Cast Functions and Operators
7     Comparison Operators
8     Date and Time Functions
9     Encryption Functions
10     Enterprise Encryption Functions
11     Flow Control Functions
12     GROUP BY Functions and Modifiers
13     GTID
14     Information Functions
15     Internal Functions
16     Locking Functions
17     Logical Operators
18     Miscellaneous Functions
19     Numeric Functions
20     Performance Schema Functions
21     Spatial Functions
22     String Functions
23     Window Functions
24     XML