HELP

Displays a list of supported command categories, or help for a specified command/category

Arguments

command, category, ALL, PATTERNS, SHORTCUTS, or FIND <text> (all optional)

Examples

HELP;
HELP EXPORT;
HELP DESCR;
HELP FIND excel;
HELP ALL;
HELP PATTERNS;
HELP SHORTCUTS;

Notes

BroadSQL's help: HELP, HELP <category>, HELP <command>, HELP FIND <text>, HELP ALL, HELP PATTERNS and HELP SHORTCUTS.

HELP alone prints two tables: the command categories (name, alias, description), followed by the Patterns and Shortcuts topics, and the forms of HELP itself. HELP ALL prints the full command reference grouped by category. HELP <category> (by name or alias, for example HELP EXPORT) lists the commands of one category. HELP FIND <text> searches command names, synonyms and descriptions and category names and descriptions. HELP <command> shows the detailed help of one command. HELP PATTERNS documents the syntaxes usable inside SQL (<@file>, <@csv:...>, <@excel:...>, <@last:...>, <@clipboard>) and the line shortcuts @file, / and / <environment>. HELP SHORTCUTS lists the keyboard shortcuts of the interactive console; it needs no connection. An unknown topic gets a "Did you mean" suggestion when a category or command name is close.

When the name matches no BroadSQL command, category or topic and the current connection is H2, the help of H2's own SQL grammar for that term is shown. It does not change the result that <@last:column> refers to.

Last modified in release 5.3.1.