1MYSQL(1) MySQL Database System MYSQL(1)
2
6 mysql - the MySQL command-line client
7
9 mysql [options] db_name
10
12 mysql is a simple SQL shell with input line editing capabilities. It
13 supports interactive and noninteractive use. When used interactively,
14 query results are presented in an ASCII-table format. When used
15 noninteractively (for example, as a filter), the result is presented in
16 tab-separated format. The output format can be changed using command
17 options.
18 If you have problems due to insufficient memory for large result sets,
20 use the --quick option. This forces mysql to retrieve results from the
21 server a row at a time rather than retrieving the entire result set and
22 buffering it in memory before displaying it. This is done by returning
23 the result set using the mysql_use_result() C API function in the
24 client/server library rather than mysql_store_result().
25 Note
27 Alternatively, MySQL Shell offers access to the X DevAPI. For
28 details, see MySQL Shell 8.0[1].
29 Using mysql is very easy. Invoke it from the prompt of your command
31 interpreter as follows:
32 mysql db_name
34 Or:
36 mysql --user=user_name --password db_name
38 In this case, you'll need to enter your password in response to the
40 prompt that mysql displays:
41 Enter password: your_password
43 Then type an SQL statement, end it with ;, \g, or \G and press Enter.
45 Typing Control+C interrupts the current statement if there is one, or
47 cancels any partial input line otherwise.
48 You can execute SQL statements in a script file (batch file) like this:
50 mysql db_name < script.sql > output.tab
52 On Unix, the mysql client logs statements executed interactively to a
54 history file. See the section called “MYSQL CLIENT LOGGING”.
55
57 mysql supports the following options, which can be specified on the
58 command line or in the [mysql] and [client] groups of an option file.
59 For information about option files used by MySQL programs, see
60 Section 4.2.2.2, “Using Option Files”.
61 • --help, -? Display a help message and exit.
63 • --auto-rehash Enable automatic rehashing. This option is on by
65 default, which enables database, table, and column name completion.
66 Use --disable-auto-rehash to disable rehashing. That causes mysql
67 to start faster, but you must issue the rehash command or its \#
68 shortcut if you want to use name completion.
69 To complete a name, enter the first part and press Tab. If the name
71 is unambiguous, mysql completes it. Otherwise, you can press Tab
72 again to see the possible names that begin with what you have typed
73 so far. Completion does not occur if there is no default database.
74 Note
76 This feature requires a MySQL client that is compiled with the
77 readline library. Typically, the readline library is not
78 available on Windows.
79 • --auto-vertical-output Cause result sets to be displayed vertically
81 if they are too wide for the current window, and using normal
82 tabular format otherwise. (This applies to statements terminated by
83 ; or \G.)
84 • --batch, -B Print results using tab as the column separator, with
86 each row on a new line. With this option, mysql does not use the
87 history file.
88 Batch mode results in nontabular output format and escaping of
90 special characters. Escaping may be disabled by using raw mode; see
91 the description for the --raw option.
92 • --binary-as-hex When this option is given, mysql displays binary
94 data using hexadecimal notation (0xvalue). This occurs whether the
95 overall output display format is tabular, vertical, HTML, or XML.
96 --binary-as-hex when enabled affects display of all binary strings,
98 including those returned by functions such as CHAR() and UNHEX().
99 The following example demonistrates this using the ASCII code for A
100 (65 decimal, 41 hexadecimal):
101 • --binary-as-hex disabled:
103 mysql> SELECT CHAR(0x41), UNHEX('41');
105 +------------+-------------+
106 | CHAR(0x41) | UNHEX('41') |
107 +------------+-------------+
108 | A | A |
109 +------------+-------------+
110 • --binary-as-hex enabled:
112 mysql> SELECT CHAR(0x41), UNHEX('41');
114 +------------------------+--------------------------+
115 | CHAR(0x41) | UNHEX('41') |
116 +------------------------+--------------------------+
117 | 0x41 | 0x41 |
118 +------------------------+--------------------------+
119 To write a binary string expression so that it displays as a
121 character string regardless of whether --binary-as-hex is enabled,
122 use these techniques:
123 • The CHAR() function has a USING charset clause:
125 mysql> SELECT CHAR(0x41 USING utf8mb4);
127 +--------------------------+
128 | CHAR(0x41 USING utf8mb4) |
129 +--------------------------+
130 | A |
131 +--------------------------+
132 • More generally, use CONVERT() to convert an expression to a
134 given character set:
135 mysql> SELECT CONVERT(UNHEX('41') USING utf8mb4);
137 +------------------------------------+
138 | CONVERT(UNHEX('41') USING utf8mb4) |
139 +------------------------------------+
140 | A |
141 +------------------------------------+
142 As of MySQL 8.0.19, when mysql operates in interactive mode, this
144 option is enabled by default. In addition, output from the status
145 (or \s) command includes this line when the option is enabled
146 implicitly or explicitly:
147 Binary data as: Hexadecimal
149 To disable hexadecimal notation, use --skip-binary-as-hex
151 • --binary-mode This option helps when processing mysqlbinlog output
153 that may contain BLOB values. By default, mysql translates \r\n in
154 statement strings to \n and interprets \0 as the statement
155 terminator. --binary-mode disables both features. It also disables
156 all mysql commands except charset and delimiter in noninteractive
157 mode (for input piped to mysql or loaded using the source command).
158 • --bind-address=ip_address On a computer having multiple network
160 interfaces, use this option to select which interface to use for
161 connecting to the MySQL server.
162 • --character-sets-dir=dir_name The directory where character sets
164 are installed. See Section 10.15, “Character Set Configuration”.
165 • --column-names Write column names in results.
167 • --column-type-info Display result set metadata. This information
169 corresponds to the contents of C API MYSQL_FIELD data structures.
170 See C API Basic Data Structures[2].
171 • --comments, -c Whether to strip or preserve comments in statements
173 sent to the server. The default is --skip-comments (strip
174 comments), enable with --comments (preserve comments).
175 Note
177 The mysql client always passes optimizer hints to the server,
178 regardless of whether this option is given.
179 Comment stripping is deprecated. Expect this feature and the
181 options to control it to be removed in a future MySQL release.
182 • --compress, -C Compress all information sent between the client and
184 the server if possible. See Section 4.2.8, “Connection Compression
185 Control”.
186 As of MySQL 8.0.18, this option is deprecated. Expect it be removed
188 in a future version of MySQL. See the section called “Configuring
189 Legacy Connection Compression”.
190 • --compression-algorithms=value The permitted compression algorithms
192 for connections to the server. The available algorithms are the
193 same as for the protocol_compression_algorithms system variable.
194 The default value is uncompressed.
195 For more information, see Section 4.2.8, “Connection Compression
197 Control”.
198 This option was added in MySQL 8.0.18.
200 • --connect-expired-password Indicate to the server that the client
202 can handle sandbox mode if the account used to connect has an
203 expired password. This can be useful for noninteractive invocations
204 of mysql because normally the server disconnects noninteractive
205 clients that attempt to connect using an account with an expired
206 password. (See Section 6.2.16, “Server Handling of Expired
207 Passwords”.)
208 • --connect-timeout=value The number of seconds before connection
210 timeout. (Default value is 0.)
211 • --database=db_name, -D db_name The database to use. This is useful
213 primarily in an option file.
214 • --debug[=debug_options], -# [debug_options] Write a debugging log.
216 A typical debug_options string is d:t:o,file_name. The default is
217 d:t:o,/tmp/mysql.trace.
218 This option is available only if MySQL was built using WITH_DEBUG.
220 MySQL release binaries provided by Oracle are not built using this
221 option.
222 • --debug-check Print some debugging information when the program
224 exits.
225 This option is available only if MySQL was built using WITH_DEBUG.
227 MySQL release binaries provided by Oracle are not built using this
228 option.
229 • --debug-info, -T Print debugging information and memory and CPU
231 usage statistics when the program exits.
232 This option is available only if MySQL was built using WITH_DEBUG.
234 MySQL release binaries provided by Oracle are not built using this
235 option.
236 • --default-auth=plugin A hint about which client-side authentication
238 plugin to use. See Section 6.2.17, “Pluggable Authentication”.
239 • --default-character-set=charset_name Use charset_name as the
241 default character set for the client and connection.
242 This option can be useful if the operating system uses one
244 character set and the mysql client by default uses another. In this
245 case, output may be formatted incorrectly. You can usually fix such
246 issues by using this option to force the client to use the system
247 character set instead.
248 For more information, see Section 10.4, “Connection Character Sets
250 and Collations”, and Section 10.15, “Character Set Configuration”.
251 • --defaults-extra-file=file_name Read this option file after the
253 global option file but (on Unix) before the user option file. If
254 the file does not exist or is otherwise inaccessible, an error
255 occurs. If file_name is not an absolute path name, it is
256 interpreted relative to the current directory.
257 For additional information about this and other option-file
259 options, see Section 4.2.2.3, “Command-Line Options that Affect
260 Option-File Handling”.
261 • --defaults-file=file_name Use only the given option file. If the
263 file does not exist or is otherwise inaccessible, an error occurs.
264 If file_name is not an absolute path name, it is interpreted
265 relative to the current directory.
266 Exception: Even with --defaults-file, client programs read
268 .mylogin.cnf.
269 For additional information about this and other option-file
271 options, see Section 4.2.2.3, “Command-Line Options that Affect
272 Option-File Handling”.
273 • --defaults-group-suffix=str Read not only the usual option groups,
275 but also groups with the usual names and a suffix of str. For
276 example, mysql normally reads the [client] and [mysql] groups. If
277 this option is given as --defaults-group-suffix=_other, mysql also
278 reads the [client_other] and [mysql_other] groups.
279 For additional information about this and other option-file
281 options, see Section 4.2.2.3, “Command-Line Options that Affect
282 Option-File Handling”.
283 • --delimiter=str Set the statement delimiter. The default is the
285 semicolon character (;).
286 • --disable-named-commands Disable named commands. Use the \* form
288 only, or use named commands only at the beginning of a line ending
289 with a semicolon (;). mysql starts with this option enabled by
290 default. However, even with this option, long-format commands still
291 work from the first line. See the section called “MYSQL CLIENT
292 COMMANDS”.
293 • --dns-srv-name=name Specifies the name of a DNS SRV record that
295 determines the candidate hosts to use for establishing a connection
296 to a MySQL server. For information about DNS SRV support in MySQL,
297 see Section 4.2.6, “Connecting to the Server Using DNS SRV
298 Records”.
299 Suppose that DNS is configured with this SRV information for the
301 example.com domain:
302 Name TTL Class Priority Weight Port Target
304 _mysql._tcp.example.com. 86400 IN SRV 0 5 3306 host1.example.com
305 _mysql._tcp.example.com. 86400 IN SRV 0 10 3306 host2.example.com
306 _mysql._tcp.example.com. 86400 IN SRV 10 5 3306 host3.example.com
307 _mysql._tcp.example.com. 86400 IN SRV 20 5 3306 host4.example.com
308 To use that DNS SRV record, invoke mysql like this:
310 mysql --dns-srv-name=_mysql._tcp.example.com
312 mysql then attempts a connection to each server in the group until
314 a successful connection is established. A failure to connect occurs
315 only if a connection cannot be established to any of the servers.
316 The priority and weight values in the DNS SRV record determine the
317 order in which servers should be tried.
318 When invoked with --dns-srv-name, mysql attempts to establish TCP
320 connections only.
321 The --dns-srv-name option takes precedence over the --host option
323 if both are given. --dns-srv-name causes connection establishment
324 to use the mysql_real_connect_dns_srv() C API function rather than
325 mysql_real_connect(). However, if the connect command is
326 subsequently used at runtime and specifies a host name argument,
327 that host name takes precedence over any --dns-srv-name option
328 given at mysql startup to specify a DNS SRV record.
329 This option was added in MySQL 8.0.22.
331 • --enable-cleartext-plugin Enable the mysql_clear_password cleartext
333 authentication plugin. (See Section 6.4.1.4, “Client-Side Cleartext
334 Pluggable Authentication”.)
335 • --execute=statement, -e statement Execute the statement and quit.
337 The default output format is like that produced with --batch. See
338 Section 4.2.2.1, “Using Options on the Command Line”, for some
339 examples. With this option, mysql does not use the history file.
340 • --force, -f Continue even if an SQL error occurs.
342 • --get-server-public-key Request from the server the public key
344 required for RSA key pair-based password exchange. This option
345 applies to clients that authenticate with the caching_sha2_password
346 authentication plugin. For that plugin, the server does not send
347 the public key unless requested. This option is ignored for
348 accounts that do not authenticate with that plugin. It is also
349 ignored if RSA-based password exchange is not used, as is the case
350 when the client connects to the server using a secure connection.
351 If --server-public-key-path=file_name is given and specifies a
353 valid public key file, it takes precedence over
354 --get-server-public-key.
355 For information about the caching_sha2_password plugin, see
357 Section 6.4.1.2, “Caching SHA-2 Pluggable Authentication”.
358 • --histignore A list of one or more colon-separated patterns
360 specifying statements to ignore for logging purposes. These
361 patterns are added to the default pattern list
362 ("*IDENTIFIED*:*PASSWORD*"). The value specified for this option
363 affects logging of statements written to the history file, and to
364 syslog if the --syslog option is given. For more information, see
365 the section called “MYSQL CLIENT LOGGING”.
366 • --host=host_name, -h host_name Connect to the MySQL server on the
368 given host.
369 The --dns-srv-name option takes precedence over the --host option
371 if both are given. --dns-srv-name causes connection establishment
372 to use the mysql_real_connect_dns_srv() C API function rather than
373 mysql_real_connect(). However, if the connect command is
374 subsequently used at runtime and specifies a host name argument,
375 that host name takes precedence over any --dns-srv-name option
376 given at mysql startup to specify a DNS SRV record.
377 • --html, -H Produce HTML output.
379 • --ignore-spaces, -i Ignore spaces after function names. The effect
381 of this is described in the discussion for the IGNORE_SPACE SQL
382 mode (see Section 5.1.11, “Server SQL Modes”).
383 • --init-command=str SQL statement to execute after connecting to the
385 server. If auto-reconnect is enabled, the statement is executed
386 again after reconnection occurs.
387 • --line-numbers Write line numbers for errors. Disable this with
389 --skip-line-numbers.
390 • --load-data-local-dir=dir_name This option affects the client-side
392 LOCAL capability for LOAD DATA operations. It specifies the
393 directory in which files named in LOAD DATA LOCAL statements must
394 be located. The effect of --load-data-local-dir depends on whether
395 LOCAL data loading is enabled or disabled:
396 • If LOCAL data loading is enabled, either by default in the
398 MySQL client library or by specifying --local-infile[=1], the
399 --load-data-local-dir option is ignored.
400 • If LOCAL data loading is disabled, either by default in the
402 MySQL client library or by specifying --local-infile=0, the
403 --load-data-local-dir option applies.
404 When --load-data-local-dir applies, the option value designates the
406 directory in which local data files must be located. Comparison of
407 the directory path name and the path name of files to be loaded is
408 case-sensitive regardless of the case sensitivity of the underlying
409 file system. If the option value is the empty string, it names no
410 directory, with the result that no files are permitted for local
411 data loading.
412 For example, to explicitly disable local data loading except for
414 files located in the /my/local/data directory, invoke mysql like
415 this:
416 mysql --local-infile=0 --load-data-local-dir=/my/local/data
418 When both --local-infile and --load-data-local-dir are given, the
420 order in which they are given does not matter.
421 Successful use of LOCAL load operations within mysql also requires
423 that the server permits local loading; see Section 6.1.6, “Security
424 Considerations for LOAD DATA LOCAL”
425 The --load-data-local-dir option was added in MySQL 8.0.21.
427 • --local-infile[={0|1}] By default, LOCAL capability for LOAD DATA
429 is determined by the default compiled into the MySQL client
430 library. To enable or disable LOCAL data loading explicitly, use
431 the --local-infile option. When given with no value, the option
432 enables LOCAL data loading. When given as --local-infile=0 or
433 --local-infile=1, the option disables or enables LOCAL data
434 loading.
435 If LOCAL capability is disabled, the --load-data-local-dir option
437 can be used to permit restricted local loading of files located in
438 a designated directory.
439 Successful use of LOCAL load operations within mysql also requires
441 that the server permits local loading; see Section 6.1.6, “Security
442 Considerations for LOAD DATA LOCAL”
443 • --login-path=name Read options from the named login path in the
445 .mylogin.cnf login path file. A “login path” is an option group
446 containing options that specify which MySQL server to connect to
447 and which account to authenticate as. To create or modify a login
448 path file, use the mysql_config_editor utility. See
449 mysql_config_editor(1).
450 For additional information about this and other option-file
452 options, see Section 4.2.2.3, “Command-Line Options that Affect
453 Option-File Handling”.
454 • --max-allowed-packet=value The maximum size of the buffer for
456 client/server communication. The default is 16MB, the maximum is
457 1GB.
458 • --max-join-size=value The automatic limit for rows in a join when
460 using --safe-updates. (Default value is 1,000,000.)
461 • --named-commands, -G Enable named mysql commands. Long-format
463 commands are permitted, not just short-format commands. For
464 example, quit and \q both are recognized. Use --skip-named-commands
465 to disable named commands. See the section called “MYSQL CLIENT
466 COMMANDS”.
467 • --net-buffer-length=value The buffer size for TCP/IP and socket
469 communication. (Default value is 16KB.)
470 • --network-namespace=name The network namespace to use for TCP/IP
472 connections. If omitted, the connection uses the default (global)
473 namespace. For information about network namespaces, see
474 Section 5.1.14, “Network Namespace Support”.
475 This option was added in MySQL 8.0.22. It is available only on
477 platforms that implement network namespace support.
478 • --no-auto-rehash, -A This has the same effect as
480 --skip-auto-rehash. See the description for --auto-rehash.
481 • --no-beep, -b Do not beep when errors occur.
483 • --no-defaults Do not read any option files. If program startup
485 fails due to reading unknown options from an option file,
486 --no-defaults can be used to prevent them from being read.
487 The exception is that the .mylogin.cnf file is read in all cases,
489 if it exists. This permits passwords to be specified in a safer way
490 than on the command line even when --no-defaults is used. To create
491 .mylogin.cnf, use the mysql_config_editor utility. See
492 mysql_config_editor(1).
493 For additional information about this and other option-file
495 options, see Section 4.2.2.3, “Command-Line Options that Affect
496 Option-File Handling”.
497 • --one-database, -o Ignore statements except those that occur while
499 the default database is the one named on the command line. This
500 option is rudimentary and should be used with care. Statement
501 filtering is based only on USE statements.
502 Initially, mysql executes statements in the input because
504 specifying a database db_name on the command line is equivalent to
505 inserting USE db_name at the beginning of the input. Then, for each
506 USE statement encountered, mysql accepts or rejects following
507 statements depending on whether the database named is the one on
508 the command line. The content of the statements is immaterial.
509 Suppose that mysql is invoked to process this set of statements:
511 DELETE FROM db2.t2;
513 USE db2;
514 DROP TABLE db1.t1;
515 CREATE TABLE db1.t1 (i INT);
516 USE db1;
517 INSERT INTO t1 (i) VALUES(1);
518 CREATE TABLE db2.t1 (j INT);
519 If the command line is mysql --force --one-database db1, mysql
521 handles the input as follows:
522 • The DELETE statement is executed because the default database
524 is db1, even though the statement names a table in a different
525 database.
526 • The DROP TABLE and CREATE TABLE statements are not executed
528 because the default database is not db1, even though the
529 statements name a table in db1.
530 • The INSERT and CREATE TABLE statements are executed because the
532 default database is db1, even though the CREATE TABLE statement
533 names a table in a different database.
534 • --pager[=command] Use the given command for paging query output. If
536 the command is omitted, the default pager is the value of your
537 PAGER environment variable. Valid pagers are less, more, cat [>
538 filename], and so forth. This option works only on Unix and only in
539 interactive mode. To disable paging, use --skip-pager. the section
540 called “MYSQL CLIENT COMMANDS”, discusses output paging further.
541 • --password[=password], -p[password] The password of the MySQL
543 account used for connecting to the server. The password value is
544 optional. If not given, mysql prompts for one. If given, there must
545 be no space between --password= or -p and the password following
546 it. If no password option is specified, the default is to send no
547 password.
548 Specifying a password on the command line should be considered
550 insecure. To avoid giving the password on the command line, use an
551 option file. See Section 6.1.2.1, “End-User Guidelines for Password
552 Security”.
553 To explicitly specify that there is no password and that mysql
555 should not prompt for one, use the --skip-password option.
556 • --pipe, -W On Windows, connect to the server using a named pipe.
558 This option applies only if the server was started with the
559 named_pipe system variable enabled to support named-pipe
560 connections. In addition, the user making the connection must be a
561 member of the Windows group specified by the
562 named_pipe_full_access_group system variable.
563 • --plugin-dir=dir_name The directory in which to look for plugins.
565 Specify this option if the --default-auth option is used to specify
566 an authentication plugin but mysql does not find it. See
567 Section 6.2.17, “Pluggable Authentication”.
568 • --port=port_num, -P port_num For TCP/IP connections, the port
570 number to use.
571 • --print-defaults Print the program name and all options that it
573 gets from option files.
574 For additional information about this and other option-file
576 options, see Section 4.2.2.3, “Command-Line Options that Affect
577 Option-File Handling”.
578 • --prompt=format_str Set the prompt to the specified format. The
580 default is mysql>. The special sequences that the prompt can
581 contain are described in the section called “MYSQL CLIENT
582 COMMANDS”.
583 • --protocol={TCP|SOCKET|PIPE|MEMORY} The transport protocol to use
585 for connecting to the server. It is useful when the other
586 connection parameters normally result in use of a protocol other
587 than the one you want. For details on the permissible values, see
588 Section 4.2.7, “Connection Transport Protocols”.
589 • --quick, -q Do not cache each query result, print each row as it is
591 received. This may slow down the server if the output is suspended.
592 With this option, mysql does not use the history file.
593 • --raw, -r For tabular output, the “boxing” around columns enables
595 one column value to be distinguished from another. For nontabular
596 output (such as is produced in batch mode or when the --batch or
597 --silent option is given), special characters are escaped in the
598 output so they can be identified easily. Newline, tab, NUL, and
599 backslash are written as \n, \t, \0, and \\. The --raw option
600 disables this character escaping.
601 The following example demonstrates tabular versus nontabular output
603 and the use of raw mode to disable escaping:
604 % mysql
606 mysql> SELECT CHAR(92);
607 +----------+
608 | CHAR(92) |
609 +----------+
610 | \ |
611 +----------+
612 % mysql -s
613 mysql> SELECT CHAR(92);
614 CHAR(92)
615 \\
616 % mysql -s -r
617 mysql> SELECT CHAR(92);
618 CHAR(92)
619 \
620 • --reconnect If the connection to the server is lost, automatically
622 try to reconnect. A single reconnect attempt is made each time the
623 connection is lost. To suppress reconnection behavior, use
624 --skip-reconnect.
625 • --safe-updates, --i-am-a-dummy, -U If this option is enabled,
627 UPDATE and DELETE statements that do not use a key in the WHERE
628 clause or a LIMIT clause produce an error. In addition,
629 restrictions are placed on SELECT statements that produce (or are
630 estimated to produce) very large result sets. If you have set this
631 option in an option file, you can use --skip-safe-updates on the
632 command line to override it. For more information about this
633 option, see Using Safe-Updates Mode (--safe-updates).
634 • --select-limit=value The automatic limit for SELECT statements when
636 using --safe-updates. (Default value is 1,000.)
637 • --server-public-key-path=file_name The path name to a file in PEM
639 format containing a client-side copy of the public key required by
640 the server for RSA key pair-based password exchange. This option
641 applies to clients that authenticate with the sha256_password or
642 caching_sha2_password authentication plugin. This option is ignored
643 for accounts that do not authenticate with one of those plugins. It
644 is also ignored if RSA-based password exchange is not used, as is
645 the case when the client connects to the server using a secure
646 connection.
647 If --server-public-key-path=file_name is given and specifies a
649 valid public key file, it takes precedence over
650 --get-server-public-key.
651 For sha256_password, this option applies only if MySQL was built
653 using OpenSSL.
654 For information about the sha256_password and caching_sha2_password
656 plugins, see Section 6.4.1.3, “SHA-256 Pluggable Authentication”,
657 and Section 6.4.1.2, “Caching SHA-2 Pluggable Authentication”.
658 • --shared-memory-base-name=name On Windows, the shared-memory name
660 to use for connections made using shared memory to a local server.
661 The default value is MYSQL. The shared-memory name is
662 case-sensitive.
663 This option applies only if the server was started with the
665 shared_memory system variable enabled to support shared-memory
666 connections.
667 • --show-warnings Cause warnings to be shown after each statement if
669 there are any. This option applies to interactive and batch mode.
670 • --sigint-ignore Ignore SIGINT signals (typically the result of
672 typing Control+C).
673 Without this option, typing Control+C interrupts the current
675 statement if there is one, or cancels any partial input line
676 otherwise.
677 • --silent, -s Silent mode. Produce less output. This option can be
679 given multiple times to produce less and less output.
680 This option results in nontabular output format and escaping of
682 special characters. Escaping may be disabled by using raw mode; see
683 the description for the --raw option.
684 • --skip-column-names, -N Do not write column names in results.
686 • --skip-line-numbers, -L Do not write line numbers for errors.
688 Useful when you want to compare result files that include error
689 messages.
690 • --socket=path, -S path For connections to localhost, the Unix
692 socket file to use, or, on Windows, the name of the named pipe to
693 use.
694 On Windows, this option applies only if the server was started with
696 the named_pipe system variable enabled to support named-pipe
697 connections. In addition, the user making the connection must be a
698 member of the Windows group specified by the
699 named_pipe_full_access_group system variable.
700 • --ssl* Options that begin with --ssl specify whether to connect to
702 the server using encryption and indicate where to find SSL keys and
703 certificates. See the section called “Command Options for Encrypted
704 Connections”.
705 • --ssl-fips-mode={OFF|ON|STRICT} Controls whether to enable FIPS
707 mode on the client side. The --ssl-fips-mode option differs from
708 other --ssl-xxx options in that it is not used to establish
709 encrypted connections, but rather to affect which cryptographic
710 operations to permit. See Section 6.8, “FIPS Support”.
711 These --ssl-fips-mode values are permitted:
713 • OFF: Disable FIPS mode.
715 • ON: Enable FIPS mode.
717 • STRICT: Enable “strict” FIPS mode.
719 Note
722 If the OpenSSL FIPS Object Module is not available, the only
723 permitted value for --ssl-fips-mode is OFF. In this case,
724 setting --ssl-fips-mode to ON or STRICT causes the client to
725 produce a warning at startup and to operate in non-FIPS mode.
726 • --syslog, -j This option causes mysql to send interactive
728 statements to the system logging facility. On Unix, this is syslog;
729 on Windows, it is the Windows Event Log. The destination where
730 logged messages appear is system dependent. On Linux, the
731 destination is often the /var/log/messages file.
732 Here is a sample of output generated on Linux by using --syslog.
734 This output is formatted for readability; each logged message
735 actually takes a single line.
736 Mar 7 12:39:25 myhost MysqlClient[20824]:
738 SYSTEM_USER:'oscar', MYSQL_USER:'my_oscar', CONNECTION_ID:23,
739 DB_SERVER:'127.0.0.1', DB:'--', QUERY:'USE test;'
740 Mar 7 12:39:28 myhost MysqlClient[20824]:
741 SYSTEM_USER:'oscar', MYSQL_USER:'my_oscar', CONNECTION_ID:23,
742 DB_SERVER:'127.0.0.1', DB:'test', QUERY:'SHOW TABLES;'
743 For more information, see the section called “MYSQL CLIENT
745 LOGGING”.
746 • --table, -t Display output in table format. This is the default for
748 interactive use, but can be used to produce table output in batch
749 mode.
750 • --tee=file_name Append a copy of output to the given file. This
752 option works only in interactive mode. the section called “MYSQL
753 CLIENT COMMANDS”, discusses tee files further.
754 • --tls-ciphersuites=ciphersuite_list The permissible ciphersuites
756 for encrypted connections that use TLSv1.3. The value is a list of
757 one or more colon-separated ciphersuite names. The ciphersuites
758 that can be named for this option depend on the SSL library used to
759 compile MySQL. For details, see Section 6.3.2, “Encrypted
760 Connection TLS Protocols and Ciphers”.
761 This option was added in MySQL 8.0.16.
763 • --tls-version=protocol_list The permissible TLS protocols for
765 encrypted connections. The value is a list of one or more
766 comma-separated protocol names. The protocols that can be named for
767 this option depend on the SSL library used to compile MySQL. For
768 details, see Section 6.3.2, “Encrypted Connection TLS Protocols and
769 Ciphers”.
770 • --unbuffered, -n Flush the buffer after each query.
772 • --user=user_name, -u user_name The user name of the MySQL account
774 to use for connecting to the server.
775 • --verbose, -v Verbose mode. Produce more output about what the
777 program does. This option can be given multiple times to produce
778 more and more output. (For example, -v -v -v produces table output
779 format even in batch mode.)
780 • --version, -V Display version information and exit.
782 • --vertical, -E Print query output rows vertically (one line per
784 column value). Without this option, you can specify vertical output
785 for individual statements by terminating them with \G.
786 • --wait, -w If the connection cannot be established, wait and retry
788 instead of aborting.
789 • --xml, -X Produce XML output.
791 <field name="column_name">NULL</field>
793 The output when --xml is used with mysql matches that of mysqldump
795 --xml. See mysqldump(1), for details.
796 The XML output also uses an XML namespace, as shown here:
798 shell> mysql --xml -uroot -e "SHOW VARIABLES LIKE 'version%'"
800 <?xml version="1.0"?>
801 <resultset statement="SHOW VARIABLES LIKE 'version%'" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
802 <row>
803 <field name="Variable_name">version</field>
804 <field name="Value">5.0.40-debug</field>
805 </row>
806 <row>
807 <field name="Variable_name">version_comment</field>
808 <field name="Value">Source distribution</field>
809 </row>
810 <row>
811 <field name="Variable_name">version_compile_machine</field>
812 <field name="Value">i686</field>
813 </row>
814 <row>
815 <field name="Variable_name">version_compile_os</field>
816 <field name="Value">suse-linux-gnu</field>
817 </row>
818 </resultset>
819 • --zstd-compression-level=level The compression level to use for
821 connections to the server that use the zstd compression algorithm.
822 The permitted levels are from 1 to 22, with larger values
823 indicating increasing levels of compression. The default zstd
824 compression level is 3. The compression level setting has no effect
825 on connections that do not use zstd compression.
826 For more information, see Section 4.2.8, “Connection Compression
828 Control”.
829 This option was added in MySQL 8.0.18.
831
833 mysql sends each SQL statement that you issue to the server to be
834 executed. There is also a set of commands that mysql itself interprets.
835 For a list of these commands, type help or \h at the mysql> prompt:
836 mysql> help
838 List of all MySQL commands:
839 Note that all text commands must be first on line and end with ';'
840 ? (\?) Synonym for `help'.
841 clear (\c) Clear the current input statement.
842 connect (\r) Reconnect to the server. Optional arguments are db and host.
843 delimiter (\d) Set statement delimiter.
844 edit (\e) Edit command with $EDITOR.
845 ego (\G) Send command to mysql server, display result vertically.
846 exit (\q) Exit mysql. Same as quit.
847 go (\g) Send command to mysql server.
848 help (\h) Display this help.
849 nopager (\n) Disable pager, print to stdout.
850 notee (\t) Don't write into outfile.
851 pager (\P) Set PAGER [to_pager]. Print the query results via PAGER.
852 print (\p) Print current command.
853 prompt (\R) Change your mysql prompt.
854 quit (\q) Quit mysql.
855 rehash (\#) Rebuild completion hash.
856 source (\.) Execute an SQL script file. Takes a file name as an argument.
857 status (\s) Get status information from the server.
858 system (\!) Execute a system shell command.
859 tee (\T) Set outfile [to_outfile]. Append everything into given
860 outfile.
861 use (\u) Use another database. Takes database name as argument.
862 charset (\C) Switch to another charset. Might be needed for processing
863 binlog with multi-byte charsets.
864 warnings (\W) Show warnings after every statement.
865 nowarning (\w) Don't show warnings after every statement.
866 resetconnection(\x) Clean session context.
867 query_attributes(\) Sets string parameters (name1 value1 name2 value2 ...)
868 for the next query to pick up.
869 For server side help, type 'help contents'
870 If mysql is invoked with the --binary-mode option, all mysql commands
872 are disabled except charset and delimiter in noninteractive mode (for
873 input piped to mysql or loaded using the source command).
874 Each command has both a long and short form. The long form is not
876 case-sensitive; the short form is. The long form can be followed by an
877 optional semicolon terminator, but the short form should not.
878 The use of short-form commands within multiple-line /* ... */ comments
880 is not supported. Short-form commands do work within single-line /*!
881 ... */ version comments, as do /*+ ... */ optimizer-hint comments,
882 which are stored in object definitions. If there is a concern that
883 optimizer-hint comments may be stored in object definitions so that
884 dump files when reloaded with mysql would result in execution of such
885 commands, either invoke mysql with the --binary-mode option or use a
886 reload client other than mysql.
887 • help [arg], \h [arg], \? [arg], ? [arg]
889 Display a help message listing the available mysql commands.
891 If you provide an argument to the help command, mysql uses it as a
893 search string to access server-side help from the contents of the
894 MySQL Reference Manual. For more information, see the section
895 called “MYSQL CLIENT SERVER-SIDE HELP”.
896 • charset charset_name, \C charset_name
898 Change the default character set and issue a SET NAMES statement.
900 This enables the character set to remain synchronized on the client
901 and server if mysql is run with auto-reconnect enabled (which is
902 not recommended), because the specified character set is used for
903 reconnects.
904 • clear, \c
906 Clear the current input. Use this if you change your mind about
908 executing the statement that you are entering.
909 • connect [db_name [host_name]], \r [db_name [host_name]]
911 Reconnect to the server. The optional database name and host name
913 arguments may be given to specify the default database or the host
914 where the server is running. If omitted, the current values are
915 used.
916 If the connect command specifies a host name argument, that host
918 takes precedence over any --dns-srv-name option given at mysql
919 startup to specify a DNS SRV record.
920 • delimiter str, \d str
922 Change the string that mysql interprets as the separator between
924 SQL statements. The default is the semicolon character (;).
925 The delimiter string can be specified as an unquoted or quoted
927 argument on the delimiter command line. Quoting can be done with
928 either single quote ('), double quote ("), or backtick (`)
929 characters. To include a quote within a quoted string, either quote
930 the string with a different quote character or escape the quote
931 with a backslash (\) character. Backslash should be avoided outside
932 of quoted strings because it is the escape character for MySQL. For
933 an unquoted argument, the delimiter is read up to the first space
934 or end of line. For a quoted argument, the delimiter is read up to
935 the matching quote on the line.
936 mysql interprets instances of the delimiter string as a statement
938 delimiter anywhere it occurs, except within quoted strings. Be
939 careful about defining a delimiter that might occur within other
940 words. For example, if you define the delimiter as X, it is not
941 possible to use the word INDEX in statements. mysql interprets
942 this as INDE followed by the delimiter X.
943 When the delimiter recognized by mysql is set to something other
945 than the default of ;, instances of that character are sent to the
946 server without interpretation. However, the server itself still
947 interprets ; as a statement delimiter and processes statements
948 accordingly. This behavior on the server side comes into play for
949 multiple-statement execution (see Multiple Statement Execution
950 Support[3]), and for parsing the body of stored procedures and
951 functions, triggers, and events (see Section 25.1, “Defining Stored
952 Programs”).
953 • edit, \e
955 Edit the current input statement. mysql checks the values of the
957 EDITOR and VISUAL environment variables to determine which editor
958 to use. The default editor is vi if neither variable is set.
959 The edit command works only in Unix.
961 • ego, \G
963 Send the current statement to the server to be executed and display
965 the result using vertical format.
966 • exit, \q
968 Exit mysql.
970 • go, \g
972 Send the current statement to the server to be executed.
974 • nopager, \n
976 Disable output paging. See the description for pager.
978 The nopager command works only in Unix.
980 • notee, \t
982 Disable output copying to the tee file. See the description for
984 tee.
985 • nowarning, \w
987 Disable display of warnings after each statement.
989 • pager [command], \P [command]
991 Enable output paging. By using the --pager option when you invoke
993 mysql, it is possible to browse or search query results in
994 interactive mode with Unix programs such as less, more, or any
995 other similar program. If you specify no value for the option,
996 mysql checks the value of the PAGER environment variable and sets
997 the pager to that. Pager functionality works only in interactive
998 mode.
999 Output paging can be enabled interactively with the pager command
1001 and disabled with nopager. The command takes an optional argument;
1002 if given, the paging program is set to that. With no argument, the
1003 pager is set to the pager that was set on the command line, or
1004 stdout if no pager was specified.
1005 Output paging works only in Unix because it uses the popen()
1007 function, which does not exist on Windows. For Windows, the tee
1008 option can be used instead to save query output, although it is not
1009 as convenient as pager for browsing output in some situations.
1010 • print, \p
1012 Print the current input statement without executing it.
1014 • prompt [str], \R [str]
1016 Reconfigure the mysql prompt to the given string. The special
1018 character sequences that can be used in the prompt are described
1019 later in this section.
1020 If you specify the prompt command with no argument, mysql resets
1022 the prompt to the default of mysql>.
1023 • query_attributes name value [name value ...]
1025 Define query attributes that apply to the next query sent to the
1027 server. For discussion of the purpose and use of query attributes,
1028 see Section 9.6, “Query Attributes”.
1029 The query_attributes command follows these rules:
1031 • The format and quoting rules for attribute names and values are
1033 the same as for the delimiter command.
1034 • The command permits up to 32 attribute name/value pairs. Names
1036 and values may be up to 1024 characters long. If a name is
1037 given without a value, an error occurs.
1038 • If multiple query_attributes commands are issued prior to query
1040 execution, only the last command applies. After sending the
1041 query, mysql clears the attribute set.
1042 • If multiple attributes are defined with the same name, attempts
1044 to retrieve the attribute value have an undefined result.
1045 • An attribute defined with an empty name cannot be retrieved by
1047 name.
1048 • If a reconnect occurs while mysql executes the query, mysql
1050 restores the attributes after reconnecting so the query can be
1051 executed again with the same attributes.
1052 • quit, \q
1055 Exit mysql.
1057 • rehash, \#
1059 Rebuild the completion hash that enables database, table, and
1061 column name completion while you are entering statements. (See the
1062 description for the --auto-rehash option.)
1063 • resetconnection, \x
1065 Reset the connection to clear the session state. This includes
1067 clearing any current query attributes defined using the
1068 query_attributes command.
1069 Resetting a connection has effects similar to mysql_change_user()
1071 or an auto-reconnect except that the connection is not closed and
1072 reopened, and re-authentication is not done. See
1073 mysql_change_user()[4], and Automatic Reconnection Control[5].
1074 This example shows how resetconnection clears a value maintained in
1076 the session state:
1077 mysql> SELECT LAST_INSERT_ID(3);
1079 +-------------------+
1080 | LAST_INSERT_ID(3) |
1081 +-------------------+
1082 | 3 |
1083 +-------------------+
1084 mysql> SELECT LAST_INSERT_ID();
1085 +------------------+
1086 | LAST_INSERT_ID() |
1087 +------------------+
1088 | 3 |
1089 +------------------+
1090 mysql> resetconnection;
1091 mysql> SELECT LAST_INSERT_ID();
1092 +------------------+
1093 | LAST_INSERT_ID() |
1094 +------------------+
1095 | 0 |
1096 +------------------+
1097 • source file_name, \. file_name
1099 Read the named file and executes the statements contained therein.
1101 On Windows, specify path name separators as / or \\.
1102 Quote characters are taken as part of the file name itself. For
1104 best results, the name should not include space characters.
1105 • status, \s
1107 Provide status information about the connection and the server you
1109 are using. If you are running with --safe-updates enabled, status
1110 also prints the values for the mysql variables that affect your
1111 queries.
1112 • system command, \! command
1114 Execute the given command using your default command interpreter.
1116 Prior to MySQL 8.0.19, the system command works only in Unix. As of
1118 8.0.19, it also works on Windows.
1119 • tee [file_name], \T [file_name]
1121 By using the --tee option when you invoke mysql, you can log
1123 statements and their output. All the data displayed on the screen
1124 is appended into a given file. This can be very useful for
1125 debugging purposes also. mysql flushes results to the file after
1126 each statement, just before it prints its next prompt. Tee
1127 functionality works only in interactive mode.
1128 You can enable this feature interactively with the tee command.
1130 Without a parameter, the previous file is used. The tee file can be
1131 disabled with the notee command. Executing tee again re-enables
1132 logging.
1133 • use db_name, \u db_name
1135 Use db_name as the default database.
1137 • warnings, \W
1139 Enable display of warnings after each statement (if there are any).
1141 Here are a few tips about the pager command:
1143 • You can use it to write to a file and the results go only to the
1145 file:
1146 mysql> pager cat > /tmp/log.txt
1148 You can also pass any options for the program that you want to use
1150 as your pager:
1151 mysql> pager less -n -i -S
1153 • In the preceding example, note the -S option. You may find it very
1155 useful for browsing wide query results. Sometimes a very wide
1156 result set is difficult to read on the screen. The -S option to
1157 less can make the result set much more readable because you can
1158 scroll it horizontally using the left-arrow and right-arrow keys.
1159 You can also use -S interactively within less to switch the
1160 horizontal-browse mode on and off. For more information, read the
1161 less manual page:
1162 man less
1164 • The -F and -X options may be used with less to cause it to exit if
1166 output fits on one screen, which is convenient when no scrolling is
1167 necessary:
1168 mysql> pager less -n -i -S -F -X
1170 • You can specify very complex pager commands for handling query
1172 output:
1173 mysql> pager cat | tee /dr1/tmp/res.txt \
1175 | tee /dr2/tmp/res2.txt | less -n -i -S
1176 In this example, the command would send query results to two files
1178 in two different directories on two different file systems mounted
1179 on /dr1 and /dr2, yet still display the results onscreen using
1180 less.
1181 You can also combine the tee and pager functions. Have a tee file
1183 enabled and pager set to less, and you are able to browse the results
1184 using the less program and still have everything appended into a file
1185 the same time. The difference between the Unix tee used with the pager
1186 command and the mysql built-in tee command is that the built-in tee
1187 works even if you do not have the Unix tee available. The built-in tee
1188 also logs everything that is printed on the screen, whereas the Unix
1189 tee used with pager does not log quite that much. Additionally, tee
1190 file logging can be turned on and off interactively from within mysql.
1191 This is useful when you want to log some queries to a file, but not
1192 others.
1193 The prompt command reconfigures the default mysql> prompt. The string
1195 for defining the prompt can contain the following special sequences.
1196.br
1198.br
1199.br
120072
1201 ┌───────────────────────────┬────────────────────────────┐
1202 │Option │ Description │
1203 ├───────────────────────────┼────────────────────────────┤
1204 │ │ The current connection │
1205 │ │ identifier │
1206 ├───────────────────────────┼────────────────────────────┤
1207 │ │ A counter that increments │
1208 │ │ for each statement you │
1209 │ │ issue │
1210 ├───────────────────────────┼────────────────────────────┤
1211 │ │ The full current date │
1212 ├───────────────────────────┼────────────────────────────┤
1213 │ │ The default database │
1214 ├───────────────────────────┼────────────────────────────┤
1215 │ │ The server host │
1216 ├───────────────────────────┼────────────────────────────┤
1217 │ │ The current delimiter │
1218 ├───────────────────────────┼────────────────────────────┤
1219 │ │ Minutes of the current │
1220 │ │ time │
1221 ├───────────────────────────┼────────────────────────────┤
1222 │ │ A newline character │
1223 ├───────────────────────────┼────────────────────────────┤
1224 │ │ The current month in │
1225 │ │ three-letter format (Jan, │
1226 │ │ Feb, ...) │
1227 ├───────────────────────────┼────────────────────────────┤
1228 │ │ The current month in │
1229 │ │ numeric format │
1230 ├───────────────────────────┼────────────────────────────┤
1231 │P │ am/pm │
1232 ├───────────────────────────┼────────────────────────────┤
1233 │ │ The current TCP/IP port or │
1234 │ │ socket file │
1235 ├───────────────────────────┼────────────────────────────┤
1236 │ │ The current time, in │
1237 │ │ 24-hour military time │
1238 │ │ (0–23) │
1239 ├───────────────────────────┼────────────────────────────┤
1240 │ │ The current time, standard │
1241 │ │ 12-hour time (1–12) │
1242 ├───────────────────────────┼────────────────────────────┤
1243 │ │ Semicolon │
1244 ├───────────────────────────┼────────────────────────────┤
1245 │ │ Seconds of the current │
1246 │ │ time │
1247 ├───────────────────────────┼────────────────────────────┤
1248 │ │ A tab character │
1249 ├───────────────────────────┼────────────────────────────┤
1250 │U │ │
1251 │ │ Your full │
1252 │ │ user_name@host_name │
1253 │ │ account name │
1254 ├───────────────────────────┼────────────────────────────┤
1255 │ │ Your user name │
1256 ├───────────────────────────┼────────────────────────────┤
1257 │ │ The server version │
1258 ├───────────────────────────┼────────────────────────────┤
1259 │ │ The current day of the │
1260 │ │ week in three-letter │
1261 │ │ format (Mon, Tue, ...) │
1262 ├───────────────────────────┼────────────────────────────┤
1263 │ │ The current year, four │
1264 │ │ digits │
1265 ├───────────────────────────┼────────────────────────────┤
1266 │y │ The current year, two │
1267 │ │ digits │
1268 ├───────────────────────────┼────────────────────────────┤
1269 │_ │ A space │
1270 ├───────────────────────────┼────────────────────────────┤
1271 │\ │ A space (a space follows │
1272 │ │ the backslash) │
1273 ├───────────────────────────┼────────────────────────────┤
1274 │´ │ Single quote │
1275 ├───────────────────────────┼────────────────────────────┤
1276 │ │ Double quote │
1277 ├───────────────────────────┼────────────────────────────┤
1278 │T}:T{ A literal backslash │ │
1279 │character │ │
1280 ├───────────────────────────┼────────────────────────────┤
1281 │\fIx │ │
1282 │ │ x, for any “x” not │
1283 │ │ listed above │
1284 └───────────────────────────┴────────────────────────────┘
1285 You can set the prompt in several ways:
1287 • Use an environment variable. You can set the MYSQL_PS1 environment
1289 variable to a prompt string. For example:
1290 export MYSQL_PS1="(\u@\h) [\d]> "
1292 • Use a command-line option. You can set the --prompt option on the
1294 command line to mysql. For example:
1295 shell> mysql --prompt="(\u@\h) [\d]> "
1297 (user@host) [database]>
1298 • Use an option file. You can set the prompt option in the [mysql]
1300 group of any MySQL option file, such as /etc/my.cnf or the .my.cnf
1301 file in your home directory. For example:
1302 [mysql]
1304 prompt=(\\u@\\h) [\\d]>\\_
1305 In this example, note that the backslashes are doubled. If you set
1307 the prompt using the prompt option in an option file, it is
1308 advisable to double the backslashes when using the special prompt
1309 options. There is some overlap in the set of permissible prompt
1310 options and the set of special escape sequences that are recognized
1311 in option files. (The rules for escape sequences in option files
1312 are listed in Section 4.2.2.2, “Using Option Files”.) The overlap
1313 may cause you problems if you use single backslashes. For example,
1314 \s is interpreted as a space rather than as the current seconds
1315 value. The following example shows how to define a prompt within an
1316 option file to include the current time in hh:mm:ss> format:
1317 [mysql]
1319 prompt="\\r:\\m:\\s> "
1320 • Set the prompt interactively. You can change your prompt
1322 interactively by using the prompt (or \R) command. For example:
1323 mysql> prompt (\u@\h) [\d]>\_
1325 PROMPT set to '(\u@\h) [\d]>\_'
1326 (user@host) [database]>
1327 (user@host) [database]> prompt
1328 Returning to default PROMPT of mysql>
1329 mysql>
1330
1332 The mysql client can do these types of logging for statements executed
1333 interactively:
1334 • On Unix, mysql writes the statements to a history file. By default,
1336 this file is named .mysql_history in your home directory. To
1337 specify a different file, set the value of the MYSQL_HISTFILE
1338 environment variable.
1339 • On all platforms, if the --syslog option is given, mysql writes the
1341 statements to the system logging facility. On Unix, this is syslog;
1342 on Windows, it is the Windows Event Log. The destination where
1343 logged messages appear is system dependent. On Linux, the
1344 destination is often the /var/log/messages file.
1345 The following discussion describes characteristics that apply to all
1347 logging types and provides information specific to each logging type.
1348 • How Logging Occurs
1350 • Controlling the History File
1352 • syslog Logging Characteristics
1354 How Logging Occurs
1355 For each enabled logging destination, statement logging occurs as
1357 follows:
1358 • Statements are logged only when executed interactively. Statements
1360 are noninteractive, for example, when read from a file or a pipe.
1361 It is also possible to suppress statement logging by using the
1362 --batch or --execute option.
1363 • Statements are ignored and not logged if they match any pattern in
1365 the “ignore” list. This list is described later.
1366 • mysql logs each nonignored, nonempty statement line individually.
1368 • If a nonignored statement spans multiple lines (not including the
1370 terminating delimiter), mysql concatenates the lines to form the
1371 complete statement, maps newlines to spaces, and logs the result,
1372 plus a delimiter.
1373 Consequently, an input statement that spans multiple lines can be
1375 logged twice. Consider this input:
1376 mysql> SELECT
1378 -> 'Today is'
1379 -> ,
1380 -> CURDATE()
1381 -> ;
1382 In this case, mysql logs the “SELECT”, “'Today is'”, “,”, “CURDATE()”,
1384 and “;” lines as it reads them. It also logs the complete statement,
1385 after mapping SELECT\n'Today is'\n,\nCURDATE() to SELECT 'Today is' ,
1386 CURDATE(), plus a delimiter. Thus, these lines appear in logged output:
1387 SELECT
1389 'Today is'
1390 ,
1391 CURDATE()
1392 ;
1393 SELECT 'Today is' , CURDATE();
1394 mysql ignores for logging purposes statements that match any pattern in
1396 the “ignore” list. By default, the pattern list is
1397 "*IDENTIFIED*:*PASSWORD*", to ignore statements that refer to
1398 passwords. Pattern matching is not case-sensitive. Within patterns, two
1399 characters are special:
1400 • ? matches any single character.
1402 • * matches any sequence of zero or more characters.
1404 To specify additional patterns, use the --histignore option or set the
1406 MYSQL_HISTIGNORE environment variable. (If both are specified, the
1407 option value takes precedence.) The value should be a list of one or
1408 more colon-separated patterns, which are appended to the default
1409 pattern list.
1410 Patterns specified on the command line might need to be quoted or
1412 escaped to prevent your command interpreter from treating them
1413 specially. For example, to suppress logging for UPDATE and DELETE
1414 statements in addition to statements that refer to passwords, invoke
1415 mysql like this:
1416 mysql --histignore="*UPDATE*:*DELETE*"
1418 Controlling the History File
1420 The .mysql_history file should be protected with a restrictive access
1422 mode because sensitive information might be written to it, such as the
1423 text of SQL statements that contain passwords. See Section 6.1.2.1,
1424 “End-User Guidelines for Password Security”. Statements in the file are
1425 accessible from the mysql client when the up-arrow key is used to
1426 recall the history. See Disabling Interactive History.
1427 If you do not want to maintain a history file, first remove
1429 .mysql_history if it exists. Then use either of the following
1430 techniques to prevent it from being created again:
1431 • Set the MYSQL_HISTFILE environment variable to /dev/null. To cause
1433 this setting to take effect each time you log in, put it in one of
1434 your shell's startup files.
1435 • Create .mysql_history as a symbolic link to /dev/null; this need be
1437 done only once:
1438 ln -s /dev/null $HOME/.mysql_history
1440 syslog Logging Characteristics
1441 If the --syslog option is given, mysql writes interactive statements to
1443 the system logging facility. Message logging has the following
1444 characteristics.
1445 Logging occurs at the “information” level. This corresponds to the
1447 LOG_INFO priority for syslog on Unix/Linux syslog capability and to
1448 EVENTLOG_INFORMATION_TYPE for the Windows Event Log. Consult your
1449 system documentation for configuration of your logging capability.
1450 Message size is limited to 1024 bytes.
1452 Messages consist of the identifier MysqlClient followed by these
1454 values:
1455 • SYSTEM_USER
1457 The operating system user name (login name) or -- if the user is
1459 unknown.
1460 • MYSQL_USER
1462 The MySQL user name (specified with the --user option) or -- if the
1464 user is unknown.
1465 • CONNECTION_ID:
1467 The client connection identifier. This is the same as the
1469 CONNECTION_ID() function value within the session.
1470 • DB_SERVER
1472 The server host or -- if the host is unknown.
1474 • DB
1476 The default database or -- if no database has been selected.
1478 • QUERY
1480 The text of the logged statement.
1482 Here is a sample of output generated on Linux by using --syslog. This
1484 output is formatted for readability; each logged message actually takes
1485 a single line.
1486 Mar 7 12:39:25 myhost MysqlClient[20824]:
1488 SYSTEM_USER:'oscar', MYSQL_USER:'my_oscar', CONNECTION_ID:23,
1489 DB_SERVER:'127.0.0.1', DB:'--', QUERY:'USE test;'
1490 Mar 7 12:39:28 myhost MysqlClient[20824]:
1491 SYSTEM_USER:'oscar', MYSQL_USER:'my_oscar', CONNECTION_ID:23,
1492 DB_SERVER:'127.0.0.1', DB:'test', QUERY:'SHOW TABLES;'
1493
1495 mysql> help search_string
1496 If you provide an argument to the help command, mysql uses it as a
1498 search string to access server-side help from the contents of the MySQL
1499 Reference Manual. The proper operation of this command requires that
1500 the help tables in the mysql database be initialized with help topic
1501 information (see Section 5.1.17, “Server-Side Help Support”).
1502 If there is no match for the search string, the search fails:
1504 mysql> help me
1506 Nothing found
1507 Please try to run 'help contents' for a list of all accessible topics
1508 Use help contents to see a list of the help categories:
1510 mysql> help contents
1512 You asked for help about help category: "Contents"
1513 For more information, type 'help <item>', where <item> is one of the
1514 following categories:
1515 Account Management
1516 Administration
1517 Data Definition
1518 Data Manipulation
1519 Data Types
1520 Functions
1521 Functions and Modifiers for Use with GROUP BY
1522 Geographic Features
1523 Language Structure
1524 Plugins
1525 Storage Engines
1526 Stored Routines
1527 Table Maintenance
1528 Transactions
1529 Triggers
1530 If the search string matches multiple items, mysql shows a list of
1532 matching topics:
1533 mysql> help logs
1535 Many help items for your request exist.
1536 To make a more specific request, please type 'help <item>',
1537 where <item> is one of the following topics:
1538 SHOW
1539 SHOW BINARY LOGS
1540 SHOW ENGINE
1541 SHOW LOGS
1542 Use a topic as the search string to see the help entry for that topic:
1544 mysql> help show binary logs
1546 Name: 'SHOW BINARY LOGS'
1547 Description:
1548 Syntax:
1549 SHOW BINARY LOGS
1550 SHOW MASTER LOGS
1551 Lists the binary log files on the server. This statement is used as
1552 part of the procedure described in [purge-binary-logs], that shows how
1553 to determine which logs can be purged.
1554 mysql> SHOW BINARY LOGS;
1555 +---------------+-----------+-----------+
1556 | Log_name | File_size | Encrypted |
1557 +---------------+-----------+-----------+
1558 | binlog.000015 | 724935 | Yes |
1559 | binlog.000016 | 733481 | Yes |
1560 +---------------+-----------+-----------+
1561 The search string can contain the wildcard characters % and _. These
1563 have the same meaning as for pattern-matching operations performed with
1564 the LIKE operator. For example, HELP rep% returns a list of topics that
1565 begin with rep:
1566 mysql> HELP rep%
1568 Many help items for your request exist.
1569 To make a more specific request, please type 'help <item>',
1570 where <item> is one of the following
1571 topics:
1572 REPAIR TABLE
1573 REPEAT FUNCTION
1574 REPEAT LOOP
1575 REPLACE
1576 REPLACE FUNCTION
1577
1579 The mysql client typically is used interactively, like this:
1580 mysql db_name
1582 However, it is also possible to put your SQL statements in a file and
1584 then tell mysql to read its input from that file. To do so, create a
1585 text file text_file that contains the statements you wish to execute.
1586 Then invoke mysql as shown here:
1587 mysql db_name < text_file
1589 If you place a USE db_name statement as the first statement in the
1591 file, it is unnecessary to specify the database name on the command
1592 line:
1593 mysql < text_file
1595 If you are already running mysql, you can execute an SQL script file
1597 using the source command or \. command:
1598 mysql> source file_name
1600 mysql> \. file_name
1601 Sometimes you may want your script to display progress information to
1603 the user. For this you can insert statements like this:
1604 SELECT '<info_to_display>' AS ' ';
1606 The statement shown outputs <info_to_display>.
1608 You can also invoke mysql with the --verbose option, which causes each
1610 statement to be displayed before the result that it produces.
1611 mysql ignores Unicode byte order mark (BOM) characters at the beginning
1613 of input files. Previously, it read them and sent them to the server,
1614 resulting in a syntax error. Presence of a BOM does not cause mysql to
1615 change its default character set. To do that, invoke mysql with an
1616 option such as --default-character-set=utf8.
1617 For more information about batch mode, see Section 3.5, “Using mysql in
1619 Batch Mode”.
1620
1622 This section provides information about techniques for more effective
1623 use of mysql and about mysql operational behavior.
1624 • Input-Line Editing
1626 • Disabling Interactive History
1628 • Unicode Support on Windows
1630 • Displaying Query Results Vertically
1632 • Using Safe-Updates Mode (--safe-updates)
1634 • Disabling mysql Auto-Reconnect
1636 • mysql Client Parser Versus Server Parser
1638 Input-Line Editing
1639 mysql supports input-line editing, which enables you to modify the
1641 current input line in place or recall previous input lines. For
1642 example, the left-arrow and right-arrow keys move horizontally within
1643 the current input line, and the up-arrow and down-arrow keys move up
1644 and down through the set of previously entered lines. Backspace
1645 deletes the character before the cursor and typing new characters
1646 enters them at the cursor position. To enter the line, press Enter.
1647 On Windows, the editing key sequences are the same as supported for
1649 command editing in console windows. On Unix, the key sequences depend
1650 on the input library used to build mysql (for example, the libedit or
1651 readline library).
1652 Documentation for the libedit and readline libraries is available
1654 online. To change the set of key sequences permitted by a given input
1655 library, define key bindings in the library startup file. This is a
1656 file in your home directory: .editrc for libedit and .inputrc for
1657 readline.
1658 For example, in libedit, Control+W deletes everything before the
1660 current cursor position and Control+U deletes the entire line. In
1661 readline, Control+W deletes the word before the cursor and Control+U
1662 deletes everything before the current cursor position. If mysql was
1663 built using libedit, a user who prefers the readline behavior for these
1664 two keys can put the following lines in the .editrc file (creating the
1665 file if necessary):
1666 bind "^W" ed-delete-prev-word
1668 bind "^U" vi-kill-line-prev
1669 To see the current set of key bindings, temporarily put a line that
1671 says only bind at the end of .editrc. mysql shows the bindings when it
1672 starts. Disabling Interactive History
1673 The up-arrow key enables you to recall input lines from current and
1675 previous sessions. In cases where a console is shared, this behavior
1676 may be unsuitable. mysql supports disabling the interactive history
1677 partially or fully, depending on the host platform.
1678 On Windows, the history is stored in memory. Alt+F7 deletes all input
1680 lines stored in memory for the current history buffer. It also deletes
1681 the list of sequential numbers in front of the input lines displayed
1682 with F7 and recalled (by number) with F9. New input lines entered after
1683 you press Alt+F7 repopulate the current history buffer. Clearing the
1684 buffer does not prevent logging to the Windows Event Viewer, if the
1685 --syslog option was used to start mysql. Closing the console window
1686 also clears the current history buffer.
1687 To disable interactive history on Unix, first delete the .mysql_history
1689 file, if it exists (previous entries are recalled otherwise). Then
1690 start mysql with the --histignore="*" option to ignore all new input
1691 lines. To re-enable the recall (and logging) behavior, restart mysql
1692 without the option.
1693 If you prevent the .mysql_history file from being created (see
1695 Controlling the History File) and use --histignore="*" to start the
1696 mysql client, the interactive history recall facility is disabled
1697 fully. Alternatively, if you omit the --histignore option, you can
1698 recall the input lines entered during the current session. Unicode
1699 Support on Windows
1700 Windows provides APIs based on UTF-16LE for reading from and writing to
1702 the console; the mysql client for Windows is able to use these APIs.
1703 The Windows installer creates an item in the MySQL menu named MySQL
1704 command line client - Unicode. This item invokes the mysql client with
1705 properties set to communicate through the console to the MySQL server
1706 using Unicode.
1707 To take advantage of this support manually, run mysql within a console
1709 that uses a compatible Unicode font and set the default character set
1710 to a Unicode character set that is supported for communication with the
1711 server:
1712 1. Open a console window.
1714 2. Go to the console window properties, select the font tab, and
1716 choose Lucida Console or some other compatible Unicode font. This
1717 is necessary because console windows start by default using a DOS
1718 raster font that is inadequate for Unicode.
1719 3. Execute mysql.exe with the --default-character-set=utf8 (or
1721 utf8mb4) option. This option is necessary because utf16le is one of
1722 the character sets that cannot be used as the client character set.
1723 See the section called “Impermissible Client Character Sets”.
1724 With those changes, mysql uses the Windows APIs to communicate with the
1726 console using UTF-16LE, and communicate with the server using UTF-8.
1727 (The menu item mentioned previously sets the font and character set as
1728 just described.)
1729 To avoid those steps each time you run mysql, you can create a shortcut
1731 that invokes mysql.exe. The shortcut should set the console font to
1732 Lucida Console or some other compatible Unicode font, and pass the
1733 --default-character-set=utf8 (or utf8mb4) option to mysql.exe.
1734 Alternatively, create a shortcut that only sets the console font, and
1736 set the character set in the [mysql] group of your my.ini file:
1737 [mysql]
1739 default-character-set=utf8
1740 Displaying Query Results Vertically
1742 Some query results are much more readable when displayed vertically,
1744 instead of in the usual horizontal table format. Queries can be
1745 displayed vertically by terminating the query with \G instead of a
1746 semicolon. For example, longer text values that include newlines often
1747 are much easier to read with vertical output:
1748 mysql> SELECT * FROM mails WHERE LENGTH(txt) < 300 LIMIT 300,1\G
1750 *************************** 1. row ***************************
1751 msg_nro: 3068
1752 date: 2000-03-01 23:29:50
1753 time_zone: +0200
1754 mail_from: Jones
1755 reply: jones@example.com
1756 mail_to: "John Smith" <smith@example.com>
1757 sbj: UTF-8
1758 txt: >>>>> "John" == John Smith writes:
1759 John> Hi. I think this is a good idea. Is anyone familiar
1760 John> with UTF-8 or Unicode? Otherwise, I'll put this on my
1761 John> TODO list and see what happens.
1762 Yes, please do that.
1763 Regards,
1764 Jones
1765 file: inbox-jani-1
1766 hash: 190402944
1767 1 row in set (0.09 sec)
1768 Using Safe-Updates Mode (--safe-updates)
1770 For beginners, a useful startup option is --safe-updates (or
1772 --i-am-a-dummy, which has the same effect). Safe-updates mode is
1773 helpful for cases when you might have issued an UPDATE or DELETE
1774 statement but forgotten the WHERE clause indicating which rows to
1775 modify. Normally, such statements update or delete all rows in the
1776 table. With --safe-updates, you can modify rows only by specifying the
1777 key values that identify them, or a LIMIT clause, or both. This helps
1778 prevent accidents. Safe-updates mode also restricts SELECT statements
1779 that produce (or are estimated to produce) very large result sets.
1780 The --safe-updates option causes mysql to execute the following
1782 statement when it connects to the MySQL server, to set the session
1783 values of the sql_safe_updates, sql_select_limit, and max_join_size
1784 system variables:
1785 SET sql_safe_updates=1, sql_select_limit=1000, max_join_size=1000000;
1787 The SET statement affects statement processing as follows:
1789 • Enabling sql_safe_updates causes UPDATE and DELETE statements to
1791 produce an error if they do not specify a key constraint in the
1792 WHERE clause, or provide a LIMIT clause, or both. For example:
1793 UPDATE tbl_name SET not_key_column=val WHERE key_column=val;
1795 UPDATE tbl_name SET not_key_column=val LIMIT 1;
1796 • Setting sql_select_limit to 1,000 causes the server to limit all
1798 SELECT result sets to 1,000 rows unless the statement includes a
1799 LIMIT clause.
1800 • Setting max_join_size to 1,000,000 causes multiple-table SELECT
1802 statements to produce an error if the server estimates it must
1803 examine more than 1,000,000 row combinations.
1804 To specify result set limits different from 1,000 and 1,000,000, you
1806 can override the defaults by using the --select-limit and
1807 --max-join-size options when you invoke mysql:
1808 mysql --safe-updates --select-limit=500 --max-join-size=10000
1810 It is possible for UPDATE and DELETE statements to produce an error in
1812 safe-updates mode even with a key specified in the WHERE clause, if the
1813 optimizer decides not to use the index on the key column:
1814 • Range access on the index cannot be used if memory usage exceeds
1816 that permitted by the range_optimizer_max_mem_size system variable.
1817 The optimizer then falls back to a table scan. See the section
1818 called “Limiting Memory Use for Range Optimization”.
1819 • If key comparisons require type conversion, the index may not be
1821 used (see Section 8.3.1, “How MySQL Uses Indexes”). Suppose that an
1822 indexed string column c1 is compared to a numeric value using WHERE
1823 c1 = 2222. For such comparisons, the string value is converted to a
1824 number and the operands are compared numerically (see Section 12.3,
1825 “Type Conversion in Expression Evaluation”), preventing use of the
1826 index. If safe-updates mode is enabled, an error occurs.
1827 As of MySQL 8.0.13, safe-updates mode also includes these behaviors:
1829 • EXPLAIN with UPDATE and DELETE statements does not produce
1831 safe-updates errors. This enables use of EXPLAIN plus SHOW WARNINGS
1832 to see why an index is not used, which can be helpful in cases such
1833 as when a range_optimizer_max_mem_size violation or type conversion
1834 occurs and the optimizer does not use an index even though a key
1835 column was specified in the WHERE clause.
1836 • When a safe-updates error occurs, the error message includes the
1838 first diagnostic that was produced, to provide information about
1839 the reason for failure. For example, the message may indicate that
1840 the range_optimizer_max_mem_size value was exceeded or type
1841 conversion occurred, either of which can preclude use of an index.
1842 • For multiple-table deletes and updates, an error is produced with
1844 safe updates enabled only if any target table uses a table scan.
1845 Disabling mysql Auto-Reconnect
1846 If the mysql client loses its connection to the server while sending a
1848 statement, it immediately and automatically tries to reconnect once to
1849 the server and send the statement again. However, even if mysql
1850 succeeds in reconnecting, your first connection has ended and all your
1851 previous session objects and settings are lost: temporary tables, the
1852 autocommit mode, and user-defined and session variables. Also, any
1853 current transaction rolls back. This behavior may be dangerous for you,
1854 as in the following example where the server was shut down and
1855 restarted between the first and second statements without you knowing
1856 it:
1857 mysql> SET @a=1;
1859 Query OK, 0 rows affected (0.05 sec)
1860 mysql> INSERT INTO t VALUES(@a);
1861 ERROR 2006: MySQL server has gone away
1862 No connection. Trying to reconnect...
1863 Connection id: 1
1864 Current database: test
1865 Query OK, 1 row affected (1.30 sec)
1866 mysql> SELECT * FROM t;
1867 +------+
1868 | a |
1869 +------+
1870 | NULL |
1871 +------+
1872 1 row in set (0.05 sec)
1873 The @a user variable has been lost with the connection, and after the
1875 reconnection it is undefined. If it is important to have mysql
1876 terminate with an error if the connection has been lost, you can start
1877 the mysql client with the --skip-reconnect option.
1878 For more information about auto-reconnect and its effect on state
1880 information when a reconnection occurs, see Automatic Reconnection
1881 Control[5]. mysql Client Parser Versus Server Parser
1882 The mysql client uses a parser on the client side that is not a
1884 duplicate of the complete parser used by the mysqld server on the
1885 server side. This can lead to differences in treatment of certain
1886 constructs. Examples:
1887 • The server parser treats strings delimited by " characters as
1889 identifiers rather than as plain strings if the ANSI_QUOTES SQL
1890 mode is enabled.
1891 The mysql client parser does not take the ANSI_QUOTES SQL mode into
1893 account. It treats strings delimited by ", ', and ` characters the
1894 same, regardless of whether ANSI_QUOTES is enabled.
1895 • Within /*! ... */ and /*+ ... */ comments, the mysql client parser
1897 interprets short-form mysql commands. The server parser does not
1898 interpret them because these commands have no meaning on the server
1899 side.
1900 If it is desirable for mysql not to interpret short-form commands
1902 within comments, a partial workaround is to use the --binary-mode
1903 option, which causes all mysql commands to be disabled except \C
1904 and \d in noninteractive mode (for input piped to mysql or loaded
1905 using the source command).
1906
1908 Copyright © 1997, 2021, Oracle and/or its affiliates.
1909 This documentation is free software; you can redistribute it and/or
1911 modify it only under the terms of the GNU General Public License as
1912 published by the Free Software Foundation; version 2 of the License.
1913 This documentation is distributed in the hope that it will be useful,
1915 but WITHOUT ANY WARRANTY; without even the implied warranty of
1916 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
1917 General Public License for more details.
1918 You should have received a copy of the GNU General Public License along
1920 with the program; if not, write to the Free Software Foundation, Inc.,
1921 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA or see
1922 http://www.gnu.org/licenses/.
1923
1926 1. MySQL Shell 8.0
1927 https://dev.mysql.com/doc/mysql-shell/8.0/en/
1928 2. C API Basic Data Structures
1930 https://dev.mysql.com/doc/c-api/8.0/en/c-api-data-structures.html
1931 3. Multiple Statement Execution Support
1933 https://dev.mysql.com/doc/c-api/8.0/en/c-api-multiple-queries.html
1934 4. mysql_change_user()
1936 https://dev.mysql.com/doc/c-api/8.0/en/mysql-change-user.html
1937 5. Automatic Reconnection Control
1939 https://dev.mysql.com/doc/c-api/8.0/en/c-api-auto-reconnect.html
1940
1942 For more information, please refer to the MySQL Reference Manual, which
1943 may already be installed locally and which is also available online at
1944 http://dev.mysql.com/doc/.
1945
1947 Oracle Corporation (http://dev.mysql.com/).
1948MySQL 8.0 09/04/2021 MYSQL(1)