On this page

HELP

Core command

Lists the command categories, or shows the help of a category, a command or a topic.

Syntax

HELP [<command> | <category> | ALL | PATTERNS | SHORTCUTS]
HELP FIND <text>

Quick start

HELP;

Lists the command categories and the help topics.

HELP DUMP;

Shows the help of the DUMP command.

Arguments

Argument	Required	Values	Default
`<command>`	No	A command name or alias	The list of categories
`<category>`	No	A category name or alias, such as `EXPORT`	The list of categories
`ALL`, `PATTERNS` or `SHORTCUTS`	No	Every command, the SQL patterns, or the keyboard shortcuts	The list of categories
`FIND <text>`	No	Text searched in the commands and categories	None

Examples

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

Details

The forms of HELP

HELP alone prints two tables: the command categories (name, alias, description) followed by the Patterns and Shortcuts topics, then the forms of HELP itself.
HELP <category>, by name or alias (for example HELP EXPORT), lists the commands of one category.
HELP <command> shows the help of one command: its purpose, syntax, arguments, examples and related commands, the same content as its page in this reference.
HELP FIND <text> searches the command names, aliases and descriptions, and the category names and descriptions.
HELP ALL prints the whole command list, grouped by category.
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.

Unknown names

A name close to a category or command gets a "Did you mean" suggestion. 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 word is shown; it does not change the result that <@last:column> refers to.

Command reference
Patterns
Console, the keyboard shortcuts

Last modified in release 5.5.0.

Found something wrong or unclear on this page? Tell us, with the page address.