mysql sends each SQL statement that you issue
to the server to be executed. There is also a set of commands
that mysql itself interprets. For a list of
these commands, type
\h at the
mysql> help 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. notee (\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. query_attributes(\) Sets string parameters (name1 value1 name2 value2 ...) for the next query to pick up. For server side help, type 'help contents'
Each command has both a long and short form. The long form is not case-sensitive; the short form is. The long form can be followed by an optional semicolon terminator, but the short form should not.
The use of short-form commands within multiple-line
... */ comments is not supported. Short-form commands
do work within single-line
/*! ... */ version
comments, as do
/*+ ... */ optimizer-hint
comments, which are stored in object definitions. If there is a
concern that optimizer-hint comments may be stored in object
definitions so that dump files when reloaded with
mysql would result in execution of such
commands, either invoke mysql with the
--binary-mode option or use a
reload client other than mysql.
Display a help message listing the available mysql commands.
If you provide an argument to the
helpcommand, mysql uses it as a search string to access server-side help from the contents of the MySQL Reference Manual. For more information, see Section 220.127.116.11, “mysql Client Server-Side Help”.
Change the default character set and issue a
SET NAMESstatement. This enables the character set to remain synchronized on the client and server if mysql is run with auto-reconnect enabled (which is not recommended), because the specified character set is used for reconnects.
Clear the current input. Use this if you change your mind about executing the statement that you are entering.
Reconnect to the server. The optional database name and host name arguments may be given to specify the default database or the host where the server is running. If omitted, the current values are used.
Change the string that mysql interprets as the separator between SQL statements. The default is the semicolon character (
The delimiter string can be specified as an unquoted or quoted argument on the
delimitercommand line. Quoting can be done with either single quote (
'), double quote (
"), or backtick (
`) characters. To include a quote within a quoted string, either quote the string with a different quote character or escape the quote with a backslash (
\) character. Backslash should be avoided outside of quoted strings because it is the escape character for MySQL. For an unquoted argument, the delimiter is read up to the first space or end of line. For a quoted argument, the delimiter is read up to the matching quote on the line.
mysql interprets instances of the delimiter string as a statement delimiter anywhere it occurs, except within quoted strings. Be careful about defining a delimiter that might occur within other words. For example, if you define the delimiter as
X, it is not possible to use the word
INDEXin statements. mysql interprets this as
INDEfollowed by the delimiter
When the delimiter recognized by mysql is set to something other than the default of
;, instances of that character are sent to the server without interpretation. However, the server itself still interprets
;as a statement delimiter and processes statements accordingly. This behavior on the server side comes into play for multiple-statement execution (see Multiple Statement Execution Support), and for parsing the body of stored procedures and functions, triggers, and events (see Section 25.1, “Defining Stored Programs”).
Edit the current input statement. mysql checks the values of the
VISUALenvironment variables to determine which editor to use. The default editor is vi if neither variable is set.
editcommand works only in Unix.
Send the current statement to the server to be executed and display the result using vertical format.
Send the current statement to the server to be executed.
Disable output paging. See the description for
nopagercommand works only in Unix.
Disable output copying to the tee file. See the description for
Disable display of warnings after each statement.
Enable output paging. By using the
--pageroption when you invoke mysql, it is possible to browse or search query results in interactive mode with Unix programs such as less, more, or any other similar program. If you specify no value for the option, mysql checks the value of the
PAGERenvironment variable and sets the pager to that. Pager functionality works only in interactive mode.
Output paging can be enabled interactively with the
pagercommand and disabled with
nopager. The command takes an optional argument; if given, the paging program is set to that. With no argument, the pager is set to the pager that was set on the command line, or
stdoutif no pager was specified.
Output paging works only in Unix because it uses the
popen()function, which does not exist on Windows. For Windows, the
teeoption can be used instead to save query output, although it is not as convenient as
pagerfor browsing output in some situations.
Print the current input statement without executing it.
Reconfigure the mysql prompt to the given string. The special character sequences that can be used in the prompt are described later in this section.
If you specify the
promptcommand with no argument, mysql resets the prompt to the default of
Define query attributes that apply to the next query sent to the server. For discussion of the purpose and use of query attributes, see Section 9.6, “Query Attributes”.
query_attributescommand follows these rules:
The format and quoting rules for attribute names and values are the same as for the
The command permits up to 32 attribute name/value pairs. Names and values may be up to 1024 characters long. If a name is given without a value, an error occurs.
query_attributescommands are issued prior to query execution, only the last command applies. After sending the query, mysql clears the attribute set.
If multiple attributes are defined with the same name, attempts to retrieve the attribute value have an undefined result.
An attribute defined with an empty name cannot be retrieved by name.
Rebuild the completion hash that enables database, table, and column name completion while you are entering statements. (See the description for the
Reset the connection to clear the session state. This includes clearing any current query attributes defined using the
Resetting a connection has effects similar to
mysql_change_user()or an auto-reconnect except that the connection is not closed and reopened, and re-authentication is not done. See mysql_change_user(), and Automatic Reconnection Control.
This example shows how
resetconnectionclears a value maintained in the session state:
mysql> SELECT LAST_INSERT_ID(3); +-------------------+ | LAST_INSERT_ID(3) | +-------------------+ | 3 | +-------------------+ mysql> SELECT LAST_INSERT_ID(); +------------------+ | LAST_INSERT_ID() | +------------------+ | 3 | +------------------+ mysql> resetconnection; mysql> SELECT LAST_INSERT_ID(); +------------------+ | LAST_INSERT_ID() | +------------------+ | 0 | +------------------+
Read the named file and executes the statements contained therein. On Windows, specify path name separators as
Quote characters are taken as part of the file name itself. For best results, the name should not include space characters.
Provide status information about the connection and the server you are using. If you are running with
statusalso prints the values for the mysql variables that affect your queries.
Execute the given command using your default command interpreter.
Prior to MySQL 8.0.19, the
systemcommand works only in Unix. As of 8.0.19, it also works on Windows.
By using the
--teeoption when you invoke mysql, you can log statements and their output. All the data displayed on the screen is appended into a given file. This can be very useful for debugging purposes also. mysql flushes results to the file after each statement, just before it prints its next prompt. Tee functionality works only in interactive mode.
You can enable this feature interactively with the
teecommand. Without a parameter, the previous file is used. The
teefile can be disabled with the
teeagain re-enables logging.
db_nameas the default database.
Enable display of warnings after each statement (if there are any).
Here are a few tips about the
You can use it to write to a file and the results go only to the file:
mysql> pager cat > /tmp/log.txt
You can also pass any options for the program that you want to use as your pager:
mysql> pager less -n -i -S
In the preceding example, note the
-Soption. You may find it very useful for browsing wide query results. Sometimes a very wide result set is difficult to read on the screen. The
-Soption to less can make the result set much more readable because you can scroll it horizontally using the left-arrow and right-arrow keys. You can also use
-Sinteractively within less to switch the horizontal-browse mode on and off. For more information, read the less manual page:
-Xoptions may be used with less to cause it to exit if output fits on one screen, which is convenient when no scrolling is necessary:
mysql> pager less -n -i -S -F -X
You can specify very complex pager commands for handling query output:
mysql> pager cat | tee /dr1/tmp/res.txt \ | tee /dr2/tmp/res2.txt | less -n -i -S
In this example, the command would send query results to two files in two different directories on two different file systems mounted on
/dr2, yet still display the results onscreen using less.
You can also combine the
pager functions. Have a
tee file enabled and
set to less, and you are able to browse the
results using the less program and still have
everything appended into a file the same time. The difference
between the Unix
tee used with the
pager command and the
is that the built-in
tee works even if you do
not have the Unix tee available. The built-in
tee also logs everything that is printed on
the screen, whereas the Unix tee used with
pager does not log quite that much.
tee file logging can be turned
on and off interactively from within mysql.
This is useful when you want to log some queries to a file, but
prompt command reconfigures the default
mysql> prompt. The string for defining the
prompt can contain the following special sequences.
||The current connection identifier|
||A counter that increments for each statement you issue|
||The full current date|
||The default database|
||The server host|
||The current delimiter|
||Minutes of the current time|
||A newline character|
||The current month in three-letter format (Jan, Feb, …)|
||The current month in numeric format|
||The current TCP/IP port or socket file|
||The current time, in 24-hour military time (0–23)|
||The current time, standard 12-hour time (1–12)|
||Seconds of the current time|
||A tab character|
||Your user name|
||The server version|
||The current day of the week in three-letter format (Mon, Tue, …)|
||The current year, four digits|
||The current year, two digits|
||A space (a space follows the backslash)|
You can set the prompt in several ways:
Use an environment variable. You can set the
MYSQL_PS1environment variable to a prompt string. For example:
export MYSQL_PS1="(\u@\h) [\d]> "
$> mysql --prompt="(\u@\h) [\d]> " (user@host) [database]>
Use an option file. You can set the
promptoption in the
[mysql]group of any MySQL option file, such as
.my.cnffile in your home directory. For example:
[mysql] prompt=(\\u@\\h) [\\d]>\\_
In this example, note that the backslashes are doubled. If you set the prompt using the
promptoption in an option file, it is advisable to double the backslashes when using the special prompt options. There is some overlap in the set of permissible prompt options and the set of special escape sequences that are recognized in option files. (The rules for escape sequences in option files are listed in Section 18.104.22.168, “Using Option Files”.) The overlap may cause you problems if you use single backslashes. For example,
\sis interpreted as a space rather than as the current seconds value. The following example shows how to define a prompt within an option file to include the current time in
[mysql] prompt="\\r:\\m:\\s> "
Set the prompt interactively. You can change your prompt interactively by using the
\R) command. For example:
mysql> prompt (\u@\h) [\d]>\_ PROMPT set to '(\u@\h) [\d]>\_' (user@host) [database]> (user@host) [database]> prompt Returning to default PROMPT of mysql> mysql>