Skip to content

Commit 705a6be

Browse files
committed
Updating man pages from Docs
Approved-by: Bjorn Munch <bjorn.munch@oracle.com>
1 parent b2344c7 commit 705a6be

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

68 files changed

+4530
-2824
lines changed

man/comp_err.1

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
.\" Title: \fBcomp_err\fR
33
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
44
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
5-
.\" Date: 09/04/2020
5+
.\" Date: 11/26/2020
66
.\" Manual: MySQL Database System
77
.\" Source: MySQL 8.0
88
.\" Language: English
99
.\"
10-
.TH "\FBCOMP_ERR\FR" "1" "09/04/2020" "MySQL 8\&.0" "MySQL Database System"
10+
.TH "\FBCOMP_ERR\FR" "1" "11/26/2020" "MySQL 8\&.0" "MySQL Database System"
1111
.\" -----------------------------------------------------------------
1212
.\" * Define some portability stuff
1313
.\" -----------------------------------------------------------------

man/ibd2sdi.1

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
.\" Title: \fBibd2sdi\fR
33
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
44
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
5-
.\" Date: 09/04/2020
5+
.\" Date: 11/26/2020
66
.\" Manual: MySQL Database System
77
.\" Source: MySQL 8.0
88
.\" Language: English
99
.\"
10-
.TH "\FBIBD2SDI\FR" "1" "09/04/2020" "MySQL 8\&.0" "MySQL Database System"
10+
.TH "\FBIBD2SDI\FR" "1" "11/26/2020" "MySQL 8\&.0" "MySQL Database System"
1111
.\" -----------------------------------------------------------------
1212
.\" * Define some portability stuff
1313
.\" -----------------------------------------------------------------

man/innochecksum.1

+7-7
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
.\" Title: \fBinnochecksum\fR
33
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
44
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
5-
.\" Date: 09/04/2020
5+
.\" Date: 11/26/2020
66
.\" Manual: MySQL Database System
77
.\" Source: MySQL 8.0
88
.\" Language: English
99
.\"
10-
.TH "\FBINNOCHECKSUM\FR" "1" "09/04/2020" "MySQL 8\&.0" "MySQL Database System"
10+
.TH "\FBINNOCHECKSUM\FR" "1" "11/26/2020" "MySQL 8\&.0" "MySQL Database System"
1111
.\" -----------------------------------------------------------------
1212
.\" * Define some portability stuff
1313
.\" -----------------------------------------------------------------
@@ -48,11 +48,11 @@ cannot be used on tablespace files that the server already has open\&. For such
4848
CHECK TABLE
4949
to check tables within the tablespace\&. Attempting to run
5050
\fBinnochecksum\fR
51-
on a tablespace that the server already has open will result in an
52-
\(lqUnable to lock file\(rq
51+
on a tablespace that the server already has open results in an
52+
Unable to lock file
5353
error\&.
5454
.PP
55-
If checksum mismatches are found, you would normally restore the tablespace from backup or start the server and attempt to use
55+
If checksum mismatches are found, restore the tablespace from backup or start the server and attempt to use
5656
\fBmysqldump\fR
5757
to make a backup of the tables within the tablespace\&.
5858
.PP
@@ -477,7 +477,7 @@ option\&. If the
477477
\fB\-\-write\fR
478478
option is not specified,
479479
\fBinnochecksum\fR
480-
will terminate\&.
480+
terminates\&.
481481
.sp
482482
In this example, an
483483
innodb
@@ -788,7 +788,7 @@ option is missing when
788788
\(lqread from standard in\(rq
789789
is expected,
790790
\fBinnochecksum\fR
791-
will output
791+
prints
792792
\fBinnochecksum\fR
793793
usage information indicating that the
794794
\(lq\-\(rq

man/lz4_decompress.1

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
.\" Title: \fBlz4_decompress\fR
33
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
44
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
5-
.\" Date: 09/04/2020
5+
.\" Date: 11/26/2020
66
.\" Manual: MySQL Database System
77
.\" Source: MySQL 8.0
88
.\" Language: English
99
.\"
10-
.TH "\FBLZ4_DECOMPRESS\FR" "1" "09/04/2020" "MySQL 8\&.0" "MySQL Database System"
10+
.TH "\FBLZ4_DECOMPRESS\FR" "1" "11/26/2020" "MySQL 8\&.0" "MySQL Database System"
1111
.\" -----------------------------------------------------------------
1212
.\" * Define some portability stuff
1313
.\" -----------------------------------------------------------------

man/my_print_defaults.1

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
.\" Title: \fBmy_print_defaults\fR
33
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
44
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
5-
.\" Date: 09/04/2020
5+
.\" Date: 11/26/2020
66
.\" Manual: MySQL Database System
77
.\" Source: MySQL 8.0
88
.\" Language: English
99
.\"
10-
.TH "\FBMY_PRINT_DEFAULTS\FR" "1" "09/04/2020" "MySQL 8\&.0" "MySQL Database System"
10+
.TH "\FBMY_PRINT_DEFAULTS\FR" "1" "11/26/2020" "MySQL 8\&.0" "MySQL Database System"
1111
.\" -----------------------------------------------------------------
1212
.\" * Define some portability stuff
1313
.\" -----------------------------------------------------------------
@@ -35,7 +35,7 @@ my_print_defaults \- display options from option files
3535
.SH "DESCRIPTION"
3636
.PP
3737
\fBmy_print_defaults\fR
38-
displays the options that are present in option groups of option files\&. The output indicates what options will be used by programs that read the specified option groups\&. For example, the
38+
displays the options that are present in option groups of option files\&. The output indicates what options are used by programs that read the specified option groups\&. For example, the
3939
\fBmysqlcheck\fR
4040
program reads the
4141
[mysqlcheck]

man/myisam_ftdump.1

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
.\" Title: \fBmyisam_ftdump\fR
33
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
44
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
5-
.\" Date: 09/04/2020
5+
.\" Date: 11/26/2020
66
.\" Manual: MySQL Database System
77
.\" Source: MySQL 8.0
88
.\" Language: English
99
.\"
10-
.TH "\FBMYISAM_FTDUMP\FR" "1" "09/04/2020" "MySQL 8\&.0" "MySQL Database System"
10+
.TH "\FBMYISAM_FTDUMP\FR" "1" "11/26/2020" "MySQL 8\&.0" "MySQL Database System"
1111
.\" -----------------------------------------------------------------
1212
.\" * Define some portability stuff
1313
.\" -----------------------------------------------------------------

man/myisamchk.1

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
.\" Title: \fBmyisamchk\fR
33
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
44
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
5-
.\" Date: 09/04/2020
5+
.\" Date: 11/26/2020
66
.\" Manual: MySQL Database System
77
.\" Source: MySQL 8.0
88
.\" Language: English
99
.\"
10-
.TH "\FBMYISAMCHK\FR" "1" "09/04/2020" "MySQL 8\&.0" "MySQL Database System"
10+
.TH "\FBMYISAMCHK\FR" "1" "11/26/2020" "MySQL 8\&.0" "MySQL Database System"
1111
.\" -----------------------------------------------------------------
1212
.\" * Define some portability stuff
1313
.\" -----------------------------------------------------------------

man/myisamlog.1

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
.\" Title: \fBmyisamlog\fR
33
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
44
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
5-
.\" Date: 09/04/2020
5+
.\" Date: 11/26/2020
66
.\" Manual: MySQL Database System
77
.\" Source: MySQL 8.0
88
.\" Language: English
99
.\"
10-
.TH "\FBMYISAMLOG\FR" "1" "09/04/2020" "MySQL 8\&.0" "MySQL Database System"
10+
.TH "\FBMYISAMLOG\FR" "1" "11/26/2020" "MySQL 8\&.0" "MySQL Database System"
1111
.\" -----------------------------------------------------------------
1212
.\" * Define some portability stuff
1313
.\" -----------------------------------------------------------------

man/myisampack.1

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
.\" Title: \fBmyisampack\fR
33
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
44
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
5-
.\" Date: 09/04/2020
5+
.\" Date: 11/26/2020
66
.\" Manual: MySQL Database System
77
.\" Source: MySQL 8.0
88
.\" Language: English
99
.\"
10-
.TH "\FBMYISAMPACK\FR" "1" "09/04/2020" "MySQL 8\&.0" "MySQL Database System"
10+
.TH "\FBMYISAMPACK\FR" "1" "11/26/2020" "MySQL 8\&.0" "MySQL Database System"
1111
.\" -----------------------------------------------------------------
1212
.\" * Define some portability stuff
1313
.\" -----------------------------------------------------------------

man/mysql.1

+124-10
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
.\" Title: \fBmysql\fR
33
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
44
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
5-
.\" Date: 09/04/2020
5+
.\" Date: 11/26/2020
66
.\" Manual: MySQL Database System
77
.\" Source: MySQL 8.0
88
.\" Language: English
99
.\"
10-
.TH "\FBMYSQL\FR" "1" "09/04/2020" "MySQL 8\&.0" "MySQL Database System"
10+
.TH "\FBMYSQL\FR" "1" "11/26/2020" "MySQL 8\&.0" "MySQL Database System"
1111
.\" -----------------------------------------------------------------
1212
.\" * Define some portability stuff
1313
.\" -----------------------------------------------------------------
@@ -493,7 +493,7 @@ The
493493
\fBmysql\fR
494494
client always passes optimizer hints to the server, regardless of whether this option is given\&.
495495
.sp
496-
Comment stripping is deprecated\&. This feature and the options to control it will be removed in a future MySQL release\&.
496+
Comment stripping is deprecated\&. Expect this feature and the options to control it to be removed in a future MySQL release\&.
497497
.sp .5v
498498
.RE
499499
.RE
@@ -511,7 +511,7 @@ Comment stripping is deprecated\&. This feature and the options to control it wi
511511
Compress all information sent between the client and the server if possible\&. See
512512
Section\ \&4.2.8, \(lqConnection Compression Control\(rq\&.
513513
.sp
514-
As of MySQL 8\&.0\&.18, this option is deprecated\&. It will be removed in a future MySQL version\&. See
514+
As of MySQL 8\&.0\&.18, this option is deprecated\&. Expect it be removed in a future version of MySQL\&. See
515515
the section called \(lqConfiguring Legacy Connection Compression\(rq\&.
516516
.RE
517517
.sp
@@ -1229,6 +1229,21 @@ The buffer size for TCP/IP and socket communication\&. (Default value is 16KB\&.
12291229
.sp -1
12301230
.IP \(bu 2.3
12311231
.\}
1232+
\fB\-\-network\-namespace=\fR\fB\fIname\fR\fR
1233+
The network namespace to use for TCP/IP connections\&. If omitted, the connection uses the default (global) namespace\&. For information about network namespaces, see
1234+
Section\ \&5.1.14, \(lqNetwork Namespace Support\(rq\&.
1235+
.sp
1236+
This option was added in MySQL 8\&.0\&.22\&. It is available only on platforms that implement network namespace support\&.
1237+
.RE
1238+
.sp
1239+
.RS 4
1240+
.ie n \{\
1241+
\h'-04'\(bu\h'+03'\c
1242+
.\}
1243+
.el \{\
1244+
.sp -1
1245+
.IP \(bu 2.3
1246+
.\}
12321247
\fB\-\-no\-auto\-rehash\fR,
12331248
\fB\-A\fR
12341249
This has the same effect as
@@ -2181,6 +2196,8 @@ charset (\eC) Switch to another charset\&. Might be needed for processing
21812196
warnings (\eW) Show warnings after every statement\&.
21822197
nowarning (\ew) Don\*(Aqt show warnings after every statement\&.
21832198
resetconnection(\ex) Clean session context\&.
2199+
query_attributes(\e) Sets string parameters (name1 value1 name2 value2 \&.\&.\&.)
2200+
for the next query to pick up\&.
21842201
For server side help, type \*(Aqhelp contents\*(Aq
21852202
.fi
21862203
.if n \{\
@@ -2320,7 +2337,7 @@ command line\&. Quoting can be done with either single quote (\*(Aq), double quo
23202337
.sp
23212338
\fBmysql\fR
23222339
interprets instances of the delimiter string as a statement delimiter anywhere it occurs, except within quoted strings\&. Be careful about defining a delimiter that might occur within other words\&. For example, if you define the delimiter as
2323-
X, you will be unable to use the word
2340+
X, it is not possible to use the word
23242341
INDEX
23252342
in statements\&.
23262343
\fBmysql\fR
@@ -2336,7 +2353,7 @@ is set to something other than the default of
23362353
;
23372354
as a statement delimiter and processes statements accordingly\&. This behavior on the server side comes into play for multiple\-statement execution (see
23382355
\m[blue]\fBC API Multiple Statement Execution Support\fR\m[]\&\s-2\u[3]\d\s+2), and for parsing the body of stored procedures and functions, triggers, and events (see
2339-
Section\ \&24.1, \(lqDefining Stored Programs\(rq)\&.
2356+
Section\ \&25.1, \(lqDefining Stored Programs\(rq)\&.
23402357
.RE
23412358
.sp
23422359
.RS 4
@@ -2539,6 +2556,101 @@ mysql>\&.
25392556
.sp -1
25402557
.IP \(bu 2.3
25412558
.\}
2559+
query_attributes \fIname\fR \fIvalue\fR [\fIname\fR \fIvalue\fR \&.\&.\&.]
2560+
.sp
2561+
Define query attributes that apply to the next query sent to the server\&. For discussion of the purpose and use of query attributes, see
2562+
Section\ \&9.6, \(lqQuery Attributes\(rq\&.
2563+
.sp
2564+
The
2565+
query_attributes
2566+
command follows these rules:
2567+
.sp
2568+
.RS 4
2569+
.ie n \{\
2570+
\h'-04'\(bu\h'+03'\c
2571+
.\}
2572+
.el \{\
2573+
.sp -1
2574+
.IP \(bu 2.3
2575+
.\}
2576+
The format and quoting rules for attribute names and values are the same as for the
2577+
delimiter
2578+
command\&.
2579+
.RE
2580+
.sp
2581+
.RS 4
2582+
.ie n \{\
2583+
\h'-04'\(bu\h'+03'\c
2584+
.\}
2585+
.el \{\
2586+
.sp -1
2587+
.IP \(bu 2.3
2588+
.\}
2589+
The command permits up to 32 attribute name/value pairs\&. Names and values may be up to 1024 characters long\&. If a name is given without a value, an error occurs\&.
2590+
.RE
2591+
.sp
2592+
.RS 4
2593+
.ie n \{\
2594+
\h'-04'\(bu\h'+03'\c
2595+
.\}
2596+
.el \{\
2597+
.sp -1
2598+
.IP \(bu 2.3
2599+
.\}
2600+
If multiple
2601+
query_attributes
2602+
commands are issued prior to query execution, only the last command applies\&. After sending the query,
2603+
\fBmysql\fR
2604+
clears the attribute set\&.
2605+
.RE
2606+
.sp
2607+
.RS 4
2608+
.ie n \{\
2609+
\h'-04'\(bu\h'+03'\c
2610+
.\}
2611+
.el \{\
2612+
.sp -1
2613+
.IP \(bu 2.3
2614+
.\}
2615+
If multiple attributes are defined with the same name, attempts to retrieve the attribute value have an undefined result\&.
2616+
.RE
2617+
.sp
2618+
.RS 4
2619+
.ie n \{\
2620+
\h'-04'\(bu\h'+03'\c
2621+
.\}
2622+
.el \{\
2623+
.sp -1
2624+
.IP \(bu 2.3
2625+
.\}
2626+
An attribute defined with an empty name cannot be retrieved by name\&.
2627+
.RE
2628+
.sp
2629+
.RS 4
2630+
.ie n \{\
2631+
\h'-04'\(bu\h'+03'\c
2632+
.\}
2633+
.el \{\
2634+
.sp -1
2635+
.IP \(bu 2.3
2636+
.\}
2637+
If a reconnect occurs while
2638+
\fBmysql\fR
2639+
executes the query,
2640+
\fBmysql\fR
2641+
restores the attributes after reconnecting so the query can be executed again with the same attributes\&.
2642+
.sp
2643+
.RE
2644+
.RE
2645+
.sp
2646+
.RS 4
2647+
.ie n \{\
2648+
\h'-04'\(bu\h'+03'\c
2649+
.\}
2650+
.el \{\
2651+
.sp -1
2652+
.IP \(bu 2.3
2653+
.\}
25422654
quit,
25432655
\eq
25442656
.sp
@@ -2573,7 +2685,9 @@ option\&.)
25732685
resetconnection,
25742686
\ex
25752687
.sp
2576-
Reset the connection to clear the session state\&.
2688+
Reset the connection to clear the session state\&. This includes clearing any current query attributes defined using the
2689+
query_attributes
2690+
command\&.
25772691
.sp
25782692
Resetting a connection has effects similar to
25792693
mysql_change_user()
@@ -3653,7 +3767,7 @@ command,
36533767
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
36543768
mysql
36553769
database be initialized with help topic information (see
3656-
Section\ \&5.1.16, \(lqServer-Side Help Support\(rq)\&.
3770+
Section\ \&5.1.17, \(lqServer-Side Help Support\(rq)\&.
36573771
.PP
36583772
If there is no match for the search string, the search fails:
36593773
.sp
@@ -4030,7 +4144,7 @@ bind
40304144
at the end of
40314145
\&.editrc\&.
40324146
\fBmysql\fR
4033-
will show the bindings when it starts\&.
4147+
shows the bindings when it starts\&.
40344148
Disabling Interactive History
40354149
.PP
40364150
The
@@ -4127,7 +4241,7 @@ the section called \(lqImpermissible Client Character Sets\(rq\&.
41274241
.PP
41284242
With those changes,
41294243
\fBmysql\fR
4130-
will use the Windows APIs to communicate with the console using UTF\-16LE, and communicate with the server using UTF\-8\&. (The menu item mentioned previously sets the font and character set as just described\&.)
4244+
uses the Windows APIs to communicate with the console using UTF\-16LE, and communicate with the server using UTF\-8\&. (The menu item mentioned previously sets the font and character set as just described\&.)
41314245
.PP
41324246
To avoid those steps each time you run
41334247
\fBmysql\fR, you can create a shortcut that invokes

0 commit comments

Comments
 (0)