pingcap/tidb

support "help" statement

Open

#16,575 opened on Apr 18, 2020

View on GitHub
 (4 comments) (2 reactions) (0 assignees)Go (6,186 forks)batch import
feature/acceptedhelp wantedtype/feature-request

Repository metrics

Stars
 (40,090 stars)
PR merge metrics
 (Avg merge 14d 4h) (346 merged PRs in 30d)

Description

Feature Request

Is your feature request related to a problem? Please describe:

In some scenarios, people can not access user documents through web browsers to get help.

Describe the feature you'd like:

Support the help statement as MySQL does. See the document for details: 13.8.3 HELP Statement

HELP 'search_string' The HELP statement returns online information from the MySQL Reference Manual. Its proper operation requires that the help tables in the mysql database be initialized with help topic information (see Section 5.1.14, “Server-Side Help Support”).

The HELP statement searches the help tables for the given search string and displays the result of the search. The search string is not case-sensitive.

The search string can contain the wildcard characters % and _. These have the same meaning as for pattern-matching operations performed with the LIKE operator. For example, HELP 'rep%' returns a list of topics that begin with rep.

Describe alternatives you've considered:

Searching from a string maybe is not easy to use. We can combine help command with some sub commands. Such as help error [search_string], help function [search_string], help statements [search_string].

Teachability, Documentation, Adoption, Migration Strategy:

N/A

Contributor guide