HELP

Core command

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

Arguments

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

Examples

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

Notes

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

Bare HELP is deliberately compact - a one-line-per-category menu (see CommandCategory), not the full command reference. HELP ALL prints the full reference grouped by category; HELP <category> (matched by display name, enum name, or a short alias - see findByName) lists just that category's commands; HELP FIND <text> searches command names/synonyms/descriptions and category names/ descriptions; HELP <command> shows one command's detailed help; HELP PATTERNS documents the macro syntaxes (<@file>, <@csv:...>, <@excel:...>, <@last:...>, <@clipboard>, @file, /, / <environment>) that aren't Command subclasses and so don't appear in the category listings above. An unrecognized topic gets a simple "Did you mean" suggestion (Levenshtein distance against category names/aliases and command keywords) rather than a bare error.

If the given name doesn't match any BroadSQL command/category/topic and the current connection is H2, BroadSQL falls back to H2's own native HELP grammar for that term - preserved unchanged from before this rewrite (see LastCaptureSuppressor, used so this internal lookup never clobbers <@last:column>'s source data).

Last modified in release 5.1.6.