Skip to content

Commit 0c2757c

Browse files
bjornmubjornmu
committed
Updating man pages from Docs
Approved-by: Erlend Dahl <erlend.dahl@oracle.com>
1 parent da86040 commit 0c2757c

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

+467
-403
lines changed

‎man/comp_err.1

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
.\" Title: comp_err
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: 05/23/2023
5+
.\" Date: 06/02/2023
66
.\" Manual: MySQL Database System
77
.\" Source: MySQL 8.1
88
.\" Language: English
99
.\"
10-
.TH "COMP_ERR" "1" "05/23/2023" "MySQL 8\&.1" "MySQL Database System"
10+
.TH "COMP_ERR" "1" "06/02/2023" "MySQL 8\&.1" "MySQL Database System"
1111
.\" -----------------------------------------------------------------
1212
.\" * Define some portability stuff
1313
.\" -----------------------------------------------------------------

‎man/ibd2sdi.1

Lines changed: 82 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
.\" Title: ibd2sdi
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: 05/23/2023
5+
.\" Date: 06/02/2023
66
.\" Manual: MySQL Database System
77
.\" Source: MySQL 8.1
88
.\" Language: English
99
.\"
10-
.TH "IBD2SDI" "1" "05/23/2023" "MySQL 8\&.1" "MySQL Database System"
10+
.TH "IBD2SDI" "1" "06/02/2023" "MySQL 8\&.1" "MySQL Database System"
1111
.\" -----------------------------------------------------------------
1212
.\" * Define some portability stuff
1313
.\" -----------------------------------------------------------------
@@ -348,11 +348,17 @@ $> \fBibd2sdi \-\-id=7 \&.\&./data/test/t1\&.ibd\fR
348348
\fB\-t \fR\fB\fI#\fR\fR
349349
Retrieves serialized dictionary information (SDI) matching the specified object type\&. SDI is provided for table (type=1) and tablespace (type=2) objects\&.
350350
.sp
351+
This example show output for a tablespace
352+
ts1
353+
in the
354+
test
355+
database:
356+
.sp
351357
.if n \{\
352358
.RS 4
353359
.\}
354360
.nf
355-
$> \fBibd2sdi \-\-type=2 \&.\&./data/test/t1\&.ibd\fR
361+
$> \fBibd2sdi \-\-type=2 \&.\&./data/test/ts1\&.ibd\fR
356362
["ibd2sdi"
357363
,
358364
{
@@ -365,15 +371,15 @@ $> \fBibd2sdi \-\-type=2 \&.\&./data/test/t1\&.ibd\fR
365371
"sdi_version": 1,
366372
"dd_object_type": "Tablespace",
367373
"dd_object": {
368-
"name": "test/t1",
374+
"name": "test/ts1",
369375
"comment": "",
370376
"options": "",
371377
"se_private_data": "flags=16417;id=2;server_version=80003;space_version=1;",
372378
"engine": "InnoDB",
373379
"files": [
374380
{
375381
"ordinal_position": 1,
376-
"filename": "\&./test/t1\&.ibd",
382+
"filename": "\&./test/ts1\&.ibd",
377383
"se_private_data": "id=2;"
378384
}
379385
]
@@ -385,6 +391,66 @@ $> \fBibd2sdi \-\-type=2 \&.\&./data/test/t1\&.ibd\fR
385391
.if n \{\
386392
.RE
387393
.\}
394+
.sp
395+
Due to the way in which
396+
InnoDB
397+
handles default value metadata, a default value may be present and non\-empty in
398+
\fBibd2sdi\fR
399+
output for a given table column even if it is not defined using
400+
DEFAULT\&. Consider the two tables created using the following statements, in the database named
401+
i:
402+
.sp
403+
.if n \{\
404+
.RS 4
405+
.\}
406+
.nf
407+
CREATE TABLE t1 (c VARCHAR(16) NOT NULL);
408+
CREATE TABLE t2 (c VARCHAR(16) NOT NULL DEFAULT "Sakila");
409+
.fi
410+
.if n \{\
411+
.RE
412+
.\}
413+
.sp
414+
Using
415+
\fBibd2sdi\fR, we can see that the
416+
default_value
417+
for column
418+
c
419+
is nonempty and is in fact padded to length in both tables, like this:
420+
.sp
421+
.if n \{\
422+
.RS 4
423+
.\}
424+
.nf
425+
$> \fBibd2sdi \&.\&./data/i/t1\&.ibd | grep \-m1 \*(Aq\e"default_value\e"\*(Aq | cut \-b34\- | sed \-e s/,//\fR
426+
"AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\enAAAAAAAAAAA="
427+
$> \fBibd2sdi \&.\&./data/i/t2\&.ibd | grep \-m1 \*(Aq\e"default_value\e"\*(Aq | cut \-b34\- | sed \-e s/,//\fR
428+
"BlNha2lsYQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\enAAAAAAAAAAA="
429+
.fi
430+
.if n \{\
431+
.RE
432+
.\}
433+
.sp
434+
Examination of
435+
\fBibd2sdi\fR
436+
output may be easier using a JSON\-aware utility like
437+
\fB\m[blue]\fBjq\fR\m[]\&\s-2\u[1]\d\s+2\fR, as shown here:
438+
.sp
439+
.if n \{\
440+
.RS 4
441+
.\}
442+
.nf
443+
$> \fBibd2sdi \&.\&./data/i/t1\&.ibd | jq \*(Aq\&.[1]["object"]["dd_object"]["columns"][0]["default_value"]\*(Aq\fR
444+
"AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\enAAAAAAAAAAA="
445+
$> \fBibd2sdi \&.\&./data/i/t2\&.ibd | jq \*(Aq\&.[1]["object"]["dd_object"]["columns"][0]["default_value"]\*(Aq\fR
446+
"BlNha2lsYQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\enAAAAAAAAAAA="
447+
.fi
448+
.if n \{\
449+
.RE
450+
.\}
451+
.sp
452+
For more information, see the
453+
\m[blue]\fBMySQL Internals documentation\fR\m[]\&\s-2\u[2]\d\s+2\&.
388454
.RE
389455
.sp
390456
.RS 4
@@ -498,6 +564,17 @@ This documentation is distributed in the hope that it will be useful, but WITHOU
498564
.PP
499565
You should have received a copy of the GNU General Public License along with the program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA or see http://www.gnu.org/licenses/.
500566
.sp
567+
.SH "NOTES"
568+
.IP " 1." 4
569+
jq
570+
.RS 4
571+
\%https://stedolan.github.io/jq/
572+
.RE
573+
.IP " 2." 4
574+
MySQL Internals documentation
575+
.RS 4
576+
\%https://dev.mysql.com/doc/dev/
577+
.RE
501578
.SH "SEE ALSO"
502579
For more information, please refer to the MySQL Reference Manual,
503580
which may already be installed locally and which is also available

‎man/innochecksum.1

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
.\" Title: innochecksum
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: 05/23/2023
5+
.\" Date: 06/02/2023
66
.\" Manual: MySQL Database System
77
.\" Source: MySQL 8.1
88
.\" Language: English
99
.\"
10-
.TH "INNOCHECKSUM" "1" "05/23/2023" "MySQL 8\&.1" "MySQL Database System"
10+
.TH "INNOCHECKSUM" "1" "06/02/2023" "MySQL 8\&.1" "MySQL Database System"
1111
.\" -----------------------------------------------------------------
1212
.\" * Define some portability stuff
1313
.\" -----------------------------------------------------------------

‎man/lz4_decompress.1

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
.\" Title: lz4_decompress
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: 05/23/2023
5+
.\" Date: 06/02/2023
66
.\" Manual: MySQL Database System
77
.\" Source: MySQL 8.1
88
.\" Language: English
99
.\"
10-
.TH "LZ4_DECOMPRESS" "1" "05/23/2023" "MySQL 8\&.1" "MySQL Database System"
10+
.TH "LZ4_DECOMPRESS" "1" "06/02/2023" "MySQL 8\&.1" "MySQL Database System"
1111
.\" -----------------------------------------------------------------
1212
.\" * Define some portability stuff
1313
.\" -----------------------------------------------------------------

‎man/my_print_defaults.1

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
.\" Title: my_print_defaults
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: 05/23/2023
5+
.\" Date: 06/02/2023
66
.\" Manual: MySQL Database System
77
.\" Source: MySQL 8.1
88
.\" Language: English
99
.\"
10-
.TH "MY_PRINT_DEFAULTS" "1" "05/23/2023" "MySQL 8\&.1" "MySQL Database System"
10+
.TH "MY_PRINT_DEFAULTS" "1" "06/02/2023" "MySQL 8\&.1" "MySQL Database System"
1111
.\" -----------------------------------------------------------------
1212
.\" * Define some portability stuff
1313
.\" -----------------------------------------------------------------

‎man/myisam_ftdump.1

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
.\" Title: myisam_ftdump
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: 05/23/2023
5+
.\" Date: 06/02/2023
66
.\" Manual: MySQL Database System
77
.\" Source: MySQL 8.1
88
.\" Language: English
99
.\"
10-
.TH "MYISAM_FTDUMP" "1" "05/23/2023" "MySQL 8\&.1" "MySQL Database System"
10+
.TH "MYISAM_FTDUMP" "1" "06/02/2023" "MySQL 8\&.1" "MySQL Database System"
1111
.\" -----------------------------------------------------------------
1212
.\" * Define some portability stuff
1313
.\" -----------------------------------------------------------------

‎man/myisamchk.1

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
.\" Title: myisamchk
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: 05/23/2023
5+
.\" Date: 06/02/2023
66
.\" Manual: MySQL Database System
77
.\" Source: MySQL 8.1
88
.\" Language: English
99
.\"
10-
.TH "MYISAMCHK" "1" "05/23/2023" "MySQL 8\&.1" "MySQL Database System"
10+
.TH "MYISAMCHK" "1" "06/02/2023" "MySQL 8\&.1" "MySQL Database System"
1111
.\" -----------------------------------------------------------------
1212
.\" * Define some portability stuff
1313
.\" -----------------------------------------------------------------

‎man/myisamlog.1

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
.\" Title: myisamlog
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: 05/23/2023
5+
.\" Date: 06/02/2023
66
.\" Manual: MySQL Database System
77
.\" Source: MySQL 8.1
88
.\" Language: English
99
.\"
10-
.TH "MYISAMLOG" "1" "05/23/2023" "MySQL 8\&.1" "MySQL Database System"
10+
.TH "MYISAMLOG" "1" "06/02/2023" "MySQL 8\&.1" "MySQL Database System"
1111
.\" -----------------------------------------------------------------
1212
.\" * Define some portability stuff
1313
.\" -----------------------------------------------------------------

‎man/myisampack.1

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
.\" Title: myisampack
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: 05/23/2023
5+
.\" Date: 06/02/2023
66
.\" Manual: MySQL Database System
77
.\" Source: MySQL 8.1
88
.\" Language: English
99
.\"
10-
.TH "MYISAMPACK" "1" "05/23/2023" "MySQL 8\&.1" "MySQL Database System"
10+
.TH "MYISAMPACK" "1" "06/02/2023" "MySQL 8\&.1" "MySQL Database System"
1111
.\" -----------------------------------------------------------------
1212
.\" * Define some portability stuff
1313
.\" -----------------------------------------------------------------

‎man/mysql.1

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
.\" Title: mysql
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: 05/23/2023
5+
.\" Date: 06/02/2023
66
.\" Manual: MySQL Database System
77
.\" Source: MySQL 8.1
88
.\" Language: English
99
.\"
10-
.TH "MYSQL" "1" "05/23/2023" "MySQL 8\&.1" "MySQL Database System"
10+
.TH "MYSQL" "1" "06/02/2023" "MySQL 8\&.1" "MySQL Database System"
1111
.\" -----------------------------------------------------------------
1212
.\" * Define some portability stuff
1313
.\" -----------------------------------------------------------------
@@ -1098,7 +1098,8 @@ Section\ \&5.1.11, \(lqServer SQL Modes\(rq)\&.
10981098
.IP \(bu 2.3
10991099
.\}
11001100
\fB\-\-init\-command=str\fR
1101-
SQL statement to execute after connecting to the server\&. If auto\-reconnect is enabled, the statement is executed again after reconnection occurs\&.
1101+
Single SQL statement to execute after connecting to the server\&. If auto\-reconnect is enabled, the statement is executed again after reconnection occurs\&. The definition resets existing statements defined by it or
1102+
\fBinit\-command\-add\fR\&.
11021103
.RE
11031104
.sp
11041105
.RS 4

‎man/mysql.server.1

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
.\" Title: mysql.server
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: 05/23/2023
5+
.\" Date: 06/02/2023
66
.\" Manual: MySQL Database System
77
.\" Source: MySQL 8.1
88
.\" Language: English
99
.\"
10-
.TH "MYSQL\&.SERVER" "1" "05/23/2023" "MySQL 8\&.1" "MySQL Database System"
10+
.TH "MYSQL\&.SERVER" "1" "06/02/2023" "MySQL 8\&.1" "MySQL Database System"
1111
.\" -----------------------------------------------------------------
1212
.\" * Define some portability stuff
1313
.\" -----------------------------------------------------------------

‎man/mysql_config.1

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
.\" Title: mysql_config
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: 05/23/2023
5+
.\" Date: 06/02/2023
66
.\" Manual: MySQL Database System
77
.\" Source: MySQL 8.1
88
.\" Language: English
99
.\"
10-
.TH "MYSQL_CONFIG" "1" "05/23/2023" "MySQL 8\&.1" "MySQL Database System"
10+
.TH "MYSQL_CONFIG" "1" "06/02/2023" "MySQL 8\&.1" "MySQL Database System"
1111
.\" -----------------------------------------------------------------
1212
.\" * Define some portability stuff
1313
.\" -----------------------------------------------------------------

‎man/mysql_config_editor.1

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
.\" Title: mysql_config_editor
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: 05/23/2023
5+
.\" Date: 06/02/2023
66
.\" Manual: MySQL Database System
77
.\" Source: MySQL 8.1
88
.\" Language: English
99
.\"
10-
.TH "MYSQL_CONFIG_EDITOR" "1" "05/23/2023" "MySQL 8\&.1" "MySQL Database System"
10+
.TH "MYSQL_CONFIG_EDITOR" "1" "06/02/2023" "MySQL 8\&.1" "MySQL Database System"
1111
.\" -----------------------------------------------------------------
1212
.\" * Define some portability stuff
1313
.\" -----------------------------------------------------------------

‎man/mysql_migrate_keyring.1

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
.\" Title: mysql_migrate_keyring
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: 05/23/2023
5+
.\" Date: 06/02/2023
66
.\" Manual: MySQL Database System
77
.\" Source: MySQL 8.1
88
.\" Language: English
99
.\"
10-
.TH "MYSQL_MIGRATE_KEYRING" "1" "05/23/2023" "MySQL 8\&.1" "MySQL Database System"
10+
.TH "MYSQL_MIGRATE_KEYRING" "1" "06/02/2023" "MySQL 8\&.1" "MySQL Database System"
1111
.\" -----------------------------------------------------------------
1212
.\" * Define some portability stuff
1313
.\" -----------------------------------------------------------------

‎man/mysql_secure_installation.1

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
.\" Title: mysql_secure_installation
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: 05/23/2023
5+
.\" Date: 06/02/2023
66
.\" Manual: MySQL Database System
77
.\" Source: MySQL 8.1
88
.\" Language: English
99
.\"
10-
.TH "MYSQL_SECURE_INSTALLATION" "1" "05/23/2023" "MySQL 8\&.1" "MySQL Database System"
10+
.TH "MYSQL_SECURE_INSTALLATION" "1" "06/02/2023" "MySQL 8\&.1" "MySQL Database System"
1111
.\" -----------------------------------------------------------------
1212
.\" * Define some portability stuff
1313
.\" -----------------------------------------------------------------

‎man/mysql_ssl_rsa_setup.1

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
.\" Title: mysql_ssl_rsa_setup
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: 05/23/2023
5+
.\" Date: 06/02/2023
66
.\" Manual: MySQL Database System
77
.\" Source: MySQL 8.1
88
.\" Language: English
99
.\"
10-
.TH "MYSQL_SSL_RSA_SETUP" "1" "05/23/2023" "MySQL 8\&.1" "MySQL Database System"
10+
.TH "MYSQL_SSL_RSA_SETUP" "1" "06/02/2023" "MySQL 8\&.1" "MySQL Database System"
1111
.\" -----------------------------------------------------------------
1212
.\" * Define some portability stuff
1313
.\" -----------------------------------------------------------------

‎man/mysql_tzinfo_to_sql.1

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
.\" Title: mysql_tzinfo_to_sql
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: 05/23/2023
5+
.\" Date: 06/02/2023
66
.\" Manual: MySQL Database System
77
.\" Source: MySQL 8.1
88
.\" Language: English
99
.\"
10-
.TH "MYSQL_TZINFO_TO_SQL" "1" "05/23/2023" "MySQL 8\&.1" "MySQL Database System"
10+
.TH "MYSQL_TZINFO_TO_SQL" "1" "06/02/2023" "MySQL 8\&.1" "MySQL Database System"
1111
.\" -----------------------------------------------------------------
1212
.\" * Define some portability stuff
1313
.\" -----------------------------------------------------------------

0 commit comments

Comments
 (0)