@@ -27,7 +27,7 @@ mysql \- the MySQL command\-line tool
\fBmysql\fR
is a simple SQL shell (with GNU
readline
capabilities)\&. It supports interactive and noninteractive use\&. When used interactively, query results are presented in an ASCII\-table format\&. When used noninteractively (for example, as a filter), the result is presented in tab\-separated format\&. The output format can be changed using command options\&.
capabilities)\&. It supports interactive and non\-interactive use\&. When used interactively, query results are presented in an ASCII\-table format\&. When used non\-interactively (for example, as a filter), the result is presented in tab\-separated format\&. The output format can be changed using command options\&.
.PP
If you have problems due to insufficient memory for large result sets, use the
\fB\-\-quick\fR
...
...
@@ -70,13 +70,11 @@ Then type an SQL statement, end it with
\eG
and press Enter\&.
.PP
As of MySQL 5\&.1\&.10, typing Control\-C causes
Typing Control\-C causes
\fBmysql\fR
to attempt to kill the current statement\&. If this cannot be done, or Control\-C is typed again before the statement is killed,
\fBmysql\fR
exits\&. Previously, Control\-C caused
\fBmysql\fR
to exit in all cases\&.
exits\&.
.PP
You can execute SQL statements in a script file (batch file) like this:
supports the following options, which can be specified on the command line or in the
[mysql]
and
[client]
[mysql], [client], [client-server] or [client-mariadb]
option file groups\&.
\fBmysql\fR
also supports the options for processing option files described at
Section\ \&4.2.3.3.1, \(lqCommand-Line Options that Affect Option-File Handling\(rq\&.
also supports the options for processing option files\&.
.sp
.RS 4
.ie n \{\
...
...
@@ -130,12 +125,27 @@ Display a help message and exit\&.
.sp -1
.IP \(bu 2.3
.\}
.\" mysql: abort-source-on-error option
.\" abort-source-on-error: mysql
\fB\-\-abort\-source\-on\-error\fR
.sp
Abort 'source filename' operations in case of errors\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mysql: auto-rehash option
.\" auto-rehash option: mysql
\fB\-\-auto\-rehash\fR
.sp
Enable automatic rehashing\&. This option is on by default, which enables database, table, and column name completion\&. Use
\fB\-\-disable\-auto\-rehash\fR
\fB\-\-disable\-auto\-rehash\fR, \fB\-\-no\-auto\-rehash\fR, or \fB\-\-skip\-auto\-rehash\fR
to disable rehashing\&. That causes
\fBmysql\fR
to start faster, but you must issue the
...
...
@@ -155,6 +165,21 @@ completes it\&. Otherwise, you can press Tab again to see the possible names tha
.sp -1
.IP \(bu 2.3
.\}
.\" mysql: auto-vertical-output option
.\" auto-vertical-output option: mysql
\fB\-\-auto\-vertical\-output\fR
.sp
Automatically switch to vertical output mode if the result is wider than the terminal width\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mysql: batch option
.\" batch option: mysql
\fB\-\-batch\fR,
...
...
@@ -177,12 +202,26 @@ option\&.
.sp -1
.IP \(bu 2.3
.\}
.\" mysql: binary-mode option
.\" binary-mode option: mysql
\fB\-\-binary\-mode\fR
.sp
By default, ASCII '\e0' is disallowed and '\er\en' is translated to '\en'\&. This switch turns off both features, and also turns off parsing of all client commands except \eC and DELIMITER, in non-interactive mode (for input piped to mysql or loaded using the 'source' command)\&. This is necessary when processing output from mysqlbinlog that may contain blobs\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mysql: character-sets-dir option
.\" character-sets-dir option: mysql
\fB\-\-character\-sets\-dir=\fR\fB\fIpath\fR\fR
.sp
The directory where character sets are installed\&. See
Section\ \&9.5, \(lqCharacter Set Configuration\(rq\&.
The directory where character sets are installed\&.
.RE
.sp
.RS 4
...
...
@@ -213,10 +252,7 @@ Write column names in results\&.
\fB\-\-column\-type\-info\fR,
\fB\-m\fR
.sp
Display result set metadata\&. This option was added in MySQL 5\&.1\&.14\&. (Before that, use
\fB\-\-debug\-info\fR\&.) The
\fB\-m\fR
short option was added in MySQL 5\&.1\&.21\&.
Display result set metadata\&.
.RE
.sp
.RS 4
...
...
@@ -232,7 +268,7 @@ short option was added in MySQL 5\&.1\&.21\&.
\fB\-\-comments\fR,
\fB\-c\fR
.sp
Whether to preserve comments in statements sent to the server\&. The default is \-\-skip\-comments (discard comments), enable with \-\-comments (preserve comments)\&. This option was added in MySQL 5\&.1\&.23\&.
Whether to preserve comments in statements sent to the server\&. The default is \-\-skip\-comments (discard comments), enable with \-\-comments (preserve comments)\&.
.RE
.sp
.RS 4
...
...
@@ -279,7 +315,7 @@ Set the number of seconds before connection timeout\&. (Default value is 0\&.)
\fB\-\-database=\fR\fB\fIdb_name\fR\fR,
\fB\-D \fR\fB\fIdb_name\fR\fR
.sp
The database to use\&. This is useful primarily in an option file\&.
The database to use\&.
.RE
.sp
.RS 4
...
...
@@ -314,7 +350,7 @@ string is
.\" debug-check option: mysql
\fB\-\-debug\-check\fR
.sp
Print some debugging information when the program exits\&. This option was added in MySQL 5\&.1\&.21\&.
Print some debugging information when the program exits\&.
.RE
.sp
.RS 4
...
...
@@ -330,9 +366,22 @@ Print some debugging information when the program exits\&. This option was added
\fB\-\-debug\-info\fR,
\fB\-T\fR
.sp
Before MySQL 5\&.1\&.14, this option prints debugging information and memory and CPU usage statistics when the program exits, and also causes display of result set metadata during execution\&. As of MySQL 5\&.1\&.14, use
\fB\-\-column\-type\-info\fR
to display result set metadata\&.
Prints debugging information and memory and CPU usage statistics when the program exits\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mysql: default-auth option
.\" default-auth option: mysql
\fB\-\-default\-auth=\fR\fB\fIname\fR
.sp
Default authentication client-side plugin to use\&.
.RE
.sp
.RS 4
...
...
@@ -355,12 +404,25 @@ A common issue that can occur when the operating system uses
utf8
or another multi\-byte character set is that output from the
\fBmysql\fR
client is formatted incorrectly, due to the fact that the MySQL client uses the
client is formatted incorrectly, due to the fact that the MariaDB client uses the
latin1
character set by default\&. You can usually fix such issues by using this option to force the client to use the system character set instead\&.
.RE
.sp
See
Section\ \&9.5, \(lqCharacter Set Configuration\(rq, for more information\&.
Set \fB\fIfilename\fR\fR as the file to read default options from after the global defaults files has been read\&.
Must be given as first option\&.
In addition to the groups named on the command line, read groups that have the given suffix\&.
.RE
.sp
.RS 4
...
...
@@ -444,9 +505,8 @@ the section called \(lqMYSQL COMMANDS\(rq\&.
\fB\-\-execute=\fR\fB\fIstatement\fR\fR,
\fB\-e \fR\fB\fIstatement\fR\fR
.sp
Execute the statement and quit\&. The default output format is like that produced with
\fB\-\-batch\fR\&. See
Section\ \&4.2.3.1, \(lqUsing Options on the Command Line\(rq, for some examples\&.
Execute the statement and quit\&. Disables \fB\-\-force\fR and history file\&. The default output format is like that produced with
\fB\-\-batch\fR\&.
.RE
.sp
.RS 4
...
...
@@ -462,7 +522,7 @@ Section\ \&4.2.3.1, \(lqUsing Options on the Command Line\(rq, for some examples
\fB\-\-force\fR,
\fB\-f\fR
.sp
Continue even if an SQL error occurs\&.
Continue even if an SQL error occurs\&. Sets \fB\-\-abort\-source\-on-error\fR to 0\&.
.RE
.sp
.RS 4
...
...
@@ -478,7 +538,7 @@ Continue even if an SQL error occurs\&.
\fB\-\-host=\fR\fB\fIhost_name\fR\fR,
\fB\-h \fR\fB\fIhost_name\fR\fR
.sp
Connect to the MySQL server on the given host\&.
Connect to the MariaDB server on the given host\&.
.RE
.sp
.RS 4
...
...
@@ -510,10 +570,22 @@ Produce HTML output\&.
\fB\-\-ignore\-spaces\fR,
\fB\-i\fR
.sp
Ignore spaces after function names\&. The effect of this is described in the discussion for the
IGNORE_SPACE
SQL mode (see
Section\ \&5.1.8, \(lqServer SQL Modes\(rq)\&.
Ignore spaces after function names\&. Allows one to have spaces (including tab characters and new line characters) between function name and '('\&. The drawback is that this causes built in functions to become reserved words\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mysql: init-command option
.\" init-command option: mysql
\fB\-\-init\-command=\fR\fB\fIstr\fR\fR\fR
.sp
SQL Command to execute when connecting to the MariaDB server\&. Will automatically be re-executed when reconnecting\&.
.RE
.sp
.RS 4
...
...
@@ -570,7 +642,7 @@ has no effect if the server does not also support it\&.
.\" max-allowed-packet option: mysql
\fB\-\-max\-allowed\-packet=\fR\fB\fInum\fR\fR
.sp
Set the maximum packet length to send to or receive from the server\&. (Default value is 16MB\&.)
Set the maximum packet length to send to or receive from the server\&. (Default value is 16MB, largest 1GB\&.)
.RE
.sp
.RS 4
...
...
@@ -611,7 +683,7 @@ and
both are recognized\&. Use
\fB\-\-skip\-named\-commands\fR
to disable named commands\&. See
the section called \(lqMYSQL COMMANDS\(rq\&.
the section called \(lqMYSQL COMMANDS\(rq\&. Disabled by default\&.
.RE
.sp
.RS 4
...
...
@@ -688,72 +760,12 @@ Do not read default options from any option file\&. This must be given as the fi
.sp -1
.IP \(bu 2.3
.\}
.\" mysql: no-named-commands option
.\" no-named-commands option: mysql
\fB\-\-no\-named\-commands\fR,
\fB\-g\fR
.sp
Deprecated, use
\fB\-\-disable\-named\-commands\fR
instead\&.
\fB\-\-no\-named\-commands\fR
is removed in MySQL 5\&.5\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mysql: no-pager option
.\" no-pager option: mysql
\fB\-\-no\-pager\fR
.sp
Deprecated form of
\fB\-\-skip\-pager\fR\&. See the
\fB\-\-pager\fR
option\&.
\fB\-\-no\-pager\fR
is removed in MySQL 5\&.5\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mysql: no-tee option
.\" no-tee option: mysql
\fB\-\-no\-tee\fR
.sp
Deprecated form of
\fB\-\-skip\-tee\fR\&. See the
\fB\-\-tee\fR
option\&.
\fB\-\-no\-tee\fR
is removed in MySQL 5\&.5\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mysql: one-database option
.\" one-database option: mysql
\fB\-\-one\-database\fR,
\fB\-o\fR
.sp
Ignore statements except those for the default database named on the command line\&. This is useful for skipping updates to other databases in the binary log\&.
Ignore statements except those those that occur while the default database is the one named on the command line\&. This filtering is limited, and based only on USE statements\&. This is useful for skipping updates to other databases in the binary log\&.
.RE
.sp
.RS 4
...
...
@@ -803,8 +815,7 @@ option on the command line,
\fBmysql\fR
prompts for one\&.
.sp
Specifying a password on the command line should be considered insecure\&. See
Section\ \&5.3.2.2, \(lqEnd-User Guidelines for Password Security\(rq\&. You can use an option file to avoid giving the password on the command line\&.
Specifying a password on the command line should be considered insecure\&. You can use an option file to avoid giving the password on the command line\&.
.RE
.sp
.RS 4
...
...
@@ -831,12 +842,27 @@ On Windows, connect to the server via a named pipe\&. This option applies only i
.sp -1
.IP \(bu 2.3
.\}
.\" mysql: plugin-dir option
.\" plugin-dir option: mysql
\fB\-\-plugin\-dir=\fIdir_name\fR
.sp
Directory for client-side plugins\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mysql: port option
.\" port option: mysql
\fB\-\-port=\fR\fB\fIport_num\fR\fR,
\fB\-P \fR\fB\fIport_num\fR\fR
.sp
The TCP/IP port number to use for the connection\&.
The TCP/IP port number to use for the connection or 0 for default to, in order of preference, my.cnf, $MYSQL_TCP_PORT, /etc/services, built-in default (3306)\&.
.RE
.sp
.RS 4
...
...
@@ -862,12 +888,26 @@ Print the program argument list and exit\&. This must be given as the first argu
.sp -1
.IP \(bu 2.3
.\}
.\" mysql: progress-reports option
.\" progress-reports option: mysql
\fB\-\-progress\-reports\fR
.sp
Get progress reports for long running commands (such as ALTER TABLE)\&. (Defaults to on; use \fB\-\-skip\-progress\-reports\fR to disable\&.)
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mysql: prompt option
.\" prompt option: mysql
\fB\-\-prompt=\fR\fB\fIformat_str\fR\fR
.sp
Set the prompt to the specified format\&. The default is
mysql>\&. The special sequences that the prompt can contain are described in
Set the prompt to the specified format\&. The special sequences that the prompt can contain are described in
the section called \(lqMYSQL COMMANDS\(rq\&.
.RE
.sp
...
...
@@ -883,8 +923,7 @@ the section called \(lqMYSQL COMMANDS\(rq\&.
.\" protocol option: mysql
\fB\-\-protocol={TCP|SOCKET|PIPE|MEMORY}\fR
.sp
The connection protocol to use for connecting to the server\&. It is useful when the other connection parameters normally would cause a protocol to be used other than the one you want\&. For details on the allowable values, see
Section\ \&4.2.2, \(lqConnecting to the MySQL Server\(rq\&.
The connection protocol to use for connecting to the server\&. It is useful when the other connection parameters normally would cause a protocol to be used other than the one you want\&.
.RE
.sp
.RS 4
...
...
@@ -972,8 +1011,8 @@ CHAR(92)
.\" reconnect option: mysql
\fB\-\-reconnect\fR
.sp
If the connection to the server is lost, automatically try to reconnect\&. A single reconnect attempt is made each time the connection is lost\&. To suppress reconnection behavior, use
\fB\-\-skip\-reconnect\fR\&.
If the connection to the server is lost, automatically try to reconnect\&. A single reconnect attempt is made each time the connection is lost\&. Enabled by default, to disable use
\fB\-\-skip\-reconnect\fR or \fB\-\-disable\-reconnect\fR\&.
.RE
.sp
.RS 4
...
...
@@ -1173,12 +1212,137 @@ localhost, the Unix socket file to use, or, on Windows, the name of the named pi
.\}
.\" mysql: SSL options
.\" SSL options: mysql
\fB\-\-ssl*\fR
.sp
Options that begin with
\fB\-\-ssl\fR
specify whether to connect to the server via SSL and indicate where to find SSL keys and certificates\&. See
should be protected with a restrictive access mode because sensitive information might be written to it, such as the text of SQL statements that contain passwords\&. See
Section\ \&5.3.2.2, \(lqEnd-User Guidelines for Password Security\(rq\&.
should be protected with a restrictive access mode because sensitive information might be written to it, such as the text of SQL statements that contain passwords\&.
.PP
If you do not want to maintain a history file, first remove
\&.mysql_history
...
...
@@ -1625,7 +1751,7 @@ If you provide an argument to the
help
command,
\fBmysql\fR
uses it as a search string to access server\-side help from the contents of the MySQL Reference Manual\&. For more information, see
uses it as a search string to access server\-side help\&. For more information, see
the section called \(lqMYSQL SERVER-SIDE HELP\(rq\&.
.RE
.sp
...
...
@@ -1646,7 +1772,7 @@ Change the default character set and issue a
SET NAMES
statement\&. This enables the character set to remain synchronized on the client and server if
\fBmysql\fR
is run with auto\-reconnect enabled (which is not recommended), because the specified character set is used for reconnects\&. This command was added in MySQL 5\&.1\&.7\&.
is run with auto\-reconnect enabled (which is not recommended), because the specified character set is used for reconnects\&.
.RE
.sp
.RS 4
...
...
@@ -1698,16 +1824,14 @@ Change the string that
\fBmysql\fR
interprets as the separator between SQL statements\&. The default is the semicolon character (\(lq;\(rq)\&.
.sp
The delimiter can be specified as an unquoted or quoted argument\&. Quoting can be done with either single quote (\') or douple quote (") characters\&. To include a quote within a quoted string, either quote the string with the other quote character or escape the quote with a backslash (\(lq\e\(rq) character\&. Backslash should be avoided outside of quoted strings because it is the escape character for MySQL\&. For an unquoted argument, the delmiter 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\&.
The delimiter can be specified as an unquoted or quoted argument\&. Quoting can be done with either single quote (\') or douple quote (") characters\&. To include a quote within a quoted string, either quote the string with the other quote character or escape the quote with a backslash (\(lq\e\(rq) character\&. Backslash should be avoided outside of quoted strings because it is the escape character for MariaDB\&. For an unquoted argument, the delmiter 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\&.
.sp
When the delimiter recognized by
\fBmysql\fR
is set to something other than the default of
\(lq;\(rq, instances of that character are sent to the server without interpretation\&. However, the server itself still interprets
\(lq;\(rq
as a statement delimiter and processes statements accordingly\&. This behavior on the server side comes into play for multiple\-statement execution (see
Section\ \&21.9.12, \(lqC API Support for Multiple Statement Execution\(rq), and for parsing the body of stored procedures and functions, triggers, and events (see
as a statement delimiter and processes statements accordingly\&. This behavior on the server side comes into play for multiple\-statement execution, and for parsing the body of stored procedures and functions, triggers, and events\&.
In this example, note that the backslashes are doubled\&. If you set the prompt using the
prompt
option 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 allowable 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\ \&4.2.3.3, \(lqUsing Option Files\(rq\&.) The overlap may cause you problems if you use single backslashes\&. For example,
option 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 allowable prompt options and the set of special escape sequences that are recognized in option files\&. The overlap may cause you problems if you use single backslashes\&. For example,
\es
is 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
HH:MM:SS>
...
...
@@ -2581,10 +2704,9 @@ If you provide an argument to the
help
command,
\fBmysql\fR
uses it as a search string to access server\-side help from the contents of the MySQL Reference Manual\&. The proper operation of this command requires that the help tables in the
uses it as a search string to access server\-side help\&. The proper operation of this command requires that the help tables in the
mysql
database be initialized with help topic information (see
Section\ \&5.1.9, \(lqServer-Side Help\(rq)\&.
database be initialized with help topic information.
.PP
If there is no match for the search string, the search fails:
.sp
...
...
@@ -2775,17 +2897,14 @@ with the
\fB\-\-verbose\fR
option, which causes each statement to be displayed before the result that it produces\&.
.PP
As of MySQL 5\&.1\&.23,
\fBmysql\fR
ignores Unicode byte order mark (BOM) characters at the beginning of input files\&. Previously, it read them and sent them to the server, resulting in a syntax error\&. Presence of a BOM does not cause
ignores Unicode byte order mark (BOM) characters at the beginning of input files\&. Presence of a BOM does not cause
\fBmysql\fR
to change its default character set\&. To do that, invoke
\fBmysql\fR
with an option such as
\fB\-\-default\-character\-set=utf8\fR\&.
.PP
For more information about batch mode, see
Section\ \&3.5, \(lqUsing mysql in Batch Mode\(rq\&.
.SH "MYSQL TIPS"
.PP
This section describes some techniques that can help you use
...
...
@@ -2839,7 +2958,7 @@ When you use the
\fB\-\-safe\-updates\fR
option,
\fBmysql\fR
issues the following statement when it connects to the MySQL server:
issues the following statement when it connects to the MariaDB server:
.sp
.if n \{\
.RS 4
...
...
@@ -2851,9 +2970,6 @@ SET sql_safe_updates=1, sql_select_limit=1000, sql_max_join_size=1000000;
.RE
.\}
.PP
See
Section\ \&5.1.5, \(lqSession System Variables\(rq\&.
.PP
The
SET
statement has the following effects:
...
...
@@ -2973,8 +3089,6 @@ client with the
\fB\-\-skip\-reconnect\fR
option\&.
.PP
For more information about auto\-reconnect and its effect on state information when a reconnection occurs, see
