| --- |
| { |
| "title": "HELP", |
| "language": "en" |
| } |
| --- |
| |
| <!-- |
| Licensed to the Apache Software Foundation (ASF) under one |
| or more contributor license agreements. See the NOTICE file |
| distributed with this work for additional information |
| regarding copyright ownership. The ASF licenses this file |
| to you under the Apache License, Version 2.0 (the |
| "License"); you may not use this file except in compliance |
| with the License. You may obtain a copy of the License at |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| Unless required by applicable law or agreed to in writing, |
| software distributed under the License is distributed on an |
| "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| KIND, either express or implied. See the License for the |
| specific language governing permissions and limitations |
| under the License. |
| --> |
| |
| ## HELP |
| |
| ### Name |
| |
| HELP |
| |
| ### Description |
| |
| The directory of help can be queried by changing the command |
| |
| grammar: |
| |
| ``` sql |
| HELP <item> |
| ``` |
| |
| All Doris commands can be listed with `help` |
| |
| ```sql |
| List of all MySQL commands: |
| Note that all text commands must be first on line and end with ';' |
| ? (\?) Synonym for `help'. |
| clear (\c) Clear the current input statement. |
| connect (\r) Reconnect to the server. Optional arguments are db and host. |
| delimiter (\d) Set statement delimiter. |
| edit (\e) Edit command with $EDITOR. |
| ego (\G) Send command to mysql server, display result vertically. |
| exit (\q) Exit mysql. Same as quit. |
| go (\g) Send command to mysql server. |
| help (\h) Display this help. |
| nopager (\n) Disable pager, print to stdout. |
| note (\t) Don't write into outfile. |
| pager (\P) Set PAGER [to_pager]. Print the query results via PAGER. |
| print (\p) Print current command. |
| prompt (\R) Change your mysql prompt. |
| quit (\q) Quit mysql. |
| rehash (\#) Rebuild completion hash. |
| source (\.) Execute an SQL script file. Takes a file name as an argument. |
| status (\s) Get status information from the server. |
| system (\!) Execute a system shell command. |
| tee (\T) Set outfile [to_outfile]. Append everything into given outfile. |
| use (\u) Use another database. Takes database name as argument. |
| charset (\C) Switch to another charset. Might be needed for processing binlog with multi-byte charsets. |
| warnings (\W) Show warnings after every statement. |
| nowarning (\w) Don't show warnings after every statement. |
| resetconnection(\x) Clean session context. |
| |
| For server side help, type 'help contents' |
| ``` |
| |
| Get the Doris SQL help contents via `help contents` |
| |
| ```sql |
| Many help items for your request exist. |
| To make a more specific request, please type 'help <item>', |
| where <item> is one of the following |
| categories: |
| sql-functions |
| sql-statements |
| ``` |
| |
| ### Example |
| |
| 1. List all SQL help contents of Doris |
| |
| ```sql |
| help contents |
| ``` |
| |
| 2. The command to list all function directories of the Doris cluster |
| |
| ```sql |
| help sql-functions |
| ``` |
| |
| 3. List all functions under the date function |
| |
| ```sql |
| help date-time-functions |
| ``` |
| |
| |
| ### Keywords |
| |
| HELP |
| |
| ### Best Practice |
| |