diff options
Diffstat (limited to 'man')
68 files changed, 30003 insertions, 0 deletions
diff --git a/man/CMakeLists.txt b/man/CMakeLists.txt new file mode 100644 index 00000000..e6d7ab32 --- /dev/null +++ b/man/CMakeLists.txt @@ -0,0 +1,97 @@ +# Copyright (c) 2012, 2020, MariaDB +# +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; version 2 of the License. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program; if not, write to the Free Software +# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1335 USA + +SET(MAN1_WSREP wsrep_sst_rsync.1 wsrep_sst_common.1 wsrep_sst_mariabackup.1 + wsrep_sst_mysqldump.1 wsrep_sst_rsync_wan.1 galera_recovery.1 galera_new_cluster.1) +SET(MAN1_SERVER innochecksum.1 myisam_ftdump.1 myisamchk.1 + aria_chk.1 aria_dump_log.1 aria_ftdump.1 aria_pack.1 aria_read_log.1 + aria_s3_copy.1 + myisamlog.1 myisampack.1 mysql.server.1 mariadb-conv.1 + mysql_fix_extensions.1 + mysql_install_db.1 + mysql_upgrade.1 + mysqld_multi.1 mysqld_safe.1 + resolveip.1 mariadb-service-convert.1 + mysqld_safe_helper.1 + mysql_ldb.1 myrocks_hotbackup.1 + mbstream.1 mariabackup.1) +IF(WITH_WSREP) + SET(MAN1_SERVER ${MAN1_SERVER} ${MAN1_WSREP}) +ENDIF() +SET(MAN8_SERVER mysqld.8) +SET(MAN1_CLIENT msql2mysql.1 mysql.1 mysql_find_rows.1 mysql_waitpid.1 + mysqldumpslow.1 + mysqlaccess.1 mysqladmin.1 mysqlbinlog.1 mysqlcheck.1 + mysqldump.1 mysqlimport.1 mysqlshow.1 mysqlslap.1 mytop.1 + mysql_plugin.1 mysql_embedded.1 my_print_defaults.1 + mysqlhotcopy.1 mysql_setpermission.1 mysql_tzinfo_to_sql.1 + mysql_convert_table_format.1 replace.1 mysql_secure_installation.1 + perror.1 resolve_stack_dump.1) +SET(MAN1_DEVEL mysql_config.1) +SET(MAN1_TEST mysql-stress-test.pl.1 mysql-test-run.pl.1 mysql_client_test.1 + mysqltest.1 mysqltest_embedded.1 mysql_client_test_embedded.1 + my_safe_process.1) +IF(NOT WITHOUT_SERVER) + INSTALL(FILES ${MAN1_SERVER} DESTINATION ${INSTALL_MANDIR}/man1 COMPONENT ManPagesServer) + INSTALL(FILES ${MAN8_SERVER} DESTINATION ${INSTALL_MANDIR}/man8 COMPONENT ManPagesServer) +ENDIF() + +INSTALL(FILES ${MAN1_CLIENT} DESTINATION ${INSTALL_MANDIR}/man1 COMPONENT ManPagesClient) +INSTALL(FILES ${MAN1_DEVEL} DESTINATION ${INSTALL_MANDIR}/man1 COMPONENT ManPagesDevelopment) +INSTALL(FILES ${MAN1_TEST} DESTINATION ${INSTALL_MANDIR}/man1 COMPONENT ManPagesTest) + +macro(MARIADB_SYMLINK_MANPAGE) + list(LENGTH MARIADB_SYMLINK_TOS _len) + math(EXPR _listlen "${_len}-1") + + foreach(_index RANGE ${_listlen}) + list(GET MARIADB_SYMLINK_TOS ${_index} _name) + + set(_manname "${_name}") + list(FIND MAN1_SERVER ${_manname}.1 _iman1server) + list(FIND MAN8_SERVER ${_manname}.8 _iman8server) + list(FIND MAN1_CLIENT ${_manname}.1 _iman1client) + list(FIND MAN1_DEVEL ${_manname}.1 _iman1devel) + list(FIND MAN1_TEST ${_manname}.1 _iman1test) + + if (${_iman1client} GREATER -1) + MARIADB_SYMLINK_MANPAGE_CREATE(${_manname} ${_index} 1 "man1" ManPagesClient) + endif() + if (${_iman1devel} GREATER -1) + MARIADB_SYMLINK_MANPAGE_CREATE(${_manname} ${_index} 1 "man1" ManPagesDevelopment) + endif() + if (${_iman1test} GREATER -1) + MARIADB_SYMLINK_MANPAGE_CREATE(${_manname} ${_index} 1 "man1" ManPagesTest) + endif() + if (WITHOUT_SERVER) + continue() + endif() + if (${_iman1server} GREATER -1) + MARIADB_SYMLINK_MANPAGE_CREATE(${_manname} ${_index} 1 "man1" ManPagesServer) + endif() + if (${_iman8server} GREATER -1) + MARIADB_SYMLINK_MANPAGE_CREATE(${_manname} ${_index} 8 "man8" ManPagesServer) + endif() + endforeach(_index) +endmacro(MARIADB_SYMLINK_MANPAGE) + +macro(MARIADB_SYMLINK_MANPAGE_CREATE mysqlname index mannr dir comp) + LIST(GET MARIADB_SYMLINK_FROMS ${index} _mariadbname) + SET(dest "${CMAKE_CURRENT_BINARY_DIR}/${_mariadbname}.${mannr}") + FILE(WRITE ${dest} ".so ${dir}/${mysqlname}.${mannr}") + INSTALL(FILES ${dest} DESTINATION ${INSTALL_MANDIR}/${dir} COMPONENT ${comp}) +endmacro(MARIADB_SYMLINK_MANPAGE_CREATE) + +MARIADB_SYMLINK_MANPAGE() diff --git a/man/aria_chk.1 b/man/aria_chk.1 new file mode 100644 index 00000000..435dac75 --- /dev/null +++ b/man/aria_chk.1 @@ -0,0 +1,244 @@ +.TH ARIA_CHK "1" "May 2014" "aria_chk Ver 1.2" "User Commands" +.SH NAME +aria_chk \- Aria table\-maintenance utility +.SH SYNOPSIS +.B aria_chk +[\fIOPTIONS\fR] \fItables\fR[\fI.MAI\fR] +.SH DESCRIPTION +Describe, check and repair of Aria tables. +Used without options all tables on the command will be checked for errors +.SS "Global options" +.TP +\fB\-#\fR, \fB\-\-debug=\fR... +Output debug log. Often this is 'd:t:o,filename'. +.TP +\fB\-H\fR, \fB\-\-HELP\fR +Print all argument options sorted alphabetically. +.TP +\fB\-?\fR, \fB\-\-help\fR +Print all options by groups +.TP +\fB\-\-datadir\fR=\fIpath\fR +Path for control file (and logs if \fB\-\-logdir\fR not used) +.TP +\fB\-\-logdir\fR=\fIpath\fR +Path for log files +.TP +\fB\-\-ignore\-control\-file\fR +Don't open the control file. Only use this if you +are sure the tables are not in use by another +program! +.TP +\fB\-\-require\-control\-file\fR +Abort if we can't find/read the maria_log_control +file +.TP +\fB\-s\fR, \fB\-\-silent\fR +Only print errors. One can use two \fB\-s\fR to make +maria_chk very silent. +.TP +\fB\-t\fR, \fB\-\-tmpdir\fR=\fIpath\fR +Path for temporary files. Multiple paths can be +specified, separated by colon (:), they will be used +in a round\-robin fashion. +.TP +\fB\-v\fR, \fB\-\-verbose\fR +Print more information. This can be used with +\fB\-\-description\fR and \fB\-\-check\fR. Use many \fB\-v\fR for more verbosity. +.TP +\fB\-V\fR, \fB\-\-version\fR +Print version and exit. +.TP +\fB\-w\fR, \fB\-\-wait\fR +Wait if table is locked. +.SS "Check options (check is the default action for aria_chk)" +.TP +\fB\-c\fR, \fB\-\-check\fR +Check table for errors. +.TP +\fB\-e\fR, \fB\-\-extend\-check\fR +Check the table VERY thoroughly. Only use this in +extreme cases as aria_chk should normally be able to +find out if the table is ok even without this switch. +.TP +\fB\-F\fR, \fB\-\-fast\fR +Check only tables that haven't been closed properly. +.TP +\fB\-C\fR, \fB\-\-check\-only\-changed\fR +Check only tables that have changed since last check. +.TP +\fB\-f\fR, \fB\-\-force\fR +Restart with '\-r' if there are any errors in the table. +States will be updated as with '\-\-update\-state'. +.TP +\fB\-i\fR, \fB\-\-information\fR +Print statistics information about table that is checked. +.TP +\fB\-m\fR, \fB\-\-medium\-check\fR +Faster than extend\-check, but only finds 99.99% of +all errors. Should be good enough for most cases. +.TP +\fB\-T\fR, \fB\-\-read\-only\fR +Don't mark table as checked. +.TP +\fB\-U\fR, \fB\-\-update\-state\fR +Mark tables as crashed if any errors were found and +clean if check didn't find any errors but table was +marked as 'not clean' before. This allows one to get +rid of warnings like 'table not properly closed'. If +table was updated, update also the timestamp for when +the check was made. This option is on by default! +Use \fB\-\-skip\-update\-state\fR to disable. +.HP +\fB\-\-warning\-for\-wrong\-transaction\-id\fR +.IP +Give a warning if we find a transaction id in the table that is bigger +than what exists in the control file. Use \fB\-\-skip\-\fR... to disable warning +.SS "Recover (repair)/ options (When using '--recover' or '--safe-recover')" +.TP +\fB\-B\fR, \fB\-\-backup\fR +Make a backup of the .MAD file as 'filename\-time.BAK'. +.TP +\fB\-\-correct\-checksum\fR +Correct checksum information for table. +.TP +\fB\-D\fR, \fB\-\-data\-file\-length=\fR# +Max length of data file (when recreating data +file when it's full). +.TP +\fB\-e\fR, \fB\-\-extend\-check\fR +Try to recover every possible row from the data file +Normally this will also find a lot of garbage rows; +Don't use this option if you are not totally desperate. +.TP +\fB\-f\fR, \fB\-\-force\fR +Overwrite old temporary files. +.TP +\fB\-k\fR, \fB\-\-keys\-used=\fR# +Tell Aria to update only some specific keys. # is a +bit mask of which keys to use. This can be used to +get faster inserts. +.TP +\fB\-\-max\-record\-length=\fR# +Skip rows bigger than this if aria_chk can't allocate +memory to hold it. +.TP +\fB\-r\fR, \fB\-\-recover\fR +Can fix almost anything except unique keys that aren't +unique. +.TP +\fB\-n\fR, \fB\-\-sort\-recover\fR +Forces recovering with sorting even if the temporary +file would be very big. +.TP +\fB\-p\fR, \fB\-\-parallel\-recover\fR +Uses the same technique as '\-r' and '\-n', but creates +all the keys in parallel, in different threads. +.TP +\fB\-o\fR, \fB\-\-safe\-recover\fR +Uses old recovery method; Slower than '\-r' but can +handle a couple of cases where '\-r' reports that it +can't fix the data file. +.TP +\fB\-\-transaction\-log\fR +Log repair command to transaction log. This is needed +if one wants to use the aria_read_log to repeat the +repair +.TP +\fB\-\-character\-sets\-dir=\fR... +Directory where character sets are. +.TP +\fB\-\-set\-collation\fR=\fIname\fR +Change the collation used by the index. +.TP +\fB\-q\fR, \fB\-\-quick\fR +Faster repair by not modifying the data file. +One can give a second '\-q' to force aria_chk to +modify the original datafile in case of duplicate keys. +NOTE: Tables where the data file is corrupted can't be +fixed with this option. +.TP +\fB\-u\fR, \fB\-\-unpack\fR +Unpack file packed with ariapack. +.SS "Other actions" +.TP +\fB\-a\fR, \fB\-\-analyze\fR +Analyze distribution of keys. Will make some joins in +MariaDB faster. You can check the calculated distribution +by using '\-\-description \fB\-\-verbose\fR table_name'. +.TP +\fB\-\-stats_method\fR=\fIname\fR +Specifies how index statistics collection code should +treat NULLs. Possible values of name are "nulls_unequal" +(default for 4.1/5.0), "nulls_equal" (emulate 4.0), and +"nulls_ignored". +.TP +\fB\-d\fR, \fB\-\-description\fR +Prints some information about table. +.TP +\fB\-A\fR, \fB\-\-set\-auto\-increment\fR[=\fIvalue\fR] +Force auto_increment to start at this or higher value +If no value is given, then sets the next auto_increment +value to the highest used value for the auto key + 1. +.TP +\fB\-S\fR, \fB\-\-sort\-index\fR +Sort index blocks. This speeds up 'read\-next' in +applications. +.TP +\fB\-R\fR, \fB\-\-sort\-records=\fR# +Sort records according to an index. This makes your +data much more localized and may speed up things +(It may be VERY slow to do a sort the first time!). +.TP +\fB\-b\fR, \fB\-\-block\-search=\fR# +Find a record, a block at given offset belongs to. +.TP +\fB\-z\fR, \fB\-\-zerofill\fR +Fill empty space in data and index files with zeroes. +This makes the data file movable between different +servers. +.TP +\fB\-\-zerofill\-keep\-lsn\fR +Like \fB\-\-zerofill\fR but does not zero out LSN of +data/index pages. +.PP +.SS "Variables" +.TP +\fB\-\-page_buffer_size=\fR# +Size of page buffer. Used by \fB\-\-safe\-repair\fR +.TP +\fB\-\-read_buffer_size=\fR# +Read buffer size for sequential reads during scanning +.TP +\fB\-\-sort_buffer_size=\fR# +Size of sort buffer. Used by \fB\-\-recover\fR +.TP +\fB\-\-sort_key_blocks=\fR# +Internal buffer for sorting keys; Don't touch. +.TP +\fB\-\-write_buffer_size=\fR# +Write buffer size for sequential writes during repair +.PP +Default options are read from the following files in the given order: +\fB/etc/my.cnf /etc/mysql/my.cnf ~/.my.cnf\fR +.PP +The following groups are read: \fBaria_chk\fR +.PP +The following options may be given as the first argument: +.TP +\fB\-\-print\-defaults\fR +Print the program argument list and exit. +.TP +\fB\-\-no\-defaults\fR +Don't read default options from any option file. +.TP +\fB\-\-defaults\-file=\fR# +Only read default options from the given file #. +.TP +\fB\-\-defaults\-extra\-file=\fR# +Read this file after the global files are read. +.PP +.SH "SEE ALSO" +\fBmyisamchk(1)\fR +.PP +For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/ diff --git a/man/aria_dump_log.1 b/man/aria_dump_log.1 new file mode 100644 index 00000000..16463fc2 --- /dev/null +++ b/man/aria_dump_log.1 @@ -0,0 +1,55 @@ +.TH ARIA_DUMP_LOG "1" "May 2014" "aria_dump_log Ver 1.0" "User Commands" +.SH NAME +aria_dump_log \- Dump content of Aria log pages. +.SH SYNOPSIS +.B aria_dump_log +\fI-f file OPTIONS\fR +.SH DESCRIPTION +Dump content of Aria log pages. +.TP +\fB\-#\fR, \fB\-\-debug\fR[=\fIname\fR] +Output debug log. Often the argument is 'd:t:o,filename'. +.TP +\fB\-f\fR, \fB\-\-file\fR=\fIname\fR +Path to file which will be read +.TP +\fB\-?\fR, \fB\-\-help\fR +Display this help and exit. +.TP +\fB\-o\fR, \fB\-\-offset=\fR# +Start reading log from this offset +.TP +\fB\-n\fR, \fB\-\-pages=\fR# +Number of pages to read +.TP +\fB\-U\fR, \fB\-\-unit\-test\fR +Use unit test record table (for logs created by unittests +.TP +\fB\-V\fR, \fB\-\-version\fR +Print version and exit. +.PP +Default options are read from the following files in the given order: +\fB/etc/my.cnf\fB +\fB/etc/mysql/my.cnf\fB +\fB~/.my.cnf\fB +.PP +The following groups are read: \fBaria_dump_log\fR +.PP +The following options may be given as the first argument: +.TP +\fB\-\-print\-defaults\fR +Print the program argument list and exit. +.TP +\fB\-\-no\-defaults\fR +Don't read default options from any option file. +.TP +\fB\-\-defaults\-file=\fR# +Only read default options from the given file #. +.TP +\fB\-\-defaults\-extra\-file=\fR# +Read this file after the global files are read. +.PP +.SH "SEE ALSO" +For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/ +.SH AUTHOR +MariaDB Foundation (http://www.mariadb.org/). diff --git a/man/aria_ftdump.1 b/man/aria_ftdump.1 new file mode 100644 index 00000000..7b5ba5f5 --- /dev/null +++ b/man/aria_ftdump.1 @@ -0,0 +1,28 @@ +.TH ARIA_FTDUMP "1" "May 2014" "aria_ftdump Ver 1.0" "User Commands" +.SH NAME +aria_ftdump \- display full\-text index information +.SH DESCRIPTION +Use: aria_ft_dump <table_name> <index_num> +.TP +\fB\-?\fR, \fB\-h\fR, \fB\-\-help\fR +Display help and exit. +.TP +\fB\-c\fR, \fB\-\-count\fR +Calculate per\-word stats (counts and global weights). +.TP +\fB\-d\fR, \fB\-\-dump\fR +Dump index (incl. data offsets and word weights). +.TP +\fB\-l\fR, \fB\-\-length\fR +Report length distribution. +.TP +\fB\-s\fR, \fB\-\-stats\fR +Report global stats. +.TP +\fB\-v\fR, \fB\-\-verbose\fR +Be verbose. +.PP +.SH "SEE ALSO" +\fBmyisam_ftdump(1)\fR +.PP +For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/ diff --git a/man/aria_pack.1 b/man/aria_pack.1 new file mode 100644 index 00000000..2557507b --- /dev/null +++ b/man/aria_pack.1 @@ -0,0 +1,75 @@ +.TH ARIA_PACK "1" "May 2014" "aria_pack Ver 1.0" "User Commands" +.SH NAME +aria_pack \- generate compressed, read\-only Aria tables +.SH SYNOPSIS +.B aria_pack +[\fIOPTIONS\fR] \fIfilename\fR... +.SH DESCRIPTION +Pack a Aria\-table to take much less space. +Keys are not updated, you must run \fBaria_chk \-rq\fR on the index (.MAI) file +afterwards to update the keys. +You should give the .MAI file as the filename argument. +To unpack a packed table, run \fBaria_chk \-u\fR on the table +.TP +\fB\-b\fR, \fB\-\-backup\fR +Make a backup of the table as table_name.OLD. +.TP +\fB\-\-character\-sets\-dir\fR=\fIname\fR +Directory where character sets are. +.TP +\fB\-#\fR, \fB\-\-debug\fR[=\fIname\fR] +Output debug log. Often this is 'd:t:o,filename'. +.TP +\fB\-f\fR, \fB\-\-force\fR +Force packing of table even if it gets bigger or if +tempfile exists. +.TP +\fB\-j\fR, \fB\-\-join\fR=\fIname\fR +Join all given tables into 'new_table_name'. All tables +MUST have identical layouts. +.TP +\fB\-?\fR, \fB\-\-help\fR +Display this help and exit. +.TP +\fB\-s\fR, \fB\-\-silent\fR +Be more silent. +.TP +\fB\-T\fR, \fB\-\-tmpdir\fR=\fIname\fR +Use temporary directory to store temporary table. +.TP +\fB\-t\fR, \fB\-\-test\fR +Don't pack table, only test packing it. +.TP +\fB\-v\fR, \fB\-\-verbose\fR +Write info about progress and packing result. Use many \fB\-v\fR +for more verbosity! +.TP +\fB\-V\fR, \fB\-\-version\fR +Output version information and exit. +.TP +\fB\-w\fR, \fB\-\-wait\fR +Wait and retry if table is in use. +.PP +Default options are read from the following files in the given order: +\fB/etc/my.cnf /etc/mysql/my.cnf ~/.my.cnf\fR +.PP +The following groups are read: \fBariapack\fR +.PP +The following options may be given as the first argument: +.TP +\fB\-\-print\-defaults\fR +Print the program argument list and exit. +.TP +\fB\-\-no\-defaults\fR +Don't read default options from any option file. +.TP +\fB\-\-defaults\-file=\fR# +Only read default options from the given file #. +.TP +\fB\-\-defaults\-extra\-file=\fR# +Read this file after the global files are read. +.PP +.SH "SEE ALSO" +\fBmyisampack(1)\fR +.PP +For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/ diff --git a/man/aria_read_log.1 b/man/aria_read_log.1 new file mode 100644 index 00000000..db42162c --- /dev/null +++ b/man/aria_read_log.1 @@ -0,0 +1,107 @@ +.TH ARIA_READ_LOG "1" "May 2014" "aria_read_log Ver 1.3" "User Commands" +.SH NAME +aria_read_log \- display Aria log file contents +.SH SYNOPSIS +.B aria_read_log +\fIOPTIONS\fR +.SH DESCRIPTION +Display and apply log records from a Aria transaction log +found in the current directory (for now) +.PP +Note: Aria is compiled without \fB\-DIDENTICAL_PAGES_AFTER_RECOVERY\fR +which means that the table files are not byte\-to\-byte identical to +files created during normal execution. This should be ok, except for +test scripts that tries to compare files before and after recovery. +.PP +You need to use one of \fB\-d\fR or \fB\-a\fR +.TP +\fB\-a\fR, \fB\-\-apply\fR +Apply log to tables: modifies tables! you should make a +backup first! Displays a lot of information if not run +with \fB\-\-silent\fR +.TP +\fB\-\-character\-sets\-dir\fR=\fIname\fR +Directory where character sets are. +.TP +\fB\-c\fR, \fB\-\-check\fR +if \fB\-\-display\-only\fR, check if record is fully readable (for +debugging) +.TP +\fB\-#\fR, \fB\-\-debug\fR[=\fIname\fR] +Output debug log. Often the argument is 'd:t:o,filename'. +.TP +\fB\-\-force\-crash=\fR# +Force crash after # recovery events +.TP +\fB\-?\fR, \fB\-\-help\fR +Display this help and exit. +.TP +\fB\-d\fR, \fB\-\-display\-only\fR +display brief info read from records' header +.TP +\fB\-e\fR, \fB\-\-end\-lsn=\fR# +Stop applying at this lsn. If end\-lsn is used, UNDO:s +will not be applied +.TP +\fB\-h\fR, \fB\-\-aria\-log\-dir\-path\fR=\fIname\fR +Path to the directory where to store transactional log +.TP +\fB\-P\fR, \fB\-\-page\-buffer\-size=\fR# +The size of the buffer used for index blocks for Aria +tables +.TP +\fB\-o\fR, \fB\-\-start\-from\-lsn=\fR# +Start reading log from this lsn +.TP +\fB\-C\fR, \fB\-\-start\-from\-checkpoint\fR +Start applying from last checkpoint +.TP +\fB\-s\fR, \fB\-\-silent\fR +Print less information during apply/undo phase +.TP +\fB\-T\fR, \fB\-\-tables\-to\-redo\fR=\fIname\fR +List of tables separated with , that we should apply +REDO on. Use this if you only want to recover some tables +.TP +\fB\-t\fR, \fB\-\-tmpdir\fR=\fIname\fR +Path for temporary files. Multiple paths can be +specified, separated by colon (:) +.TP +\fB\-\-translog\-buffer\-size=\fR# +The size of the buffer used for transaction log for Aria +tables +.TP +\fB\-u\fR, \fB\-\-undo\fR +Apply UNDO records to tables. (disable with +\fB\-\-disable\-undo\fR) +(Defaults to on; use \fB\-\-skip\-undo\fR to disable.) +.TP +\fB\-v\fR, \fB\-\-verbose\fR +Print more information during apply/undo phase +.TP +\fB\-V\fR, \fB\-\-version\fR +Print version and exit. +.PP +Default options are read from the following files in the given order: +\fB/etc/my.cnf /etc/mysql/my.cnf ~/.my.cnf\fR +.PP +The following groups are read: \fBaria_read_log\fR +.PP +The following options may be given as the first argument: +.TP +\fB\-\-print\-defaults\fR +Print the program argument list and exit. +.TP +\fB\-\-no\-defaults\fR +Don't read default options from any option file. +.TP +\fB\-\-defaults\-file=\fR# +Only read default options from the given file #. +.TP +\fB\-\-defaults\-extra\-file=\fR# +Read this file after the global files are read. +.PP +.SH "SEE ALSO" +\fBmyisamlog(1)\fR +.PP +For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/ diff --git a/man/aria_s3_copy.1 b/man/aria_s3_copy.1 new file mode 100644 index 00000000..5844d5a7 --- /dev/null +++ b/man/aria_s3_copy.1 @@ -0,0 +1,52 @@ +.TH ARIA_S3_COPY "1" "June 2020" "aria_s3_copy Ver 1.0" "User Commands" +.SH NAME +aria_s3_copy \- Copy an Aria table to and from s3 +.SH DESCRIPTION +Usage: aria_s3_copy \-\-aws\-access\-key=# \-\-aws\-secret\-access\-key=# \-\-aws\-region=# \-\-op=(from_s3 | to_s3 | delete_from_s3) [OPTIONS] tables[.MAI] +.TP +\fB\-?\fR, \fB\-h\fR, \fB\-\-help\fR +Display help and exit. +.TP +\fB\-k\fR, \fB\-\-s3\-access\-key=name\fR +AWS access key ID +.TP +\fB\-r\fR, \fB\-s3\-region=name\fR +AWS region +.TP +\fB\-K\fR, \fB\-s3\-secret\-key=name\fR +AWS secret access key ID +.TP +\fB\-b\fR, \fB\-s3\-bucket=name\fR +AWS prefix for tables +.TP +\fB\-h\fR, \fB\-s3\-host\-name=name\fR +Host name to S3 provider +.TP +\fB\-c\fR, \fB\-compress\fR +Use compression +.TP +\fB\-o\fR, \fB\-op=name\fR +Operation to execute. One of 'from_s3', 'to_s3' or 'delete_from_s3' +.TP +\fB\-d\fR, \fB\-database=name\fR +Database for copied table (second prefix). If not given, the directory of the table file is used +.TP +\fB\-B\fR, \fB\-s3\-block\-size=#\fR +Block size for data/index blocks in s3 +.TP +\fB\-L\fR, \fB\-s3\-protocol\-version=name\fR +Protocol used to communication with S3. One of "Auto", "Amazon" or "Original". +.TP +\fB\-f\fR, \fB\-force\fR +Force copy even if target exists +.TP +\fB\-V\fR, \fB\-version\fR +Print version and exit. +.TP +\fB\-\-s3\-debug\fR +Output debug log from marias3 to stdout +.TP +\fB\-v\fR, \fB\-\-verbose\fR +Be verbose. +.PP +For more information, please refer to the MariaDB Knowledge Base page https://mariadb.com/kb/en/aria_s3_copy/ diff --git a/man/comp_err.1 b/man/comp_err.1 new file mode 100644 index 00000000..6f000869 --- /dev/null +++ b/man/comp_err.1 @@ -0,0 +1,261 @@ +'\" t +.\" +.TH "\fBCOMP_ERR\fR" "1" "15 May 2020" "MariaDB 10.11" "MariaDB Database System" +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.\" comp_err +.SH "NAME" +comp_err \- compile MariaDB error message file +.SH "SYNOPSIS" +.HP \w'\fBcomp_err\ [\fR\fB\fIoptions\fR\fR\fB]\fR\ 'u +\fBcomp_err [\fR\fB\fIoptions\fR\fR\fB]\fR +.SH "DESCRIPTION" +.PP +\fBcomp_err\fR +creates the +errmsg\&.sys +file that is used by +\fBmysqld\fR +to determine the error messages to display for different error codes\&. +\fBcomp_err\fR +normally is run automatically when MariaDB is built\&. It compiles the +errmsg\&.sys +file from the plaintext file located at +sql/share/errmsg\&.txt +in MariaDB source distributions\&. +.PP +\fBcomp_err\fR +also generates +mysqld_error\&.h, +mysqld_ername\&.h, and +sql_state\&.h +header files\&. +.PP +For more information about how error messages are defined, see the MySQL Internals Manual\&. +.PP +Invoke +\fBcomp_err\fR +like this: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBcomp_err [\fR\fB\fIoptions\fR\fR\fB]\fR +.fi +.if n \{\ +.RE +.\} +.PP +\fBcomp_err\fR +supports the following options\&. +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" comp_err: help option +.\" help option: comp_err +\fB\-\-help\fR, +\fB\-?\fR +.sp +Display a help message and exit\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" comp_err: charset option +.\" charset option: comp_err +\fB\-\-charset=\fR\fB\fIpath\fR\fR, +\fB\-C \fR\fB\fIpath\fR\fR +.sp +The character set directory\&. The default is +\&.\&./sql/share/charsets\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" comp_err: debug option +.\" debug option: comp_err +\fB\-\-debug=\fR\fB\fIdebug_options\fR\fR, +\fB\-# \fR\fB\fIdebug_options\fR\fR +.sp +Write a debugging log\&. A typical +\fIdebug_options\fR +string is +\'d:t:O,\fIfile_name\fR\'\&. The default is +\'d:t:O,/tmp/comp_err\&.trace\'\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" comp_err: debug-info option +.\" debug-info option: comp_err +\fB\-\-debug\-info\fR, +\fB\-T\fR +.sp +Print some debugging information when the program exits\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" comp_err: header_file option +.\" header_file option: comp_err +\fB\-\-header_file=\fR\fB\fIfile_name\fR\fR, +\fB\-H \fR\fB\fIfile_name\fR\fR +.sp +The name of the error header file\&. The default is +mysqld_error\&.h\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" comp_err: in_file option +.\" in_file option: comp_err +\fB\-\-in_file=\fR\fB\fIfile_name\fR\fR, +\fB\-F \fR\fB\fIfile_name\fR\fR +.sp +The name of the input file\&. The default is +\&.\&./sql/share/errmsg\&.txt\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" comp_err: name_file option +.\" name_file option: comp_err +\fB\-\-name_file=\fR\fB\fIfile_name\fR\fR, +\fB\-N \fR\fB\fIfile_name\fR\fR +.sp +The name of the error name file\&. The default is +mysqld_ername\&.h\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" comp_err: out_dir option +.\" out_dir option: comp_err +\fB\-\-out_dir=\fR\fB\fIpath\fR\fR, +\fB\-D \fR\fB\fIpath\fR\fR +.sp +The name of the output base directory\&. The default is +\&.\&./sql/share/\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" comp_err: out_file option +.\" out_file option: comp_err +\fB\-\-out_file=\fR\fB\fIfile_name\fR\fR, +\fB\-O \fR\fB\fIfile_name\fR\fR +.sp +The name of the output file\&. The default is +errmsg\&.sys\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" comp_err: statefile option +.\" statefile option: comp_err +\fB\-\-statefile=\fR\fB\fIfile_name\fR\fR, +\fB\-S \fR\fB\fIfile_name\fR\fR +.sp +The name for the SQLSTATE header file\&. The default is +sql_state\&.h\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" comp_err: version option +.\" version option: comp_err +\fB\-\-version\fR, +\fB\-V\fR +.sp +Display version information and exit\&. +.RE +.SH "COPYRIGHT" +.br +.PP +Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc., 2010-2020 MariaDB Foundation +.PP +This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License. +.PP +This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. +.PP +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-1335 USA or see http://www.gnu.org/licenses/. +.sp +.SH "SEE ALSO" +For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/ +.SH AUTHOR +MariaDB Foundation (http://www.mariadb.org/). diff --git a/man/galera_new_cluster.1 b/man/galera_new_cluster.1 new file mode 100644 index 00000000..4e03abf1 --- /dev/null +++ b/man/galera_new_cluster.1 @@ -0,0 +1,36 @@ +'\" t +.\" +.TH "\fBGALERA_NEW_CLUSTER\fR" "1" "15 May 2020" "MariaDB 10.11" "MariaDB Database System" +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH NAME +galera_new_cluster \- starting a new Galera cluster +.SH DESCRIPTION +Used to bootstrap a new Galera Cluster when all nodes are down\&. +Run galera_new_cluster on the first node only\&. +On the remaining nodes simply run 'service @DAEMON_NAME@ start'\&. +.PP +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" galera_new_cluster: help option +.\" help option: galera_new_cluster +\fB\-\-help\fR, +\fB\-h\fR +.sp +Display a help message and exit\&. +.PP +.sp +.SH "SEE ALSO" +For more information on configuration and usage see +https://mariadb.com/kb/en/mariadb/getting-started-with-mariadb-galera-cluster/ diff --git a/man/galera_recovery.1 b/man/galera_recovery.1 new file mode 100644 index 00000000..18da2fa5 --- /dev/null +++ b/man/galera_recovery.1 @@ -0,0 +1,16 @@ +'\" t +.\" +.TH "\fBGALERA_RECOVERY\fR" "1" "15 May 2020" "MariaDB 10.11" "MariaDB Database System" +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH NAME +galera_recovery \- recover from non\-graceful shutdown +.SH DESCRIPTION +Use: Recover from non\-graceful shutdown\. +.PP +For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/ diff --git a/man/innochecksum.1 b/man/innochecksum.1 new file mode 100644 index 00000000..ae7a5b03 --- /dev/null +++ b/man/innochecksum.1 @@ -0,0 +1,317 @@ +'\" t +.\" +.TH "\fBINNOCHECKSUM\fR" "1" "15 May 2020" "MariaDB 10.11" "MariaDB Database System" +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.\" innochecksum +.SH "NAME" +innochecksum \- offline InnoDB file checksum utility +.SH "SYNOPSIS" +.HP \w'\fBinnochecksum\ [\fR\fB\fIoptions\fR\fR\fB]\ \fR\fB\fIfile_name\fR\fR\ 'u +\fBinnochecksum [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fIfile_name\fR\fR +.SH "DESCRIPTION" +.PP +\fBinnochecksum\fR +prints checksums for +InnoDB +files\&. This tool reads an +InnoDB +tablespace file, calculates the checksum for each page, compares the calculated checksum to the stored checksum, and reports mismatches, which indicate damaged pages\&. It was originally developed to speed up verifying the integrity of tablespace files after power outages but can also be used after file copies\&. Because checksum mismatches will cause +InnoDB +to deliberately shut down a running server, it can be preferable to use this tool rather than waiting for a server in production usage to encounter the damaged pages\&. +.PP +\fBinnochecksum\fR +cannot be used on tablespace files that the server already has open\&. For such files, you should use +CHECK TABLE +to check tables within the tablespace\&. +.PP +If checksum mismatches are found, you would normally restore the tablespace from backup or start the server and attempt to use +\fBmariadb-dump\fR +to make a backup of the tables within the tablespace\&. +.PP +Invoke +\fBinnochecksum\fR +like this: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBinnochecksum [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fIfile_name\fR\fR +.fi +.if n \{\ +.RE +.\} +.PP +\fBinnochecksum\fR +supports the following options\&. For options that refer to page numbers, the numbers are zero\-based\&. +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fB\-?, --help\fR +.sp +Displays help and exits\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fB\-a \fR\fB\fInum\fB, --allow-mismatches=#\fR +.sp +Maximum checksum mismatch allowed before innochecksum terminates. Defaults to 0, which terminates on the first mismatch\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fB\-c, --count\fR +.sp +Print a count of the number of pages in the file\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fB\-e \fR\fB\fInum\fB, --end-page=#\fR\fR +.sp +End at this page number\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fB\-i, --per-page-details\fR +.sp +Print out per-page detail information\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fB\-I, --info\fR +.sp +Synonym for \fB--help\fR\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fB\-f, --leaf\fR +.sp +Examine leaf index pages\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fB\-l \fR\fB\fIfn\fB, --log=fn\fR\fR +.sp +Log output to the specified filename, fn\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fB\-m \fR\fB\fInum\fB, --merge=#\fR\fR +.sp +Leaf page count if merge given number of consecutive pages\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fB\-n, --no-check\fR\fR +.sp +Ignore the checksum verification. Until MariaDB 10.6, must be used with the --write option\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fB\-p \fR\fB\fInum\fB, --page-num=#\fR\fR +.sp +Check only this page number\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fB\-D \fR\fB\fIname\fB, --page-type-dump=name\fR\fR +.sp +Dump the page type info for each page in a tablespace\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fB\-S, --page-type-summary\fR\fR +.sp +Display a count of each page type in a tablespace\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fB\-s \fR\fB\fInum\fB, --start-page\fR\fR +.sp +Start at this page number\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fB\-u, --skip-corrupt\fR\fR +.sp +Skip corrupt pages\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fB\-C \fR\fB\fIname\fB, --strict-check=name\fR\fR +.sp +Specify the strict checksum algorithm. One of: crc32, innodb, none. If not specified, validates against innodb, crc32 and none. Removed in MariaDB 10.6\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fB\-w \fR\fB\fIname\fB, --write=name\fR\fR +.sp +Rewrite the checksum algorithm. One of crc32, innodb, none. An exclusive lock is obtained during use. Use in conjunction with the -no-check option to rewrite an invalid checksum. Removed in MariaDB 10.6\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fB\-v, --verbose\fR +.sp +Verbose mode; print a progress indicator every five seconds\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fB\-V, --version\fR +.sp +Displays version information and exits\&. +.RE +.SH "COPYRIGHT" +.br +.PP +Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc., 2010-2023 MariaDB Foundation +.PP +This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License. +.PP +This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. +.PP +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-1335 USA or see http://www.gnu.org/licenses/. +.sp +.SH "SEE ALSO" +For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/ +.SH AUTHOR +MariaDB Foundation (http://www.mariadb.org/). diff --git a/man/mariabackup.1 b/man/mariabackup.1 new file mode 100644 index 00000000..705234fe --- /dev/null +++ b/man/mariabackup.1 @@ -0,0 +1,16 @@ +'\" t +.\" +.TH "\fBMARIABACKUP\fR" "1" "15 May 2020" "MariaDB 10.11" "MariaDB Database System" +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH NAME +mariabackup \- Backup tool +.SH DESCRIPTION +Use \fBmariabackup \-\-help\fR for details on usage\. +.PP +For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/ diff --git a/man/mariadb-conv.1 b/man/mariadb-conv.1 new file mode 100644 index 00000000..487ad003 --- /dev/null +++ b/man/mariadb-conv.1 @@ -0,0 +1,104 @@ +'\" t +.\" +.TH "\fBMARIADB-CONV\fR" "1" "15 May 2020" "MariaDB 10.11" "MariaDB Database System" +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.\" mariadb\-conv +.SH "NAME" +mariadb\-conv \- character set conversion utility for MariaDB +.SH "SYNOPSIS" +.HP \w'\fBmariadb\-conv\ [\fR\fB\fIOPTION...\fR\fR\fB]\ [\fR\fB\fIFILE...\fR\fR\fB]\ 'u +\fBmariadb\-conv [\fR\fB\fIOPTION...\fR\fR\fB] [\fR\fB\fIFILE...\fR\fR\fB] \fR +.SH "DESCRIPTION" +.PP +\fBmariadb\-conv\fR +is a character set conversion utility for MariaDB\&. +.PP +\fBmariadb-conv\fR +supports the following options\&. +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mariadb-conv: from option +.\" from option: mariadb-conv +\fB\-\-from=\fR\fB\fIname\fR\fR, +\fB\-f \fR\fB\fIname\fR\fR +.sp +Specifies the encoding of the input\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mariadb-conv: to option +.\" to option: mariadb-conv +\fB\-\-to=\fR\fB\fIname\fR\fR, +\fB\-t \fR\fB\fIname\fR\fR +.sp +Specifies the encoding of the output\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mariadb-conv: continue option +.\" continue option: mariadb-conv +\fB\-\-continue\fR, +\fB\-c \fR +.sp +Silently ignore conversion errors\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mariadb-conv: continue option +.\" continue option: mariadb-conv +\fB\-\-delimiter=\fR\fB\fIname\fR\fR, +.sp +Treat the specified characters as delimiters\&. +.RE +.SH "COPYRIGHT" +.br +.PP +Copyright 2020 MariaDB Foundation +.PP +This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License. +.PP +This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. +.PP +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-1335 USA or see http://www.gnu.org/licenses/. +.sp +.SH "SEE ALSO" +For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/en/mariadb-conv/ +.SH AUTHOR +MariaDB Foundation (http://www.mariadb.org/). diff --git a/man/mariadb-service-convert.1 b/man/mariadb-service-convert.1 new file mode 100644 index 00000000..258c1793 --- /dev/null +++ b/man/mariadb-service-convert.1 @@ -0,0 +1,20 @@ +'\" t +.\" +.TH "\fBMARIADB-SERVICE-CONVERT\fR" "1" "15 May 2020" "MariaDB 10.11" "MariaDB Database System" +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH NAME +mariadb-service-convert \- generate a mariadb.service file based on the current mysql/mariadb settings +.SH DESCRIPTION +Use: Generate a mariadb.service file based on the current mysql/mariadb settings\. +This is to assist distro maintainers in migrating to systemd service definations from +a user mysqld_safe settings in the my.cnf files\. +.PP +Redirect output to user directory like /etc/systemd/system/mariadb.service.d/migrated-from-my.cnf-settings.conf +.PP +For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/ diff --git a/man/mbstream.1 b/man/mbstream.1 new file mode 100644 index 00000000..9409d866 --- /dev/null +++ b/man/mbstream.1 @@ -0,0 +1,16 @@ +'\" t +.\" +.TH "\fBMBSTREAM\fR" "1" "15 May 2020" "MariaDB 10.11" "MariaDB Database System" +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH NAME +mbstream \- Serialize/deserialize files in the XBSTREAM format +.SH DESCRIPTION +Use \fBmbstream \-\-help\fR for details on usage\. +.PP +For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/ diff --git a/man/msql2mysql.1 b/man/msql2mysql.1 new file mode 100644 index 00000000..ed6c136f --- /dev/null +++ b/man/msql2mysql.1 @@ -0,0 +1,67 @@ +'\" t +.\" +.TH "\fBMSQL2MYSQL\fR" "1" "15 May 2020" "MariaDB 10.11" "MariaDB Database System" +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.\" msql2mysql +.SH "NAME" +msql2mysql \- convert mSQL programs for use with MySQL +.SH "SYNOPSIS" +.HP \w'\fBmsql2mysql\fR\fB\fIC\-source\-file\fR\fR\fB\ \&.\&.\&.\fR\ 'u +\fBmsql2mysql\fR\fB\fIC\-source\-file\fR\fR\fB \&.\&.\&.\fR +.SH "DESCRIPTION" +.PP +Initially, the MySQL C API was developed to be very similar to that for the mSQL database system\&. Because of this, mSQL programs often can be converted relatively easily for use with MySQL by changing the names of the C API functions\&. +.PP +The +\fBmsql2mysql\fR +utility performs the conversion of mSQL C API function calls to their MySQL equivalents\&. +\fBmsql2mysql\fR +converts the input file in place, so make a copy of the original before converting it\&. For example, use +\fBmsql2mysql\fR +like this: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBcp client\-prog\&.c client\-prog\&.c\&.orig\fR +shell> \fBmsql2mysql client\-prog\&.c\fR +client\-prog\&.c converted +.fi +.if n \{\ +.RE +.\} +.PP +Then examine +client\-prog\&.c +and make any post\-conversion revisions that may be necessary\&. +.PP +\fBmsql2mysql\fR +uses the +\fBreplace\fR +utility to make the function name substitutions\&. See +\fBreplace\fR(1)\&. +.SH "COPYRIGHT" +.br +.PP +Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc., 2010-2020 MariaDB Foundation +.PP +This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License. +.PP +This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. +.PP +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-1335 USA or see http://www.gnu.org/licenses/. +.sp +.SH "SEE ALSO" +For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/ +.SH AUTHOR +MariaDB Foundation (http://www.mariadb.org/). diff --git a/man/my_print_defaults.1 b/man/my_print_defaults.1 new file mode 100644 index 00000000..d519d89e --- /dev/null +++ b/man/my_print_defaults.1 @@ -0,0 +1,217 @@ +'\" t +.\" +.TH "\fBMY_PRINT_DEFAULTS\fR" "1" "15 May 2020" "MariaDB 10.11" "MariaDB Database System" +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.\" my_print_defaults +.SH "NAME" +my_print_defaults \- display options from option files +.SH "SYNOPSIS" +.HP \w'\fBmy_print_defaults\ [\fR\fB\fIoptions\fR\fR\fB]\ \fR\fB\fIoption_group\fR\fR\fB\ \&.\&.\&.\fR\ 'u +\fBmy_print_defaults [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fIoption_group\fR\fR\fB \&.\&.\&.\fR +.SH "DESCRIPTION" +.PP +\fBmy_print_defaults\fR +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 +\fBmysqlcheck\fR +program reads the +[mysqlcheck] +and +[client] +option groups\&. To see what options are present in those groups in the standard option files, invoke +\fBmy_print_defaults\fR +like this: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmy_print_defaults mysqlcheck client\fR +\-\-user=myusername +\-\-password=secret +\-\-host=localhost +.fi +.if n \{\ +.RE +.\} +.PP +The output consists of options, one per line, in the form that they would be specified on the command line\&. +.PP +\fBmy_print_defaults\fR +supports the following options\&. +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" my_print_defaults: help option +.\" help option: my_print_defaults +\fB\-\-help\fR, +\fB\-?\fR +.sp +Display a help message and exit\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" my_print_defaults: config-file option +.\" config-file option: my_print_defaults +\fB +.\" my_print_defaults: defaults-file option +.\" defaults-file option: my_print_defaults +\fB\-\-defaults\-file=\fR\fB\fIfile_name\fR\fR, +\fB\-c \fR\fB\fIfile_name\fR\fR +.sp +Read only the given option file\&. If no extension is given, default extension(.ini or .cnf) will +be used\&. If \fB\-\-defaults\-file\fR is +the first option, then read this file only, do not read global or per\-user config files; should be the first option. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" my_print_defaults: debug option +.\" debug option: my_print_defaults +\fB\-\-debug=\fR\fB\fIdebug_options\fR\fR, +\fB\-# \fR\fB\fIdebug_options\fR\fR +.sp +Write a debugging log\&. A typical +\fIdebug_options\fR +string is 'd:t:o,\fIfile_name\fR'. The default is 'd:t:o,/tmp/my_print_defaults.trace'. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" my_print_defaults: defaults-extra-file option +.\" defaults-extra-file option: my_print_defaults +\fB\-\-defaults\-extra\-file=\fR\fB\fIfile_name\fR\fR, +.\" my_print_defaults: extra-file option +.\" extra-file option: my_print_defaults +\fB\-e \fR\fB\fIfile_name\fR\fR +.sp +Read this option file after the global option file but (on Unix) before the user option +file\&. Should be the first option\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" my_print_defaults: defaults-group-suffix option +.\" defaults-group-suffix option: my_print_defaults +\fB\-\-defaults\-group\-suffix=\fR\fB\fIsuffix\fR\fR, +\fB\-g \fR\fB\fIsuffix\fR\fR +.sp +In addition to the groups named on the command line, read groups that have the given suffix\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" my_print_defaults: --mysqld option +.\" mysqld option: my_print_defaults +\fB\-\-mysqld\fR +.sp +Read the same set of groups that the mysqld binary does. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" my_print_defaults: no-defaults option +.\" no-defaults option: my_print_defaults +\fB\-\-no\-defaults\fR, +\fB\-n\fR +.sp +Return an empty string (useful for scripts)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" my_print_defaults: verbose option +.\" verbose option: my_print_defaults +\fB\-\-verbose\fR, +\fB\-v\fR +.sp +Verbose mode\&. Print more information about what the program does\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" my_print_defaults: version option +.\" version option: my_print_defaults +\fB\-\-version\fR, +\fB\-V\fR +.sp +Display version information and exit\&. +.RE +.SH "COPYRIGHT" +.br +.PP +Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc., 2010-2020 MariaDB Foundation +.PP +This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License. +.PP +This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. +.PP +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-1335 USA or see http://www.gnu.org/licenses/. +.sp +.SH "SEE ALSO" +For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/ +.SH AUTHOR +MariaDB Foundation (http://www.mariadb.org/). diff --git a/man/my_safe_process.1 b/man/my_safe_process.1 new file mode 100644 index 00000000..455e1b88 --- /dev/null +++ b/man/my_safe_process.1 @@ -0,0 +1,16 @@ +'\" t +.\" +.TH "\fBMY_SAFE_PROCESS\fR" "1" "15 May 2020" "MariaDB 10.11" "MariaDB Database System" +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH NAME +my_safe_process \- Utility program that encapsulates process creation, monitoring and bulletproof process cleanup +.SH DESCRIPTION +Use: safe_process [options to safe_process] -- progname arg1 \.\.\. argn\. +.PP +For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/ diff --git a/man/myisam_ftdump.1 b/man/myisam_ftdump.1 new file mode 100644 index 00000000..449ff55d --- /dev/null +++ b/man/myisam_ftdump.1 @@ -0,0 +1,249 @@ +'\" t +.\" +.TH "\fBMYISAM_FTDUMP\fR" "1" "15 May 2020" "MariaDB 10.11" "MariaDB Database System" +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.\" myisam_ftdump +.SH "NAME" +myisam_ftdump \- display full\-text index information +.SH "SYNOPSIS" +.HP \w'\fBmyisam_ftdump\ [\fR\fB\fIoptions\fR\fR\fB]\ \fR\fB\fItbl_name\fR\fR\fB\ \fR\fB\fIindex_num\fR\fR\ 'u +\fBmyisam_ftdump [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fItbl_name\fR\fR\fB \fR\fB\fIindex_num\fR\fR +.SH "DESCRIPTION" +.PP +\fBmyisam_ftdump\fR +displays information about +FULLTEXT +indexes in +MyISAM +tables\&. It reads the +MyISAM +index file directly, so it must be run on the server host where the table is located\&. Before using +\fBmyisam_ftdump\fR, be sure to issue a +FLUSH TABLES +statement first if the server is running\&. +.PP +\fBmyisam_ftdump\fR +scans and dumps the entire index, which is not particularly fast\&. On the other hand, the distribution of words changes infrequently, so it need not be run often\&. +.PP +Invoke +\fBmyisam_ftdump\fR +like this: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmyisam_ftdump [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fItbl_name\fR\fR\fB \fR\fB\fIindex_num\fR\fR +.fi +.if n \{\ +.RE +.\} +.PP +The +\fItbl_name\fR +argument should be the name of a +MyISAM +table\&. You can also specify a table by naming its index file (the file with the +\&.MYI +suffix)\&. If you do not invoke +\fBmyisam_ftdump\fR +in the directory where the table files are located, the table or index file name must be preceded by the path name to the table's database directory\&. Index numbers begin with 0\&. +.PP +Example: Suppose that the +test +database contains a table named +mytexttablel +that has the following definition: +.sp +.if n \{\ +.RS 4 +.\} +.nf +CREATE TABLE mytexttable +( + id INT NOT NULL, + txt TEXT NOT NULL, + PRIMARY KEY (id), + FULLTEXT (txt) +); +.fi +.if n \{\ +.RE +.\} +.PP +The index on +id +is index 0 and the +FULLTEXT +index on +txt +is index 1\&. If your working directory is the +test +database directory, invoke +\fBmyisam_ftdump\fR +as follows: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmyisam_ftdump mytexttable 1\fR +.fi +.if n \{\ +.RE +.\} +.PP +If the path name to the +test +database directory is +/usr/local/mysql/data/test, you can also specify the table name argument using that path name\&. This is useful if you do not invoke +\fBmyisam_ftdump\fR +in the database directory: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmyisam_ftdump /usr/local/mysql/data/test/mytexttable 1\fR +.fi +.if n \{\ +.RE +.\} +.PP +You can use +\fBmyisam_ftdump\fR +to generate a list of index entries in order of frequency of occurrence like this: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmyisam_ftdump \-c mytexttable 1 | sort \-r\fR +.fi +.if n \{\ +.RE +.\} +.PP +\fBmyisam_ftdump\fR +supports the following options: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" myisam_ftdump: help option +.\" help option: myisam_ftdump +\fB\-\-help\fR, +\fB\-h\fR +\fB\-?\fR +.sp +Display a help message and exit\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" myisam_ftdump: count option +.\" count option: myisam_ftdump +\fB\-\-count\fR, +\fB\-c\fR +.sp +Calculate per\-word statistics (counts and global weights)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" myisam_ftdump: dump option +.\" dump option: myisam_ftdump +\fB\-\-dump\fR, +\fB\-d\fR +.sp +Dump the index, including data offsets and word weights\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" myisam_ftdump: length option +.\" length option: myisam_ftdump +\fB\-\-length\fR, +\fB\-l\fR +.sp +Report the length distribution\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" myisam_ftdump: stats option +.\" stats option: myisam_ftdump +\fB\-\-stats\fR, +\fB\-s\fR +.sp +Report global index statistics\&. This is the default operation if no other operation is specified\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" myisam_ftdump: verbose option +.\" verbose option: myisam_ftdump +\fB\-\-verbose\fR, +\fB\-v\fR +.sp +Verbose mode\&. Print more output about what the program does\&. +.RE +.SH "COPYRIGHT" +.br +.PP +Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc., 2010-2020 MariaDB Foundation +.PP +This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License. +.PP +This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. +.PP +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-1335 USA or see http://www.gnu.org/licenses/. +.sp +.SH "SEE ALSO" +For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/ +.SH AUTHOR +MariaDB Foundation (http://www.mariadb.org/). diff --git a/man/myisamchk.1 b/man/myisamchk.1 new file mode 100644 index 00000000..dae679bd --- /dev/null +++ b/man/myisamchk.1 @@ -0,0 +1,2519 @@ +'\" t +.\" +.TH "\fBMYISAMCHK\fR" "1" "15 May 2020" "MariaDB 10.11" "MariaDB Database System" +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.\" myisamchk +.SH "NAME" +myisamchk \- MyISAM table\-maintenance utility +.SH "SYNOPSIS" +.HP \w'\fBmyisamchk\ [\fR\fB\fIoptions\fR\fR\fB]\ \fR\fB\fItbl_name\fR\fR\fB\ \&.\&.\&.\fR\ 'u +\fBmyisamchk [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fItbl_name\fR\fR\fB \&.\&.\&.\fR +.SH "DESCRIPTION" +.PP +The +\fBmyisamchk\fR +utility gets information about your database tables or checks, repairs, or optimizes them\&. +\fBmyisamchk\fR +works with +MyISAM +tables (tables that have +\&.MYD +and +\&.MYI +files for storing data and indexes)\&. +.PP +The use of +\fBmyisamchk\fR +with partitioned tables is not supported\&. +.if n \{\ +.sp +.\} +.RS 4 +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.ps +1 +\fBCaution\fR +.ps -1 +.br +.PP +It is best to make a backup of a table before performing a table repair operation; under some circumstances the operation might cause data loss\&. Possible causes include but are not limited to file system errors\&. +.sp .5v +.RE +.PP +Invoke +\fBmyisamchk\fR +like this: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmyisamchk [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fItbl_name\fR\fR\fB \&.\&.\&.\fR +.fi +.if n \{\ +.RE +.\} +.PP +The +\fIoptions\fR +specify what you want +\fBmyisamchk\fR +to do\&. They are described in the following sections\&. You can also get a list of options by invoking +\fBmyisamchk \-\-help\fR\&. +.PP +With no options, +\fBmyisamchk\fR +simply checks your table as the default operation\&. To get more information or to tell +\fBmyisamchk\fR +to take corrective action, specify options as described in the following discussion\&. +.PP +\fItbl_name\fR +is the database table you want to check or repair\&. If you run +\fBmyisamchk\fR +somewhere other than in the database directory, you must specify the path to the database directory, because +\fBmyisamchk\fR +has no idea where the database is located\&. In fact, +\fBmyisamchk\fR +does not actually care whether the files you are working on are located in a database directory\&. You can copy the files that correspond to a database table into some other location and perform recovery operations on them there\&. +.PP +You can name several tables on the +\fBmyisamchk\fR +command line if you wish\&. You can also specify a table by naming its index file (the file with the +\&.MYI +suffix)\&. This allows you to specify all tables in a directory by using the pattern +*\&.MYI\&. For example, if you are in a database directory, you can check all the +MyISAM +tables in that directory like this: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmyisamchk *\&.MYI\fR +.fi +.if n \{\ +.RE +.\} +.PP +If you are not in the database directory, you can check all the tables there by specifying the path to the directory: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmyisamchk \fR\fB\fI/path/to/database_dir/\fR\fR\fB*\&.MYI\fR +.fi +.if n \{\ +.RE +.\} +.PP +You can even check all tables in all databases by specifying a wildcard with the path to the MariaDB data directory: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmyisamchk \fR\fB\fI/path/to/datadir/*/*\fR\fR\fB\&.MYI\fR +.fi +.if n \{\ +.RE +.\} +.PP +The recommended way to quickly check all +MyISAM +tables is: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmyisamchk \-\-silent \-\-fast \fR\fB\fI/path/to/datadir/*/*\fR\fR\fB\&.MYI\fR +.fi +.if n \{\ +.RE +.\} +.PP +If you want to check all +MyISAM +tables and repair any that are corrupted, you can use the following command: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmyisamchk \-\-silent \-\-force \-\-fast \-\-update\-state \e\fR + \fB\-\-key_buffer_size=64M \-\-sort_buffer_size=64M \e\fR + \fB\-\-read_buffer_size=1M \-\-write_buffer_size=1M \e\fR + \fB\fI/path/to/datadir/*/*\fR\fR\fB\&.MYI\fR +.fi +.if n \{\ +.RE +.\} +.PP +This command assumes that you have more than 64MB free\&. For more information about memory allocation with +\fBmyisamchk\fR, see +the section called \(lqMYISAMCHK MEMORY USAGE\(rq\&. +.if n \{\ +.sp +.\} +.RS 4 +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.ps +1 +\fBImportant\fR +.ps -1 +.br +.PP +\fIYou must ensure that no other program is using the tables while you are running \fR\fI\fBmyisamchk\fR\fR\&. The most effective means of doing so is to shut down the MariaDB server while running +\fBmyisamchk\fR, or to lock all tables that +\fBmyisamchk\fR +is being used on\&. +.PP +Otherwise, when you run +\fBmyisamchk\fR, it may display the following error message: +.sp +.if n \{\ +.RS 4 +.\} +.nf +warning: clients are using or haven't closed the table properly +.fi +.if n \{\ +.RE +.\} +.PP +This means that you are trying to check a table that has been updated by another program (such as the +\fBmysqld\fR +server) that hasn't yet closed the file or that has died without closing the file properly, which can sometimes lead to the corruption of one or more +MyISAM +tables\&. +.PP +If +\fBmysqld\fR +is running, you must force it to flush any table modifications that are still buffered in memory by using +FLUSH TABLES\&. You should then ensure that no one is using the tables while you are running +\fBmyisamchk\fR +.PP +However, the easiest way to avoid this problem is to use +CHECK TABLE +instead of +\fBmyisamchk\fR +to check tables\&. +.sp .5v +.RE +.PP +\fBmyisamchk\fR +supports the following options, which can be specified on the command line or in the +[myisamchk] +option file group\&. +.SH "MYISAMCHK GENERAL OPTIONS" +.\" options: myisamchk +.\" myisamchk: options +.PP +The options described in this section can be used for any type of table maintenance operation performed by +\fBmyisamchk\fR\&. The sections following this one describe options that pertain only to specific operations, such as table checking or repairing\&. +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" myisamchk: help option +.\" help option: myisamchk +\fB\-\-help\fR, +\fB\-?\fR +.sp +Display a help message and exit\&. Options are grouped by type of operation\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" myisamchk: HELP option +.\" HELP option: myisamchk +\fB\-\-HELP\fR, +\fB\-H\fR +.sp +Display a help message and exit\&. Options are presented in a single list\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" myisamchk: debug option +.\" debug option: myisamchk +\fB\-\-debug=\fR\fB\fIdebug_options\fR\fR, +\fB\-# \fR\fB\fIdebug_options\fR\fR +.sp +Write a debugging log\&. A typical +\fIdebug_options\fR +string is 'd:t:o,\fIfile_name\fR'. The default is 'd:t:o,/tmp/myisamchk.trace'. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" myisamchk: silent option +.\" silent option: myisamchk +\fB\-\-silent\fR, +\fB\-s\fR +.sp +Silent mode\&. Write output only when errors occur\&. You can use +\fB\-s\fR +twice (\fB\-ss\fR) to make +\fBmyisamchk\fR +very silent\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" myisamchk: verbose option +.\" verbose option: myisamchk +\fB\-\-verbose\fR, +\fB\-v\fR +.sp +Verbose mode\&. Print more information about what the program does\&. This can be used with +\fB\-d\fR +and +\fB\-e\fR\&. Use +\fB\-v\fR +multiple times (\fB\-vv\fR, +\fB\-vvv\fR) for even more output\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" myisamchk: version option +.\" version option: myisamchk +\fB\-\-version\fR, +\fB\-V\fR +.sp +Display version information and exit\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" myisamchk: wait option +.\" wait option: myisamchk +\fB\-\-wait\fR, +\fB\-w\fR +.sp +Instead of terminating with an error if the table is locked, wait until the table is unlocked before continuing\&. If you are running +\fBmysqld\fR +with external locking disabled, the table can be locked only by another +\fBmyisamchk\fR +command\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" myisamchk: print argument list option +.\" print argument list option: myisamchk +\fB\-\-print\-defaults\fR +.sp +Print the program argument list and exit\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" myisamchk: no defaults option +.\" no defaults option: myisamchk +\fB\-\-no\-defaults\fR +.sp +Don't read default options from any option file\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" myisamchk: defaults file option +.\" defaults file option: myisamchk +\fB\-\-defaults\-file=#\fR +.sp +Only read default options from the given file\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" myisamchk: defaults extrafile option +.\" defaults extra file option: myisamchk +\fB\-\-defaults\-extra\-file=#\fR +.sp +Read this file after the global files are read\&. +.RE +.PP +You can also set the following variables by using +\fB\-\-\fR\fB\fIvar_name\fR\fR\fB=\fR\fB\fIvalue\fR\fR +syntax: +.\" decode_bits myisamchk variable +.\" ft_max_word_len myisamchk variable +.\" ft_min_word_len myisamchk variable +.\" ft_stopword_file myisamchk variable +.\" key_buffer_size myisamchk variable +.\" key_cache_block_size myisamchk variable +.\" myisam_block_size myisamchk variable +.\" read_buffer_size myisamchk variable +.\" sort_buffer_size myisamchk variable +.\" sort_key_blocks myisamchk variable +.\" stats_method myisamchk variable +.\" write_buffer_size myisamchk variable +.TS +allbox tab(:); +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l. +T{ +\fBVariable\fR +T}:T{ +\fBDefault Value\fR +T} +T{ +decode_bits +T}:T{ +9 +T} +T{ +ft_max_word_len +T}:T{ +version\-dependent +T} +T{ +ft_min_word_len +T}:T{ +4 +T} +T{ +ft_stopword_file +T}:T{ +built\-in list +T} +T{ +key_buffer_size +T}:T{ +523264 +T} +T{ +key_cache_block_size +T}:T{ +1024 +T} +T{ +myisam_block_size +T}:T{ +1024 +T} +T{ +read_buffer_size +T}:T{ +262136 +T} +T{ +sort_buffer_size +T}:T{ +2097144 +T} +T{ +sort_key_blocks +T}:T{ +16 +T} +T{ +stats_method +T}:T{ +nulls_unequal +T} +T{ +write_buffer_size +T}:T{ +262136 +T} +.TE +.sp 1 +.PP +The possible +\fBmyisamchk\fR +variables and their default values can be examined with +\fBmyisamchk \-\-help\fR: +.PP +sort_buffer_size +is used when the keys are repaired by sorting keys, which is the normal case when you use +\fB\-\-recover\fR\&. +.PP +key_buffer_size +is used when you are checking the table with +\fB\-\-extend\-check\fR +or when the keys are repaired by inserting keys row by row into the table (like when doing normal inserts)\&. Repairing through the key buffer is used in the following cases: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +You use +\fB\-\-safe\-recover\fR\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +The temporary files needed to sort the keys would be more than twice as big as when creating the key file directly\&. This is often the case when you have large key values for +CHAR, +VARCHAR, or +TEXT +columns, because the sort operation needs to store the complete key values as it proceeds\&. If you have lots of temporary space and you can force +\fBmyisamchk\fR +to repair by sorting, you can use the +\fB\-\-sort\-recover\fR +option\&. +.RE +.PP +Repairing through the key buffer takes much less disk space than using sorting, but is also much slower\&. +.PP +If you want a faster repair, set the +key_buffer_size +and +sort_buffer_size +variables to about 25% of your available memory\&. You can set both variables to large values, because only one of them is used at a time\&. +.PP +myisam_block_size +is the size used for index blocks\&. +.PP +stats_method +influences how +NULL +values are treated for index statistics collection when the +\fB\-\-analyze\fR +option is given\&. It acts like the +myisam_stats_method +system variable\&. For more information, see the description of +myisam_stats_method +in +Section\ \&5.1.4, \(lqServer System Variables\(rq, and +Section\ \&7.4.7, \(lqMyISAM Index Statistics Collection\(rq\&. +.PP +ft_min_word_len +and +ft_max_word_len +indicate the minimum and maximum word length for +FULLTEXT +indexes\&. +ft_stopword_file +names the stopword file\&. These need to be set under the following circumstances\&. +.PP +If you use +\fBmyisamchk\fR +to perform an operation that modifies table indexes (such as repair or analyze), the +FULLTEXT +indexes are rebuilt using the default full\-text parameter values for minimum and maximum word length and the stopword file unless you specify otherwise\&. This can result in queries failing\&. +.PP +The problem occurs because these parameters are known only by the server\&. They are not stored in +MyISAM +index files\&. To avoid the problem if you have modified the minimum or maximum word length or the stopword file in the server, specify the same +ft_min_word_len, +ft_max_word_len, and +ft_stopword_file +values to +\fBmyisamchk\fR +that you use for +\fBmysqld\fR\&. For example, if you have set the minimum word length to 3, you can repair a table with +\fBmyisamchk\fR +like this: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmyisamchk \-\-recover \-\-ft_min_word_len=3 \fR\fB\fItbl_name\fR\fR\fB\&.MYI\fR +.fi +.if n \{\ +.RE +.\} +.PP +To ensure that +\fBmyisamchk\fR +and the server use the same values for full\-text parameters, you can place each one in both the +[mysqld] +and +[myisamchk] +sections of an option file: +.sp +.if n \{\ +.RS 4 +.\} +.nf +[mysqld] +ft_min_word_len=3 +[myisamchk] +ft_min_word_len=3 +.fi +.if n \{\ +.RE +.\} +.PP +An alternative to using +\fBmyisamchk\fR +is to use the +REPAIR TABLE, +ANALYZE TABLE, +OPTIMIZE TABLE, or +ALTER TABLE\&. These statements are performed by the server, which knows the proper full\-text parameter values to use\&. +.SH "MYISAMCHK CHECK OPTIONS" +.\" check options: myisamchk +.\" tables: checking +.PP +\fBmyisamchk\fR +supports the following options for table checking operations: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" myisamchk: check option +.\" check option: myisamchk +\fB\-\-check\fR, +\fB\-c\fR +.sp +Check the table for errors\&. This is the default operation if you specify no option that selects an operation type explicitly\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" myisamchk: check-only-changed option +.\" check-only-changed option: myisamchk +\fB\-\-check\-only\-changed\fR, +\fB\-C\fR +.sp +Check only tables that have changed since the last check\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" myisamchk: extend-check option +.\" extend-check option: myisamchk +\fB\-\-extend\-check\fR, +\fB\-e\fR +.sp +Check the table very thoroughly\&. This is quite slow if the table has many indexes\&. This option should only be used in extreme cases\&. Normally, +\fBmyisamchk\fR +or +\fBmyisamchk \-\-medium\-check\fR +should be able to determine whether there are any errors in the table\&. +.sp +If you are using +\fB\-\-extend\-check\fR +and have plenty of memory, setting the +key_buffer_size +variable to a large value helps the repair operation run faster\&. +.sp +For a description of the output format, see +the section called \(lqMYISAMCHK TABLE INFORMATION\(rq\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" myisamchk: fast option +.\" fast option: myisamchk +\fB\-\-fast\fR, +\fB\-F\fR +.sp +Check only tables that haven't been closed properly\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" myisamchk: force option +.\" force option: myisamchk +\fB\-\-force\fR, +\fB\-f\fR +.sp +Do a repair operation automatically if +\fBmyisamchk\fR +finds any errors in the table\&. The repair type is the same as that specified with the +\fB\-\-recover\fR +or +\fB\-r\fR +option\&. States will be updated as with +\fB\-\-update\-state\fR\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" myisamchk: information option +.\" information option: myisamchk +\fB\-\-information\fR, +\fB\-i\fR +.sp +Print informational statistics about the table that is checked\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" myisamchk: medium-check option +.\" medium-check option: myisamchk +\fB\-\-medium\-check\fR, +\fB\-m\fR +.sp +Do a check that is faster than an +\fB\-\-extend\-check\fR +operation\&. This finds only 99\&.99% of all errors, which should be good enough in most cases\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" myisamchk: read-only option +.\" read-only option: myisamchk +\fB\-\-read\-only\fR, +\fB\-T\fR +.sp +Do not mark the table as checked\&. This is useful if you use +\fBmyisamchk\fR +to check a table that is in use by some other application that does not use locking, such as +\fBmysqld\fR +when run with external locking disabled\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" myisamchk: update-state option +.\" update-state option: myisamchk +\fB\-\-update\-state\fR, +\fB\-U\fR +.sp +Store information in the +\&.MYI +file to indicate when the table was checked and whether the table crashed\&. This should be used to get full benefit of the +\fB\-\-check\-only\-changed\fR +option, but you shouldn't use this option if the +\fBmysqld\fR +server is using the table and you are running it with external locking disabled\&. +.RE +.SH "MYISAMCHK REPAIR OPTIONS" +.\" repair options: myisamchk +.\" files: repairing +.PP +\fBmyisamchk\fR +supports the following options for table repair operations (operations performed when an option such as +\fB\-\-recover\fR +or +\fB\-\-safe\-recover\fR +is given): +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" myisamchk: backup option +.\" backup option: myisamchk +\fB\-\-backup\fR, +\fB\-B\fR +.sp +Make a backup of the +\&.MYD +file as +\fIfile_name\fR\-\fItime\fR\&.BAK +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" myisamchk: character-sets-dir option +.\" character-sets-dir option: myisamchk +\fB\-\-character\-sets\-dir=\fR\fB\fIpath\fR\fR +.sp +The directory where character sets are installed\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" myisamchk: correct-checksum option +.\" correct-checksum option: myisamchk +\fB\-\-correct\-checksum\fR +.sp +Correct the checksum information for the table\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" myisamchk: create-missing-keys option +.\" create-missing-keys option: myisamchk +\fB\-\-create\-missing\-keys\fR +.sp +Create missing keys. This assumes that the data file is correct and that the +number of rows stored in the index file is correct\&. Enables +\fB\-\-quick\fR\&. + +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" myisamchk: data-file-length option +.\" data-file-length option: myisamchk +\fB\-\-data\-file\-length=\fR\fB\fIlen\fR\fR, +\fB\-D \fR\fB\fIlen\fR\fR +.sp +The maximum length of the data file (when re\-creating data file when it is +\(lqfull\(rq)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" myisamchk: extend-check option +.\" extend-check option: myisamchk +\fB\-\-extend\-check\fR, +\fB\-e\fR +.sp +Do a repair that tries to recover every possible row from the data file\&. Normally, this also finds a lot of garbage rows\&. Do not use this option unless you are desperate\&. +.sp +For a description of the output format, see +the section called \(lqMYISAMCHK TABLE INFORMATION\(rq\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" myisamchk: force option +.\" force option: myisamchk +\fB\-\-force\fR, +\fB\-f\fR +.sp +Overwrite old intermediate files (files with names like +\fItbl_name\fR\&.TMD) instead of aborting\&. Add another +\fB\-\-force\fR +to avoid 'myisam_sort_buffer_size is too small' errors\&. In this case +we will attempt to do the repair with the given +\fBmyisam_sort_buffer_size\fR +and dynamically allocate as many management buffers as needed\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" myisamchk: keys-used option +.\" keys-used option: myisamchk +\fB\-\-keys\-used=\fR\fB\fIval\fR\fR, +\fB\-k \fR\fB\fIval\fR\fR +.sp +For +\fBmyisamchk\fR, the option value is a bit\-value that indicates which indexes to update\&. Each binary bit of the option value corresponds to a table index, where the first index is bit 0\&. An option value of 0 disables updates to all indexes, which can be used to get faster inserts\&. Deactivated indexes can be reactivated by using +\fBmyisamchk \-r\fR\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" myisamchk: max-record-length option +.\" max-record-length option: myisamchk +\fB\-\-max\-record\-length=\fR\fB\fIlen\fR\fR +.sp +Skip rows larger than the given length if +\fBmyisamchk\fR +cannot allocate memory to hold them\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" myisamchk: parallel-recover option +.\" parallel-recover option: myisamchk +\fB\-\-parallel\-recover\fR, +\fB\-p\fR +.sp +Use the same technique as +\fB\-r\fR +and +\fB\-n\fR, but create all the keys in parallel, using different threads\&. +\fIThis is beta\-quality code\&. Use at your own risk!\fR +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" myisamchk: quick option +.\" quick option: myisamchk +\fB\-\-quick\fR, +\fB\-q\fR +.sp +Achieve a faster repair by modifying only the index file, not the data file\&. You can specify this option twice to force +\fBmyisamchk\fR +to modify the original data file in case of duplicate keys\&. NOTE: Tables where the data file is corrupted can't be fixed with this option\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" myisamchk: recover option +.\" recover option: myisamchk +\fB\-\-recover\fR, +\fB\-r\fR +.sp +Do a repair that can fix almost any problem except unique keys that are not unique (which is an extremely unlikely error with +MyISAM +tables)\&. If you want to recover a table, this is the option to try first\&. You should try +\fB\-\-safe\-recover\fR +only if +\fBmyisamchk\fR +reports that the table cannot be recovered using +\fB\-\-recover\fR\&. (In the unlikely case that +\fB\-\-recover\fR +fails, the data file remains intact\&.) +.sp +If you have lots of memory, you should increase the value of +sort_buffer_size\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" myisamchk: safe-recover option +.\" safe-recover option: myisamchk +\fB\-\-safe\-recover\fR, +\fB\-o\fR +.sp +Do a repair using an old recovery method that reads through all rows in order and updates all index trees based on the rows found\&. This is an order of magnitude slower than +\fB\-\-recover\fR, but can handle a couple of very unlikely cases that +\fB\-\-recover\fR +cannot\&. This recovery method also uses much less disk space than +\fB\-\-recover\fR\&. Normally, you should repair first using +\fB\-\-recover\fR, and then with +\fB\-\-safe\-recover\fR +only if +\fB\-\-recover\fR +fails\&. +.sp +If you have lots of memory, you should increase the value of +key_buffer_size\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" myisamchk: set-collation option +.\" set-collation option: myisamchk +\fB\-\-set\-collation=\fR\fB\fIname\fR\fR +.sp +Specify the collation to use for sorting table indexes\&. The character set name is implied by the first part of the collation name\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" myisamchk: sort-recover option +.\" sort-recover option: myisamchk +\fB\-\-sort\-recover\fR, +\fB\-n\fR +.sp +Force +\fBmyisamchk\fR +to use sorting to resolve the keys even if the temporary files would be very large\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" myisamchk: tmpdir option +.\" tmpdir option: myisamchk +\fB\-\-tmpdir=\fR\fB\fIpath\fR\fR, +\fB\-t \fR\fB\fIpath\fR\fR +.sp +The path of the directory to be used for storing temporary files\&. If this is not set, +\fBmyisamchk\fR +uses the value of the +TMPDIR +environment variable\&. +tmpdir +can be set to a list of directory paths that are used successively in round\-robin fashion for creating temporary files\&. The separator character between directory names is the colon (\(lq:\(rq) on Unix and the semicolon (\(lq;\(rq) on Windows, NetWare, and OS/2\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" myisamchk: unpack option +.\" unpack option: myisamchk +\fB\-\-unpack\fR, +\fB\-u\fR +.sp +Unpack a table that was packed with +\fBmyisampack\fR\&. +.RE +.SH "OTHER MYISAMCHK OPTIONS" +.PP +\fBmyisamchk\fR +supports the following options for actions other than table checks and repairs: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" myisamchk: analyze option +.\" analyze option: myisamchk +\fB\-\-analyze\fR, +\fB\-a\fR +.sp +Analyze the distribution of key values\&. This improves join performance by enabling the join optimizer to better choose the order in which to join the tables and which indexes it should use\&. To obtain information about the key distribution, use a +\fBmyisamchk \-\-description \-\-verbose \fR\fB\fItbl_name\fR\fR +command or the +SHOW INDEX FROM \fItbl_name\fR +statement\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" myisamchk: block-search option +.\" block-search option: myisamchk +\fB\-\-block\-search=\fR\fB\fIoffset\fR\fR, +\fB\-b \fR\fB\fIoffset\fR\fR +.sp +Find the record that a block at the given offset belongs to\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" myisamchk: description option +.\" description option: myisamchk +\fB\-\-description\fR, +\fB\-d\fR +.sp +Print some descriptive information about the table\&. Specifying the +\fB\-\-verbose\fR +option once or twice produces additional information\&. See +the section called \(lqMYISAMCHK TABLE INFORMATION\(rq\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" myisamchk: set-auto-increment[ option +.\" set-auto-increment[ option: myisamchk +\fB\-\-set\-auto\-increment[=\fR\fB\fIvalue\fR\fR\fB]\fR, +\fB\-A[\fR\fB\fIvalue\fR\fR\fB]\fR +.sp +Force +AUTO_INCREMENT +numbering for new records to start at the given value (or higher, if there are existing records with +AUTO_INCREMENT +values this large)\&. If +\fIvalue\fR +is not specified, +AUTO_INCREMENT +numbers for new records begin with the largest value currently in the table, plus one\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" myisamchk: sort-index option +.\" sort-index option: myisamchk +\fB\-\-sort\-index\fR, +\fB\-S\fR +.sp +Sort the index tree blocks in high\-low order\&. This optimizes seeks and makes table scans that use indexes faster\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" myisamchk: sort-records option +.\" sort-records option: myisamchk +\fB\-\-sort\-records=\fR\fB\fIN\fR\fR, +\fB\-R \fR\fB\fIN\fR\fR +.sp +Sort records according to a particular index\&. This makes your data much more localized and may speed up range\-based +SELECT +and +ORDER BY +operations that use this index\&. (The first time you use this option to sort a table, it may be very slow\&.) To determine a table's index numbers, use +SHOW INDEX, which displays a table's indexes in the same order that +\fBmyisamchk\fR +sees them\&. Indexes are numbered beginning with 1\&. +.sp +If keys are not packed (PACK_KEYS=0), they have the same length, so when +\fBmyisamchk\fR +sorts and moves records, it just overwrites record offsets in the index\&. If keys are packed (PACK_KEYS=1), +\fBmyisamchk\fR +must unpack key blocks first, then re\-create indexes and pack the key blocks again\&. (In this case, re\-creating indexes is faster than updating offsets for each index\&.) +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" myisamchk: stats_method option +.\" stats_method option: myisamchk +\fB\-\-stats\-method=name\fR +.sp +Specifies how index statistics collection code should treat NULLs\&. Possible values +of name are "nulls_unequal" (default), "nulls_equal" (emulate MySQL 4 behavior), and "nulls_ignored"\&. +.RE +.SH "MYISAMCHK TABLE INFORMATION" +.\" table description: myisamchk +.\" tables: information +.\" examples: myisamchk output +.\" myisamchk: example output +.PP +To obtain a description of a +MyISAM +table or statistics about it, use the commands shown here\&. The output from these commands is explained later in this section\&. +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fBmyisamchk \-d \fR\fB\fItbl_name\fR\fR +.sp +Runs +\fBmyisamchk\fR +in +\(lqdescribe mode\(rq +to produce a description of your table\&. If you start the MariaDB server with external locking disabled, +\fBmyisamchk\fR +may report an error for a table that is updated while it runs\&. However, because +\fBmyisamchk\fR +does not change the table in describe mode, there is no risk of destroying data\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fBmyisamchk \-dv \fR\fB\fItbl_name\fR\fR +.sp +Adding +\fB\-v\fR +runs +\fBmyisamchk\fR +in verbose mode so that it produces more information about the table\&. Adding +\fB\-v\fR +a second time produces even more information\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fBmyisamchk \-eis \fR\fB\fItbl_name\fR\fR +.sp +Shows only the most important information from a table\&. This operation is slow because it must read the entire table\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fBmyisamchk \-eiv \fR\fB\fItbl_name\fR\fR +.sp +This is like +\fB\-eis\fR, but tells you what is being done\&. +.RE +.PP +The +\fItbl_name\fR +argument can be either the name of a +MyISAM +table or the name of its index file, as described in +\fBmyisamchk\fR(1)\&. Multiple +\fItbl_name\fR +arguments can be given\&. +.PP +Suppose that a table named +person +has the following structure\&. (The +MAX_ROWS +table option is included so that in the example output from +\fBmyisamchk\fR +shown later, some values are smaller and fit the output format more easily\&.) +.sp +.if n \{\ +.RS 4 +.\} +.nf +CREATE TABLE person +( + id INT NOT NULL AUTO_INCREMENT, + last_name VARCHAR(20) NOT NULL, + first_name VARCHAR(20) NOT NULL, + birth DATE, + death DATE, + PRIMARY KEY (id), + INDEX (last_name, first_name), + INDEX (birth) +) MAX_ROWS = 1000000; +.fi +.if n \{\ +.RE +.\} +.PP +Suppose also that the table has these data and index file sizes: +.sp +.if n \{\ +.RS 4 +.\} +.nf +\-rw\-rw\-\-\-\- 1 mysql mysql 9347072 Aug 19 11:47 person\&.MYD +\-rw\-rw\-\-\-\- 1 mysql mysql 6066176 Aug 19 11:47 person\&.MYI +.fi +.if n \{\ +.RE +.\} +.PP +Example of +\fBmyisamchk \-dvv\fR +output: +.sp +.if n \{\ +.RS 4 +.\} +.nf +MyISAM file: person +Record format: Packed +Character set: latin1_swedish_ci (8) +File\-version: 1 +Creation time: 2009\-08\-19 16:47:41 +Recover time: 2009\-08\-19 16:47:56 +Status: checked,analyzed,optimized keys +Auto increment key: 1 Last value: 306688 +Data records: 306688 Deleted blocks: 0 +Datafile parts: 306688 Deleted data: 0 +Datafile pointer (bytes): 4 Keyfile pointer (bytes): 3 +Datafile length: 9347072 Keyfile length: 6066176 +Max datafile length: 4294967294 Max keyfile length: 17179868159 +Recordlength: 54 +table description: +Key Start Len Index Type Rec/key Root Blocksize +1 2 4 unique long 1 99328 1024 +2 6 20 multip\&. varchar prefix 512 3563520 1024 + 27 20 varchar 512 +3 48 3 multip\&. uint24 NULL 306688 6065152 1024 +Field Start Length Nullpos Nullbit Type +1 1 1 +2 2 4 no zeros +3 6 21 varchar +4 27 21 varchar +5 48 3 1 1 no zeros +6 51 3 1 2 no zeros +.fi +.if n \{\ +.RE +.\} +.PP +Explanations for the types of information +\fBmyisamchk\fR +produces are given here\&. +\(lqKeyfile\(rq +refers to the index file\&. +\(lqRecord\(rq +and +\(lqrow\(rq +are synonymous, as are +\(lqfield\(rq +and +\(lqcolumn\&.\(rq +.PP +The initial part of the table description contains these values: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +MyISAM file +.sp +Name of the +MyISAM +(index) file\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Record format +.sp +The format used to store table rows\&. The preceding examples use +Fixed length\&. Other possible values are +Compressed +and +Packed\&. (Packed +corresponds to what +SHOW TABLE STATUS +reports as +Dynamic\&.) +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Chararacter set +.sp +The table default character set\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +File\-version +.sp +Version of +MyISAM +format\&. Currently always 1\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Creation time +.sp +When the data file was created\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Recover time +.sp +When the index/data file was last reconstructed\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Status +.sp +Table status flags\&. Possible values are +crashed, +open, +changed, +analyzed, +optimized keys, and +sorted index pages\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Auto increment key, +Last value +.sp +The key number associated the table's +AUTO_INCREMENT +column, and the most recently generated value for this column\&. These fields do not appear if there is no such column\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Data records +.sp +The number of rows in the table\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Deleted blocks +.sp +How many deleted blocks still have reserved space\&. You can optimize your table to minimize this space\&. See +Section\ \&6.6.4, \(lqMyISAM Table Optimization\(rq\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Datafile parts +.sp +For dynamic\-row format, this indicates how many data blocks there are\&. For an optimized table without fragmented rows, this is the same as +Data records\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Deleted data +.sp +How many bytes of unreclaimed deleted data there are\&. You can optimize your table to minimize this space\&. See +Section\ \&6.6.4, \(lqMyISAM Table Optimization\(rq\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Datafile pointer +.sp +The size of the data file pointer, in bytes\&. It is usually 2, 3, 4, or 5 bytes\&. Most tables manage with 2 bytes, but this cannot be controlled from MariaDB yet\&. For fixed tables, this is a row address\&. For dynamic tables, this is a byte address\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Keyfile pointer +.sp +The size of the index file pointer, in bytes\&. It is usually 1, 2, or 3 bytes\&. Most tables manage with 2 bytes, but this is calculated automatically by MariaDB\&. It is always a block address\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Max datafile length +.sp +How long the table data file can become, in bytes\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Max keyfile length +.sp +How long the table index file can become, in bytes\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Recordlength +.sp +How much space each row takes, in bytes\&. +.RE +.PP +The +table description +part of the output includes a list of all keys in the table\&. For each key, +\fBmyisamchk\fR +displays some low\-level information: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Key +.sp +This key's number\&. This value is shown only for the first column of the key\&. If this value is missing, the line corresponds to the second or later column of a multiple\-column key\&. For the table shown in the example, there are two +table description +lines for the second index\&. This indicates that it is a multiple\-part index with two parts\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Start +.sp +Where in the row this portion of the index starts\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Len +.sp +How long this portion of the index is\&. For packed numbers, this should always be the full length of the column\&. For strings, it may be shorter than the full length of the indexed column, because you can index a prefix of a string column\&. The total length of a multiple\-part key is the sum of the +Len +values for all key parts\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Index +.sp +Whether a key value can exist multiple times in the index\&. Possible values are +unique +or +multip\&. +(multiple)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Type +.sp +What data type this portion of the index has\&. This is a +MyISAM +data type with the possible values +packed, +stripped, or +empty\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Root +.sp +Address of the root index block\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Blocksize +.sp +The size of each index block\&. By default this is 1024, but the value may be changed at compile time when MariaDB is built from source\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Rec/key +.sp +This is a statistical value used by the optimizer\&. It tells how many rows there are per value for this index\&. A unique index always has a value of 1\&. This may be updated after a table is loaded (or greatly changed) with +\fBmyisamchk \-a\fR\&. If this is not updated at all, a default value of 30 is given\&. +.RE +.PP +The last part of the output provides information about each column: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Field +.sp +The column number\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Start +.sp +The byte position of the column within table rows\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Length +.sp +The length of the column in bytes\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Nullpos, +Nullbit +.sp +For columns that can be +NULL, +MyISAM +stores +NULL +values as a flag in a byte\&. Depending on how many nullable columns there are, there can be one or more bytes used for this purpose\&. The +Nullpos +and +Nullbit +values, if nonempty, indicate which byte and bit contains that flag indicating whether the column is +NULL\&. +.sp +The position and number of bytes used to store +NULL +flags is shown in the line for field 1\&. This is why there are six +Field +lines for the +person +table even though it has only five columns\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Type +.sp +The data type\&. The value may contain any of the following descriptors: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +constant +.sp +All rows have the same value\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +no endspace +.sp +Do not store endspace\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +no endspace, not_always +.sp +Do not store endspace and do not do endspace compression for all values\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +no endspace, no empty +.sp +Do not store endspace\&. Do not store empty values\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +table\-lookup +.sp +The column was converted to an +ENUM\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +zerofill(\fIN\fR) +.sp +The most significant +\fIN\fR +bytes in the value are always 0 and are not stored\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +no zeros +.sp +Do not store zeros\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +always zero +.sp +Zero values are stored using one bit\&. +.RE +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Huff tree +.sp +The number of the Huffman tree associated with the column\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Bits +.sp +The number of bits used in the Huffman tree\&. +.RE +.PP +The +Huff tree +and +Bits +fields are displayed if the table has been compressed with +\fBmyisampack\fR\&. See +\fBmyisampack\fR(1), for an example of this information\&. +.PP +Example of +\fBmyisamchk \-eiv\fR +output: +.sp +.if n \{\ +.RS 4 +.\} +.nf +Checking MyISAM file: person +Data records: 306688 Deleted blocks: 0 +\- check file\-size +\- check record delete\-chain +No recordlinks +\- check key delete\-chain +block_size 1024: +\- check index reference +\- check data record references index: 1 +Key: 1: Keyblocks used: 98% Packed: 0% Max levels: 3 +\- check data record references index: 2 +Key: 2: Keyblocks used: 99% Packed: 97% Max levels: 3 +\- check data record references index: 3 +Key: 3: Keyblocks used: 98% Packed: \-14% Max levels: 3 +Total: Keyblocks used: 98% Packed: 89% +\- check records and index references +\fI*** LOTS OF ROW NUMBERS DELETED ***\fR +Records: 306688 M\&.recordlength: 25 Packed: 83% +Recordspace used: 97% Empty space: 2% Blocks/Record: 1\&.00 +Record blocks: 306688 Delete blocks: 0 +Record data: 7934464 Deleted data: 0 +Lost space: 256512 Linkdata: 1156096 +User time 43\&.08, System time 1\&.68 +Maximum resident set size 0, Integral resident set size 0 +Non\-physical pagefaults 0, Physical pagefaults 0, Swaps 0 +Blocks in 0 out 7, Messages in 0 out 0, Signals 0 +Voluntary context switches 0, Involuntary context switches 0 +Maximum memory usage: 1046926 bytes (1023k) +.fi +.if n \{\ +.RE +.\} +.PP +\fBmyisamchk \-eiv\fR +output includes the following information: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Data records +.sp +The number of rows in the table\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Deleted blocks +.sp +How many deleted blocks still have reserved space\&. You can optimize your table to minimize this space\&. See +Section\ \&6.6.4, \(lqMyISAM Table Optimization\(rq\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Key +.sp +The key number\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Keyblocks used +.sp +What percentage of the keyblocks are used\&. When a table has just been reorganized with +\fBmyisamchk\fR, the values are very high (very near theoretical maximum)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Packed +.sp +MariaDB tries to pack key values that have a common suffix\&. This can only be used for indexes on +CHAR +and +VARCHAR +columns\&. For long indexed strings that have similar leftmost parts, this can significantly reduce the space used\&. In the preceding example, the second key is 40 bytes long and a 97% reduction in space is achieved\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Max levels +.sp +How deep the B\-tree for this key is\&. Large tables with long key values get high values\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Records +.sp +How many rows are in the table\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +M\&.recordlength +.sp +The average row length\&. This is the exact row length for tables with fixed\-length rows, because all rows have the same length\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Packed +.sp +MariaDB strips spaces from the end of strings\&. The +Packed +value indicates the percentage of savings achieved by doing this\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Recordspace used +.sp +What percentage of the data file is used\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Empty space +.sp +What percentage of the data file is unused\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Blocks/Record +.sp +Average number of blocks per row (that is, how many links a fragmented row is composed of)\&. This is always 1\&.0 for fixed\-format tables\&. This value should stay as close to 1\&.0 as possible\&. If it gets too large, you can reorganize the table\&. See +Section\ \&6.6.4, \(lqMyISAM Table Optimization\(rq\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Recordblocks +.sp +How many blocks (links) are used\&. For fixed\-format tables, this is the same as the number of rows\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Deleteblocks +.sp +How many blocks (links) are deleted\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Recorddata +.sp +How many bytes in the data file are used\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Deleted data +.sp +How many bytes in the data file are deleted (unused)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Lost space +.sp +If a row is updated to a shorter length, some space is lost\&. This is the sum of all such losses, in bytes\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Linkdata +.sp +When the dynamic table format is used, row fragments are linked with pointers (4 to 7 bytes each)\&. +Linkdata +is the sum of the amount of storage used by all such pointers\&. +.RE +.SH "MYISAMCHK MEMORY USAGE" +.\" memory usage: myisamchk +.PP +Memory allocation is important when you run +\fBmyisamchk\fR\&. +\fBmyisamchk\fR +uses no more memory than its memory\-related variables are set to\&. If you are going to use +\fBmyisamchk\fR +on very large tables, you should first decide how much memory you want it to use\&. The default is to use only about 3MB to perform repairs\&. By using larger values, you can get +\fBmyisamchk\fR +to operate faster\&. For example, if you have more than 32MB RAM, you could use options such as these (in addition to any other options you might specify): +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmyisamchk \-\-sort_buffer_size=16M \e\fR + \fB\-\-key_buffer_size=16M \e\fR + \fB\-\-read_buffer_size=1M \e\fR + \fB\-\-write_buffer_size=1M \&.\&.\&.\fR +.fi +.if n \{\ +.RE +.\} +.PP +Using +\fB\-\-sort_buffer_size=16M\fR +should probably be enough for most cases\&. +.PP +Be aware that +\fBmyisamchk\fR +uses temporary files in +TMPDIR\&. If +TMPDIR +points to a memory file system, out of memory errors can easily occur\&. If this happens, run +\fBmyisamchk\fR +with the +\fB\-\-tmpdir=\fR\fB\fIpath\fR\fR +option to specify a directory located on a file system that has more space\&. +.PP +When performing repair operations, +\fBmyisamchk\fR +also needs a lot of disk space: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Twice the size of the data file (the original file and a copy)\&. This space is not needed if you do a repair with +\fB\-\-quick\fR; in this case, only the index file is re\-created\&. +\fIThis space must be available on the same file system as the original data file\fR, as the copy is created in the same directory as the original\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Space for the new index file that replaces the old one\&. The old index file is truncated at the start of the repair operation, so you usually ignore this space\&. This space must be available on the same file system as the original data file\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +When using +\fB\-\-recover\fR +or +\fB\-\-sort\-recover\fR +(but not when using +\fB\-\-safe\-recover\fR), you need space on disk for sorting\&. This space is allocated in the temporary directory (specified by +TMPDIR +or +\fB\-\-tmpdir=\fR\fB\fIpath\fR\fR)\&. The following formula yields the amount of space required: +.sp +.if n \{\ +.RS 4 +.\} +.nf +(\fIlargest_key\fR + \fIrow_pointer_length\fR) \(mu \fInumber_of_rows\fR \(mu 2 +.fi +.if n \{\ +.RE +.\} +.sp +You can check the length of the keys and the +\fIrow_pointer_length\fR +with +\fBmyisamchk \-dv \fR\fB\fItbl_name\fR\fR +(see +the section called \(lqMYISAMCHK TABLE INFORMATION\(rq)\&. The +\fIrow_pointer_length\fR +and +\fInumber_of_rows\fR +values are the +Datafile pointer +and +Data records +values in the table description\&. To determine the +\fIlargest_key\fR +value, check the +Key +lines in the table description\&. The +Len +column indicates the number of bytes for each key part\&. For a multiple\-column index, the key size is the sum of the +Len +values for all key parts\&. +.RE +.PP +If you have a problem with disk space during repair, you can try +\fB\-\-safe\-recover\fR +instead of +\fB\-\-recover\fR\&. +.SH "COPYRIGHT" +.br +.PP +Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc., 2010-2020 MariaDB Foundation +.PP +This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License. +.PP +This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. +.PP +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-1335 USA or see http://www.gnu.org/licenses/. +.sp +.SH "SEE ALSO" +For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/ +.SH AUTHOR +MariaDB Foundation (http://www.mariadb.org/). diff --git a/man/myisamlog.1 b/man/myisamlog.1 new file mode 100644 index 00000000..dbf50cf7 --- /dev/null +++ b/man/myisamlog.1 @@ -0,0 +1,232 @@ +'\" t +.\" +.TH "\fBMYISAMLOG\fR" "1" "15 May 2020" "MariaDB 10.11" "MariaDB Database System" +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.\" myisamlog +.\" isamlog +.SH "NAME" +myisamlog \- display MyISAM log file contents +.SH "SYNOPSIS" +.HP \w'\fBmyisamlog\ [\fR\fB\fIoptions\fR\fR\fB]\ [\fR\fB\fIlog_file\fR\fR\fB\ [\fR\fB\fItbl_name\fR\fR\fB]\ \&.\&.\&.]\fR\ 'u +\fBmyisamlog [\fR\fB\fIoptions\fR\fR\fB] [\fR\fB\fIlog_file\fR\fR\fB [\fR\fB\fItbl_name\fR\fR\fB] \&.\&.\&.]\fR +.SH "DESCRIPTION" +.PP +\fBmyisamlog\fR +processes the contents of a +MyISAM +log file\&. +.PP +Invoke +\fBmyisamlog\fR +like this: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmyisamlog [\fR\fB\fIoptions\fR\fR\fB] [\fR\fB\fIlog_file\fR\fR\fB [\fR\fB\fItbl_name\fR\fR\fB] \&.\&.\&.]\fR +shell> \fBisamlog [\fR\fB\fIoptions\fR\fR\fB] [\fR\fB\fIlog_file\fR\fR\fB [\fR\fB\fItbl_name\fR\fR\fB] \&.\&.\&.]\fR +.fi +.if n \{\ +.RE +.\} +.PP +The default operation is update (\fB\-u\fR)\&. If a recovery is done (\fB\-r\fR), all writes and possibly updates and deletes are done and errors are only counted\&. The default log file name is +myisam\&.log +for +\fBmyisamlog\fR +and +isam\&.log +for +\fBisamlog\fR +if no +\fIlog_file\fR +argument is given\&. If tables are named on the command line, only those tables are updated\&. +.PP +\fBmyisamlog\fR +supports the following options: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fB\-?\fR, +\fB\-I\fR +.sp +Display a help message and exit\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fB\-c \fR\fB\fIN\fR\fR +.sp +Execute only +\fIN\fR +commands\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fB\-f \fR\fB\fIN\fR\fR +.sp +Specify the maximum number of open files\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fB\-i\fR +.sp +Display extra information before exiting\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fB\-o \fR\fB\fIoffset\fR\fR +.sp +Specify the starting offset\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fB\-p \fR\fB\fIN\fR\fR +.sp +Remove +\fIN\fR +components from path\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fB\-r\fR +.sp +Perform a recovery operation\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fB\-R \fR\fB\fIrecord_pos_file record_pos\fR\fR +.sp +Specify record position file and record position\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fB\-u\fR +.sp +Perform an update operation\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fB\-v\fR +.sp +Verbose mode\&. Print more output about what the program does\&. This option can be given multiple times to produce more and more output\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fB\-w \fR\fB\fIwrite_file\fR\fR +.sp +Specify the write file\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fB\-V\fR +.sp +Display version information\&. +.RE +.SH "COPYRIGHT" +.br +.PP +Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc., 2010-2020 MariaDB Foundation +.PP +This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License. +.PP +This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. +.PP +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-1335 USA or see http://www.gnu.org/licenses/. +.sp +.SH "SEE ALSO" +For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/ +.SH AUTHOR +MariaDB Foundation (http://www.mariadb.org/). diff --git a/man/myisampack.1 b/man/myisampack.1 new file mode 100644 index 00000000..89dab7d8 --- /dev/null +++ b/man/myisampack.1 @@ -0,0 +1,837 @@ +'\" t +.\" +.TH "\fBMYISAMPACK\fR" "1" "15 May 2020" "MariaDB 10.11" "MariaDB Database System" +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.\" myisampack +.\" compressed tables +.\" tables: compressed +.\" MyISAM: compressed tables +.SH "NAME" +myisampack \- generate compressed, read\-only MyISAM tables +.SH "SYNOPSIS" +.HP \w'\fBmyisampack\ [\fR\fB\fIoptions\fR\fR\fB]\ \fR\fB\fIfile_name\fR\fR\fB\ \&.\&.\&.\fR\ 'u +\fBmyisampack [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fIfile_name\fR\fR\fB \&.\&.\&.\fR +.SH "DESCRIPTION" +.PP +The +\fBmyisampack\fR +utility compresses +MyISAM +tables\&. +\fBmyisampack\fR +works by compressing each column in the table separately\&. Usually, +\fBmyisampack\fR +packs the data file 40%\(en70%\&. +.PP +When the table is used later, the server reads into memory the information needed to decompress columns\&. This results in much better performance when accessing individual rows, because you only have to uncompress exactly one row\&. +.PP +MySQL uses +mmap() +when possible to perform memory mapping on compressed tables\&. If +mmap() +does not work, MySQL falls back to normal read/write file operations\&. +.PP +Please note the following: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +If the +\fBmysqld\fR +server was invoked with external locking disabled, it is not a good idea to invoke +\fBmyisampack\fR +if the table might be updated by the server during the packing process\&. It is safest to compress tables with the server stopped\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +After packing a table, it becomes read only\&. This is generally intended (such as when accessing packed tables on a CD)\&. +.RE +.PP +Invoke +\fBmyisampack\fR +like this: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmyisampack [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fIfile_name\fR\fR\fB \&.\&.\&.\fR +.fi +.if n \{\ +.RE +.\} +.PP +Each file name argument should be the name of an index (\&.MYI) file\&. If you are not in the database directory, you should specify the path name to the file\&. It is permissible to omit the +\&.MYI +extension\&. +.PP +After you compress a table with +\fBmyisampack\fR, you should use +\fBmyisamchk \-rq\fR +to rebuild its indexes\&. +\fBmyisamchk\fR(1)\&. +.PP +\fBmyisampack\fR +supports the following options\&. It also reads option files and supports the options for processing them described at +Section\ \&4.2.3.3.1, \(lqCommand-Line Options that Affect Option-File Handling\(rq\&. +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" myisampack: help option +.\" help option: myisampack +\fB\-\-help\fR, +\fB\-?\fR +.sp +Display a help message and exit\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" myisampack: backup option +.\" backup option: myisampack +\fB\-\-backup\fR, +\fB\-b\fR +.sp +Make a backup of each table's data file using the name +\fItbl_name\fR\&.OLD\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" myisampack: character-sets-dir option +.\" character-sets-dir option: myisampack +\fB\-\-character\-sets\-dir=\fR\fB\fIpath\fR\fR +.sp +The directory where character sets are installed\&. See +Section\ \&9.5, \(lqCharacter Set Configuration\(rq\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" myisampack: debug option +.\" debug option: myisampack +\fB\-\-debug[=\fR\fB\fIdebug_options\fR\fR\fB]\fR, +\fB\-# [\fR\fB\fIdebug_options\fR\fR\fB]\fR +.sp +Write a debugging log\&. A typical +\fIdebug_options\fR +string is 'd:t:o,\fIfile_name\fR'. The default is 'd:t:o'. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" myisampack: force option +.\" force option: myisampack +\fB\-\-force\fR, +\fB\-f\fR +.sp +Produce a packed table even if it becomes larger than the original or if the intermediate file from an earlier invocation of +\fBmyisampack\fR +exists\&. (\fBmyisampack\fR +creates an intermediate file named +\fItbl_name\fR\&.TMD +in the database directory while it compresses the table\&. If you kill +\fBmyisampack\fR, the +\&.TMD +file might not be deleted\&.) Normally, +\fBmyisampack\fR +exits with an error if it finds that +\fItbl_name\fR\&.TMD +exists\&. With +\fB\-\-force\fR, +\fBmyisampack\fR +packs the table anyway\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" myisampack: join option +.\" join option: myisampack +\fB\-\-join=\fR\fB\fIbig_tbl_name\fR\fR, +\fB\-j \fR\fB\fIbig_tbl_name\fR\fR +.sp +Join all tables named on the command line into a single packed table +\fIbig_tbl_name\fR\&. All tables that are to be combined +\fImust\fR +have identical structure (same column names and types, same indexes, and so forth)\&. +.sp +\fIbig_tbl_name\fR +must not exist prior to the join operation\&. All source tables named on the command line to be merged into +\fIbig_tbl_name\fR +must exist\&. The source tables are read for the join operation but not modified\&. The join operation does not create a +\&.frm +file for +\fIbig_tbl_name\fR, so after the join operation finishes, copy the +\&.frm +file from one of the source tables and name it +\fIbig_tbl_name\fR\&.frm\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" myisampack: silent option +.\" silent option: myisampack +\fB\-\-silent\fR, +\fB\-s\fR +.sp +Silent mode\&. Write output only when errors occur\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" myisampack: test option +.\" test option: myisampack +\fB\-\-test\fR, +\fB\-t\fR +.sp +Do not actually pack the table, just test packing it\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" myisampack: tmpdir option +.\" tmpdir option: myisampack +\fB\-\-tmpdir=\fR\fB\fIpath\fR\fR, +\fB\-T \fR\fB\fIpath\fR\fR +.sp +Use the named directory as the location where +\fBmyisampack\fR +creates temporary files\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" myisampack: verbose option +.\" verbose option: myisampack +\fB\-\-verbose\fR, +\fB\-v\fR +.sp +Verbose mode\&. Write information about the progress of the packing operation and its result\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" myisampack: version option +.\" version option: myisampack +\fB\-\-version\fR, +\fB\-V\fR +.sp +Display version information and exit\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" myisampack: wait option +.\" wait option: myisampack +\fB\-\-wait\fR, +\fB\-w\fR +.sp +Wait and retry if the table is in use\&. If the +\fBmysqld\fR +server was invoked with external locking disabled, it is not a good idea to invoke +\fBmyisampack\fR +if the table might be updated by the server during the packing process\&. +.RE +.\" examples: compressed tables +.PP +The following sequence of commands illustrates a typical table compression session: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBls \-l station\&.*\fR +\-rw\-rw\-r\-\- 1 monty my 994128 Apr 17 19:00 station\&.MYD +\-rw\-rw\-r\-\- 1 monty my 53248 Apr 17 19:00 station\&.MYI +\-rw\-rw\-r\-\- 1 monty my 5767 Apr 17 19:00 station\&.frm +shell> \fBmyisamchk \-dvv station\fR +MyISAM file: station +Isam\-version: 2 +Creation time: 1996\-03\-13 10:08:58 +Recover time: 1997\-02\-02 3:06:43 +Data records: 1192 Deleted blocks: 0 +Datafile parts: 1192 Deleted data: 0 +Datafile pointer (bytes): 2 Keyfile pointer (bytes): 2 +Max datafile length: 54657023 Max keyfile length: 33554431 +Recordlength: 834 +Record format: Fixed length +table description: +Key Start Len Index Type Root Blocksize Rec/key +1 2 4 unique unsigned long 1024 1024 1 +2 32 30 multip\&. text 10240 1024 1 +Field Start Length Type +1 1 1 +2 2 4 +3 6 4 +4 10 1 +5 11 20 +6 31 1 +7 32 30 +8 62 35 +9 97 35 +10 132 35 +11 167 4 +12 171 16 +13 187 35 +14 222 4 +15 226 16 +16 242 20 +17 262 20 +18 282 20 +19 302 30 +20 332 4 +21 336 4 +22 340 1 +23 341 8 +24 349 8 +25 357 8 +26 365 2 +27 367 2 +28 369 4 +29 373 4 +30 377 1 +31 378 2 +32 380 8 +33 388 4 +34 392 4 +35 396 4 +36 400 4 +37 404 1 +38 405 4 +39 409 4 +40 413 4 +41 417 4 +42 421 4 +43 425 4 +44 429 20 +45 449 30 +46 479 1 +47 480 1 +48 481 79 +49 560 79 +50 639 79 +51 718 79 +52 797 8 +53 805 1 +54 806 1 +55 807 20 +56 827 4 +57 831 4 +shell> \fBmyisampack station\&.MYI\fR +Compressing station\&.MYI: (1192 records) +\- Calculating statistics +normal: 20 empty\-space: 16 empty\-zero: 12 empty\-fill: 11 +pre\-space: 0 end\-space: 12 table\-lookups: 5 zero: 7 +Original trees: 57 After join: 17 +\- Compressing file +87\&.14% +Remember to run myisamchk \-rq on compressed tables +shell> \fBls \-l station\&.*\fR +\-rw\-rw\-r\-\- 1 monty my 127874 Apr 17 19:00 station\&.MYD +\-rw\-rw\-r\-\- 1 monty my 55296 Apr 17 19:04 station\&.MYI +\-rw\-rw\-r\-\- 1 monty my 5767 Apr 17 19:00 station\&.frm +shell> \fBmyisamchk \-dvv station\fR +MyISAM file: station +Isam\-version: 2 +Creation time: 1996\-03\-13 10:08:58 +Recover time: 1997\-04\-17 19:04:26 +Data records: 1192 Deleted blocks: 0 +Datafile parts: 1192 Deleted data: 0 +Datafile pointer (bytes): 3 Keyfile pointer (bytes): 1 +Max datafile length: 16777215 Max keyfile length: 131071 +Recordlength: 834 +Record format: Compressed +table description: +Key Start Len Index Type Root Blocksize Rec/key +1 2 4 unique unsigned long 10240 1024 1 +2 32 30 multip\&. text 54272 1024 1 +Field Start Length Type Huff tree Bits +1 1 1 constant 1 0 +2 2 4 zerofill(1) 2 9 +3 6 4 no zeros, zerofill(1) 2 9 +4 10 1 3 9 +5 11 20 table\-lookup 4 0 +6 31 1 3 9 +7 32 30 no endspace, not_always 5 9 +8 62 35 no endspace, not_always, no empty 6 9 +9 97 35 no empty 7 9 +10 132 35 no endspace, not_always, no empty 6 9 +11 167 4 zerofill(1) 2 9 +12 171 16 no endspace, not_always, no empty 5 9 +13 187 35 no endspace, not_always, no empty 6 9 +14 222 4 zerofill(1) 2 9 +15 226 16 no endspace, not_always, no empty 5 9 +16 242 20 no endspace, not_always 8 9 +17 262 20 no endspace, no empty 8 9 +18 282 20 no endspace, no empty 5 9 +19 302 30 no endspace, no empty 6 9 +20 332 4 always zero 2 9 +21 336 4 always zero 2 9 +22 340 1 3 9 +23 341 8 table\-lookup 9 0 +24 349 8 table\-lookup 10 0 +25 357 8 always zero 2 9 +26 365 2 2 9 +27 367 2 no zeros, zerofill(1) 2 9 +28 369 4 no zeros, zerofill(1) 2 9 +29 373 4 table\-lookup 11 0 +30 377 1 3 9 +31 378 2 no zeros, zerofill(1) 2 9 +32 380 8 no zeros 2 9 +33 388 4 always zero 2 9 +34 392 4 table\-lookup 12 0 +35 396 4 no zeros, zerofill(1) 13 9 +36 400 4 no zeros, zerofill(1) 2 9 +37 404 1 2 9 +38 405 4 no zeros 2 9 +39 409 4 always zero 2 9 +40 413 4 no zeros 2 9 +41 417 4 always zero 2 9 +42 421 4 no zeros 2 9 +43 425 4 always zero 2 9 +44 429 20 no empty 3 9 +45 449 30 no empty 3 9 +46 479 1 14 4 +47 480 1 14 4 +48 481 79 no endspace, no empty 15 9 +49 560 79 no empty 2 9 +50 639 79 no empty 2 9 +51 718 79 no endspace 16 9 +52 797 8 no empty 2 9 +53 805 1 17 1 +54 806 1 3 9 +55 807 20 no empty 3 9 +56 827 4 no zeros, zerofill(2) 2 9 +57 831 4 no zeros, zerofill(1) 2 9 +.fi +.if n \{\ +.RE +.\} +.PP +\fBmyisampack\fR +displays the following kinds of information: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +normal +.sp +The number of columns for which no extra packing is used\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +empty\-space +.sp +The number of columns containing values that are only spaces\&. These occupy one bit\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +empty\-zero +.sp +The number of columns containing values that are only binary zeros\&. These occupy one bit\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +empty\-fill +.sp +The number of integer columns that do not occupy the full byte range of their type\&. These are changed to a smaller type\&. For example, a +BIGINT +column (eight bytes) can be stored as a +TINYINT +column (one byte) if all its values are in the range from +\-128 +to +127\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +pre\-space +.sp +The number of decimal columns that are stored with leading spaces\&. In this case, each value contains a count for the number of leading spaces\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +end\-space +.sp +The number of columns that have a lot of trailing spaces\&. In this case, each value contains a count for the number of trailing spaces\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +table\-lookup +.sp +The column had only a small number of different values, which were converted to an +ENUM +before Huffman compression\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +zero +.sp +The number of columns for which all values are zero\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Original trees +.sp +The initial number of Huffman trees\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +After join +.sp +The number of distinct Huffman trees left after joining trees to save some header space\&. +.RE +.PP +After a table has been compressed, the +Field +lines displayed by +\fBmyisamchk \-dvv\fR +include additional information about each column: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Type +.sp +The data type\&. The value may contain any of the following descriptors: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +constant +.sp +All rows have the same value\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +no endspace +.sp +Do not store endspace\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +no endspace, not_always +.sp +Do not store endspace and do not do endspace compression for all values\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +no endspace, no empty +.sp +Do not store endspace\&. Do not store empty values\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +table\-lookup +.sp +The column was converted to an +ENUM\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +zerofill(\fIN\fR) +.sp +The most significant +\fIN\fR +bytes in the value are always 0 and are not stored\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +no zeros +.sp +Do not store zeros\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +always zero +.sp +Zero values are stored using one bit\&. +.RE +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Huff tree +.sp +The number of the Huffman tree associated with the column\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Bits +.sp +The number of bits used in the Huffman tree\&. +.RE +.PP +After you run +\fBmyisampack\fR, you must run +\fBmyisamchk\fR +to re\-create any indexes\&. At this time, you can also sort the index blocks and create statistics needed for the MySQL optimizer to work more efficiently: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmyisamchk \-rq \-\-sort\-index \-\-analyze \fR\fB\fItbl_name\fR\fR\fB\&.MYI\fR +.fi +.if n \{\ +.RE +.\} +.PP +After you have installed the packed table into the MySQL database directory, you should execute +\fBmysqladmin flush\-tables\fR +to force +\fBmysqld\fR +to start using the new table\&. +.PP +To unpack a packed table, use the +\fB\-\-unpack\fR +option to +\fBmyisamchk\fR\&. +.SH "COPYRIGHT" +.br +.PP +Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc., 2010-2020 MariaDB Foundation +.PP +This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License. +.PP +This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. +.PP +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-1335 USA or see http://www.gnu.org/licenses/. +.sp +.SH "SEE ALSO" +For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/ +.SH AUTHOR +MariaDB Foundation (http://www.mariadb.org/). diff --git a/man/myrocks_hotbackup.1 b/man/myrocks_hotbackup.1 new file mode 100644 index 00000000..99dcbefa --- /dev/null +++ b/man/myrocks_hotbackup.1 @@ -0,0 +1,82 @@ +.TH MYROCKS_HOTBACKUP "1" "15 May 2020" "MariaDB 10.11" "MariaDB Database System" +.SH NAME +myrocks_hotbackup \- streaming backup for MariaDB MyRocks +.SH DESCRIPTION +Usage: +.PP +Backup: set \fB\-o\fR pipefail; myrocks_hotbackup \fB\-\-user\fR=\fI\,root\/\fR \fB\-\-password\fR=\fI\,pw\/\fR \fB\-\-port\fR=\fI\,3306\/\fR \fB\-\-checkpoint_dir=\fR<directory where temporary backup hard links are created> | ssh \fB\-o\fR NoneEnabled=yes remote_server 'tar \fB\-xi\fR \fB\-C\fR <directory on remote server where backups will be sent>' . You need to execute backup command on a server where you take backups. +.PP +Backup using WDT: myrocks_hotbackup \fB\-\-user\fR=\fI\,root\/\fR \fB\-\-password\fR=\fI\,pw\/\fR \fB\-\-stream\fR=\fI\,wdt\/\fR \fB\-\-checkpoint_dir=\fR<directory where temporary backup hard links are created> \fB\-\-destination=\fR<remote host name> \fB\-\-backup_dir=\fR<remote directory name>. This has to be executed at the src host. +.PP +Move\-Back: myrocks_hotbackup \fB\-\-move_back\fR \fB\-\-datadir=\fR<dest mysql datadir> \fB\-\-rocksdb_datadir=\fR<dest rocksdb datadir> \fB\-\-rocksdb_waldir=\fR<dest rocksdb wal dir> \fB\-\-backup_dir=\fR<where backup files are stored> . You need to execute move\-back command on a server where backup files are sent. +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +show this help message and exit +.TP +\fB\-i\fR CHECKPOINT_INTERVAL, \fB\-\-interval\fR=\fI\,CHECKPOINT_INTERVAL\/\fR +Number of seconds to renew checkpoint +.TP +\fB\-c\fR CHECKPOINT_DIRECTORY, \fB\-\-checkpoint_dir\fR=\fI\,CHECKPOINT_DIRECTORY\/\fR +Local directory name where checkpoints will be +created. +.TP +\fB\-d\fR DATADIR, \fB\-\-datadir\fR=\fI\,DATADIR\/\fR +backup mode: src MySQL datadir. move_back mode: dest +MySQL datadir +.TP +\fB\-s\fR OUTPUT_STREAM, \fB\-\-stream\fR=\fI\,OUTPUT_STREAM\/\fR +Setting streaming backup options. Currently tar, WDT +and xbstream are supported. Default is tar +.TP +\fB\-\-destination\fR=\fI\,DESTINATION\/\fR +Remote server name. Only used for WDT mode so far. +.TP +\fB\-\-avg_mbytes_per_sec\fR=\fI\,AVG_MBYTES_PER_SEC\/\fR +Average backup rate in MBytes/sec. WDT only. +.TP +\fB\-\-extra_wdt_sender_options\fR=\fI\,EXTRA_WDT_SENDER_OPTIONS\/\fR +Extra options for WDT sender +.TP +\fB\-\-extra_wdt_receiver_options\fR=\fI\,EXTRA_WDT_RECEIVER_OPTIONS\/\fR +Extra options for WDT receiver +.TP +\fB\-u\fR MYSQL_USER, \fB\-\-user\fR=\fI\,MYSQL_USER\/\fR +MySQL user name +.TP +\fB\-p\fR MYSQL_PASSWORD, \fB\-\-password\fR=\fI\,MYSQL_PASSWORD\/\fR +MySQL password name +.TP +\fB\-P\fR MYSQL_PORT, \fB\-\-port\fR=\fI\,MYSQL_PORT\/\fR +MySQL port number +.TP +\fB\-S\fR MYSQL_SOCKET, \fB\-\-socket\fR=\fI\,MYSQL_SOCKET\/\fR +MySQL socket path. Takes precedence over \fB\-\-port\fR. +.TP +\fB\-m\fR, \fB\-\-move_back\fR +Moving MyRocks backup files to proper locations. +.TP +\fB\-r\fR ROCKSDB_DATADIR, \fB\-\-rocksdb_datadir\fR=\fI\,ROCKSDB_DATADIR\/\fR +RocksDB target data directory where backup data files +will be moved. Must be empty. +.TP +\fB\-w\fR ROCKSDB_WALDIR, \fB\-\-rocksdb_waldir\fR=\fI\,ROCKSDB_WALDIR\/\fR +RocksDB target data directory where backup wal files +will be moved. Must be empty. +.TP +\fB\-b\fR BACKUPDIR, \fB\-\-backup_dir\fR=\fI\,BACKUPDIR\/\fR +backup mode for WDT: Remote directory to store backup. +move_back mode: Locations where backup files are +stored. +.TP +\fB\-f\fR, \fB\-\-skip_check_frm_timestamp\fR +skipping to check if frm files are updated after +starting backup. +.TP +\fB\-D\fR DEBUG_SIGNAL_FILE, \fB\-\-debug_signal_file\fR=\fI\,DEBUG_SIGNAL_FILE\/\fR +debugging purpose: waiting until the specified file is +created +.SH "SEE ALSO" +For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/ +.SH AUTHOR +MariaDB Foundation (http://www.mariadb.org/). diff --git a/man/mysql-stress-test.pl.1 b/man/mysql-stress-test.pl.1 new file mode 100644 index 00000000..6024a2ec --- /dev/null +++ b/man/mysql-stress-test.pl.1 @@ -0,0 +1,496 @@ +'\" t +.\" +.TH "\fBMYSQL\-STRESS\-TEST\fR" "1" "15 May 2020" "MariaDB 10.11" "MariaDB Database System" +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.\" mysql-stress-test.pl +.SH "NAME" +mysql-stress-test.pl \- server stress test program +.SH "SYNOPSIS" +.HP \w'\fBmysql\-stress\-test\&.pl\ [\fR\fB\fIoptions\fR\fR\fB]\fR\ 'u +\fBmysql\-stress\-test\&.pl [\fR\fB\fIoptions\fR\fR\fB]\fR +.SH "DESCRIPTION" +.PP +The +\fBmysql\-stress\-test\&.pl\fR +Perl script performs stress\-testing of the MariaDB server\&. +.PP +\fBmysql\-stress\-test\&.pl\fR +requires a version of Perl that has been built with threads support\&. +.PP +Invoke +\fBmysql\-stress\-test\&.pl\fR +like this: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysql\-stress\-test\&.pl [\fR\fB\fIoptions\fR\fR\fB]\fR +.fi +.if n \{\ +.RE +.\} +.PP +\fBmysql\-stress\-test\&.pl\fR +supports the following options: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-stress-test.pl: help option +.\" help option: mysql-stress-test.pl +\fB\-\-help\fR +.sp +Display a help message and exit\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-stress-test.pl: abort-on-error option +.\" abort-on-error option: mysql-stress-test.pl +\fB\-\-abort\-on\-error=\fR\fB\fIN\fR\fR +.sp +Causes the program to abort if an error with severity less than or equal to N was encountered\&. Set to 1 to abort on any error\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-stress-test.pl: check-tests-file option +.\" check-tests-file option: mysql-stress-test.pl +\fB\-\-check\-tests\-file\fR +.sp +Periodically check the file that lists the tests to be run\&. If it has been modified, reread the file\&. This can be useful if you update the list of tests to be run during a stress test\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-stress-test.pl: cleanup option +.\" cleanup option: mysql-stress-test.pl +\fB\-\-cleanup\fR +.sp +Force cleanup of the working directory\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-stress-test.pl: log-error-details option +.\" log-error-details option: mysql-stress-test.pl +\fB\-\-log\-error\-details\fR +.sp +Log error details in the global error log file\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-stress-test.pl: loop-count option +.\" loop-count option: mysql-stress-test.pl +\fB\-\-loop\-count=\fR\fB\fIN\fR\fR +.sp +In sequential test mode, the number of loops to execute before exiting\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-stress-test.pl: mysqltest option +.\" mysqltest option: mysql-stress-test.pl +\fB\-\-mysqltest=\fR\fB\fIpath\fR\fR +.sp +The path name to the +\fBmysqltest\fR +program\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-stress-test.pl: server-database option +.\" server-database option: mysql-stress-test.pl +\fB\-\-server\-database=\fR\fB\fIdb_name\fR\fR +.sp +The database to use for the tests\&. The default is +test\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-stress-test.pl: server-host option +.\" server-host option: mysql-stress-test.pl +\fB\-\-server\-host=\fR\fB\fIhost_name\fR\fR +.sp +The host name of the local host to use for making a TCP/IP connection to the local server\&. By default, the connection is made to +localhost +using a Unix socket file\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-stress-test.pl: server-logs-dir option +.\" server-logs-dir option: mysql-stress-test.pl +\fB\-\-server\-logs\-dir=\fR\fB\fIpath\fR\fR +.sp +This option is required\&. +\fIpath\fR +is the directory where all client session logs will be stored\&. Usually this is the shared directory that is associated with the server used for testing\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-stress-test.pl: server-password option +.\" server-password option: mysql-stress-test.pl +\fB\-\-server\-password=\fR\fB\fIpassword\fR\fR +.sp +The password to use when connecting to the server\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-stress-test.pl: server-port option +.\" server-port option: mysql-stress-test.pl +\fB\-\-server\-port=\fR\fB\fIport_num\fR\fR +.sp +The TCP/IP port number to use for connecting to the server\&. The default is 3306\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-stress-test.pl: server-socket option +.\" server-socket option: mysql-stress-test.pl +\fB\-\-server\-socket=\fR\fB\fIfile_name\fR\fR +.sp +For connections to +localhost, the Unix socket file to use, or, on Windows, the name of the named pipe to use\&. The default is +/tmp/mysql\&.sock\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-stress-test.pl: server-user option +.\" server-user option: mysql-stress-test.pl +\fB\-\-server\-user=\fR\fB\fIuser_name\fR\fR +.sp +The MariaDB user name to use when connecting to the server\&. The default is +root\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-stress-test.pl: sleep-time option +.\" sleep-time option: mysql-stress-test.pl +\fB\-\-sleep\-time=\fR\fB\fIN\fR\fR +.sp +The delay in seconds between test executions\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-stress-test.pl: stress-basedir option +.\" stress-basedir option: mysql-stress-test.pl +\fB\-\-stress\-basedir=\fR\fB\fIpath\fR\fR +.sp +This option is required\&. +\fIpath\fR +is the working directory for the test run\&. It is used as the temporary location for result tracking during testing\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-stress-test.pl: stress-datadir option +.\" stress-datadir option: mysql-stress-test.pl +\fB\-\-stress\-datadir=\fR\fB\fIpath\fR\fR +.sp +The directory of data files to be used during testing\&. The default location is the +data +directory under the location given by the +\fB\-\-stress\-suite\-basedir\fR +option\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-stress-test.pl: stress-init-file option +.\" stress-init-file option: mysql-stress-test.pl +\fB\-\-stress\-init\-file[=\fR\fB\fIpath\fR\fR\fB]\fR +.sp +\fIfile_name\fR +is the location of the file that contains the list of tests to be run once to initialize the database for the testing\&. If missing, the default file is +stress_init\&.txt +in the test suite directory\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-stress-test.pl: stress-mode option +.\" stress-mode option: mysql-stress-test.pl +\fB\-\-stress\-mode=\fR\fB\fImode\fR\fR +.sp +This option indicates the test order in stress\-test mode\&. The +\fImode\fR +value is either +random +to select tests in random order or +seq +to run tests in each thread in the order specified in the test list file\&. The default mode is +random\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-stress-test.pl: stress-suite-basedir option +.\" stress-suite-basedir option: mysql-stress-test.pl +\fB\-\-stress\-suite\-basedir=\fR\fB\fIpath\fR\fR +.sp +This option is required\&. +\fIpath\fR +is the directory that has the +t +and +\fIr\fR +subdirectories containing the test case and result files\&. This directory is also the default location of the +stress\-test\&.txt +file that contains the list of tests\&. (A different location can be specified with the +\fB\-\-stress\-tests\-file\fR +option\&.) +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-stress-test.pl: stress-tests-file option +.\" stress-tests-file option: mysql-stress-test.pl +\fB\-\-stress\-tests\-file[=\fR\fB\fIfile_name\fR\fR\fB]\fR +.sp +Use this option to run the stress tests\&. +\fIfile_name\fR +is the location of the file that contains the list of tests\&. If +\fIfile_name\fR +is omitted, the default file is +stress\-test\&.txt +in the stress suite directory\&. (See +\fB\-\-stress\-suite\-basedir\fR\&.) +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-stress-test.pl: suite option +.\" suite option: mysql-stress-test.pl +\fB\-\-suite=\fR\fB\fIsuite_name\fR\fR +.sp +Run the named test suite\&. The default name is +main +(the regular test suite located in the +mysql\-test +directory)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-stress-test.pl: test-count option +.\" test-count option: mysql-stress-test.pl +\fB\-\-test\-count=\fR\fB\fIN\fR\fR +.sp +The number of tests to execute before exiting\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-stress-test.pl: test-duration option +.\" test-duration option: mysql-stress-test.pl +\fB\-\-test\-duration=\fR\fB\fIN\fR\fR +.sp +The duration of stress testing in seconds\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-stress-test.pl: threads option +.\" threads option: mysql-stress-test.pl +\fB\-\-threads=\fR\fB\fIN\fR\fR +.sp +The number of threads\&. The default is 1\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-stress-test.pl: verbose option +.\" verbose option: mysql-stress-test.pl +\fB\-\-verbose\fR +.sp +Verbose mode\&. Print more information about what the program does\&. +.RE +.SH "COPYRIGHT" +.br +.PP +Copyright \(co 2007, 2010, Oracle and/or its affiliates, 2010-2020 MariaDB Foundation +.PP +This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License. +.PP +This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. +.PP +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-1335 USA or see http://www.gnu.org/licenses/. +.sp +.SH "SEE ALSO" +For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/ +.SH AUTHOR +MariaDB Foundation (http://www.mariadb.org/). diff --git a/man/mysql-test-run.pl.1 b/man/mysql-test-run.pl.1 new file mode 100644 index 00000000..1677c070 --- /dev/null +++ b/man/mysql-test-run.pl.1 @@ -0,0 +1,2318 @@ +'\" t +.\" +.TH "\fBMYSQL\-TEST\-RUN\fR" "1" "15 May 2020" "MariaDB 10.11" "MariaDB Database System" +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.\" mysql-test-run.pl +.SH "NAME" +mysql-test-run.pl \- run MariaDB test suite +.SH "SYNOPSIS" +.HP \w'\fBmysql\-test\-run\&.pl\ [\fR\fB\fIoptions\fR\fR\fB]\fR\ 'u +\fBmysql\-test\-run\&.pl [\fR\fB\fIoptions\fR\fR\fB]\fR +.SH "DESCRIPTION" +.PP +The +\fBmysql\-test\-run\&.pl\fR +Perl script is the main application used to run the MariaDB test suite\&. It invokes +\fBmysqltest\fR +to run individual test cases\&. +.PP +Invoke +\fBmysql\-test\-run\&.pl\fR +in the +mysql\-test +directory like this: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysql\-test\-run\&.pl [\fR\fB\fIoptions\fR\fR\fB] [\fR\fB\fItest_name\fR\fR\fB] \&.\&.\&.\fR +.fi +.if n \{\ +.RE +.\} +.PP +Each +\fItest_name\fR +argument names a test case\&. The test case file that corresponds to the test name is +t/\fItest_name\fR\&.test\&. +.PP +For each +\fItest_name\fR +argument, +\fBmysql\-test\-run\&.pl\fR +runs the named test case\&. With no +\fItest_name\fR +arguments, +\fBmysql\-test\-run\&.pl\fR +runs all +\&.test +files in the +t +subdirectory\&. +.PP +If no suffix is given for the test name, a suffix of +\&.test +is assumed\&. Any leading path name is ignored\&. These commands are equivalent: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysql\-test\-run\&.pl mytest\fR +shell> \fBmysql\-test\-run\&.pl mytest\&.test\fR +shell> \fBmysql\-test\-run\&.pl t/mytest\&.test\fR +.fi +.if n \{\ +.RE +.\} +.PP +A suite name can be given as part of the test name\&. That is, the syntax for naming a test is: +.sp +.if n \{\ +.RS 4 +.\} +.nf +[\fIsuite_name\fR\&.]\fItest_name\fR[\&.\fIsuffix\fR] +.fi +.if n \{\ +.RE +.\} +.PP +If a suite name is given, +\fBmysql\-test\-run\&.pl\fR +looks in that suite for the test\&. The test file corresponding to a test named +\fIsuite_name\&.test_name\fR +is found in +suite/\fIsuite_name\fR/t/\fItest_name\fR\&.test\&. There is also an implicit suite name +main +for the tests in the top +t +directory\&. With no suite name, +\fBmysql\-test\-run\&.pl\fR +looks in the default list of suites for a match and runs the test in any suites where it finds the test\&. Suppose that the default suite list is +main, +binlog, +rpl, and that a test +mytest\&.test +exists in the +main +and +rpl +suites\&. With an argument of +mytest +or +mytest\&.test, +\fBmysql\-test\-run\&.pl\fR +will run +mytest\&.test +from the +main +and +rpl +suites\&. +.PP +To run a family of test cases for which the names share a common prefix, use the +\fB\-\-do\-test=\fR\fB\fIprefix\fR\fR +option\&. For example, +\fB\-\-do\-test=rpl\fR +runs the replication tests (test cases that have names beginning with +rpl)\&. +\fB\-\-skip\-test\fR +has the opposite effect of skipping test cases for which the names share a common prefix\&. +.PP +The argument for the +\fB\-\-do\-test\fR +and +\fB\-\-skip\-test\fR +options also allows more flexible specification of which tests to perform or skip\&. If the argument contains a pattern metacharacter other than a lone period, it is interpreted as a Perl regular expression and applies to test names that match the pattern\&. If the argument contains a lone period or does not contain any pattern metacharacters, it is interpreted the same way as previously and matches test names that begin with the argument value\&. For example, +\fB\-\-do\-test=testa\fR +matches tests that begin with +testa, +\fB\-\-do\-test=main\&.testa\fR +matches tests in the +main +test suite that begin with +testa, and +\fB\-\-do\-test=main\&.*testa\fR +matches test names that contain +main +followed by +testa +with anything in between\&. In the latter case, the pattern match is not anchored to the beginning of the test name, so it also matches names such as +xmainytesta\&. +.PP +To perform setup prior to running tests, +\fBmysql\-test\-run\&.pl\fR +needs to invoke +\fBmysqld\fR +with the +\fB\-\-bootstrap\fR +and +\fB\-\-skip\-grant\-tables\fR +options\&. If MySQL was configured with the +\fB\-\-disable\-grant\-options\fR +option, +\fB\-\-bootstrap\fR, +\fB\-\-skip\-grant\-tables\fR, and +\fB\-\-init\-file\fR +will be disabled\&. To handle this, set the +MYSQLD_BOOTSTRAP +environment variable to the full path name of a server that has all options enabled\&. +\fBmysql\-test\-run\&.pl\fR +will use that server to perform setup; it is not used to run the tests\&. +.PP +The +init_file +test will fail if +\fB\-\-init\-file\fR +is disabled\&. This is an expected failure that can be handled as follows: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBexport MYSQLD_BOOTSTRAP\fR +shell> \fBMYSQLD_BOOTSTRAP=/full/path/to/mysqld\fR +shell> \fBmake test force="\-\-skip\-test=init_file"\fR +.fi +.if n \{\ +.RE +.\} +.PP +To run +\fBmysql\-test\-run\&.pl\fR +on Windows, you'll need either Cygwin or ActiveState Perl to run it\&. You may also need to install the modules required by the script\&. To run the test script, change location into the +mysql\-test +directory, set the +MTR_VS_CONFIG +environment variable to the configuration you selected earlier (or use the +\fB\-\-vs\-config\fR +option), and invoke +\fBmysql\-test\-run\&.pl\fR\&. For example (using Cygwin and the +\fBbash\fR +shell): +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBcd mysql\-test\fR +shell> \fBexport MTR_VS_CONFIG=debug\fR +shell> \fB\&./mysqltest\-run\&.pl \-\-force \-\-timer\fR +shell> \fB\&./mysqltest\-run\&.pl \-\-force \-\-timer \-\-ps\-protocol\fR +.fi +.if n \{\ +.RE +.\} +.PP +\fBmysql\-test\-run\&.pl\fR +uses several environment variables\&. Some of them are listed in the following table\&. Some of these are set from the outside and used by +\fBmysql\-test\-run\&.pl\fR, others are set by +\fBmysql\-test\-run\&.pl\fR +instead, and may be referred to in tests\&. +.TS +allbox tab(:); +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l. +T{ +\fBVariable\fR +T}:T{ +\fBMeaning\fR +T} +T{ +MTR_VERSION +T}:T{ +If set to 1, will run the older version 1 of \fBmysql\-test\-run\&.pl\fR\&. This will affect what functionailty is available and what command line options are supported\&. +T} +T{ +MTR_MEM +T}:T{ +If set to anything, will run tests with files in "memory" using tmpfs or + ramdisk\&. Not available on Windows\&. Same as + \fB\-\-mem\fR option +T} +T{ +MTR_PARALLEL +T}:T{ +If set, defines number of parallel threads executing tests\&. Same as + \fB\-\-parallel\fR option +T} +T{ +MTR_BUILD_THREAD +T}:T{ +If set, defines which port number range is used for the server +T} +T{ +MTR_PORT_BASE +T}:T{ +If set, defines which port number range is used for the server +T} +T{ +MTR_\fINAME\fR_TIMEOUT +T}:T{ +Setting of a timeout in minutes or seconds, corresponding to command line option \fB\-\-\fR\fB\fIname\fR\fR\fB\-timeout\fR\&. Available timeout names are TESTCASE, SUITE (both in minutes) and START, SHUTDOWN (both in seconds)\&. These variables are supported from MySQL 5\&.1\&.44\&. +T} +T{ +MYSQL_TEST +T}:T{ +Path name to \fBmysqltest\fR binary +T} +T{ +MYSQLD_BOOTSTRAP +T}:T{ +Full path name to \fBmysqld\fR that has all options enabled +T} +T{ +MYSQLTEST_VARDIR +T}:T{ +Path name to the var directory that is used for + logs, temporary files, and so forth +T} +T{ +MYSQL_TEST_DIR +T}:T{ +Full path to the mysql\-test directory where tests + are being run from +T} +T{ +MYSQL_TMP_DIR +T}:T{ +Path to temp directory used for temporary files during tests +T} +.TE +.sp 1 +.PP +The variable +MTR_PORT_BASE +was added in MySQL 5\&.1\&.45 as a more logical replacement for +MTR_BUILD_THREAD\&. It gives the actual port number directly (will be rounded down to a multiple of 10)\&. If you use +MTR_BUILD_THREAD, the port number is found by multiplying this by 10 and adding 10000\&. +.PP +Tests sometimes rely on certain environment variables being defined\&. For example, certain tests assume that +MYSQL_TEST +is defined so that +\fBmysqltest\fR +can invoke itself with +exec $MYSQL_TEST\&. +.PP +Other tests may refer to the last three variables listed in the preceding table, to locate files to read or write\&. For example, tests that need to create files will typically put them in +$MYSQL_TMP_DIR/\fIfile_name\fR\&. +.PP +If you are running +\fBmysql\-test\-run\&.pl\fR +version 1 by setting +MTR_VERSION, note that this only affects the test driver, not the test client (and its language) or the tests themselves\&. +.PP +A few tests might not run with version 1 because they depend on some feature of version 2\&. You may have those tests skipped by adding the test name to the file +lib/v1/incompatible\&.tests\&. This feature is available from MySQL 5\&.1\&.40\&. +.PP +\fBmysql\-test\-run\&.pl\fR +supports the options in the following list\&. An argument of +\fB\-\-\fR +tells +\fBmysql\-test\-run\&.pl\fR +not to process any following arguments as options\&. +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: help option +.\" help option: mysql-test-run.pl +\fB\-\-help\fR, +\fB\-h\fR +.sp +Display a help message and exit\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: big-test option +.\" big-test option: mysql-test-run.pl +\fB\-\-big\-test\fR +.sp +Allow tests marked as "big" to run\&. Tests can be thus marked by including the line +\fB\-\-source include/big_test\&.inc\fR, and they will only be run if this option is given, or if the environment variable +BIG_TEST +is set to 1\&. Repeat this option twice to run only "big" tests\&. +.sp +This is typically used for tests that take a very long to run, or that use many resources, so that they are not suitable for running as part of a normal test suite run\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: boot-dbx option +.\" boot-dbx option: mysql-test-run.pl +\fB\-\-boot\-dbx\fR +.sp +Run the mysqld server used for bootstrapping the database through the dbx debugger\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: boot-ddd option +.\" boot-ddd option: mysql-test-run.pl +\fB\-\-boot\-ddd\fR +.sp +Run the mysqld server used for bootstrapping the database through the ddd debugger\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: boot-gdb option +.\" boot-gdb option: mysql-test-run.pl +\fB\-\-boot\-gdb\fR +.sp +Run the mysqld server used for bootstrapping the database through the gdb debugger\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: build-thread option +.\" build-thread option: mysql-test-run.pl +\fB\-\-[mtr\-]build\-thread=\fR\fB\fInumber\fR\fR +.sp +Specify a number to calculate port numbers from\&. The formula is 10 * +\fIbuild_thread\fR ++ 10000\&. Instead of a number, it can be set to +auto, which is also the default value, in which case +\fBmysql\-test\-run\&.pl\fR +will allocate a number unique to this host\&. +.sp +The value (number or +auto) can also be set with the +MTR_BUILD_THREAD +environment variable\&. +.sp +The more logical +\fB\-\-port\-base\fR +is supported as an alternative\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: callgrind option +.\" callgrind option: mysql-test-run.pl +\fB\-\-callgrind\fR +.sp +Instructs +\fBvalgrind\fR +to use +\fBcallgrind\fR\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: check-testcases option +.\" check-testcases option: mysql-test-run.pl +\fB\-\-check\-testcases\fR +.sp +Check test cases for side effects\&. This is done by checking system state before and after each test case; if there is any difference, a warning to that effect will be written, but the test case will not be marked as failed because of it\&. This check is enabled by default\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: client-bindir option +.\" client-bindir option: mysql-test-run.pl +\fB\-\-client\-bindir=\fR\fB\fIpath\fR\fR +.sp +The path to the directory where client binaries are located\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: client-dbx option +.\" client-dbx option: mysql-test-run.pl +\fB\-\-client\-dbx\fR +.sp +Start +\fBmysqltest\fR +in the +\fBdbx\fR +debugger\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: client-ddd option +.\" client-ddd option: mysql-test-run.pl +\fB\-\-client\-ddd\fR +.sp +Start +\fBmysqltest\fR +in the +\fBddd\fR +debugger\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: client-debugger option +.\" client-debugger option: mysql-test-run.pl +\fB\-\-client\-debugger=\fR\fB\fIdebugger\fR\fR +.sp +Start +\fBmysqltest\fR +in the named debugger\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: client-gdb option +.\" client-gdb option: mysql-test-run.pl +\fB\-\-client\-gdb\fR +.sp +Start +\fBmysqltest\fR +in the +\fBgdb\fR +debugger\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: client-libdir option +.\" client-libdir option: mysql-test-run.pl +\fB\-\-client\-libdir=\fR\fB\fIpath\fR\fR +.sp +The path to the directory where client libraries are located\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: combination option +.\" combination option: mysql-test-run.pl +\fB\-\-combination=\fR\fB\fIvalue\fR\fR +.sp +Extra options to pass to +\fBmysqld\fR\&. The value should consist of one or more comma\-separated +\fBmysqld\fR +options\&. This option is similar to +\fB\-\-mysqld\fR +but should be given two or more times\&. +\fBmysql\-test\-run\&.pl\fR +executes multiple test runs, using the options for each instance of +\fB\-\-combination\fR +in successive runs\&. If +\fB\-\-combination\fR +is given only once, it has no effect\&. For test runs specific to a given test suite, an alternative to the use of +\fB\-\-combination\fR +is to create a +combinations +file in the suite directory\&. The file should contain a section of options for each test run\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: comment option +.\" comment option: mysql-test-run.pl +\fB\-\-comment=\fR\fB\fIstr\fR\fR +.sp +Write +\fIstr\fR +to the output within lines filled with +#, as a form of banner\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: compress option +.\" compress option: mysql-test-run.pl +\fB\-\-compress\fR +.sp +Compress all information sent between the client and the server if both support compression\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: cursor-protocol option +.\" cursor-protocol option: mysql-test-run.pl +\fB\-\-cursor\-protocol\fR +.sp +Use the cursor protocol between client and server +(implies +\fB\-\-ps\-protocol\fR)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: dbx option +.\" dbx option: mysql-test-run.pl +\fB\-\-dbx\fR +.sp +Start the +\fBmysqld(s)\fR +in the +\fBdbx\fR +debugger\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: ddd option +.\" ddd option: mysql-test-run.pl +\fB\-\-ddd\fR +.sp +Start the +\fBmysqld(s)\fR +in the +\fBddd\fR +debugger\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: debug option +.\" debug option: mysql-test-run.pl +\fB\-\-debug\fR +.sp +Dump trace output for all clients and servers\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: debug-common option +.\" debug-common option: mysql-test-run.pl +\fB\-\-debug\-common\fR +.sp +Same as \fB--debug\fR, but sets the 'd' debug flags to "query,info,error,enter,exit"\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: debug-server option +.\" debug-server option: mysql-test-run.pl +\fB\-\-debug\-server\fR +.sp +Use debug version of server, but without turning on tracing\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: debugger option +.\" debugger option: mysql-test-run.pl +\fB\-\-debugger=\fR\fB\fIdebugger\fR\fR +.sp +Start +\fBmysqld\fR +using the named debugger\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: debug-sync-timeout option +.\" debug-sync-timeout option: mysql-test-run.pl +\fB\-\-debug\-sync\-timeout=\fR\fB\fIN\fR\fR +.sp +Controls whether the Debug Sync facility for testing and debugging is enabled\&. The option value is a timeout in seconds\&. The default value is 300\&. A value of 0 disables Debug Sync\&. The value of this option also becomes the default timeout for individual synchronization points\&. +.sp +\fBmysql\-test\-run\&.pl\fR +passes +\fB\-\-loose\-debug\-sync\-timeout=\fR\fB\fIN\fR\fR +to +\fBmysqld\fR\&. The +\fB\-\-loose\fR +prefix is used so that +\fBmysqld\fR +does not fail if Debug Sync is not compiled in\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: defaults-file option +.\" defaults-file option: mysql-test-run.pl +\fB\-\-defaults\-file=\fR\fB\fIfile_name\fR\fR +.sp +Use the named file as fixed config file template for all tests\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: defaults_extra_file option +.\" default_extra_file option: mysql-test-run.pl +\fB\-\-defaults_extra_file=\fR\fB\fIfile_name\fR\fR +.sp +Add setting from the named file to all generated configs\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: do-test option +.\" do-test option: mysql-test-run.pl +\fB\-\-do\-test=\fR\fB\fIprefix\fR\fR|\fB\fIregex\fR\fR +.sp +Run all test cases having a name that begins with the given +\fIprefix\fR +value, or fulfils the +\fIregex\fR\&. This option provides a convenient way to run a family of similarly named tests\&. +.sp +The argument for the +\fB\-\-do\-test\fR +option also allows more flexible specification of which tests to perform\&. If the argument contains a pattern metacharacter other than a lone period, it is interpreted as a Perl regular expression and applies to test names that match the pattern\&. If the argument contains a lone period or does not contain any pattern metacharacters, it is interpreted the same way as previously and matches test names that begin with the argument value\&. For example, +\fB\-\-do\-test=testa\fR +matches tests that begin with +testa, +\fB\-\-do\-test=main\&.testa\fR +matches tests in the +main +test suite that begin with +testa, and +\fB\-\-do\-test=main\&.*testa\fR +matches test names that contain +main +followed by +testa +with anything in between\&. In the latter case, the pattern match is not anchored to the beginning of the test name, so it also matches names such as +xmainytestz\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: dry-run option +.\" dry-run option: mysql-test-run.pl +\fB\-\-dry\-run\fR +.sp +Don't run any tests, print the list of tests that were selected for execution\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: embedded-server option +.\" embedded-server option: mysql-test-run.pl +\fB\-\-embedded\-server\fR +.sp +Use a version of +\fBmysqltest\fR +built with the embedded server\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: enable-disabled option +.\" enable-disabled option: mysql-test-run.pl +\fB\-\-enable\-disabled\fR +.sp +Ignore any +disabled\&.def +file, and also run tests marked as disabled\&. Success or failure of those tests will be reported the same way as other tests\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: experimental option +.\" experimental option: mysql-test-run.pl +\fB\-\-experimental=\fR\fB\fIfile_name\fR\fR +.sp +Specify a file that contains a list of test cases that should be displayed with the +[ exp\-fail ] +code rather than +[ fail ] +if they fail\&. +.sp +For an example of a file that might be specified via this option, see +mysql\-test/collections/default\&.experimental\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: extern option +.\" extern option: mysql-test-run.pl +\fB\-\-extern\fR +\fIoption\fR=\fIvalue\fR +.sp +Use an already running server\&. The option/value pair is what is needed by the +\fBmysql\fR +client to connect to the server\&. Each +\fB\-\-extern\fR option +can only take one option/value pair as an argument, so you need to repeat +\fB\-\-extern\fR +for each pair needed\&. Example: +.sp +.if n \{\ +.RS 4 +.\} +.nf + \&./mysql\-test\-run\&.pl \-\-extern socket=var/tmp/mysqld\&.1\&.sock alias +.fi +.if n \{\ +.RE +.\} +.sp +Note: If a test case has an +\&.opt +file that requires the server to be restarted with specific options, the file will not be used\&. The test case likely will fail as a result\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: fast option +.\" fast option: mysql-test-run.pl +\fB\-\-fast\fR +.sp +Do not perform controlled shutdown when servers need to be restarted or at the end of the test run\&. This is equivalent to using +\-\-shutdown\-timeout=0\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: force-restart option +.\" force-restart option: mysql-test-run.pl +\fB\-\-force\-restart\fR +.sp +Always restart servers between tests\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: force option +.\" force option: mysql-test-run.pl +\fB\-\-force\fR +.sp +Normally, +\fBmysql\-test\-run\&.pl\fR +exits if a test case fails\&. +\fB\-\-force\fR +causes execution to continue regardless of test case failure\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: gcov option +.\" gcov option: mysql-test-run.pl +\fB\-\-gcov\fR +.sp +Collect coverage information after the test\&. The result is a +\fBgcov\fR +file per source and header file\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: gcov-src-dir option +.\" gcov-src-dir option: mysql-test-run.pl +\fB\-\-gcov\-src\-dir\fR +.sp +Colllect coverage only within the given subdirectory\&. For example, if you're only developing the SQL layer, +it makes sense to use \fB--gcov-src-dir=sql\fR\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: gdb option +.\" gdb option: mysql-test-run.pl +\fB\-\-gdb\fR +.sp +Start the +\fBmysqld(s)\fR +in the +\fBgdb\fR +debugger\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: gprof option +.\" gprof option: mysql-test-run.pl +\fB\-\-gprof\fR +.sp +Collect profiling information using the +\fBgprof\fR +profiling tool\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: manual-dbx option +.\" manual-dbx option: mysql-test-run.pl +\fB\-\-manual\-dbx\fR +.sp +Use a server that has already been started by the user in the +\fBdbx\fR +debugger\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: manual-ddd option +.\" manual-ddd option: mysql-test-run.pl +\fB\-\-manual\-ddd\fR +.sp +Use a server that has already been started by the user in the +\fBddd\fR +debugger\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: manual-debug option +.\" manual-debug option: mysql-test-run.pl +\fB\-\-manual\-debug\fR +.sp +Use a server that has already been started by the user in a debugger\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: manual-gdb option +.\" manual-gdb option: mysql-test-run.pl +\fB\-\-manual\-gdb\fR +.sp +Use a server that has already been started by the user in the +\fBgdb\fR +debugger\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: manual-lldb option +.\" manual-lldb option: mysql-test-run.pl +\fB\-\-manual\-lldb\fR +.sp +Use a server that has already been started by the user in the +\fBlldb\fR +debugger\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: mark-progress option +.\" mark-progress option: mysql-test-run.pl +\fB\-\-mark\-progress\fR +.sp +Marks progress with timing (in milliseconds) and line number in +var/log/\fItestname\fR\&.progress\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: max-connections option +.\" max-connections option: mysql-test-run.pl +\fB\-\-max\-connections=\fR\fB\fInum\fR\fR +.sp +The maximum number of simultaneous server connections that may be used per test\&. If not set, the maximum is 128\&. Minimum allowed limit is 8, maximum is 5120\&. Corresponds to the same option for +\fBmysqltest\fR\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: max-save-core option +.\" max-save-core option: mysql-test-run.pl +\fB\-\-max\-save\-core=\fR\fB\fIN\fR\fR +.sp +Limit the number of core files saved, to avoid filling up disks in case of a frequently crashing server\&. Defaults to 5, set to 0 for no limit\&. May also be set with the environment variable +MTR_MAX_SAVE_CORE +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: max-save-datadir option +.\" max-save-datadir option: mysql-test-run.pl +\fB\-\-max\-save\-datadir=\fR\fB\fIN\fR\fR +.sp +Limit the number of data directories saved after failed tests, to avoid filling up disks in case of frequent failures\&. Defaults to 20, set to 0 for no limit\&. May also be set with the environment variable +MTR_MAX_SAVE_DATADIR +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: max-test-fail option +.\" max-test-fail option: mysql-test-run.pl +\fB\-\-max\-test\-fail=\fR\fB\fIN\fR\fR +.sp +Stop execution after the specified number of tests have failed, to avoid using up resources (and time) in case of massive failures\&. retries are not counted, nor are failures of tests marked experimental\&. Defaults to 10, set to 0 for no limit\&. May also be set with the environment variable +MTR_MAX_TEST_FAIL +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: mem option +.\" mem option: mysql-test-run.pl +\fB\-\-mem\fR +.sp +This option is not supported on Windows\&. +.sp +Run the test suite in memory, using tmpfs or ramdisk\&. This can decrease test times significantly, in particular if you would otherwise be running over a remote file system\&. +\fBmysql\-test\-run\&.pl\fR +attempts to find a suitable location using a built\-in list of standard locations for tmpfs and puts the +var +directory there\&. This option also affects placement of temporary files, which are created in +var/tmp\&. +.sp +The default list includes +/dev/shm\&. You can also enable this option by setting the environment variable +MTR_MEM[=\fIdir_name\fR]\&. If +\fIdir_name\fR +is given, it is added to the beginning of the list of locations to search, so it takes precedence over any built\-in locations\&. +.sp +Once you have run tests with +\fB\-\-mem\fR +within a +mysql\-testdirectory, a soflink +var +will have been set up to the temporary directory, and this will be re\-used the next time, until the soflink is deleted\&. Thus, you do not have to repeat the +\fB\-\-mem\fR +option next time\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: mysqld option +.\" mysqld option: mysql-test-run.pl +\fB\-\-mysqld=\fR\fB\fIvalue\fR\fR +.sp +Extra options to pass to +\fBmysqld\fR\&. The value should consist of one or more comma\-separated +\fBmysqld\fR +options\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: mysqld-env option +.\" mysqld-env option: mysql-test-run.pl +\fB\-\-mysqld\-env=\fR\fB\fIVAR=VAL\fR\fR +.sp +Specify additional environment settings for "mysqld"\&. Use additional \fB--mysqld-env\fR options to set more than one variable\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: nocheck-testcases option +.\" nocheck-testcases option: mysql-test-run.pl +\fB\-\-nocheck\-testcases\fR +.sp +Disable the check for test case side effects; see +\fB\-\-check\-testcases\fR +for a description\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: noreorder option +.\" noreorder option: mysql-test-run.pl +\fB\-\-noreorder\fR +.sp +Do not reorder tests to reduce number of restarts, but run them in exactly the order given\&. If a whole suite is to be run, the tests are run in alphabetical order, though similar combinations will be grouped together\&. If more than one suite is listed, the tests are run one suite at a time, in the order listed\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: notimer option +.\" notimer option: mysql-test-run.pl +\fB\-\-notimer\fR +.sp +Cause +\fBmysqltest\fR +not to generate a timing file\&. The effect of this is that the report from each test case does not include the timing in milliseconds as it normally does\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: nowarnings option +.\" nowarnings option: mysql-test-run.pl +\fB\-\-nowarnings\fR +.sp +Do not look for and report errors and warning in the server logs\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: parallel option +.\" parallel option: mysql-test-run.pl +\fB\-\-parallel={\fR\fB\fIN\fR\fR\fB|auto}\fR +.sp +Run tests using +\fIN\fR +parallel threads\&. By default, 1 thread is used\&. Use +\fB\-\-parallel=auto\fR +for auto\-setting of +\fIN\fR\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: port-base option +.\" port-base option: mysql-test-run.pl +\fB\-\-[mtr\-]port\-base=\fR\fB\fIP\fR\fR +.sp +Specify base of port numbers to be used; a block of 10 will be allocated\&. +\fIP\fR +should be divisible by 10; if it is not, it will be rounded down\&. If running with more than one parallel test thread, thread 2 will use the next block of 10 and so on\&. +.sp +If the port number is given as +auto, which is also the default, +\fBmysql\-test\-run\&.pl\fR will allocate a number unique to this host\&. The value may also be given with the environment variable +MTR_PORT_BASE\&. +.sp +If both \fB\-\-build\-thread\fR and \fB\-\-port\-base\fR are used, +\fB\-\-port\-base\fR +takes precedence\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: print-testcases option +.\" print-testcases option: mysql-test-run.pl +\fB\-\-print\-testcases\fR +.sp +Do not run any tests, but print details about all tests, in the order they would have been run\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: ps-protocol option +.\" ps-protocol option: mysql-test-run.pl +\fB\-\-ps\-protocol\fR +.sp +Use the binary protocol between client and server\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: record option +.\" record option: mysql-test-run.pl +\fB\-\-record\fR +.sp +Pass the +\fB\-\-record\fR +option to +\fBmysqltest\fR\&. This option requires a specific test case to be named on the command line\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: reorder option +.\" reorder option: mysql-test-run.pl +\fB\-\-reorder\fR +.sp +Reorder tests to minimize the number of server restarts needed\&. This is the default behavior\&. There is no guarantee that a particular set of tests will always end up in the same order\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: repeat option +.\" repeat option: mysql-test-run.pl +\fB\-\-repeat=\fR\fB\fIN\fR\fR +.sp +Run each test +\fIN\fR +number of times\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: report-features option +.\" report-features option: mysql-test-run.pl +\fB\-\-report\-features\fR +.sp +First run a "test" that reports MariaDB features, displaying the output of SHOW ENGINES and SHOW VARIABLES\&. This can be +used to verify that binaries are built with all required features\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: report-times option +.\" report-times option: mysql-test-run.pl +\fB\-\-report\-times\fR +.sp +Report how much time has been spent on different phases of test execution\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: retry option +.\" retry option: mysql-test-run.pl +\fB\-\-retry=\fR\fB\fIN\fR\fR +.sp +If a test fails, it is retried up to a maximum of +\fIN\fR +runs (default 1)\&. Retries are also limited by the maximum number of failures before stopping, +set with the \fB-\-retry\-failure\fR option\&. This option has no effect unless +\fB\-\-force\fR +is also used; without it, test execution will terminate after the first failure\&. +.sp +The +\fB\-\-retry\fR +and +\fB\-\-retry\-failure\fR +options do not affect how many times a test repeated with +\fB\-\-repeat\fR +may fail in total, as each repetition is considered a new test case, which may in turn be retried if it fails\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: retry-failure option +.\" retry-failure option: mysql-test-run.pl +\fB\-\-retry\-failure=\fR\fB\fIN\fR\fR +.sp +When using the \fB-\-retry\fR option to retry failed tests, +stop when N failures have occurred (default 2)\&. Setting it to 0 or 1 effectively turns off retries\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: shutdown-timeout option +.\" shutdown-timeout option: mysql-test-run.pl +\fB\-\-shutdown\-timeout=\fR\fB\fISECONDS\fR\fR +.sp +Max number of seconds to wait for servers to do controlled shutdown before killing them\&. Default is 10\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: skip-combinations option +.\" skip-combinations option: mysql-test-run.pl +\fB\-\-skip\-combinations\fR +.sp +Do not apply combinations; ignore combinations file or option\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: skip-rpl option +.\" skip-rpl option: mysql-test-run.pl +\fB\-\-skip\-rpl\fR +.sp +Skip replication test cases\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: skip-ssl option +.\" skip-ssl option: mysql-test-run.pl +\fB\-\-skip\-ssl\fR +.sp +Do not start +\fBmysqld\fR +with support for SSL connections\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: skip-test option +.\" skip-test option: mysql-test-run.pl +\fB\-\-skip\-test=\fR\fB\fIregex\fR\fR|\fR\fB\fIregex\fR\fR +.sp +Specify a regular expression to be applied to test case names\&. Cases with names that match the expression are skipped\&. tests to skip\&. +.sp +The argument for the +\fB\-\-skip\-test\fR +option allows more flexible specification of which tests to skip\&. If the argument contains a pattern metacharacter other than a lone period, it is interpreted as a Perl regular expression and applies to test names that match the pattern\&. See the description of the +\fB\-\-do\-test\fR +option for details\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: skip-test-list option +.\" skip-test-list option: mysql-test-run.pl +\fB\-\-skip\-test\-list=\fB\fIFILE\fR +.sp +Skip the tests listed in FILE\&. Each line in the file is an entry and should be formatted as: <TESTNAME> : <COMMENT> +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fB\-\-skip\-*\fR +.sp +\fB\-\-skip\-*\fR +options not otherwise recognized by +\fBmysql\-test\-run\&.pl\fR +are passed to the master server\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: sleep option +.\" sleep option: mysql-test-run.pl +\fB\-\-sleep=\fR\fB\fIN\fR\fR +.sp +Pass +\fB\-\-sleep=\fR\fB\fIN\fR\fR +to +\fBmysqltest\fR\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: sp-protocol option +.\" sp-protocol option: mysql-test-run.pl +\fB\-\-sp\-protocol\fR +.sp +Create a stored procedure to execute all queries\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: ssl option +.\" ssl option: mysql-test-run.pl +\fB\-\-ssl\fR +.sp +If +\fBmysql\-test\-run\&.pl\fR +is started with the +\fB\-\-ssl\fR +option, it sets up a secure connection for all test cases\&. In this case, if +\fBmysqld\fR +does not support SSL, +\fBmysql\-test\-run\&.pl\fR +exits with an error message: +Couldn't find support for SSL +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: staging-run option +.\" staging-run option: mysql-test-run.pl +\fB\-\-staging\-run\fR +.sp +Run a limited number of tests (no slow tests)\&. Used for running staging trees with valgrind\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: start-and-exit option +.\" start-and-exit option: mysql-test-run.pl +\fB\-\-start\fR +.sp +Initialize and start servers with the startup settings for the specified test case\&. You can use this option to start a server to which you can connect later\&. For example, after building a source distribution you can start a server and connect to it with the +\fBmysql\fR +client like this: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBcd mysql\-test\fR +shell> \fB\&./mysql\-test\-run\&.pl \-\-start alias &\fR +shell> \fB\&.\&./mysql \-S \&./var/tmp/master\&.sock \-h localhost \-u root\fR +.fi +.if n \{\ +.RE +.\} +.sp +If no tests are named on the command line, the server(s) will be started with settings for the first test that would have been run without the +\fB\-\-start\fR +option\&. +.sp +\fBmysql\-test\-run\&.pl\fR +will stop once the server has been started, but will terminate if the server dies\&. If killed, it will also shut down the server\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: start-and-exit option +.\" start-and-exit option: mysql-test-run.pl +\fB\-\-start\-and\-exit\fR +.sp +Same +\fB\-\-start\fR, but mysql-test-run terminates and leaves just the server running\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: start-dirty option +.\" start-dirty option: mysql-test-run.pl +\fB\-\-start\-dirty\fR +.sp +This is similar to +\fB\-\-start\fR, but will skip the database initialization phase and assume that database files are already available\&. Usually this means you must have run another test first\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: start-from option +.\" start-from option: mysql-test-run.pl +\fB\-\-start\-from=\fR\fB\fItest_name\fR\fR +.sp +\fBmysql\-test\-run\&.pl\fR +sorts the list of names of the test cases to be run, and then begins with +\fItest_name\fR\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: strace option +.\" strace option: mysql-test-run.pl +\fB\-\-strace\fR +.sp +Run the "mysqld" executables using strace. Default options are \fB-f -o var/log/'mysqld-name'.strace\fR\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: strace-client option +.\" strace-client option: mysql-test-run.pl +\fB\-\-strace\-client\fR +.sp +Create +\fBstrace\fR +output for +\fBmysqltest\fR, optionally specifying name and path +to the trace program to use\&. +.sp +Example: \&./mysql\-test\-run\&.pl \-\-strace\-client=ktrace +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: strace-option option +.\" strace-option option: mysql-test-run.pl +\fB\-\-strace\-option\fR=\fR\fB\fIARGS\fR\fR +.sp +Option to give +\fBstrace\fR, +replaces default option(s)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: stress option +.\" stress option: mysql-test-run.pl +\fB\-\-stress=\fR\fB\fIARGS\fR\fR +.sp +Run stress test, providing options to mysql\-stress\-test\&.pl\&. Options are separated by comma\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: suite option +.\" suite option: mysql-test-run.pl +\fB\-\-suite[s]=\fR\fB\fIsuite_name...\fR\fR +.sp +Comma separated list of suite names to run. The default is: +"main-,archive-,binlog-,csv-,federated-,funcs_1-,funcs_2-, +handler-,heap-,innodb-,innodb_fts-,innodb_zip-,maria-, +multi_source-,optimizer_unfixed_bugs-,parts-,perfschema-, +plugins-,roles-,rpl-,sys_vars-,unit-,vcol-"\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: stop-file option +.\" stop-file option: mysql-test-run.pl +\fB\-\-stop\-file=\fR\fB\fIfile\fR\fR +.sp +If this file is detected, mysqltest will not start new tests until the file is removed (also MTR_STOP_FILE environment variable)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: stop-keep-alive option +.\" stop-keep-alive option: mysql-test-run.pl +\fB\-\-stop\-keep\-alive=\fR\fB\fIsec\fR\fR +.sp +Works with \fB--stop-file\fR, print messages every \fIsec\fR seconds when mysqltest is waiting to remove the file (for buildbot) (also MTR_STOP_KEEP_ALIVE environment variable)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: suite-timeout option +.\" suite-timeout option: mysql-test-run.pl +\fB\-\-suite\-timeout=\fR\fB\fIminutes\fR\fR +.sp +Specify the maximum test suite runtime in minutes\&. The default is 360\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: testcase-timeout option +.\" testcase-timeout option: mysql-test-run.pl +\fB\-\-testcase\-timeout\fR +.sp +Specify the maximum test case runtime in minutes\&. The default is 15\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: timediff option +.\" timediff option: mysql-test-run.pl +\fB\-\-timediff\fR +.sp +Used with \fB\-\-timestamp\fR, also print time passed since the previous test started\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: timer option +.\" timer option: mysql-test-run.pl +\fB\-\-timer\fR +.sp +Cause +\fBmysqltest\fR +to generate a timing file\&. The default file is named +\&./var/log/timer\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: timestamp option +.\" timestamp option: mysql-test-run.pl +\fB\-\-timestamp\fR +.sp +Prints a timestamp before the test case name in each test report line, showing when the test ended\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: tmpdir option +.\" tmpdir option: mysql-test-run.pl +\fB\-\-tmpdir=\fR\fB\fIpath\fR\fR +.sp +The directory where temporary file are stored\&. The default location is +\&./var/tmp\&. The environment variable +MYSQL_TMP_DIR +will be set to the path for this directory, whether it has the default value or has been set explicitly\&. This may be referred to in tests\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: user option +.\" user option: mysql-test-run.pl +\fB\-\-user=\fR\fB\fIuser_name\fR\fR +.sp +The MariaDB user name to use when connecting to the server (default root)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: user-args option +.\" user-args option: mysql-test-run.pl +\fB\-\-user\-args\fR +.sp +In combination with \fBstart*\fR and no test name, drops arguments to mysqld except those specified with \fB\-\-mysqld\fR (if any)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: valgrind option +.\" valgrind option: mysql-test-run.pl +\fB\-\-valgrind[\-all]\fR +.sp +Run +\fBmysqltest\fR +and +\fBmysqld\fR +with +\fBvalgrind\fR\&. This and the following +\fB\-\-valgrind\fR +options require that the executables have been built with +\fBvalgrind\fR +support\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: valgrind-mysqld option +.\" valgrind-mysqld option: mysql-test-run.pl +\fB\-\-valgrind\-mysqld\fR +.sp +Run the +\fBmysqld\fR +server with +\fBvalgrind\fR\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: valgrind-mysqltest option +.\" valgrind-mysqltest option: mysql-test-run.pl +\fB\-\-valgrind\-mysqltest\fR +.sp +Run the +\fBmysqltest\fR +and +\fBmysql_client_test\fR +executables with +\fBvalgrind\fR\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: valgrind-options option +.\" valgrind-options option: mysql-test-run.pl +\fB\-\-valgrind\-option=\fR\fB\fIstr\fR\fR +.sp +Option to give \fBvalgrind\fR. Replaces default option(s)\&. Can be specified more then once&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: valgrind-path option +.\" valgrind-path option: mysql-test-run.pl +\fB\-\-valgrind\-path=\fR\fB\fIpath\fR\fR +.sp +Path to the +\fBvalgrind\fR +executable\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: vardir option +.\" vardir option: mysql-test-run.pl +\fB\-\-vardir=\fR\fB\fIpath\fR\fR +.sp +Specify the path where files generated during the test run are stored\&. The default location is +\&./var\&. The environment variable +MYSQLTEST_VARDIR +will be set to the path for this directory, whether it has the default value or has been set explicitly\&. This may be referred to in tests\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: verbose option +.\" verbose option: mysql-test-run.pl +\fB\-\-verbose\fR +.sp +Give more verbose output regarding test execution\&. Use the option twice to get even more output\&. Note that the output generated within each test case is not affected\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: verbose-restart option +.\" verbose-restart option: mysql-test-run.pl +\fB\-\-verbose\-restart\fR +.sp +Write when and why servers are restarted between test cases\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: view-protocol option +.\" view-protocol option: mysql-test-run.pl +\fB\-\-view\-protocol\fR +.sp +Create a view to execute all non updating queries\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: vs-config option +.\" vs-config option: mysql-test-run.pl +\fB\-\-vs\-config=\fR\fB\fIconfig_val\fR\fR +.sp +Visual Studio configuration used to create executables +(default: MTR_VS_CONFIG environment variable) +This option is for Windows only\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: wait-all option +.\" wait-all option: mysql-test-run.pl +\fB\-\-wait\-all\fR +.sp +If +\fB\-\-start\fR +or +\fB\-\-start\-dirty\fR +is used, wait for all servers to exit before termination\&. Otherwise, it will terminate if one (of several) servers is restarted\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: warnings option +.\" warnings option: mysql-test-run.pl +\fB\-\-warnings\fR +.sp +Search the server log for errors or warning after each test and report any suspicious ones; if any are found, the test will be marked as failed\&. This is the default behavior, it may be turned off with +\fB\-\-nowarnings\fR\&. +.RE +.sp +.RS 4 +.RE +.SH "COPYRIGHT" +.br +.PP +Copyright \(co 2007, 2010, Oracle and/or its affiliates, 2010-2020 MariaDB Foundation +.PP +This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License. +.PP +This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. +.PP +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-1335 USA or see http://www.gnu.org/licenses/. +.sp +.SH "SEE ALSO" +For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/ +.SH AUTHOR +MariaDB Foundation (http://www.mariadb.org/). diff --git a/man/mysql.1 b/man/mysql.1 new file mode 100644 index 00000000..2e499a62 --- /dev/null +++ b/man/mysql.1 @@ -0,0 +1,3134 @@ +'\" t +.\" +.TH "\fBMARIADB\fR" "1" "15 May 2020" "MariaDB 10.11" "MariaDB Database System" +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.\" mysql +.\" command-line tool +.\" tools: command-line +.\" scripts: SQL +.\" SQL scripts +.\" batch SQL files +.SH "NAME" +mariadb \- the MariaDB command\-line tool (mysql is now a symlink to mariadb) +.SH "SYNOPSIS" +.HP \w'\fBmysql\ [\fR\fB\fIoptions\fR\fR\fB]\ \fR\fB\fIdb_name\fR\fR\ 'u +\fBmysql [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fIdb_name\fR\fR +.SH "DESCRIPTION" +.PP +\fBmysql\fR +is a simple SQL shell (with GNU +readline +capabilities)\&. It supports interactive and non\-interactive use\&. When used interactively, query results are presented in an ASCII\-table format\&. When used non\-interactively (for example, as a filter), the result is presented in tab\-separated format\&. The output format can be changed using command options\&. +.PP +If you have problems due to insufficient memory for large result sets, use the +\fB\-\-quick\fR +option\&. This forces +\fBmysql\fR +to retrieve results from the server a row at a time rather than retrieving the entire result set and buffering it in memory before displaying it\&. This is done by returning the result set using the +mysql_use_result() +C API function in the client/server library rather than +mysql_store_result()\&. +.PP +Using +\fBmysql\fR +is very easy\&. Invoke it from the prompt of your command interpreter as follows: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysql \fR\fB\fIdb_name\fR\fR +.fi +.if n \{\ +.RE +.\} +.PP +Or: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysql \-\-user=\fR\fB\fIuser_name\fR\fR\fB \-\-password=\fR\fB\fIyour_password\fR\fR\fB \fR\fB\fIdb_name\fR\fR +.fi +.if n \{\ +.RE +.\} +.PP +Then type an SQL statement, end it with +\(lq;\(rq, +\eg, or +\eG +and press Enter\&. +.PP +Typing Control\-C causes +\fBmysql\fR +to attempt to kill the current statement\&. If this cannot be done, or Control\-C is typed again before the statement is killed, +\fBmysql\fR +exits\&. +.PP +You can execute SQL statements in a script file (batch file) like this: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysql \fR\fB\fIdb_name\fR\fR\fB < \fR\fB\fIscript\&.sql\fR\fR\fB > \fR\fB\fIoutput\&.tab\fR\fR +.fi +.if n \{\ +.RE +.\} +.SH "MYSQL OPTIONS" +.\" mysql command options +.\" command options: mysql +.\" options: command-line: mysql +.\" startup parameters: mysql +.PP +\fBmysql\fR +supports the following options, which can be specified on the command line or in the +[mysql], [client], [client-server] or [client-mariadb] +option file groups\&. +\fBmysql\fR +also supports the options for processing option files\&. +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: help option +.\" help option: mysql +\fB\-\-help\fR, +\fB\-?\fR, +\fB\-I\fR +.sp +Display a help message and exit\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: abort-source-on-error option +.\" abort-source-on-error: mysql +\fB\-\-abort\-source\-on\-error\fR +.sp +Abort 'source filename' operations in case of errors\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: auto-rehash option +.\" auto-rehash option: mysql +\fB\-\-auto\-rehash\fR +.sp +Enable automatic rehashing\&. This option is on by default, which enables database, table, and column name completion\&. Use +\fB\-\-disable\-auto\-rehash\fR, \fB\-\-no\-auto\-rehash\fR, or \fB\-\-skip\-auto\-rehash\fR +to disable rehashing\&. That causes +\fBmysql\fR +to start faster, but you must issue the +rehash +command if you want to use name completion\&. +.sp +To complete a name, enter the first part and press Tab\&. If the name is unambiguous, +\fBmysql\fR +completes it\&. Otherwise, you can press Tab again to see the possible names that begin with what you have typed so far\&. Completion does not occur if there is no default database\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: auto-vertical-output option +.\" auto-vertical-output option: mysql +\fB\-\-auto\-vertical\-output\fR +.sp +Automatically switch to vertical output mode if the result is wider than the terminal width\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: batch option +.\" batch option: mysql +\fB\-\-batch\fR, +\fB\-B\fR +.sp +Print results using tab as the column separator, with each row on a new line\&. With this option, +\fBmysql\fR +does not use the history file\&. +.sp +Batch mode results in nontabular output format and escaping of special characters\&. Escaping may be disabled by using raw mode; see the description for the +\fB\-\-raw\fR +option\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: binary-mode option +.\" binary-mode option: mysql +\fB\-\-binary\-mode\fR +.sp +Binary mode allows certain character sequences to be processed as data that +would otherwise be treated with a special meaning by the parser\&. +Specifically, this switch turns off parsing of all client commands except \eC +and DELIMITER in non-interactive mode (i\&.e\&., when binary mode is combined +with either 1) piped input, 2) the --batch mysql option, or 3) the 'source' +command)\&. Also, in binary mode, occurrences of '\er\en' and ASCII '\e0' are +preserved within strings, whereas by default, '\er\en' is translated to '\en' +and '\e0' is disallowed in user input\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: character-sets-dir option +.\" character-sets-dir option: mysql +\fB\-\-character\-sets\-dir=\fR\fB\fIpath\fR\fR +.sp +The directory where character sets are installed\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: column-names option +.\" column-names option: mysql +\fB\-\-column\-names\fR +.sp +Write column names in results\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: column-type-info option +.\" column-type-info option: mysql +\fB\-\-column\-type\-info\fR, +\fB\-m\fR +.sp +Display result set metadata\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: comments option +.\" comments option: mysql +\fB\-\-comments\fR, +\fB\-c\fR +.sp +Whether to preserve comments in statements sent to the server\&. The default is \-\-skip\-comments (discard comments), enable with \-\-comments (preserve comments)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: compress option +.\" compress option: mysql +\fB\-\-compress\fR, +\fB\-C\fR +.sp +Compress all information sent between the client and the server if both support compression\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: connect-timeout option +.\" connect-timeout option: mysql +\fB\-\-connect\-timeout=\fR\fB\fIseconds\fR\fR +.sp +Set the number of seconds before connection timeout\&. (Default value is 0\&.) +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: database option +.\" database option: mysql +\fB\-\-database=\fR\fB\fIdb_name\fR\fR, +\fB\-D \fR\fB\fIdb_name\fR\fR +.sp +The database to use\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: debug option +.\" debug option: mysql +\fB\-\-debug[=\fR\fB\fIdebug_options\fR\fR\fB]\fR, +\fB\-# [\fR\fB\fIdebug_options\fR\fR\fB]\fR +.sp +Write a debugging log\&. A typical +\fIdebug_options\fR +string is 'd:t:o,\fIfile_name\fR'. The default is 'd:t:o,/tmp/mysql.trace'. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: debug-check option +.\" debug-check option: mysql +\fB\-\-debug\-check\fR +.sp +Print some debugging information when the program exits\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: debug-info option +.\" debug-info option: mysql +\fB\-\-debug\-info\fR, +\fB\-T\fR +.sp +Prints debugging information and memory and CPU usage statistics when the program exits\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: default-auth option +.\" default-auth option: mysql +\fB\-\-default\-auth=\fR\fB\fIname\fR +.sp +Default authentication client-side plugin to use\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: default-character-set option +.\" default-character-set option: mysql +\fB\-\-default\-character\-set=\fR\fB\fIcharset_name\fR\fR +.sp +Use +\fIcharset_name\fR +as the default character set for the client and connection\&. +.sp +A common issue that can occur when the operating system uses +utf8 +or another multi\-byte character set is that output from the +\fBmysql\fR +client is formatted incorrectly, due to the fact that the MariaDB client uses the +latin1 +character set by default\&. You can usually fix such issues by using this option to force the client to use the system character set instead\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: defaults-extra-file option +.\" defaults-extra-file option: mysql +\fB\-\-defaults-extra-file=\fR\fB\fIfilename\fR\fR +.sp +Set \fB\fIfilename\fR\fR as the file to read default options from after the global defaults files has been read\&. +Must be given as first option\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: defaults-file option +.\" defaults-file option: mysql +\fB\-\-defaults-file=\fR\fB\fIfilename\fR\fR +.sp +Set \fB\fIfilename\fR\fR as the file to read default options from, override global defaults files\&. Must be given as first option\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: defaults-group-suffix option +.\" defaults-group-suffix option: mysql +\fB\-\-defaults\-group\-suffix=\fR\fB\fIsuffix\fR\fR +.sp +In addition to the groups named on the command line, read groups that have the given suffix\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: delimiter option +.\" delimiter option: mysql +\fB\-\-delimiter=\fR\fB\fIstr\fR\fR +.sp +Set the statement delimiter\&. The default is the semicolon character (\(lq;\(rq)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: disable named commands +.\" disable named command: mysql +\fB\-\-disable\-named\-commands\fR +.sp +Disable named commands\&. Use the +\e* +form only, or use named commands only at the beginning of a line ending with a semicolon (\(lq;\(rq)\&. +\fBmysql\fR +starts with this option +\fIenabled\fR +by default\&. However, even with this option, long\-format commands still work from the first line\&. See +the section called \(lqMYSQL COMMANDS\(rq\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: enable cleartext plugin option +.\" enable cleartext plugin option: mysql +\fB\-\-enable\-cleartext\-plugin\fR +.sp +Obsolete option\&. Exists only for MySQL compatibility\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: execute option +.\" execute option: mysql +\fB\-\-execute=\fR\fB\fIstatement\fR\fR, +\fB\-e \fR\fB\fIstatement\fR\fR +.sp +Execute the statement and quit\&. Disables \fB\-\-force\fR and history file\&. The default output format is like that produced with +\fB\-\-batch\fR\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: force option +.\" force option: mysql +\fB\-\-force\fR, +\fB\-f\fR +.sp +Continue even if an SQL error occurs\&. Sets \fB\-\-abort\-source\-on-error\fR to 0\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: host option +.\" host option: mysql +\fB\-\-host=\fR\fB\fIhost_name\fR\fR, +\fB\-h \fR\fB\fIhost_name\fR\fR +.sp +Connect to the MariaDB server on the given host\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: html option +.\" html option: mysql +\fB\-\-html\fR, +\fB\-H\fR +.sp +Produce HTML output\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: ignore-spaces option +.\" ignore-spaces option: mysql +\fB\-\-ignore\-spaces\fR, +\fB\-i\fR +.sp +Ignore spaces after function names\&. Allows one to have spaces (including tab characters and new line characters) between function name and '('\&. The drawback is that this causes built in functions to become reserved words\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: init-command option +.\" init-command option: mysql +\fB\-\-init\-command=\fR\fB\fIstr\fR\fR\fR +.sp +SQL Command to execute when connecting to the MariaDB server\&. Will automatically be re-executed when reconnecting\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: line-numbers option +.\" line-numbers option: mysql +\fB\-\-line\-numbers\fR +.sp +Write line numbers for errors\&. Disable this with +\fB\-\-skip\-line\-numbers\fR\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: local-infile option +.\" local-infile option: mysql +\fB\-\-local\-infile[={0|1}]\fR +.sp +Enable or disable +LOCAL +capability for +LOAD DATA INFILE\&. With no value, the option enables +LOCAL\&. The option may be given as +\fB\-\-local\-infile=0\fR +or +\fB\-\-local\-infile=1\fR +to explicitly disable or enable +LOCAL\&. Enabling +LOCAL +has no effect if the server does not also support it\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: max-allowed-packet option +.\" max-allowed-packet option: mysql +\fB\-\-max\-allowed\-packet=\fR\fB\fInum\fR\fR +.sp +Set the maximum packet length to send to or receive from the server\&. (Default value is 16MB, largest 1GB\&.) +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: max-join-size option +.\" max-join-size option: mysql +\fB\-\-max\-join\-size=\fR\fB\fInum\fR\fR +.sp +Set the automatic limit for rows in a join when using +\fB\-\-safe\-updates\fR\&. (Default value is 1,000,000\&.) +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: named-commands option +.\" named-commands option: mysql +\fB\-\-named\-commands\fR, +\fB\-G\fR +.sp +Enable named +\fBmysql\fR +commands\&. Long\-format commands are allowed, not just short\-format commands\&. For example, +quit +and +\eq +both are recognized\&. Use +\fB\-\-skip\-named\-commands\fR +to disable named commands\&. See +the section called \(lqMYSQL COMMANDS\(rq\&. Disabled by default\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\h'-04'\(bu\h'+03'\c +.\} +.\" mysql: net-buffer-length option +.\" net-buffer-length option: mysql +\fB\-\-net\-buffer\-length=\fR\fB\fIsize\fR\fR +.sp +Set the buffer size for TCP/IP and socket communication\&. (Default value is 16KB\&.) +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: no-auto-rehash option +.\" no-auto-rehash option: mysql +\fB\-\-no\-auto\-rehash\fR, +\fB\-A\fR +.sp +This has the same effect as +\fB\-\-skip\-auto\-rehash\fR\&. See the description for +\fB\-\-auto\-rehash\fR\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: no-beep option +.\" no-beep option: mysql +\fB\-\-no\-beep\fR, +\fB\-b\fR +.sp +Do not beep when errors occur\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: no-defaults option +.\" no-defaults option: mysql +\fB\-\-no\-defaults\fR +.sp +Do not read default options from any option file\&. This must be given as the first argument\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: one-database option +.\" one-database option: mysql +\fB\-\-one\-database\fR, +\fB\-o\fR +.sp +Ignore statements except those those that occur while the default database is the one named on the command line\&. This filtering is limited, and based only on USE statements\&. This is useful for skipping updates to other databases in the binary log\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: pager option +.\" pager option: mysql +\fB\-\-pager[=\fR\fB\fIcommand\fR\fR\fB]\fR +.sp +Use the given command for paging query output\&. If the command is omitted, the default pager is the value of your +PAGER +environment variable\&. Valid pagers are +\fBless\fR, +\fBmore\fR, +\fBcat [> filename]\fR, and so forth\&. This option works only on Unix and only in interactive mode\&. To disable paging, use +\fB\-\-skip\-pager\fR\&. +the section called \(lqMYSQL COMMANDS\(rq, discusses output paging further\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: password option +.\" password option: mysql +\fB\-\-password[=\fR\fB\fIpassword\fR\fR\fB]\fR, +\fB\-p[\fR\fB\fIpassword\fR\fR\fB]\fR +.sp +The password to use when connecting to the server\&. If you use the short option form (\fB\-p\fR), you +\fIcannot\fR +have a space between the option and the password\&. If you omit the +\fIpassword\fR +value following the +\fB\-\-password\fR +or +\fB\-p\fR +option on the command line, +\fBmysql\fR +prompts for one\&. +.sp +Specifying a password on the command line should be considered insecure\&. You can use an option file to avoid giving the password on the command line\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: pipe option +.\" pipe option: mysql +\fB\-\-pipe\fR, +\fB\-W\fR +.sp +On Windows, connect to the server via a named pipe\&. This option applies only if the server supports named\-pipe connections\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: plugin-dir option +.\" plugin-dir option: mysql +\fB\-\-plugin\-dir=\fIdir_name\fR +.sp +Directory for client-side plugins\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: port option +.\" port option: mysql +\fB\-\-port=\fR\fB\fIport_num\fR\fR, +\fB\-P \fR\fB\fIport_num\fR\fR +.sp +The TCP/IP port number to use for the connection or 0 for default to, in order of preference, my.cnf, $MYSQL_TCP_PORT, /etc/services, built-in default (3306)\&. +Forces --protocol=tcp when specified on the command line without other connection properties\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: print-defaults option +.\" print-defaults option: mysql +\fB\-\-print\-defaults\fR +.sp +Print the program argument list and exit\&. This must be given as the first argument\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: progress-reports option +.\" progress-reports option: mysql +\fB\-\-progress\-reports\fR +.sp +Get progress reports for long running commands (such as ALTER TABLE)\&. (Defaults to on; use \fB\-\-skip\-progress\-reports\fR to disable\&.) +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: prompt option +.\" prompt option: mysql +\fB\-\-prompt=\fR\fB\fIformat_str\fR\fR +.sp +Set the prompt to the specified format\&. The special sequences that the prompt can contain are described in +the section called \(lqMYSQL COMMANDS\(rq\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: protocol option +.\" protocol option: mysql +\fB\-\-protocol={TCP|SOCKET|PIPE|MEMORY}\fR +.sp +The connection protocol to use for connecting to the server\&. It is useful when the other connection parameters normally would cause a protocol to be used other than the one you want\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: quick option +.\" quick option: mysql +\fB\-\-quick\fR, +\fB\-q\fR +.sp +Do not cache each query result, print each row as it is received\&. This may slow down the server if the output is suspended\&. With this option, +\fBmysql\fR +does not use the history file\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: raw option +.\" raw option: mysql +\fB\-\-raw\fR, +\fB\-r\fR +.sp +For tabular output, the +\(lqboxing\(rq +around columns enables one column value to be distinguished from another\&. For nontabular output (such as is produced in batch mode or when the +\fB\-\-batch\fR +or +\fB\-\-silent\fR +option is given), special characters are escaped in the output so they can be identified easily\&. Newline, tab, +NUL, and backslash are written as +\en, +\et, +\e0, and +\e\e\&. The +\fB\-\-raw\fR +option disables this character escaping\&. +.sp +The following example demonstrates tabular versus nontabular output and the use of raw mode to disable escaping: +.sp +.if n \{\ +.RS 4 +.\} +.nf +% \fBmysql\fR +mysql> SELECT CHAR(92); ++\-\-\-\-\-\-\-\-\-\-+ +| CHAR(92) | ++\-\-\-\-\-\-\-\-\-\-+ +| \e | ++\-\-\-\-\-\-\-\-\-\-+ +% \fBmysql \-s\fR +mysql> SELECT CHAR(92); +CHAR(92) +\e\e +% \fBmysql \-s \-r\fR +mysql> SELECT CHAR(92); +CHAR(92) +\e +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: reconnect option +.\" reconnect option: mysql +\fB\-\-reconnect\fR +.sp +If the connection to the server is lost, automatically try to reconnect\&. A single reconnect attempt is made each time the connection is lost\&. Enabled by default, to disable use +\fB\-\-skip\-reconnect\fR or \fB\-\-disable\-reconnect\fR\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: safe-updates option +.\" safe-updates option: mysql +.\" mysql: i-am-a-dummy option +.\" i-am-a-dummy option: mysql +\fB\-\-safe\-updates\fR, +\fB\-\-i\-am\-a\-dummy\fR, +\fB\-U\fR +.sp +Allow only those +UPDATE +and +DELETE +statements that specify which rows to modify by using key values\&. If you have set this option in an option file, you can override it by using +\fB\-\-safe\-updates\fR +on the command line\&. See +the section called \(lqMYSQL TIPS\(rq, for more information about this option\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: secure-auth option +.\" secure-auth option: mysql +\fB\-\-secure\-auth\fR +.sp +Do not send passwords to the server in old (pre\-4\&.1\&.1) format\&. This prevents connections except for servers that use the newer password format\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: select-limit option +.\" select-limit option: mysql +\fB\-\-select\-limit=\fR\fB\fIlimit\fR\fR +.sp +Set automatic limit for SELECT when using \fB\-\-safe\-updates\fR\&. (Default value is 1,000\&.) +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: server-arg option +.\" server-arg option: mysql +\fB\-\-server\-arg=\fR\fB\fIname\fR\fR +.sp +Send \fB\fIname\fR\fR as a parameter to the embedded server\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: show-warnings option +.\" show-warnings option: mysql +\fB\-\-show\-warnings\fR +.sp +Cause warnings to be shown after each statement if there are any\&. This option applies to interactive and batch mode\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: sigint-ignore option +.\" sigint-ignore option: mysql +\fB\-\-sigint\-ignore\fR +.sp +Ignore +SIGINT +signals (typically the result of typing Control\-C)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: silent option +.\" silent option: mysql +\fB\-\-silent\fR, +\fB\-s\fR +.sp +Silent mode\&. Produce less output\&. This option can be given multiple times to produce less and less output\&. +.sp +This option results in nontabular output format and escaping of special characters\&. Escaping may be disabled by using raw mode; see the description for the +\fB\-\-raw\fR +option\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: skip-auto-rehash option +.\" skip-auto-rehash option: mysql +\fB\-\-skip\-auto\-rehash\fR +.sp +Disable automatic rehashing\&. Synonym for \fB\-\-disable\-auto\-rehash\fR\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: skip-column-names option +.\" skip-column-names option: mysql +\fB\-\-skip\-column\-names\fR, +\fB\-N\fR +.sp +Do not write column names in results\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: skip-line-numbers option +.\" skip-line-numbers option: mysql +\fB\-\-skip\-line\-numbers\fR, +\fB\-L\fR +.sp +Do not write line numbers for errors\&. Useful when you want to compare result files that include error messages\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: socket option +.\" socket option: mysql +\fB\-\-socket=\fR\fB\fIpath\fR\fR, +\fB\-S \fR\fB\fIpath\fR\fR +.sp +For connections to +localhost, the Unix socket file to use, or, on Windows, the name of the named pipe to use\&. +Forces --protocol=socket when specified on the command line without other connection properties; on Windows, forces --protocol=pipe\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: SSL options +.\" SSL options: mysql +\fB\-\-ssl\fR +.sp +Enable SSL for connection (automatically enabled with other flags). Disable with +\fB\-\-skip-ssl\fR\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: SSL CA option +.\" SSL CA option: mysql +\fB\-\-ssl\-ca=\fIname\fR +.sp +CA file in PEM format (check OpenSSL docs, implies +\fB\-\-ssl\fR)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: SSL CA Path option +.\" SSL CA Path option: mysql +\fB\-\-ssl\-capath=\fIname\fR +.sp +CA directory (check OpenSSL docs, implies +\fB\-\-ssl\fR)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: SSL Cert option +.\" SSL Cert option: mysql +\fB\-\-ssl\-cert=\fIname\fR +.sp +X509 cert in PEM format (check OpenSSL docs, implies +\fB\-\-ssl\fR)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: SSL Cipher option +.\" SSL Cipher option: mysql +\fB\-\-ssl\-cipher=\fIname\fR +.sp +SSL cipher to use (check OpenSSL docs, implies +\fB\-\-ssl\fR)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: SSL Key option +.\" SSL Key option: mysql +\fB\-\-ssl\-key=\fIname\fR +.sp +X509 key in PEM format (check OpenSSL docs, implies +\fB\-\-ssl\fR)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: SSL Crl option +.\" SSL CRL option: mysql +\fB\-\-ssl\-crl=\fIname\fR +.sp +Certificate revocation list (check OpenSSL docs, implies +\fB\-\-ssl\fR)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: SSL Crlpath option +.\" SSL Crlpath option: mysql +\fB\-\-ssl\-crlpath=\fIname\fR +.sp +Certificate revocation list path (check OpenSSL docs, implies +\fB\-\-ssl\fR)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: SSL Verify Server Cert option +.\" SSL Verify Server Cert option: mysql +\fB\-\-ssl\-verify\-server\-cert\fR +.sp +Verify server's "Common Name" in its cert against hostname used when connecting. This option is disabled by default\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: table option +.\" table option: mysql +\fB\-\-table\fR, +\fB\-t\fR +.sp +Display output in table format\&. This is the default for interactive use, but can be used to produce table output in batch mode\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: tee option +.\" tee option: mysql +\fB\-\-tee=\fR\fB\fIfile_name\fR\fR +.sp +Append a copy of output to the given file\&. This option works only in interactive mode\&. +the section called \(lqMYSQL COMMANDS\(rq, discusses tee files further\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: unbuffered option +.\" unbuffered option: mysql +\fB\-\-unbuffered\fR, +\fB\-n\fR +.sp +Flush the buffer after each query\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: user option +.\" user option: mysql +\fB\-\-user=\fR\fB\fIuser_name\fR\fR, +\fB\-u \fR\fB\fIuser_name\fR\fR +.sp +The MariaDB user name to use when connecting to the server\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: verbose option +.\" verbose option: mysql +\fB\-\-verbose\fR, +\fB\-v\fR +.sp +Verbose mode\&. Produce more output about what the program does\&. This option can be given multiple times to produce more and more output\&. (For example, +\fB\-v \-v \-v\fR +produces table output format even in batch mode\&.) +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: version option +.\" version option: mysql +\fB\-\-version\fR, +\fB\-V\fR +.sp +Display version information and exit\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: vertical option +.\" vertical option: mysql +\fB\-\-vertical\fR, +\fB\-E\fR +.sp +Print query output rows vertically (one line per column value)\&. Without this option, you can specify vertical output for individual statements by terminating them with +\eG\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: wait option +.\" wait option: mysql +\fB\-\-wait\fR, +\fB\-w\fR +.sp +If the connection cannot be established, wait and retry instead of aborting\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: xml option +.\" xml option: mysql +\fB\-\-xml\fR, +\fB\-X\fR +.sp +Produce XML output\&. +The output when +\fB\-\-xml\fR +is used with +\fBmysql\fR +matches that of +\fBmysqldump \fR\fB\fB\-\-xml\fR\fR\&. See +\fBmysqldump\fR(1) +for details\&. +.sp +The XML output also uses an XML namespace, as shown here: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysql \-\-xml \-uroot \-e "SHOW VARIABLES LIKE 'version%'"\fR +<?xml version="1\&.0"?> +<resultset statement="SHOW VARIABLES LIKE 'version%'" xmlns:xsi="http://www\&.w3\&.org/2001/XMLSchema\-instance"> +<row> +<field name="Variable_name">version</field> +<field name="Value">5\&.0\&.40\-debug</field> +</row> +<row> +<field name="Variable_name">version_comment</field> +<field name="Value">Source distribution</field> +</row> +<row> +<field name="Variable_name">version_compile_machine</field> +<field name="Value">i686</field> +</row> +<row> +<field name="Variable_name">version_compile_os</field> +<field name="Value">suse\-linux\-gnu</field> +</row> +</resultset> +.fi +.RE +.PP +You can also set the following variables by using +\fB\-\-\fR\fB\fIvar_name\fR\fR\fB=\fR\fB\fIvalue\fR\fR\&. +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" timeout: connect_timeout variable +.\" connect_timeout variable +connect_timeout +.sp +The number of seconds before connection timeout\&. (Default value is +0\&.) +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" max_allowed_packet variable +max_allowed_packet +.sp +The maximum packet length to send to or receive from the server\&. (Default value is 16MB\&.) +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" max_join_size variable +max_join_size +.sp +The automatic limit for rows in a join when using +\fB\-\-safe\-updates\fR\&. (Default value is 1,000,000\&.) +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" net_buffer_length variable +net_buffer_length +.sp +The buffer size for TCP/IP and socket communication\&. (Default value is 16KB\&.) +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" select_limit variable +select_limit +.sp +The automatic limit for +SELECT +statements when using +\fB\-\-safe\-updates\fR\&. (Default value is 1,000\&.) +.RE +.\" MYSQL_HISTFILE environment variable +.\" environment variable: MYSQL_HISTFILE +.\" HOME environment variable +.\" environment variable: HOME +.\" mysql history file +.\" command-line history: mysql +.\" .mysql_history file +.PP +On Unix, the +\fBmysql\fR +client writes a record of executed statements to a history file\&. By default, this file is named +\&.mysql_history +and is created in your home directory\&. To specify a different file, set the value of the +MYSQL_HISTFILE +environment variable\&. +.PP +The +\&.mysql_history +should be protected with a restrictive access mode because sensitive information might be written to it, such as the text of SQL statements that contain passwords\&. +.PP +If you do not want to maintain a history file, first remove +\&.mysql_history +if it exists, and then use either of the following techniques: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Set the +MYSQL_HISTFILE +variable to +/dev/null\&. To cause this setting to take effect each time you log in, put the setting in one of your shell's startup files\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Create +\&.mysql_history +as a symbolic link to +/dev/null: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBln \-s /dev/null $HOME/\&.mysql_history\fR +.fi +.if n \{\ +.RE +.\} +.sp +You need do this only once\&. +.RE +.SH "MYSQL COMMANDS" +.PP +\fBmysql\fR +sends each SQL statement that you issue to the server to be executed\&. There is also a set of commands that +\fBmysql\fR +itself interprets\&. For a list of these commands, type +help +or +\eh +at the +mysql> +prompt: +.\" mysql commands: list of +.sp +.if n \{\ +.RS 4 +.\} +.nf +mysql> \fBhelp\fR +List of all MySQL commands: +Note that all text commands must be first on line and end with ';' +? (\e?) Synonym for 'help'\&. +clear (\ec) Clear command\&. +connect (\er) Reconnect to the server\&. Optional arguments are db and host\&. +delimiter (\ed) Set statement delimiter\&. +edit (\ee) Edit command with $EDITOR\&. +ego (\eG) Send command to mysql server, display result vertically\&. +exit (\eq) Exit mysql\&. Same as quit\&. +go (\eg) Send command to mysql server\&. +help (\eh) Display this help\&. +nopager (\en) Disable pager, print to stdout\&. +notee (\et) Don't write into outfile\&. +pager (\eP) Set PAGER [to_pager]\&. Print the query results via PAGER\&. +print (\ep) Print current command\&. +prompt (\eR) Change your mysql prompt\&. +quit (\eq) Quit mysql\&. +rehash (\e#) Rebuild completion hash\&. +source (\e\&.) Execute an SQL script file\&. Takes a file name as an argument\&. +status (\es) Get status information from the server\&. +system (\e!) Execute a system shell command\&. +tee (\eT) Set outfile [to_outfile]\&. Append everything into given + outfile\&. +use (\eu) Use another database\&. Takes database name as argument\&. +charset (\eC) Switch to another charset\&. Might be needed for processing + binlog with multi\-byte charsets\&. +warnings (\eW) Show warnings after every statement\&. +nowarning (\ew) Don't show warnings after every statement\&. +For server side help, type 'help contents' +.fi +.if n \{\ +.RE +.\} +.PP +Each command has both a long and short form\&. The long form is not case sensitive; the short form is\&. The long form can be followed by an optional semicolon terminator, but the short form should not\&. +.PP +The use of short\-form commands within multi\-line +/* \&.\&.\&. */ +comments is not supported\&. +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: help command +.\" help command: mysql +\fBhelp [\fR\fB\fIarg\fR\fR\fB]\fR, +\fB\eh [\fR\fB\fIarg\fR\fR\fB]\fR, +\fB\e? [\fR\fB\fIarg\fR\fR\fB]\fR, +\fB? [\fR\fB\fIarg\fR\fR\fB]\fR +.sp +Display a help message listing the available +\fBmysql\fR +commands\&. +.sp +If you provide an argument to the +help +command, +\fBmysql\fR +uses it as a search string to access server\-side help\&. For more information, see +the section called \(lqMYSQL SERVER-SIDE HELP\(rq\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: charset command +.\" charset command: mysql +\fBcharset \fR\fB\fIcharset_name\fR\fR, +\fB\eC \fR\fB\fIcharset_name\fR\fR +.sp +Change the default character set and issue a +SET NAMES +statement\&. This enables the character set to remain synchronized on the client and server if +\fBmysql\fR +is run with auto\-reconnect enabled (which is not recommended), because the specified character set is used for reconnects\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: clear command +.\" clear command: mysql +\fBclear\fR, +\fB\ec\fR +.sp +Clear the current input\&. Use this if you change your mind about executing the statement that you are entering\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: connect command +.\" connect command: mysql +\fBconnect [\fR\fB\fIdb_name\fR\fR\fB \fR\fB\fIhost_name\fR\fR\fB]]\fR, +\fB\er [\fR\fB\fIdb_name\fR\fR\fB \fR\fB\fIhost_name\fR\fR\fB]]\fR +.sp +Reconnect to the server\&. The optional database name and host name arguments may be given to specify the default database or the host where the server is running\&. If omitted, the current values are used\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: delimiter command +.\" delimiter command: mysql +\fBdelimiter \fR\fB\fIstr\fR\fR, +\fB\ed \fR\fB\fIstr\fR\fR +.sp +Change the string that +\fBmysql\fR +interprets as the separator between SQL statements\&. The default is the semicolon character (\(lq;\(rq)\&. +.sp +The delimiter can be specified as an unquoted or quoted argument\&. Quoting can be done with either single quote (') or douple quote (") characters\&. To include a quote within a quoted string, either quote the string with the other quote character or escape the quote with a backslash (\(lq\e\(rq) character\&. Backslash should be avoided outside of quoted strings because it is the escape character for MariaDB\&. For an unquoted argument, the delmiter is read up to the first space or end of line\&. For a quoted argument, the delimiter is read up to the matching quote on the line\&. +.sp +When the delimiter recognized by +\fBmysql\fR +is set to something other than the default of +\(lq;\(rq, instances of that character are sent to the server without interpretation\&. However, the server itself still interprets +\(lq;\(rq +as a statement delimiter and processes statements accordingly\&. This behavior on the server side comes into play for multiple\-statement execution, and for parsing the body of stored procedures and functions, triggers, and events\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: edit command +.\" edit command: mysql +\fBedit\fR, +\fB\ee\fR +.sp +Edit the current input statement\&. +\fBmysql\fR +checks the values of the +EDITOR +and +VISUAL +environment variables to determine which editor to use\&. The default editor is +\fBvi\fR +if neither variable is set\&. +.sp +The +\fBedit\fR +command works only in Unix\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: ego command +.\" ego command: mysql +\fBego\fR, +\fB\eG\fR +.sp +Send the current statement to the server to be executed and display the result using vertical format\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: exit command +.\" exit command: mysql +\fBexit\fR, +\fB\eq\fR +.sp +Exit +\fBmysql\fR\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: go command +.\" go command: mysql +\fBgo\fR, +\fB\eg\fR +.sp +Send the current statement to the server to be executed\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: nopager command +.\" nopager command: mysql +\fBnopager\fR, +\fB\en\fR +.sp +Disable output paging\&. See the description for +\fBpager\fR\&. +.sp +The +\fBnopager\fR +command works only in Unix\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: notee command +.\" notee command: mysql +\fBnotee\fR, +\fB\et\fR +.sp +Disable output copying to the tee file\&. See the description for +\fBtee\fR\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: nowarning command +.\" nowarning command: mysql +\fBnowarning\fR, +\fB\ew\fR +.sp +Enable display of warnings after each statement\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: pager command +.\" pager command: mysql +\fBpager [\fR\fB\fIcommand\fR\fR\fB]\fR, +\fB\eP [\fR\fB\fIcommand\fR\fR\fB]\fR +.sp +Enable output paging\&. By using the +\fB\-\-pager\fR +option when you invoke +\fBmysql\fR, it is possible to browse or search query results in interactive mode with Unix programs such as +\fBless\fR, +\fBmore\fR, or any other similar program\&. If you specify no value for the option, +\fBmysql\fR +checks the value of the +PAGER +environment variable and sets the pager to that\&. Pager functionality works only in interactive mode\&. +.sp +Output paging can be enabled interactively with the +\fBpager\fR +command and disabled with +\fBnopager\fR\&. The command takes an optional argument; if given, the paging program is set to that\&. With no argument, the pager is set to the pager that was set on the command line, or +stdout +if no pager was specified\&. +.sp +Output paging works only in Unix because it uses the +popen() +function, which does not exist on Windows\&. For Windows, the +\fBtee\fR +option can be used instead to save query output, although it is not as convenient as +\fBpager\fR +for browsing output in some situations\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: print command +.\" print command: mysql +\fBprint\fR, +\fB\ep\fR +.sp +Print the current input statement without executing it\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: prompt command +.\" prompt command: mysql +\fBprompt [\fR\fB\fIstr\fR\fR\fB]\fR, +\fB\eR [\fR\fB\fIstr\fR\fR\fB]\fR +.sp +Reconfigure the +\fBmysql\fR +prompt to the given string\&. The special character sequences that can be used in the prompt are described later in this section\&. +.sp +If you specify the +prompt +command with no argument, +\fBmysql\fR +resets the prompt to the default of +mysql>\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: quit command +.\" quit command: mysql +\fBquit\fR, +\fB\eq\fR +.sp +Exit +\fBmysql\fR\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: rehash command +.\" rehash command: mysql +\fBrehash\fR, +\fB\e#\fR +.sp +Rebuild the completion hash that enables database, table, and column name completion while you are entering statements\&. (See the description for the +\fB\-\-auto\-rehash\fR +option\&.) +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: source command +.\" source command: mysql +\fBsource \fR\fB\fIfile_name\fR\fR, +\fB\e\&. \fR\fB\fIfile_name\fR\fR +.sp +Read the named file and executes the statements contained therein\&. On Windows, you can specify path name separators as +/ +or +\e\e\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: status command +.\" status command: mysql +\fBstatus\fR, +\fB\es\fR +.sp +Provide status information about the connection and the server you are using\&. If you are running in +\fB\-\-safe\-updates\fR +mode, +status +also prints the values for the +\fBmysql\fR +variables that affect your queries\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: system command +.\" system command: mysql +\fBsystem \fR\fB\fIcommand\fR\fR, +\fB\e! \fR\fB\fIcommand\fR\fR +.sp +Execute the given command using your default command interpreter\&. +.sp +The +\fBsystem\fR +command works only in Unix\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: tee command +.\" tee command: mysql +\fBtee [\fR\fB\fIfile_name\fR\fR\fB]\fR, +\fB\eT [\fR\fB\fIfile_name\fR\fR\fB]\fR +.sp +By using the +\fB\-\-tee\fR +option when you invoke +\fBmysql\fR, you can log statements and their output\&. All the data displayed on the screen is appended into a given file\&. This can be very useful for debugging purposes also\&. +\fBmysql\fR +flushes results to the file after each statement, just before it prints its next prompt\&. Tee functionality works only in interactive mode\&. +.sp +You can enable this feature interactively with the +\fBtee\fR +command\&. Without a parameter, the previous file is used\&. The +\fBtee\fR +file can be disabled with the +\fBnotee\fR +command\&. Executing +\fBtee\fR +again re\-enables logging\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: use command +.\" use command: mysql +\fBuse \fR\fB\fIdb_name\fR\fR, +\fB\eu \fR\fB\fIdb_name\fR\fR +.sp +Use +\fIdb_name\fR +as the default database\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql: warnings command +.\" warnings command: mysql +\fBwarnings\fR, +\fB\eW\fR +.sp +Enable display of warnings after each statement (if there are any)\&. +.RE +.PP +Here are a few tips about the +\fBpager\fR +command: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +You can use it to write to a file and the results go only to the file: +.sp +.if n \{\ +.RS 4 +.\} +.nf +mysql> \fBpager cat > /tmp/log\&.txt\fR +.fi +.if n \{\ +.RE +.\} +.sp +You can also pass any options for the program that you want to use as your pager: +.sp +.if n \{\ +.RS 4 +.\} +.nf +mysql> \fBpager less \-n \-i \-S\fR +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +In the preceding example, note the +\fB\-S\fR +option\&. You may find it very useful for browsing wide query results\&. Sometimes a very wide result set is difficult to read on the screen\&. The +\fB\-S\fR +option to +\fBless\fR +can make the result set much more readable because you can scroll it horizontally using the left\-arrow and right\-arrow keys\&. You can also use +\fB\-S\fR +interactively within +\fBless\fR +to switch the horizontal\-browse mode on and off\&. For more information, read the +\fBless\fR +manual page: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBman less\fR +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +The +\fB\-F\fR +and +\fB\-X\fR +options may be used with +\fBless\fR +to cause it to exit if output fits on one screen, which is convenient when no scrolling is necessary: +.sp +.if n \{\ +.RS 4 +.\} +.nf +mysql> \fBpager less \-n \-i \-S \-F \-X\fR +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +You can specify very complex pager commands for handling query output: +.sp +.if n \{\ +.RS 4 +.\} +.nf +mysql> \fBpager cat | tee /dr1/tmp/res\&.txt \e\fR + \fB| tee /dr2/tmp/res2\&.txt | less \-n \-i \-S\fR +.fi +.if n \{\ +.RE +.\} +.sp +In this example, the command would send query results to two files in two different directories on two different file systems mounted on +/dr1 +and +/dr2, yet still display the results onscreen via +\fBless\fR\&. +.RE +.PP +You can also combine the +\fBtee\fR +and +\fBpager\fR +functions\&. Have a +\fBtee\fR +file enabled and +\fBpager\fR +set to +\fBless\fR, and you are able to browse the results using the +\fBless\fR +program and still have everything appended into a file the same time\&. The difference between the Unix +\fBtee\fR +used with the +\fBpager\fR +command and the +\fBmysql\fR +built\-in +\fBtee\fR +command is that the built\-in +\fBtee\fR +works even if you do not have the Unix +\fBtee\fR +available\&. The built\-in +\fBtee\fR +also logs everything that is printed on the screen, whereas the Unix +\fBtee\fR +used with +\fBpager\fR +does not log quite that much\&. Additionally, +\fBtee\fR +file logging can be turned on and off interactively from within +\fBmysql\fR\&. This is useful when you want to log some queries to a file, but not others\&. +.\" mysql prompt command +.PP +The +\fBprompt\fR +command reconfigures the default +mysql> +prompt\&. The string for defining the prompt can contain the following special sequences\&. +.TS +allbox tab(:); +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l. +T{ +\fBOption\fR +T}:T{ +\fBDescription\fR +T} +T{ +\ec +T}:T{ +A counter that increments for each statement you issue +T} +T{ +\eD +T}:T{ +The full current date +T} +T{ +\ed +T}:T{ +The default database +T} +T{ +\eh +T}:T{ +The server host +T} +T{ +\el +T}:T{ +The current delimiter (new in 5\&.1\&.12) +T} +T{ +\em +T}:T{ +Minutes of the current time +T} +T{ +\en +T}:T{ +A newline character +T} +T{ +\eO +T}:T{ +The current month in three\-letter format (Jan, Feb, \&...) +T} +T{ +\eo +T}:T{ +The current month in numeric format +T} +T{ +\eP +T}:T{ +am/pm +T} +T{ +\ep +T}:T{ +The current TCP/IP port or socket file +T} +T{ +\eR +T}:T{ +The current time, in 24\-hour military time (0\(en23) +T} +T{ +\er +T}:T{ +The current time, standard 12\-hour time (1\(en12) +T} +T{ +\eS +T}:T{ +Semicolon +T} +T{ +\es +T}:T{ +Seconds of the current time +T} +T{ +\et +T}:T{ +A tab character +T} +T{ +\eU +T}:T{ +.PP +Your full +\fIuser_name\fR@\fIhost_name\fR +account name +T} +T{ +\eu +T}:T{ +Your user name +T} +T{ +\ev +T}:T{ +The server version +T} +T{ +\ew +T}:T{ +The current day of the week in three\-letter format (Mon, Tue, \&...) +T} +T{ +\eY +T}:T{ +The current year, four digits +T} +T{ +\ey +T}:T{ +The current year, two digits +T} +T{ +\e_ +T}:T{ +A space +T} +T{ +\e\ \& +T}:T{ +A space (a space follows the backslash) +T} +T{ +\e' +T}:T{ +Single quote +T} +T{ +\e" +T}:T{ +Double quote +T} +T{ +\e\e +T}:T{ +A literal \(lq\e\(rq backslash character +T} +T{ +\e\fIx\fR +T}:T{ +.PP +\fIx\fR, for any +\(lq\fIx\fR\(rq +not listed above +T} +.TE +.sp 1 +.PP +You can set the prompt in several ways: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fIUse an environment variable\&.\fR +You can set the +MYSQL_PS1 +environment variable to a prompt string\&. For example: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBexport MYSQL_PS1="(\eu@\eh) [\ed]> "\fR +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fIUse a command\-line option\&.\fR +You can set the +\fB\-\-prompt\fR +option on the command line to +\fBmysql\fR\&. For example: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysql \-\-prompt="(\eu@\eh) [\ed]> "\fR +(user@host) [database]> +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fIUse an option file\&.\fR +You can set the +prompt +option in the +[mysql] +group of any MariaDB option file, such as +/etc/my\&.cnf +or the +\&.my\&.cnf +file in your home directory\&. For example: +.sp +.if n \{\ +.RS 4 +.\} +.nf +[mysql] +prompt=(\e\eu@\e\eh) [\e\ed]>\e\e_ +.fi +.if n \{\ +.RE +.\} +.sp +In this example, note that the backslashes are doubled\&. If you set the prompt using the +prompt +option in an option file, it is advisable to double the backslashes when using the special prompt options\&. There is some overlap in the set of allowable prompt options and the set of special escape sequences that are recognized in option files\&. The overlap may cause you problems if you use single backslashes\&. For example, +\es +is interpreted as a space rather than as the current seconds value\&. The following example shows how to define a prompt within an option file to include the current time in +HH:MM:SS> +format: +.sp +.if n \{\ +.RS 4 +.\} +.nf +[mysql] +prompt="\e\er:\e\em:\e\es> " +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fISet the prompt interactively\&.\fR +You can change your prompt interactively by using the +prompt +(or +\eR) command\&. For example: +.sp +.if n \{\ +.RS 4 +.\} +.nf +mysql> \fBprompt (\eu@\eh) [\ed]>\e_\fR +PROMPT set to '(\eu@\eh) [\ed]>\e_' +(\fIuser\fR@\fIhost\fR) [\fIdatabase\fR]> +(\fIuser\fR@\fIhost\fR) [\fIdatabase\fR]> prompt +Returning to default PROMPT of mysql> +mysql> +.fi +.if n \{\ +.RE +.\} +.RE +.SH "MYSQL SERVER-SIDE HELP" +.sp +.if n \{\ +.RS 4 +.\} +.nf +mysql> \fBhelp \fR\fB\fIsearch_string\fR\fR +.fi +.if n \{\ +.RE +.\} +.PP +If you provide an argument to the +help +command, +\fBmysql\fR +uses it as a search string to access server\-side help\&. The proper operation of this command requires that the help tables in the +mysql +database be initialized with help topic information. +.PP +If there is no match for the search string, the search fails: +.sp +.if n \{\ +.RS 4 +.\} +.nf +mysql> \fBhelp me\fR +Nothing found +Please try to run 'help contents' for a list of all accessible topics +.fi +.if n \{\ +.RE +.\} +.PP +Use +\fBhelp contents\fR +to see a list of the help categories: +.sp +.if n \{\ +.RS 4 +.\} +.nf +mysql> \fBhelp contents\fR +You asked for help about help category: "Contents" +For more information, type 'help <item>', where <item> is one of the +following categories: + Account Management + Administration + Data Definition + Data Manipulation + Data Types + Functions + Functions and Modifiers for Use with GROUP BY + Geographic Features + Language Structure + Plugins + Storage Engines + Stored Routines + Table Maintenance + Transactions + Triggers +.fi +.if n \{\ +.RE +.\} +.PP +If the search string matches multiple items, +\fBmysql\fR +shows a list of matching topics: +.sp +.if n \{\ +.RS 4 +.\} +.nf +mysql> \fBhelp logs\fR +Many help items for your request exist\&. +To make a more specific request, please type 'help <item>', +where <item> is one of the following topics: + SHOW + SHOW BINARY LOGS + SHOW ENGINE + SHOW LOGS +.fi +.if n \{\ +.RE +.\} +.PP +Use a topic as the search string to see the help entry for that topic: +.sp +.if n \{\ +.RS 4 +.\} +.nf +mysql> \fBhelp show binary logs\fR +Name: 'SHOW BINARY LOGS' +Description: +Syntax: +SHOW BINARY LOGS +SHOW MASTER LOGS +Lists the binary log files on the server\&. This statement is used as +part of the procedure described in [purge\-binary\-logs], that shows how +to determine which logs can be purged\&. +mysql> SHOW BINARY LOGS; ++\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-+ +| Log_name | File_size | ++\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-+ +| binlog\&.000015 | 724935 | +| binlog\&.000016 | 733481 | ++\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-+ +.fi +.if n \{\ +.RE +.\} +.SH "EXECUTING SQL STATEMENTS FROM A TEXT FILE" +.\" executing SQL statements from text files +.\" importing: data +.\" data: importing +.\" files: text +.\" text files: importing +.\" source (mysql client command) +.\" \. (mysql client command) +.\" mysql source (command for reading from text files) +.\" mysql \. (command for reading from text files) +.PP +The +\fBmysql\fR +client typically is used interactively, like this: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysql \fR\fB\fIdb_name\fR\fR +.fi +.if n \{\ +.RE +.\} +.PP +However, it is also possible to put your SQL statements in a file and then tell +\fBmysql\fR +to read its input from that file\&. To do so, create a text file +\fItext_file\fR +that contains the statements you wish to execute\&. Then invoke +\fBmysql\fR +as shown here: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysql \fR\fB\fIdb_name\fR\fR\fB < \fR\fB\fItext_file\fR\fR +.fi +.if n \{\ +.RE +.\} +.PP +If you place a +USE \fIdb_name\fR +statement as the first statement in the file, it is unnecessary to specify the database name on the command line: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysql < text_file\fR +.fi +.if n \{\ +.RE +.\} +.PP +If you are already running +\fBmysql\fR, you can execute an SQL script file using the +source +command or +\e\&. +command: +.sp +.if n \{\ +.RS 4 +.\} +.nf +mysql> \fBsource \fR\fB\fIfile_name\fR\fR +mysql> \fB\e\&. \fR\fB\fIfile_name\fR\fR +.fi +.if n \{\ +.RE +.\} +.PP +Sometimes you may want your script to display progress information to the user\&. For this you can insert statements like this: +.sp +.if n \{\ +.RS 4 +.\} +.nf +SELECT '<info_to_display>' AS ' '; +.fi +.if n \{\ +.RE +.\} +.PP +The statement shown outputs +<info_to_display>\&. +.PP +You can also invoke +\fBmysql\fR +with the +\fB\-\-verbose\fR +option, which causes each statement to be displayed before the result that it produces\&. +.PP +\fBmysql\fR +ignores Unicode byte order mark (BOM) characters at the beginning of input files\&. Presence of a BOM does not cause +\fBmysql\fR +to change its default character set\&. To do that, invoke +\fBmysql\fR +with an option such as +\fB\-\-default\-character\-set=utf8\fR\&. +.PP +.SH "MYSQL TIPS" +.PP +This section describes some techniques that can help you use +\fBmysql\fR +more effectively\&. +.SS "Displaying Query Results Vertically" +.PP +Some query results are much more readable when displayed vertically, instead of in the usual horizontal table format\&. Queries can be displayed vertically by terminating the query with \eG instead of a semicolon\&. For example, longer text values that include newlines often are much easier to read with vertical output: +.sp +.if n \{\ +.RS 4 +.\} +.nf +mysql> \fBSELECT * FROM mails WHERE LENGTH(txt) < 300 LIMIT 300,1\eG\fR +*************************** 1\&. row *************************** + msg_nro: 3068 + date: 2000\-03\-01 23:29:50 +time_zone: +0200 +mail_from: Monty + reply: monty@no\&.spam\&.com + mail_to: "Thimble Smith" <tim@no\&.spam\&.com> + sbj: UTF\-8 + txt: >>>>> "Thimble" == Thimble Smith writes: +Thimble> Hi\&. I think this is a good idea\&. Is anyone familiar +Thimble> with UTF\-8 or Unicode? Otherwise, I'll put this on my +Thimble> TODO list and see what happens\&. +Yes, please do that\&. +Regards, +Monty + file: inbox\-jani\-1 + hash: 190402944 +1 row in set (0\&.09 sec) +.fi +.if n \{\ +.RE +.\} +.SS "Using the \-\-safe\-updates Option" +.\" safe-updates option +.PP +For beginners, a useful startup option is +\fB\-\-safe\-updates\fR +(or +\fB\-\-i\-am\-a\-dummy\fR, which has the same effect)\&. It is helpful for cases when you might have issued a +DELETE FROM \fItbl_name\fR +statement but forgotten the +WHERE +clause\&. Normally, such a statement deletes all rows from the table\&. With +\fB\-\-safe\-updates\fR, you can delete rows only by specifying the key values that identify them\&. This helps prevent accidents\&. +.PP +When you use the +\fB\-\-safe\-updates\fR +option, +\fBmysql\fR +issues the following statement when it connects to the MariaDB server: +.sp +.if n \{\ +.RS 4 +.\} +.nf +SET sql_safe_updates=1, sql_select_limit=1000, sql_max_join_size=1000000; +.fi +.if n \{\ +.RE +.\} +.PP +The +SET +statement has the following effects: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +You are not allowed to execute an +UPDATE +or +DELETE +statement unless you specify a key constraint in the +WHERE +clause or provide a +LIMIT +clause (or both)\&. For example: +.sp +.if n \{\ +.RS 4 +.\} +.nf +UPDATE \fItbl_name\fR SET \fInot_key_column\fR=\fIval\fR WHERE \fIkey_column\fR=\fIval\fR; +UPDATE \fItbl_name\fR SET \fInot_key_column\fR=\fIval\fR LIMIT 1; +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +The server limits all large +SELECT +results to 1,000 rows unless the statement includes a +LIMIT +clause\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +The server aborts multiple\-table +SELECT +statements that probably need to examine more than 1,000,000 row combinations\&. +.RE +.PP +To specify limits different from 1,000 and 1,000,000, you can override the defaults by using the +\fB\-\-select\-limit\fR +and +\fB\-\-max\-join\-size\fR +options: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysql \-\-safe\-updates \-\-select\-limit=500 \-\-max\-join\-size=10000\fR +.fi +.if n \{\ +.RE +.\} +.SS "Disabling mysql Auto\-Reconnect" +.PP +If the +\fBmysql\fR +client loses its connection to the server while sending a statement, it immediately and automatically tries to reconnect once to the server and send the statement again\&. However, even if +\fBmysql\fR +succeeds in reconnecting, your first connection has ended and all your previous session objects and settings are lost: temporary tables, the autocommit mode, and user\-defined and session variables\&. Also, any current transaction rolls back\&. This behavior may be dangerous for you, as in the following example where the server was shut down and restarted between the first and second statements without you knowing it: +.sp +.if n \{\ +.RS 4 +.\} +.nf +mysql> \fBSET @a=1;\fR +Query OK, 0 rows affected (0\&.05 sec) +mysql> \fBINSERT INTO t VALUES(@a);\fR +ERROR 2006: MySQL server has gone away +No connection\&. Trying to reconnect\&.\&.\&. +Connection id: 1 +Current database: test +Query OK, 1 row affected (1\&.30 sec) +mysql> \fBSELECT * FROM t;\fR ++\-\-\-\-\-\-+ +| a | ++\-\-\-\-\-\-+ +| NULL | ++\-\-\-\-\-\-+ +1 row in set (0\&.05 sec) +.fi +.if n \{\ +.RE +.\} +.PP +The +@a +user variable has been lost with the connection, and after the reconnection it is undefined\&. If it is important to have +\fBmysql\fR +terminate with an error if the connection has been lost, you can start the +\fBmysql\fR +client with the +\fB\-\-skip\-reconnect\fR +option\&. +.PP +.SH "COPYRIGHT" +.br +.PP +Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc., 2010-2020 MariaDB Foundation +.PP +This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License. +.PP +This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. +.PP +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-1335 USA or see http://www.gnu.org/licenses/. +.sp +.SH "NOTES" +.IP " 1." 4 +Bug#25946 +.RS 4 +\%http://bugs.mysql.com/bug.php?id=25946 +.RE +.SH "SEE ALSO" +For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/ +.SH AUTHOR +MariaDB Foundation (http://www.mariadb.org/). diff --git a/man/mysql.server.1 b/man/mysql.server.1 new file mode 100644 index 00000000..b3eff1dd --- /dev/null +++ b/man/mysql.server.1 @@ -0,0 +1,180 @@ +'\" t +.\" +.TH "\fBMYSQL\&.SERVER\fR" "1" "15 May 2020" "MariaDB 10.11" "MariaDB Database System" +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.\" mysql.server +.SH "NAME" +mysql.server \- MariaDB server startup script +.SH "SYNOPSIS" +.HP \w'\fBmysql\ {start|stop}\fR\ 'u +\fBmysql {start|stop}\fR +.SH "DESCRIPTION" +.PP +MariaDB distributions on Unix include a script named +\fBmysql\&.server\fR\&. It can be used on systems such as Linux and Solaris that use System V\-style run directories to start and stop system services\&. It is also used by the Mac OS X Startup Item for MariaDB\&. +.PP +\fBmysql\&.server\fR +can be found in the +support\-files +directory under your MariaDB installation directory or in a MariaDB source distribution\&. +.PP +If you use the Linux server RPM package (MySQL\-server\-\fIVERSION\fR\&.rpm), the +\fBmysql\&.server\fR +script will be installed in the +/etc/init\&.d +directory with the name +mysql\&. You need not install it manually\&. +.PP +Some vendors provide RPM packages that install a startup script under a different name such as +\fBmysqld\fR\&. +.PP +If you install MariaDB from a source distribution or using a binary distribution format that does not install +\fBmysql\&.server\fR +automatically, you can install it manually\&. +.PP +\fBmysql\&.server\fR +reads options from the +[mysql\&.server] +and +[mysqld] +sections of option files\&. For backward compatibility, it also reads +[mysql_server] +sections, although you should rename such sections to +[mysql\&.server]&. +.PP +\fBmysql\&.server\fR +supports the following options\&. +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql.server: basedir option +.\" basedir option: mysql.server +\fB\-\-basedir=\fR\fB\fIpath\fR\fR +.sp +The path to the MariaDB installation directory\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql.server: datadir option +.\" datadir option: mysql.server +\fB\-\-datadir=\fR\fB\fIpath\fR\fR +.sp +The path to the MariaDB data directory\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql.server: pid-file option +.\" pid-file option: mysql.server +\fB\-\-pid\-file=\fR\fB\fIfile_name\fR\fR +.sp +The path name of the file in which the server should write its process ID\&. If not provided, the default, "host_name.pid" is used. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql.server: service-startup-timeout option +.\" service-startup-timeout option: mysql.server +\fB\-\-service\-startup\-timeout=\fR\fB\fIfile_name\fR\fR +.sp +How long in seconds to wait for confirmation of server startup\&. If the server does not start within this time, +\fBmysql\&.server\fR +exits with an error\&. The default value is 900\&. A value of 0 means not to wait at all for startup\&. Negative values mean to wait forever (no timeout)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql.server: use-mysqld_safe option +.\" use-mysqld_safe option: mysql.server +\fB\-\-use\-mysqld_safe\fR +.sp +Use +\fBmysqld_safe\fR +to start the server\&. This is the default\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql.server: use-manager option +.\" use-manager option: mysql.server +\fB\-\-use\-manager\fR +.sp +Use Instance Manager to start the server\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql.server: user option +.\" user option: mysql.server +\fB\-\-user=\fR\fB\fIuser_name\fR\fR +.sp +The login user name to use for running +\fBmysqld\fR\&. +.RE +.SH "COPYRIGHT" +.br +.PP +Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc., 2010-2020 MariaDB Foundation +.PP +This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License. +.PP +This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. +.PP +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-1335 USA or see http://www.gnu.org/licenses/. +.sp +.SH "SEE ALSO" +For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/ +.SH AUTHOR +MariaDB Foundation (http://www.mariadb.org/). diff --git a/man/mysql_client_test.1 b/man/mysql_client_test.1 new file mode 100644 index 00000000..2866dfa5 --- /dev/null +++ b/man/mysql_client_test.1 @@ -0,0 +1,332 @@ +'\" t +.\" +.TH "\fBMARIADB-CLIENT-TEST\fR" "1" "15 May 2020" "MariaDB 10.11" "MariaDB Database System" +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.\" mysql_client_test +.\" mysql_client_test_embedded +.SH "NAME" +mariadb-client-test \- test client API (mysql_client_test is now a symlink to mariadb-client-test) +.br +mariadb-client-test-embedded \- test client API for embedded server (mysql_client_test_embedded is now a symlink to mariadb-client-test-embedded) +.SH "SYNOPSIS" +.HP \w'\fBmysql_client_test\ [\fR\fB\fIoptions\fR\fR\fB]\ [\fR\fB\fItest_name\fR\fR\fB]\ \&.\&.\&.\fR\ 'u +\fBmysql_client_test [\fR\fB\fIoptions\fR\fR\fB] [\fR\fB\fItest_name\fR\fR\fB] \&.\&.\&.\fR +.HP \w'\fBmysql_client_test_embedded\ [\fR\fB\fIoptions\fR\fR\fB]\ [\fR\fB\fItest_name\fR\fR\fB]\ \&.\&.\&.\fR\ 'u +\fBmysql_client_test_embedded [\fR\fB\fIoptions\fR\fR\fB] [\fR\fB\fItest_name\fR\fR\fB] \&.\&.\&.\fR +.SH "DESCRIPTION" +.PP +The +\fBmysql_client_test\fR +program is used for testing aspects of the MariaDB client API that cannot be tested using +\fBmysqltest\fR +and its test language\&. +\fBmysql_client_test_embedded\fR +is similar but used for testing the embedded server\&. Both programs are run as part of the test suite\&. +.PP +The source code for the programs can be found in in +tests/mysql_client_test\&.c +in a source distribution\&. The program serves as a good source of examples illustrating how to use various features of the client API\&. +.PP +\fBmysql_client_test\fR +is used in a test by the same name in the main tests suite of +\fBmysql\-test\-run\&.pl\fR +but may also be run directly\&. Unlike the other programs listed here, it does not read an external description of what tests to run\&. Instead, all tests are coded into the program, which is written to cover all aspects of the C language API\&. +.PP +\fBmysql_client_test\fR +supports the following options: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_client_test: help option +.\" help option: mysql_client_test +\fB\-\-help\fR, +\fB\-?\fR +.sp +Display a help message and exit\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fB\-\-basedir=\fR\fB\fIdir_name\fR\fR, +.\" mysql_client_test: basedir option +.\" basedir option: mysql_client_test +\fB\-b \fR\fB\fIdir_name\fR\fR +.sp +The base directory for the tests\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fB\-\-count=\fR\fB\fIcount\fR\fR, +.\" mysql_client_test: count option +.\" count option: mysql_client_test +\fB\-t \fR\fB\fIcount\fR\fR +.sp +The number of times to execute the tests\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_client_test: database option +.\" database option: mysql_client_test +\fB\-\-database=\fR\fB\fIdb_name\fR\fR, +\fB\-D \fR\fB\fIdb_name\fR\fR +.sp +The database to use\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_client_test: debug option +.\" debug option: mysql_client_test +\fB\-\-debug[=\fR\fB\fIdebug_options\fR\fR\fB]\fR, +\fB\-#[\fR\fB\fIdebug_options\fR\fR\fB]\fR +.sp +Write a debugging log if MariaDB is built with debugging support\&. The default +\fIdebug_options\fR +value is 'd:t:o,/tmp/mysql_client_test.trace'. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fB\-\-getopt\-ll\-test=\fR\fB\fIoption\fR\fR, +.\" mysql_client_test: getopt-ll-test option +.\" getopt-ll-test option: mysql_client_test +\fB\-g \fR\fB\fIoption\fR\fR +.sp +Option to use for testing bugs in the +getopt +library\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_client_test: host option +.\" host option: mysql_client_test +\fB\-\-host=\fR\fB\fIhost_name\fR\fR, +\fB\-h \fR\fB\fIhost_name\fR\fR +.sp +Connect to the MariaDB server on the given host\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_client_test: password option +.\" password option: mysql_client_test +\fB\-\-password[=\fR\fB\fIpassword\fR\fR\fB]\fR, +\fB\-p[\fR\fB\fIpassword\fR\fR\fB]\fR +.sp +The password to use when connecting to the server\&. If you use the short option form (\fB\-p\fR), you +\fIcannot\fR +have a space between the option and the password\&. If you omit the +\fIpassword\fR +value following the +.\" mysql_client_test: password option +.\" password option: mysql_client_test +\fB\-\-password\fR +or +\fB\-p\fR +option on the command line, you are prompted for one\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_client_test: port option +.\" port option: mysql_client_test +\fB\-\-port=\fR\fB\fIport_num\fR\fR, +\fB\-P \fR\fB\fIport_num\fR\fR +.sp +The TCP/IP port number to use for the connection\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fB\-\-server\-arg=\fR\fB\fIarg\fR\fR, +.\" mysql_client_test: server-arg option +.\" server-arg option: mysql_client_test +\fB\-A \fR\fB\fIarg\fR\fR +.sp +Argument to send to the embedded server\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fB\-\-show\-tests\fR, +\fB\-T\fR +.sp +Show all test names\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_client_test: silent option +.\" silent option: mysql_client_test +\fB\-\-silent\fR, +\fB\-s\fR +.sp +Be more silent\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_client_test: socket option +.\" socket option: mysql_client_test +\fB\-\-socket=\fR\fB\fIpath\fR\fR, +\fB\-S \fR\fB\fIpath\fR\fR +.sp +The socket file to use when connecting to +localhost +(which is the default host)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fB\-\-testcase\fR, +\fB\-c\fR +.sp +The option is used when called from +\fBmysql\-test\-run\&.pl\fR, so that +\fBmysql_client_test\fR +may optionally behave in a different way than if called manually, for example by skipping some tests\&. Currently, there is no difference in behavior but the option is included in order to make this possible\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_client_test: user option +.\" user option: mysql_client_test +\fB\-\-user=\fR\fB\fIuser_name\fR\fR, +\fB\-u \fR\fB\fIuser_name\fR\fR +.sp +The MariaDB user name to use when connecting to the server\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fB\-v \fR\fB\fIdir_name\fR\fR, +.\" mysql_client_test: vardir option +.\" vardir option: mysql_client_test +\fB\-\-vardir=\fR\fB\fIdir_name\fR\fR +.sp +The data directory for tests\&. The default is +mysql\-test/var\&. +.RE +.SH "COPYRIGHT" +.br +.PP +Copyright \(co 2007, 2010, Oracle and/or its affiliates, 2010-2020 MariaDB Foundation +.PP +This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License. +.PP +This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. +.PP +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-1335 USA or see http://www.gnu.org/licenses/. +.sp +.SH "SEE ALSO" +For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/ +.SH AUTHOR +MariaDB Foundation (http://www.mariadb.org/). diff --git a/man/mysql_client_test_embedded.1 b/man/mysql_client_test_embedded.1 new file mode 100644 index 00000000..41f52801 --- /dev/null +++ b/man/mysql_client_test_embedded.1 @@ -0,0 +1 @@ +.so man1/mysql_client_test.1 diff --git a/man/mysql_config.1 b/man/mysql_config.1 new file mode 100644 index 00000000..941e3728 --- /dev/null +++ b/man/mysql_config.1 @@ -0,0 +1,247 @@ +'\" t +.\" +.TH "\fBMYSQL_CONFIG\fR" "1" "15 May 2020" "MariaDB 10.11" "MariaDB Database System" +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.\" mysql_config +.SH "NAME" +mysql_config \- get compile options for compiling clients +.SH "SYNOPSIS" +.HP \w'\fBmysql_config\ \fR\fB\fIoptions\fR\fR\ 'u +\fBmysql_config \fR\fB\fIoptions\fR\fR +.SH "DESCRIPTION" +.PP +\fBmysql_config\fR +provides you with useful information for compiling your MariaDB client and connecting it to MariaDB\&. +.PP +\fBmysql_config\fR +supports the following options\&. +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_config: cflags option +.\" cflags option: mysql_config +\fB\-\-cflags\fR +.sp +Compiler flags to find include files and critical compiler flags and defines used when compiling the +libmysqlclient +library\&. The options returned are tied to the specific compiler that was used when the library was created and might clash with the settings for your own compiler\&. Use +\fB\-\-include\fR +for more portable options that contain only include paths\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_config: include option +.\" include option: mysql_config +\fB\-\-include\fR +.sp +Compiler options to find MariaDB include files\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_config: libmysqld-libs option +.\" libmysqld-libs option: mysql_config +.\" mysql_config: embedded option +.\" embedded option: mysql_config +\fB\-\-libmysqld\-libs\fR, +\fB\-\-embedded\fR +.sp +Libraries and options required to link with the MariaDB embedded server\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_config: libs option +.\" libs option: mysql_config +\fB\-\-libs\fR +.sp +Libraries and options required to link with the MariaDB client library\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_config: libs_r option +.\" libs_r option: mysql_config +\fB\-\-libs_r\fR +.sp +Libraries and options required to link with the thread\-safe MariaDB client library\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_config: plugindir option +.\" plugindir option: mysql_config +\fB\-\-plugindir\fR +.sp +The default plugin directory path name, defined when configuring MariaDB\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_config: port option +.\" port option: mysql_config +\fB\-\-port\fR +.sp +The default TCP/IP port number, defined when configuring MariaDB\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_config: socket option +.\" socket option: mysql_config +\fB\-\-socket\fR +.sp +The default Unix socket file, defined when configuring MariaDB\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_config: variable option +.\" variable option: mysql_config +\fB\-\-variable=VAR\fR +.sp +Path to MariaDB include, library and plugin directories\&. \fBVAR\fR is one of +`pkgincludedir`, `pkglibdir` and `plugindir`, respectively\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_config: version option +.\" version option: mysql_config +\fB\-\-version\fR +.sp +Version number for the MariaDB distribution\&. +.RE +.PP +If you invoke +\fBmysql_config\fR +with no options, it displays a list of all options that it supports, and their values: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysql_config\fR +Usage: /usr/local/mysql/bin/mysql_config [options] +Options: + \-\-cflags [\-I/usr/local/mysql/include/mysql \-mcpu=pentiumpro] + \-\-include [\-I/usr/local/mysql/include/mysql] + \-\-libs [\-L/usr/local/mysql/lib/mysql \-lmysqlclient \-lz + \-lcrypt \-lnsl \-lm \-L/usr/lib \-lssl \-lcrypto] + \-\-libs_r [\-L/usr/local/mysql/lib/mysql \-lmysqlclient_r + \-lpthread \-lz \-lcrypt \-lnsl \-lm \-lpthread] + \-\-socket [/tmp/mysql\&.sock] + \-\-port [3306] + \-\-version [4\&.0\&.16] + \-\-libmysqld\-libs [\-L/usr/local/mysql/lib/mysql \-lmysqld \-lpthread \-lz + \-lcrypt \-lnsl \-lm \-lpthread \-lrt] +.fi +.if n \{\ +.RE +.\} +.PP +You can use +\fBmysql_config\fR +within a command line to include the value that it displays for a particular option\&. For example, to compile a MariaDB client program, use +\fBmysql_config\fR +as follows: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBCFG=/usr/local/mysql/bin/mysql_config\fR +shell> \fBsh \-c "gcc \-o progname `$CFG \-\-include` progname\&.c `$CFG \-\-libs`"\fR +.fi +.if n \{\ +.RE +.\} +.PP +When you use +\fBmysql_config\fR +this way, be sure to invoke it within backtick (\(lq`\(rq) characters\&. That tells the shell to execute it and substitute its output into the surrounding command\&. +.SH "COPYRIGHT" +.br +.PP +Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc., 2010-2020 MariaDB Foundation +.PP +This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License. +.PP +This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. +.PP +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-1335 USA or see http://www.gnu.org/licenses/. +.sp +.SH "SEE ALSO" +For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/ +.SH AUTHOR +MariaDB Foundation (http://www.mariadb.org/). diff --git a/man/mysql_convert_table_format.1 b/man/mysql_convert_table_format.1 new file mode 100644 index 00000000..89f6f37b --- /dev/null +++ b/man/mysql_convert_table_format.1 @@ -0,0 +1,222 @@ +'\" t +.\" +.TH "\fBMARIADB-CONVERT-TABLE-FORMAT\fR" "1" "15 May 2020" "MariaDB 10.11" "MariaDB Database System" +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.\" mysql_convert_table_format +.SH "NAME" +mariadb-convert-table-format \- convert tables to use a given storage engine (mysql_convert_table_format is now a symlink to mariadb-convert-table-format) +.SH "SYNOPSIS" +.HP \w'\fBmysql_convert_table_format\ [\fR\fB\fIoptions\fR\fR\fB]\ \fR\fB\fIdb_name\fR\fR\ 'u +\fBmysql_convert_table_format [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fIdb_name\fR\fR +.SH "DESCRIPTION" +.PP +\fBmysql_convert_table_format\fR +converts the tables in a database to use a particular storage engine (MyISAM +by default)\&. +\fBmysql_convert_table_format\fR +is written in Perl and requires that the +DBI +and +DBD::MariaDB +Perl modules be installed (see +Section\ \&2.15, \(lqPerl Installation Notes\(rq)\&. +.PP +Invoke +\fBmysql_convert_table_format\fR +like this: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysql_convert_table_format [\fR\fB\fIoptions\fR\fR\fB]\fR\fB\fIdb_name\fR\fR +.fi +.if n \{\ +.RE +.\} +.PP +The +\fIdb_name\fR +argument indicates the database containing the tables to be converted\&. +.PP +\fBmysql_convert_table_format\fR +supports the options described in the following list\&. +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_convert_table_format: help option +.\" help option: mysql_convert_table_format +\fB\-\-help\fR +.sp +Display a help message and exit\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_convert_table_format: force option +.\" force option: mysql_convert_table_format +\fB\-\-force\fR +.sp +Continue even if errors occur\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_convert_table_format: host option +.\" host option: mysql_convert_table_format +\fB\-\-host=\fR\fB\fIhost_name\fR\fR +.sp +Connect to the MariaDB server on the given host\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_convert_table_format: password option +.\" password option: mysql_convert_table_format +\fB\-\-password=\fR\fB\fIpassword\fR\fR +.sp +The password to use when connecting to the server\&. Note that the password value is not optional for this option, unlike for other MariaDB programs\&. +.sp +Specifying a password on the command line should be considered insecure\&. You can use an option file to avoid giving the password on the command line\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_convert_table_format: port option +.\" port option: mysql_convert_table_format +\fB\-\-port=\fR\fB\fIport_num\fR\fR +.sp +The TCP/IP port number to use for the connection\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_convert_table_format: socket option +.\" socket option: mysql_convert_table_format +\fB\-\-socket=\fR\fB\fIpath\fR\fR +.sp +For connections to +localhost, the Unix socket file to use\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_convert_table_format: type option +.\" type option: mysql_convert_table_format +\fB\-\-type=\fR\fB\fIengine_name\fR\fR +.sp +Specify the storage engine that the tables should be converted to use\&. The default is +MyISAM +if this option is not given\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_convert_table_format: user option +.\" user option: mysql_convert_table_format +\fB\-\-user=\fR\fB\fIuser_name\fR\fR +.sp +The MariaDB user name to use when connecting to the server\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_convert_table_format: verbose option +.\" verbose option: mysql_convert_table_format +\fB\-\-verbose\fR +.sp +Verbose mode\&. Print more information about what the program does\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_convert_table_format: version option +.\" version option: mysql_convert_table_format +\fB\-\-version\fR +.sp +Display version information and exit\&. +.RE +.SH "COPYRIGHT" +.br +.PP +Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc., 2010-2020 MariaDB Foundation +.PP +This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License. +.PP +This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. +.PP +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-1335 USA or see http://www.gnu.org/licenses/. +.sp +.SH "SEE ALSO" +For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/ +.SH AUTHOR +MariaDB Foundation (http://www.mariadb.org/). diff --git a/man/mysql_embedded.1 b/man/mysql_embedded.1 new file mode 100644 index 00000000..735c4e05 --- /dev/null +++ b/man/mysql_embedded.1 @@ -0,0 +1 @@ +.so man1/mysql.1 diff --git a/man/mysql_find_rows.1 b/man/mysql_find_rows.1 new file mode 100644 index 00000000..c80490c2 --- /dev/null +++ b/man/mysql_find_rows.1 @@ -0,0 +1,158 @@ +'\" t +.\" +.TH "\fBMARIADB-FIND-ROWS\fR" "1" "15 May 2020" "MariaDB 10.11" "MariaDB Database System" +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.\" mysql_find_rows +.SH "NAME" +mariadb-find-rows \- extract SQL statements from files (mysql_find_rows is now a symlink to mariadb-find-rows) +.SH "SYNOPSIS" +.HP \w'\fBmysql_find_rows\ [\fR\fB\fIoptions\fR\fR\fB]\ [\fR\fB\fIfile_name\fR\fR\fB\ \&.\&.\&.]\fR\ 'u +\fBmysql_find_rows [\fR\fB\fIoptions\fR\fR\fB] [\fR\fB\fIfile_name\fR\fR\fB \&.\&.\&.]\fR +.SH "DESCRIPTION" +.PP +\fBmysql_find_rows\fR +reads files containing SQL statements and extracts statements that match a given regular expression or that contain +USE \fIdb_name\fR +or +SET +statements\&. The utility was written for use with update log files (as used prior to MySQL 5\&.0) and as such expects statements to be terminated with semicolon (;) characters\&. It may be useful with other files that contain SQL statements as long as statements are terminated with semicolons\&. +.PP +Invoke +\fBmysql_find_rows\fR +like this: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysql_find_rows [\fR\fB\fIoptions\fR\fR\fB] [\fR\fB\fIfile_name\fR\fR\fB \&.\&.\&.]\fR +.fi +.if n \{\ +.RE +.\} +.PP +Each +\fIfile_name\fR +argument should be the name of file containing SQL statements\&. If no file names are given, +\fBmysql_find_rows\fR +reads the standard input\&. +.PP +Examples: +.sp +.if n \{\ +.RS 4 +.\} +.nf +mysql_find_rows \-\-regexp=problem_table \-\-rows=20 < update\&.log +mysql_find_rows \-\-regexp=problem_table update\-log\&.1 update\-log\&.2 +.fi +.if n \{\ +.RE +.\} +.PP +\fBmysql_find_rows\fR +supports the following options: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_find_rows: help option +.\" help option: mysql_find_rows +\fB\-\-help\fR, +\fB\-\-Information\fR +.sp +Display a help message and exit\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_find_rows: regexp option +.\" regexp option: mysql_find_rows +\fB\-\-regexp=\fR\fB\fIpattern\fR\fR +.sp +Display queries that match the pattern\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_find_rows: rows option +.\" rows option: mysql_find_rows +\fB\-\-rows=\fR\fB\fIN\fR\fR +.sp +Quit after displaying +\fIN\fR +queries\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_find_rows: skip-use-db option +.\" skip-use-db option: mysql_find_rows +\fB\-\-skip\-use\-db\fR +.sp +Do not include +USE \fIdb_name\fR +statements in the output\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_find_rows: start_row option +.\" start_row option: mysql_find_rows +\fB\-\-start_row=\fR\fB\fIN\fR\fR +.sp +Start output from this row\&. +.RE +.SH "COPYRIGHT" +.br +.PP +Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc., 2010-2020 MariaDB Foundation +.PP +This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License. +.PP +This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. +.PP +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-1335 USA or see http://www.gnu.org/licenses/. +.sp +.SH "SEE ALSO" +For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/ +.SH AUTHOR +MariaDB Foundation (http://www.mariadb.org/). diff --git a/man/mysql_fix_extensions.1 b/man/mysql_fix_extensions.1 new file mode 100644 index 00000000..27029004 --- /dev/null +++ b/man/mysql_fix_extensions.1 @@ -0,0 +1,68 @@ +'\" t +.\" +.TH "\fBMARIADB-FIX-EXTENSIONS\fR" "1" "15 May 2020" "MariaDB 10.11" "MariaDB Database System" +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.\" mysql_fix_extensions +.SH "NAME" +mariadb-fix-extensions \- normalize table file name extensions (mysql_fix_extensions is now a symlink to mariadb-fix-extensions) +.SH "SYNOPSIS" +.HP \w'\fBmysql_fix_extensions\ \fR\fB\fIdata_dir\fR\fR\ 'u +\fBmysql_fix_extensions \fR\fB\fIdata_dir\fR\fR +.SH "DESCRIPTION" +.PP +\fBmysql_fix_extensions\fR +converts the extensions for +MyISAM +(or +ISAM) table files to their canonical forms\&. It looks for files with extensions matching any lettercase variant of +\&.frm, +\&.myd, +\&.myi, +\&.isd, and +\&.ism +and renames them to have extensions of +\&.frm, +\&.MYD, +\&.MYI, +\&.ISD, and +\&.ISM, respectively\&. This can be useful after transferring the files from a system with case\-insensitive file names (such as Windows) to a system with case\-sensitive file names\&. +.PP +Invoke +\fBmysql_fix_extensions\fR +like this, where +\fIdata_dir\fR +is the path name to the MySQL data directory\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysql_fix_extensions \fR\fB\fIdata_dir\fR\fR +.fi +.if n \{\ +.RE +.\} +.SH "COPYRIGHT" +.br +.PP +Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc., 2010-2020 MariaDB Foundation +.PP +This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License. +.PP +This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. +.PP +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-1335 USA or see http://www.gnu.org/licenses/. +.sp +.SH "SEE ALSO" +For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/ +.SH AUTHOR +MariaDB Foundation (http://www.mariadb.org/). diff --git a/man/mysql_install_db.1 b/man/mysql_install_db.1 new file mode 100644 index 00000000..f945c259 --- /dev/null +++ b/man/mysql_install_db.1 @@ -0,0 +1,398 @@ +'\" t +.\" +.TH "\fBMARIADB-INSTALL-DB\fR" "1" "15 May 2020" "MariaDB 10.11" "MariaDB Database System" +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.\" mysql_install_db +.SH "NAME" +mariadb-install-db \- initialize MariaDB data directory (mysql_install_db is now a symlink to mariadb-install-db) +.SH "SYNOPSIS" +.HP \w'\fBmysql_install_db\ [\fR\fB\fIoptions\fR\fR\fB]\fR\ 'u +\fBmysql_install_db [\fR\fB\fIoptions\fR\fR\fB]\fR +.SH "DESCRIPTION" +.PP +\fBmysql_install_db\fR +initializes the MariaDB data directory and creates the system tables that it contains, if they do not exist\&. +.PP +To invoke +\fBmysql_install_db\fR, use the following syntax: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysql_install_db [\fR\fB\fIoptions\fR\fR\fB]\fR +.fi +.if n \{\ +.RE +.\} +.PP +Because the MariaDB server, +\fBmysqld\fR, needs to access the data directory when it runs later, you should either run +\fBmysql_install_db\fR +from the same account that will be used for running +\fBmysqld\fR +or run it as +root +and use the +\fB\-\-user\fR +option to indicate the user name that +\fBmysqld\fR +will run as\&. It might be necessary to specify other options such as +\fB\-\-basedir\fR +or +\fB\-\-datadir\fR +if +\fBmysql_install_db\fR +does not use the correct locations for the installation directory or data directory\&. For example: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBbin/mysql_install_db \-\-user=mysql \e\fR + \fB\-\-basedir=/opt/mysql/mysql \e\fR + \fB\-\-datadir=/opt/mysql/mysql/data\fR +.fi +.if n \{\ +.RE +.\} +.PP +\fBmysql_install_db\fR +needs to invoke +\fBmysqld\fR +with the +\fB\-\-bootstrap\fR +and +\fB\-\-skip\-grant\-tables\fR +options (see +Section\ \&2.3.2, \(lqTypical configure Options\(rq)\&. If MariaDB was configured with the +\fB\-\-disable\-grant\-options\fR +option, +\fB\-\-bootstrap\fR +and +\fB\-\-skip\-grant\-tables\fR +will be disabled\&. To handle this, set the +MYSQLD_BOOTSTRAP +environment variable to the full path name of a server that has all options enabled\&. +\fBmysql_install_db\fR +will use that server\&. +.PP +\fBmysql_install_db\fR +supports the following options, which can be specified on the command line or in the +[mysql_install_db] +and (if they are common to +\fBmysqld\fR) +[mysqld] +option file groups\&. +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_install_db: basedir option +.\" basedir option: mysql_install_db +\fB\-\-basedir=\fR\fB\fIpath\fR\fR +.sp +The path to the MariaDB installation directory\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_install_db: builddir option +.\" builddir option: mysql_install_db +\fB\-\-builddir=\fIpath\fR +.sp +If using \fB--srcdir\fR with out-of-directory builds, you will need to set this +to the location of the build directory where built files reside.\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_install_db: cross-bootstrap option +.\" cross-bootstrap option: mysql_install_db +\fB\-\-cross\-bootstrap\fR +.sp +For internal use. Used when building the MariaDB system tables on a different host than the target.\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_install_db: datadir option +.\" datadir option: mysql_install_db +.\" mysql_install_db: ldata option +.\" ldata option: mysql_install_db +\fB\-\-datadir=\fR\fB\fIpath\fR\fR, +\fB\-\-ldata=\fR\fB\fIpath\fR\fR +.sp +The path to the MariaDB data directory\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlcheck: defaults-extra-file option +.\" defaults-extra-file option: mysqlcheck +\fB\-\-defaults\-extra\-file=\fR\fB\fIfilename\fR\fR +.sp +Set \fB\fIfilename\fR\fR as the file to read default options from after the global defaults files has been read\&. +Must be given as first option\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlcheck: defaults-file option +.\" defaults-file option: mysqlcheck +\fB\-\-defaults\-file=\fR\fB\fIfilename\fR\fR +.sp +Set \fB\fIfilename\fR\fR as the file to read default options from, override global defaults files\&. +Must be given as first option\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_install_db: defaults-group-suffix option +.\" defaults-group-suffix option: mysql_install_db +\fB\-\-defaults\-group\-suffix=\fR\fB\fIname\fR\fR +.sp +In addition to the given groups, also read groups with this suffix\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_install_db: force option +.\" force option: mysql_install_db +\fB\-\-force\fR +.sp +Cause +\fBmysql_install_db\fR +to run even if DNS does not work\&. In that case, grant table entries that normally use host names will use IP addresses\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlcheck: help option +.\" help option: mysqlcheck +\fB\-\-help\fR +.sp +Display a help message and exit\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlcheck: no-defaults option +.\" no-defaults option: mysqlcheck +\fB\-\-no\-defaults\fR +.sp +Do not read default options from any option file\&. This must be given as the first argument\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlcheck: print-defaults option +.\" print-defaults option: mysqlcheck +\fB\-\-print\-defaults\fR +.sp +Print the program argument list and exit\&. +This must be given as the first argument\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_install_db: rpm option +.\" rpm option: mysql_install_db +\fB\-\-rpm\fR +.sp +For internal use\&. This option is used by RPM files during the MariaDB installation process\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_install_db: skip-name-resolve option +.\" skip-name-resolve option: mysql_install_db +\fB\-\-skip\-name\-resolve\fR +.sp +Use IP addresses rather than host names when creating grant table entries\&. This option can be useful if your DNS does not work\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_install_db: srcdir option +.\" srcdir option: mysql_install_db +\fB\-\-srcdir=\fR\fB\fIpath\fR\fR +.sp +For internal use\&. The directory under which +\fBmysql_install_db\fR +looks for support files such as the error message file and the file for populating the help tables\&.4\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_install_db: user option +.\" user option: mysql_install_db +\fB\-\-user=\fR\fB\fIuser_name\fR\fR +.sp +The login user name to use for running +\fBmysqld\fR\&. Files and directories created by +\fBmysqld\fR +will be owned by this user\&. You must be +root +to use this option\&. By default, +\fBmysqld\fR +runs using your current login name and files and directories that it creates will be owned by you\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_install_db: extra-file option +.\" extra-file option: mysql_install_db +\fB\-\-extra-file=\fR\fB\fIfile_path\fR\fR +.sp +Add user defined SQL file, to be executed following regular database initialization. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_install_db: verbose option +.\" verbose option: mysql_install_db +\fB\-\-verbose\fR +.sp +Verbose mode\&. Print more information about what the program does\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_install_db: windows option +.\" windows option: mysql_install_db +\fB\-\-windows\fR +.sp +For internal use\&. This option is used for creating Windows distributions\&. +.RE +.SH "COPYRIGHT" +.br +.PP +Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc., 2010-2020 MariaDB Foundation +.PP +This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License. +.PP +This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. +.PP +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-1335 USA or see http://www.gnu.org/licenses/. +.sp +.SH "SEE ALSO" +For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/ +.SH AUTHOR +MariaDB Foundation (http://www.mariadb.org/). diff --git a/man/mysql_ldb.1 b/man/mysql_ldb.1 new file mode 100644 index 00000000..5d58bd0b --- /dev/null +++ b/man/mysql_ldb.1 @@ -0,0 +1,16 @@ +'\" t +.\" +.TH "\fBMARIADB-LDB\fR" "1" "15 May 2020" "MariaDB 10.11" "MariaDB Database System" +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH NAME +mariadb-ldb \- RocksDB tool (mysql_ldb is now a symlink to mariadb-ldb) +.SH DESCRIPTION +Use \fBmysql_ldb \-\-help\fR for details on usage\. +.PP +For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/ diff --git a/man/mysql_plugin.1 b/man/mysql_plugin.1 new file mode 100644 index 00000000..0512bb50 --- /dev/null +++ b/man/mysql_plugin.1 @@ -0,0 +1,375 @@ +'\" t +.\" +.TH "\fBMARIADB-PLUGIN\fR" "1" "15 May 2020" "MariaDB 10.11" "MariaDB Database System" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.\" mysql_plugin +.SH "NAME" +mariadb-plugin \- configure MariaDB server plugins (mysql_plugin is now a symlink to mariadb-plugin) +.SH "SYNOPSIS" +.HP \w'\fBmysql_plugin\ [\fR\fB\fIoptions\fR\fR\fB]\ \fR\fB\fIplugin\fR\fR\fB\ {ENABLE|DISABLE}\fR\ 'u +\fBmysql_plugin [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fIplugin\fR\fR\fB {ENABLE|DISABLE}\fR +.SH "DESCRIPTION" +.PP +The +\fBmysql_plugin\fR +utility enables MariaDB administrators to manage which plugins a MariaDB server loads\&. It provides an alternative to manually specifying the +\fB\-\-plugin\-load\fR +option at server startup or using the +INSTALL PLUGIN +and +UNINSTALL PLUGIN +statements at runtime\&. +.PP +Depending on whether +\fBmysql_plugin\fR +is invoked to enable or disable plugins, it inserts or deletes rows in the +mysql\&.plugin +table that serves as a plugin registry\&. (To perform this operation, +\fBmysql_plugin\fR +invokes the MariaDB server in bootstrap mode\&. This means that the server must not already be running\&.) For normal server startups, the server loads and enables plugins listed in +mysql\&.plugin +automatically\&. For additional control over plugin activation, use +\fB\-\-\fR\fB\fIplugin_name\fR\fR +options named for specific plugins\&. +.PP +Each invocation of +\fBmysql_plugin\fR +reads a configuration file to determine how to configure the plugins contained in a single plugin library object file\&. To invoke +\fBmysql_plugin\fR, use this syntax: +.sp +.if n \{\ +.RS 4 +.\} +.nf +mysql_plugin [\fIoptions\fR] \fIplugin\fR {ENABLE|DISABLE} +.fi +.if n \{\ +.RE +.\} +.PP +\fIplugin\fR +is the name of the plugin to configure\&. +ENABLE +or +DISABLE +(not case sensitive) specify whether to enable or disable components of the plugin library named in the configuration file\&. The order of the +\fIplugin\fR +and +ENABLE +or +DISABLE +arguments does not matter\&. +.PP +For example, to configure components of a plugin library file named +myplugins\&.so +on Linux or +myplugins\&.dll +on Windows, specify a +\fIplugin\fR +value of +myplugins\&. Suppose that this plugin library contains three plugins, +plugin1, +plugin2, and +plugin3, all of which should be configured under +\fBmysql_plugin\fR +control\&. By convention, configuration files have a suffix of +\&.ini +and the same basename as the plugin library, so the default configuration file name for this plugin library is +myplugins\&.ini\&. The configuration file contents look like this: +.sp +.if n \{\ +.RS 4 +.\} +.nf +myplugins +plugin1 +plugin2 +plugin3 +.fi +.if n \{\ +.RE +.\} +.PP +The first line in the +myplugins\&.ini +file is the name of the library object file, without any extension such as +\&.so +or +\&.dll\&. The remaining lines are the names of the components to be enabled or disabled\&. Each value in the file should be on a separate line\&. Lines on which the first character is +\*(Aq#\*(Aq +are taken as comments and ignored\&. +.PP +To enable the plugins listed in the configuration file, invoke +\fBmysql_plugin\fR +this way: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysql_plugin myplugins ENABLE\fR +.fi +.if n \{\ +.RE +.\} +.PP +To disable the plugins, use +DISABLE +rather than +ENABLE\&. +.PP +An error occurs if +\fBmysql_plugin\fR +cannot find the configuration file or plugin library file, or if +\fBmysql_plugin\fR +cannot start the MariaDB server\&. +.PP +\fBmysql_plugin\fR +supports the following options, which can be specified on the command line or in the +[mysqld] +group of any option file\&. For options specified in a +[mysqld] +group, +\fBmysql_plugin\fR +recognizes the +\fB\-\-basedir\fR, +\fB\-\-datadir\fR, and +\fB\-\-plugin\-dir\fR +options and ignores others\&. +.PP +mysql_plugin Options +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_plugin: help option +.\" help option: mysql_plugin +\fB\-\-help\fR, +\fB\-?\fR +.sp +Display a help message and exit\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_plugin: basedir option +.\" basedir option: mysql_plugin +\fB\-\-basedir=\fR\fB\fIpath\fR\fR, +\fB\-b \fR\fB\fIpath\fR\fR +.sp +The server base directory\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_plugin: datadir option +.\" datadir option: mysql_plugin +\fB\-\-datadir=\fR\fB\fIpath\fR\fR, +\fB\-d \fR\fB\fIpath\fR\fR +.sp +The server data directory\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_plugin: my-print-defaults option +.\" my-print-defaults option: mysql_plugin +\fB\-\-my\-print\-defaults=\fR\fB\fIpath\fR\fR, +\fB\-b \fR\fB\fIpath\fR\fR +.sp +The path to the +\fBmy_print_defaults\fR +program\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_plugin: mysqld option +.\" mysqld option: mysql_plugin +\fB\-\-mysqld=\fR\fB\fIpath\fR\fR, +\fB\-b \fR\fB\fIpath\fR\fR +.sp +The path to the +\fBmysqld\fR +server\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_plugin: no-defaults option +.\" no-defaults option: mysql_plugin +\fB\-\-no\-defaults\fR, +\fB\-p\fR +.sp +Do not read values from the configuration file\&. This option enables an administrator to skip reading defaults from the configuration file\&. +.sp +With +\fBmysql_plugin\fR, this option need not be given first on the command line, unlike most other MariaDB programs that support +\fB\-\-no\-defaults\fR\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_plugin: plugin-dir option +.\" plugin-dir option: mysql_plugin +\fB\-\-plugin\-dir=\fR\fB\fIpath\fR\fR, +\fB\-p \fR\fB\fIpath\fR\fR +.sp +The server plugin directory\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_plugin: plugin-ini option +.\" plugin-ini option: mysql_plugin +\fB\-\-plugin\-ini=\fR\fB\fIfile_name\fR\fR, +\fB\-i \fR\fB\fIfile_name\fR\fR +.sp +The +\fBmysql_plugin\fR +configuration file\&. Relative path names are interpreted relative to the current directory\&. If this option is not given, the default is +\fIplugin\fR\&.ini +in the plugin directory, where +\fIplugin\fR +is the +\fIplugin\fR +argument on the command line\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_plugin: print-defaults option +.\" print-defaults option: mysql_plugin +\fB\-\-print\-defaults\fR, +\fB\-P\fR +.sp +Display the default values from the configuration file\&. This option causes +\fBmysql_plugin\fR +to print the defaults for +\fB\-\-basedir\fR, +\fB\-\-datadir\fR, and +\fB\-\-plugin\-dir\fR +if they are found in the configuration file\&. If no value for a variable is found, nothing is shown\&. +.sp +With +\fBmysql_plugin\fR, this option need not be given first on the command line, unlike most other MariaDB programs that support +\fB\-\-print\-defaults\fR\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_plugin: verbose option +.\" verbose option: mysql_plugin +\fB\-\-verbose\fR, +\fB\-v\fR +.sp +Verbose mode\&. Print more information about what the program does\&. This option can be used multiple times to increase the amount of information\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_plugin: version option +.\" version option: mysql_plugin +\fB\-\-version\fR, +\fB\-V\fR +.sp +Display version information and exit\&. +.RE +.SH "COPYRIGHT" +.br +.PP +Copyright \(co 1997, 2013, Oracle and/or its affiliates. All rights reserved., 2013-2019 MariaDB Foundation +.PP +This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License. +.PP +This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. +.PP +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-1335 USA or see http://www.gnu.org/licenses/. +.sp +.SH "SEE ALSO" +For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/ +.SH AUTHOR +MariaDB Foundation (http://www.mariadb.org/). diff --git a/man/mysql_secure_installation.1 b/man/mysql_secure_installation.1 new file mode 100644 index 00000000..0d30ee24 --- /dev/null +++ b/man/mysql_secure_installation.1 @@ -0,0 +1,167 @@ +'\" t +.\" +.TH "\fBMARIADB-SECURE-INSTALLATION\fR" "1" "15 May 2020" "MariaDB 10.11" "MariaDB Database System" +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.\" mysql_secure_installation +.SH "NAME" +mariadb-secure-installation \- improve MariaDB installation security (mysql_secure_installation is now a symlink to mariadb-secure-installation) +.SH "SYNOPSIS" +.HP \w'\fBmysql_secure_installation\fR\ 'u +\fBmysql_secure_installation\fR +.SH "DESCRIPTION" +.PP +This program enables you to improve the security of your MariaDB installation in the following ways: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +You can set a password for +root +accounts\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +You can remove +root +accounts that are accessible from outside the local host\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +You can remove anonymous\-user accounts\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +You can remove the +test +database, which by default can be accessed by anonymous users\&. +.RE +.PP +\fBmysql_secure_installation\fR +can be invoked without arguments: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysql_secure_installation\fR +.fi +.if n \{\ +.RE +.\} +.PP +The script will prompt you to determine which actions to perform\&. +.PP +\fBmysql_secure_installation\fR +accepts some options: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_secure_installation: basedir option +.\" basedir option: mysql_secure_installation +\fB\-\-basedir=\fR\fB\fIdir_name\fR\fR +.sp +Base directory\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_secure_installation: defaults-extra-file option +.\" defaults-extra-file option: mysql_secure_installation +\fB\-\-defaults\-extra\-file=\fR\fB\fIfile_name\fR\fR +.sp +Additional option file\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_secure_installation: defaults-file option +.\" defaults-file option: mysql_secure_installation +\fB\-\-defaults\-file=\fR\fB\fIfile_name\fR\fR +.sp +Option file\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_secure_installation: no-defaults option +.\" no-defaults option: mysql_secure_installation +\fB\-\-no\-defaults\fR +.sp +Don't read any defaults file\&. +.RE +.sp +Other unrecognized options will be passed on to the server\&. +.SH "COPYRIGHT" +.br +.PP +Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc., 2010-2020 MariaDB Foundation +.PP +This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License. +.PP +This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. +.PP +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-1335 USA or see http://www.gnu.org/licenses/. +.sp +.SH "SEE ALSO" +For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/ +.SH AUTHOR +MariaDB Foundation (http://www.mariadb.org/). diff --git a/man/mysql_setpermission.1 b/man/mysql_setpermission.1 new file mode 100644 index 00000000..7725ad69 --- /dev/null +++ b/man/mysql_setpermission.1 @@ -0,0 +1,168 @@ +'\" t +.\" +.TH "\fBMARIADB-SETPERMISSION\fR" "1" "15 May 2020" "MariaDB 10.11" "MariaDB Database System" +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.\" mysql_setpermission +.SH "NAME" +mariadb-setpermission \- interactively set permissions in grant tables (mysql_setpermission is now a symlink to mariadb-setpermission) +.SH "SYNOPSIS" +.HP \w'\fBmysql_setpermission\ [\fR\fB\fIoptions\fR\fR\fB]\fR\ 'u +\fBmysql_setpermission [\fR\fB\fIoptions\fR\fR\fB]\fR +.SH "DESCRIPTION" +.PP +\fBmysql_setpermission\fR +is a Perl script that was originally written and contributed by Luuk de Boer\&. It interactively sets permissions in the MariaDB grant tables\&. +\fBmysql_setpermission\fR +is written in Perl and requires that the +DBI +and +DBD::MariaDB +Perl modules be installed\&. +.PP +Invoke +\fBmysql_setpermission\fR +like this: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysql_setpermission [\fR\fB\fIoptions\fR\fR\fB]\fR +.fi +.if n \{\ +.RE +.\} +.PP +\fIoptions\fR +should be either +\fB\-\-help\fR +to display the help message, or options that indicate how to connect to the MariaDB server\&. The account used when you connect determines which permissions you have when attempting to modify existing permissions in the grant tables\&. +.PP +\fBmysql_setpermission\fR +also reads options from the +[client] +and +[perl] +groups in the +\&.my\&.cnf +file in your home directory, if the file exists\&. +.PP +\fBmysql_setpermission\fR +supports the following options: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_setpermission: help option +.\" help option: mysql_setpermission +\fB\-\-help\fR +.sp +Display a help message and exit\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_setpermission: host option +.\" host option: mysql_setpermission +\fB\-\-host=\fR\fB\fIhost_name\fR\fR +.sp +Connect to the MariaDB server on the given host\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_setpermission: password option +.\" password option: mysql_setpermission +\fB\-\-password=\fR\fB\fIpassword\fR\fR +.sp +The password to use when connecting to the server\&. Note that the password value is not optional for this option, unlike for other MariaDB programs\&. +.sp +Specifying a password on the command line should be considered insecure\&. You can use an option file to avoid giving the password on the command line\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_setpermission: port option +.\" port option: mysql_setpermission +\fB\-\-port=\fR\fB\fIport_num\fR\fR +.sp +The TCP/IP port number to use for the connection\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_setpermission: socket option +.\" socket option: mysql_setpermission +\fB\-\-socket=\fR\fB\fIpath\fR\fR +.sp +For connections to +localhost, the Unix socket file to use\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_setpermission: user option +.\" user option: mysql_setpermission +\fB\-\-user=\fR\fB\fIuser_name\fR\fR +.sp +The MariaDB user name to use when connecting to the server\&. +.RE +.SH "COPYRIGHT" +.br +.PP +Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc., 2010-2020 MariaDB Foundation +.PP +This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License. +.PP +This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. +.PP +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-1335 USA or see http://www.gnu.org/licenses/. +.sp +.SH "SEE ALSO" +For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/ +.SH AUTHOR +MariaDB Foundation (http://www.mariadb.org/). diff --git a/man/mysql_tzinfo_to_sql.1 b/man/mysql_tzinfo_to_sql.1 new file mode 100644 index 00000000..e287db0c --- /dev/null +++ b/man/mysql_tzinfo_to_sql.1 @@ -0,0 +1,123 @@ +'\" t +.\" +.TH "\fBMARIADB-TZINFO-TO-SQL\fR" "1" "22 April 2022" "MariaDB 10.11" "MariaDB Database System" +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.\" mysql_tzinfo_to_sql +.\" time zone tables +.SH "NAME" +mariadb-tzinfo-to-sql \- load the time zone tables (mysql_tzinfo_to_sql is now a symlink to mariadb-tzinfo-to-sql) +.SH "SYNOPSIS" +.HP \w'\fBmysql_tzinfo_to_sql\ \fR\fB\fIarguments\fR\fR\ 'u +\fBmysql_tzinfo_to_sql \fR\fB\fIarguments\fR\fR +.SH "DESCRIPTION" +.PP +The +\fBmysql_tzinfo_to_sql\fR +program loads the time zone tables in the +mysql +database\&. It is used on systems that have a +zoneinfo +database (the set of files describing time zones)\&. Examples of such systems are Linux, FreeBSD, Solaris, and Mac OS X\&. One likely location for these files is the +/usr/share/zoneinfo +directory (/usr/share/lib/zoneinfo +on Solaris)\&. +.PP +\fBmysql_tzinfo_to_sql\fR +can be invoked several ways: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysql_tzinfo_to_sql \fR\fB\fItz_dir\fR\fR +shell> \fBmysql_tzinfo_to_sql \fR\fB\fItz_file tz_name\fR\fR +shell> \fBmysql_tzinfo_to_sql \-\-leap \fR\fB\fItz_file\fR\fR +shell> \fBmysql_tzinfo_to_sql \-\-skip\-write\-binlog \fR\fB\fItz_dir\fR\fR +.fi +.if n \{\ +.RE +.\} +.PP +For the first invocation syntax, pass the zoneinfo directory path name to +\fBmysql_tzinfo_to_sql\fR +and send the output into the +\fBmysql\fR +program\&. For example: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysql_tzinfo_to_sql /usr/share/zoneinfo | mysql \-u root mysql\fR +.fi +.if n \{\ +.RE +.\} +.PP +\fBmysql_tzinfo_to_sql\fR +reads your system's time zone files and generates SQL statements from them\&. +\fBmysql\fR +processes those statements to load the time zone tables\&. +.PP +The second syntax causes +\fBmysql_tzinfo_to_sql\fR +to load a single time zone file +\fItz_file\fR +that corresponds to a time zone name +\fItz_name\fR: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysql_tzinfo_to_sql \fR\fB\fItz_file\fR\fR\fB \fR\fB\fItz_name\fR\fR\fB | mysql \-u root mysql\fR +.fi +.if n \{\ +.RE +.\} +.PP +If your time zone needs to account for leap seconds, invoke +\fBmysql_tzinfo_to_sql\fR +using the third syntax, which initializes the leap second information\&. +\fItz_file\fR +is the name of your time zone file: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysql_tzinfo_to_sql \-\-leap \fR\fB\fItz_file\fR\fR\fB | mysql \-u root mysql\fR +.fi +.if n \{\ +.RE +.\} +.PP +Using the \-\-skip\-write\-binlog option prevents writing of changes to the binary log or to other Galera +cluster members. This can be used with any form of running \fBmysql_tzinfo_to_sql\fR. +.PP +After running +\fBmysql_tzinfo_to_sql\fR, it is best to restart the server so that it does not continue to use any previously cached time zone data\&. +.SH "COPYRIGHT" +.br +.PP +Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc., 2010-2020 MariaDB Foundation +.PP +This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License. +.PP +This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. +.PP +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-1335 USA or see http://www.gnu.org/licenses/. +.sp +.SH "SEE ALSO" +For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/ +.SH AUTHOR +MariaDB Foundation (http://www.mariadb.org/). diff --git a/man/mysql_upgrade.1 b/man/mysql_upgrade.1 new file mode 100644 index 00000000..8532003a --- /dev/null +++ b/man/mysql_upgrade.1 @@ -0,0 +1,728 @@ +'\" t +.\" +.TH "\fBMARIADB-UPGRADE\fR" "1" "20 July 2020" "MariaDB 10.11" "MariaDB Database System" +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.\" mysql_upgrade +.\" upgrading MySQL +.\" MySQL: upgrading +.SH "NAME" +mariadb-upgrade \- check tables for MariaDB upgrade (mysql_upgrade is now a symlink to mariadb-upgrade) +.SH "SYNOPSIS" +.HP \w'\fBmysql_upgrade\ [\fR\fB\fIoptions\fR\fR\fB]\fR\ 'u +\fBmysql_upgrade [\fR\fB\fIoptions\fR\fR\fB]\fR +.SH "DESCRIPTION" +.PP +\fBmysql_upgrade\fR +examines all tables in all databases for incompatibilities with the current version of the MariaDB Server\&. +\fBmysql_upgrade\fR +also upgrades the system tables so that you can take advantage of new privileges or capabilities that might have been added\&. +.PP +\fBmysql_upgrade\fR +should be executed each time you upgrade MariaDB\&. +.PP +If a table is found to have a possible incompatibility, +\fBmysql_upgrade\fR +performs a table check\&. If any problems are found, a table repair is attempted\&. +.if n \{\ +.sp +.\} +.RS 4 +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.ps +1 +\fBNote\fR +.ps -1 +.br +.PP +On Windows Server 2008 and Windows Vista, you must run +\fBmysql_upgrade\fR +with administrator privileges\&. You can do this by running a Command Prompt as Administrator and running the command\&. Failure to do so may result in the upgrade failing to execute correctly\&. +.sp .5v +.RE +.if n \{\ +.sp +.\} +.RS 4 +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.ps +1 +\fBCaution\fR +.ps -1 +.br +.PP +You should always back up your current MariaDB installation +\fIbefore\fR +performing an upgrade\&. +.sp .5v +.RE +.PP +To use +\fBmysql_upgrade\fR, make sure that the server is running, and then invoke it like this: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysql_upgrade [\fR\fB\fIoptions\fR\fR\fB]\fR +.fi +.if n \{\ +.RE +.\} +.PP +After running +\fBmysql_upgrade\fR, stop the server and restart it so that any changes made to the system tables take effect\&. +.PP +\fBmysql_upgrade\fR +executes the following commands to check and repair tables and to upgrade the system tables: +.sp +.if n \{\ +.RS 4 +.\} +.nf +mysqlcheck \-\-all\-databases \-\-check\-upgrade \-\-auto\-repair +mysql < \fIfix_priv_tables\fR +mysqlcheck \-\-all\-databases \-\-check\-upgrade \-\-fix\-db\-names \-\-fix\-table\-names +.fi +.if n \{\ +.RE +.\} +.PP +Notes about the preceding commands: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Because +\fBmysql_upgrade\fR +invokes +\fBmysqlcheck\fR +with the +\fB\-\-all\-databases\fR +option, it processes all tables in all databases, which might take a long time to complete\&. Each table is locked and therefore unavailable to other sessions while it is being processed\&. Check and repair operations can be time\-consuming, particularly for large tables\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +For details about what checks the +\fB\-\-check\-upgrade\fR +option entails, see the description of the +FOR UPGRADE +option of the +CHECK TABLE +statement\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fIfix_priv_tables\fR +represents a script generated internally by +\fBmysql_upgrade\fR +that contains SQL statements to upgrade the tables in the +mysql +database\&. +.RE +.PP +All checked and repaired tables are marked with the current MariaDB version number\&. This ensures that next time you run +\fBmysql_upgrade\fR +with the same version of the server, it can tell whether there is any need to check or repair the table again\&. +.\" mysql_upgrade_info file: mysql_upgrade +.\" mysql_upgrade: mysql_upgrade_info file +.PP +\fBmysql_upgrade\fR +also saves the MariaDB version number in a file named +mysql_upgrade_info +in the data directory\&. This is used to quickly check whether all tables have been checked for this release so that table\-checking can be skipped\&. To ignore this file and perform the check regardless, use the +\fB\-\-force\fR +option\&. +.PP +For this reason, \fBmysql_upgrade\fR needs to be run as a user with write access to the data directory\&. +.PP +If you install MariaDB from RPM packages on Linux, you must install the server and client RPMs\&. +\fBmysql_upgrade\fR +is included in the server RPM but requires the client RPM because the latter includes +\fBmysqlcheck\fR\&. +.PP +.PP +\fBmysql_upgrade\fR +supports the following options, which can be specified on the command line or in the +[mysql_upgrade] +and +[client] +option file groups\&. Other options are passed to +\fBmysqlcheck\fR\&. For example, it might be necessary to specify the +\fB\-\-password[=\fR\fB\fIpassword\fR\fR\fB]\fR +option\&. +\fBmysql_upgrade\fR +also supports the options for processing option files\&. +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_upgrade: help option +.\" help option: mysql_upgrade +\fB\-\-help\fR, +\fB\-?\fR +.sp +Display a short help message and exit\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_upgrade: basedir option +.\" basedir option: mysql_upgrade +\fB\-\-basedir=\fR\fB\fIpath\fR\fR +.sp +Old option accepted for backward compatibility but ignored\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_upgrade: character-sets-dir option +.\" character-sets-dir option: mysql_upgrade +\fB\-\-character\-sets\-dir=\fR\fB\fIpath\fR\fR +.sp +Old option accepted for backward compatibility but ignored\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_upgrade: check-if-upgrade-is-needed option +.\" check-if-upgrade-is-needed option: mysql_upgrade +\fB\-\-check\-if\-upgrade\-is\-needed\fR +.sp +Exit with a status code indicating if an upgrade is needed\&. Returns 0 if upgrade needed or current version couldn't be determined, 1 when no action required\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_upgrade: datadir option +.\" datadir option: mysql_upgrade +\fB\-\-datadir=\fR\fB\fIpath\fR\fR +.sp +Old option accepted for backward compatibility but ignored\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_upgrade: debug option +.\" debug option: mysql_upgrade +\fB\-\-debug=\fR\fB\fIpath\fR\fR, +\fB\-# \fIpath\fR\fR +.sp +For debug builds, output debug log\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_upgrade: debug-check option +.\" debug-check option: mysql_upgrade +\fB\-\-debug\-check\fR +.sp +Print some debugging information when the program exits\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_upgrade: debug-info option +.\" debug-info option: mysql_upgrade +\fB\-\-debug\-info\fR, +\fB\-T\fR +.sp +Print debugging information and memory and CPU usage statistics when the program exits\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_upgrade: default-character-set option +.\" default-character-set option: mysql_upgrade +\fB\-\-default\-character\-set=\fR\fB\fIname\fR\fR +.sp +Old option accepted for backward compatibility but ignored\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_upgrade: force option +.\" force option: mysql_upgrade +\fB\-\-force\fR +.sp +Ignore the +mysql_upgrade_info +file and force execution of +\fBmysqlcheck\fR +even if +\fBmysql_upgrade\fR +has already been executed for the current version of MariaDB\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_upgrade: host option +.\" host option: mysql_upgrade +\fB\-\-host\fR +.sp +Connect to MariaDB on the given host\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_upgrade: password option +.\" password option: mysql_upgrade +\fB\-\-password[=\fR\fB\fIpassword\fR\fR\fB]\fR, +\fB\-p[\fR\fB\fIpassword\fR\fR\fB]\fR +.sp +The password to use when connecting to the server\&. If you use the short option form (\fB\-p\fR), you +\fIcannot\fR +have a space between the option and the password\&. If you omit the +\fIpassword\fR +value following the +\fB\-\-password\fR +or +\fB\-p\fR +option on the command line, +\fBmysql_upgrade\fR +prompts for one\&. +.sp +Specifying a password on the command line should be considered insecure\&. You can use an option file to avoid giving the password on the command line\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_upgrade: port option +.\" port option: mysql_upgrade +\fB\-\-port=\fR\fB\fIport_num\fR\fR, +\fB\-P \fR\fB\fIport_num\fR\fR +.sp +The TCP/IP port number to use for the connection\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_upgrade: protocol option +.\" protocol option: mysql_upgrade +\fB\-\-protocol={TCP|SOCKET|PIPE|MEMORY}\fR +.sp +The connection protocol to use for connecting to the server\&. It is useful when the other connection parameters normally would cause a protocol to be used other than the one you want\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_upgrade: silent option +.\" silent option: mysql_upgrade +\fB\-\-silent\fR +.sp +Print less information\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_upgrade: socket option +.\" socket option: mysql_upgrade +\fB\-\-socket=\fR\fB\fIpath\fR\fR, +\fB\-S \fR\fB\fIpath\fR\fR +.sp +For connections to +localhost, the Unix socket file to use, or, on Windows, the name of the named pipe to use\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_upgrade: SSL options +.\" SSL options: mysql_upgrade +\fB\-\-ssl\fR +.sp +Enable SSL for connection (automatically enabled with other flags). Disable with +\fB\-\-skip-ssl\fR\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_upgrade: SSL CA option +.\" SSL CA option: mysql_upgrade +\fB\-\-ssl\-ca=\fIname\fR +.sp +CA file in PEM format (check OpenSSL docs, implies +\fB\-\-ssl\fR)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_upgrade: SSL CA Path option +.\" SSL CA Path option: mysql_upgrade +\fB\-\-ssl\-capath=\fIname\fR +.sp +CA directory (check OpenSSL docs, implies +\fB\-\-ssl\fR)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_upgrade: SSL Cert option +.\" SSL Cert option: mysql_upgrade +\fB\-\-ssl\-cert=\fIname\fR +.sp +X509 cert in PEM format (check OpenSSL docs, implies +\fB\-\-ssl\fR)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_upgrade: SSL Cipher option +.\" SSL Cipher option: mysql_upgrade +\fB\-\-ssl\-cipher=\fIname\fR +.sp +SSL cipher to use (check OpenSSL docs, implies +\fB\-\-ssl\fR)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_upgrade: SSL Key option +.\" SSL Key option: mysql_upgrade +\fB\-\-ssl\-key=\fIname\fR +.sp +X509 key in PEM format (check OpenSSL docs, implies +\fB\-\-ssl\fR)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_upgrade: SSL Crl option +.\" SSL CRL option: mysql_upgrade +\fB\-\-ssl\-crl=\fIname\fR +.sp +Certificate revocation list (check OpenSSL docs, implies +\fB\-\-ssl\fR)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_upgrade: SSL Crlpath option +.\" SSL Crlpath option: mysql_upgrade +\fB\-\-ssl\-crlpath=\fIname\fR +.sp +Certificate revocation list path (check OpenSSL docs, implies +\fB\-\-ssl\fR)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_upgrade: SSL Verify Server Cert option +.\" SSL Verify Server Cert option: mysql_upgrade +\fB\-\-ssl\-verify\-server\-cert\fR +.sp +Verify server's "Common Name" in its cert against hostname used when connecting. This option is disabled by default\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_upgrade: tmpdir option +.\" tmpdir option: mysql_upgrade +\fB\-\-tmpdir=\fR\fB\fIpath\fR\fR, +\fB\-t \fR\fB\fIpath\fR\fR +.sp +The path name of the directory to use for creating temporary files\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_upgrade: upgrade-system-tables option +.\" upgrade-system-tables option: mysql_upgrade +\fB\-\-upgrade\-system\-tables\fR\fR, +\fB\-s \fR +.sp +Only upgrade the system tables in the mysql database\&. Tables in other databases are not checked or touched\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_upgrade: user option +.\" user option: mysql_upgrade +\fB\-\-user=\fR\fB\fIuser_name\fR\fR, +\fB\-u \fR\fB\fIuser_name\fR\fR +.sp +The MariaDB user name to use when connecting to the server and not using the current login\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_upgrade: verbose option +.\" verbose option: mysql_upgrade +\fB\-\-verbose\fR +.sp +Display more output about the process\&. Using it twice will print connection +arguments; using it 3 times will print out all CHECK, RENAME and ALTER TABLE +commands used during the check phase; using it 4 times (added in MariaDB 10.0.14) +will also write out all mariadb-check commands used; using it 5 times will print all +the mariadb commands used and their results while running mysql_fix_privilege_tables script\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_upgrade: version option +.\" version option: mysql_upgrade +\fB\-\-version\fR, +\fB\-V\fR +.sp +Output version information and exit\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_upgrade: version-check option +.\" version-check option: mysql_upgrade +\fB\-\-version\-check\fR, +\fB\-k\fR +.sp +Run this program only if its 'server version' matches the version +of the server to which it's connecting. Note: the 'server version' +of the program is the version of the MariaDB server with which +it was built/distributed. Defaults to on; use \fB\-\-skip\-version\-check\fR to disable\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_upgrade: write-binlog option +.\" write-binlog option: mysql_upgrade +\fB\-\-write\-binlog\fR +.sp +Cause binary logging to be enabled while +\fBmysql_upgrade\fR +runs\&. +.RE +.SH "COPYRIGHT" +.br +.PP +Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc., 2010-2020 MariaDB Foundation +.PP +This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License. +.PP +This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. +.PP +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-1335 USA or see http://www.gnu.org/licenses/. +.sp +.SH "SEE ALSO" +For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/ +.SH AUTHOR +MariaDB Foundation (http://www.mariadb.org/). diff --git a/man/mysql_waitpid.1 b/man/mysql_waitpid.1 new file mode 100644 index 00000000..268518d5 --- /dev/null +++ b/man/mysql_waitpid.1 @@ -0,0 +1,127 @@ +'\" t +.\" +.TH "\fBMARIADB-WAITPID\fR" "1" "15 May 2020" "MariaDB 10.11" "MariaDB Database System" +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.\" mysql_waitpid +.SH "NAME" +mariadb-waitpid \- kill process and wait for its termination (mysql_waitpid is now a symlink to mariadb-waitpid) +.SH "SYNOPSIS" +.HP \w'\fBmysql_waitpid\ [\fR\fB\fIoptions\fR\fR\fB]\ \fR\fB\fIpid\fR\fR\fB\ \fR\fB\fIwait_time\fR\fR\ 'u +\fBmysql_waitpid [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fIpid\fR\fR\fB \fR\fB\fIwait_time\fR\fR +.SH "DESCRIPTION" +.PP +\fBmysql_waitpid\fR +signals a process to terminate and waits for the process to exit\&. It uses the +kill() +system call and Unix signals, so it runs on Unix and Unix\-like systems\&. +.PP +Invoke +\fBmysql_waitpid\fR +like this: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysql_waitpid [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fIpid\fR\fR\fB \fR\fB\fIwait_time\fR\fR +.fi +.if n \{\ +.RE +.\} +.PP +\fBmysql_waitpid\fR +sends signal 0 to the process identified by +\fIpid\fR +and waits up to +\fIwait_time\fR +seconds for the process to terminate\&. +\fIpid\fR +and +\fIwait_time\fR +must be positive integers\&. +.PP +If process termination occurs within the wait time or the process does not exist, +\fBmysql_waitpid\fR +returns 0\&. Otherwise, it returns 1\&. +.PP +If the +kill() +system call cannot handle signal 0, +\fBmysql_waitpid()\fR +uses signal 1 instead\&. +.PP +\fBmysql_waitpid\fR +supports the following options: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_waitpid: help option +.\" help option: mysql_waitpid +\fB\-\-help\fR, +\fB\-?\fR, +\fB\-I\fR +.sp +Display a help message and exit\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_waitpid: verbose option +.\" verbose option: mysql_waitpid +\fB\-\-verbose\fR, +\fB\-v\fR +.sp +Verbose mode\&. Display a warning if signal 0 could not be used and signal 1 is used instead\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql_waitpid: version option +.\" version option: mysql_waitpid +\fB\-\-version\fR, +\fB\-V\fR +.sp +Display version information and exit\&. +.RE +.SH "COPYRIGHT" +.br +.PP +Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc., 2010-2020 MariaDB Foundation +.PP +This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License. +.PP +This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. +.PP +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-1335 USA or see http://www.gnu.org/licenses/. +.sp +.SH "SEE ALSO" +For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/ +.SH AUTHOR +MariaDB Foundation (http://www.mariadb.org/). diff --git a/man/mysqlaccess.1 b/man/mysqlaccess.1 new file mode 100644 index 00000000..762c1959 --- /dev/null +++ b/man/mysqlaccess.1 @@ -0,0 +1,429 @@ +'\" t +.\" +.TH "\fBMARIADB-ACCESS\fR" "1" "15 May 2020" "MariaDB 10.11" "MariaDB Database System" +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.\" mysqlaccess +.SH "NAME" +mariadb-access \- client for checking access privileges (mysqlaccess is now a symlink to mariadb-access) +.SH "SYNOPSIS" +.HP \w'\fBmysqlaccess\ [\fR\fB\fIhost_name\fR\fR\fB\ [\fR\fB\fIuser_name\fR\fR\fB\ [\fR\fB\fIdb_name\fR\fR\fB]]]\ [\fR\fB\fIoptions\fR\fR\fB]\fR\ 'u +\fBmysqlaccess [\fR\fB\fIhost_name\fR\fR\fB [\fR\fB\fIuser_name\fR\fR\fB [\fR\fB\fIdb_name\fR\fR\fB]]] [\fR\fB\fIoptions\fR\fR\fB]\fR +.SH "DESCRIPTION" +.PP +\fBmysqlaccess\fR +is a diagnostic tool written by Yves Carlier\&. It checks the access privileges for a host name, user name, and database combination\&. Note that +\fBmysqlaccess\fR +checks access using only the +user, +db, and +host +tables\&. It does not check table, column, or routine privileges specified in the +tables_priv, +columns_priv, or +procs_priv +tables\&. +.PP +Invoke +\fBmysqlaccess\fR +like this: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysqlaccess [\fR\fB\fIhost_name\fR\fR\fB [\fR\fB\fIuser_name\fR\fR\fB [\fR\fB\fIdb_name\fR\fR\fB]]] [\fR\fB\fIoptions\fR\fR\fB]\fR +.fi +.if n \{\ +.RE +.\} +.PP +\fBmysqlaccess\fR +supports the following options\&. +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlaccess: help option +.\" help option: mysqlaccess +\fB\-\-help\fR, +\fB\-?\fR +.sp +Display a help message and exit\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlaccess: brief option +.\" brief option: mysqlaccess +\fB\-\-brief\fR, +\fB\-b\fR +.sp +Generate reports in single\-line tabular format\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlaccess: commit option +.\" commit option: mysqlaccess +\fB\-\-commit\fR +.sp +Copy the new access privileges from the temporary tables to the original grant tables\&. The grant tables must be flushed for the new privileges to take effect\&. (For example, execute a +\fBmysqladmin reload\fR +command\&.) +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlaccess: copy option +.\" copy option: mysqlaccess +\fB\-\-copy\fR +.sp +Reload the temporary grant tables from original ones\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlaccess: db option +.\" db option: mysqlaccess +\fB\-\-db=\fR\fB\fIdb_name\fR\fR, +\fB\-d \fR\fB\fIdb_name\fR\fR +.sp +Specify the database name\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlaccess: debug option +.\" debug option: mysqlaccess +\fB\-\-debug=\fR\fB\fIN\fR\fR +.sp +Specify the debug level\&. +\fIN\fR +can be an integer from 0 to 3\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlaccess: host option +.\" host option: mysqlaccess +\fB\-\-host=\fR\fB\fIhost_name\fR\fR, +\fB\-h \fR\fB\fIhost_name\fR\fR +.sp +The host name to use in the access privileges\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlaccess: howto option +.\" howto option: mysqlaccess +\fB\-\-howto\fR +.sp +Display some examples that show how to use +\fBmysqlaccess\fR\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlaccess: old_server option +.\" old_server option: mysqlaccess +\fB\-\-old_server\fR +.sp +Connect to a very old MySQL server (before MySQL 3\&.21) that does not know how to handle full +WHERE clauses\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlaccess: password option +.\" password option: mysqlaccess +\fB\-\-password[=\fR\fB\fIpassword\fR\fR\fB]\fR, +\fB\-p[\fR\fB\fIpassword\fR\fR\fB]\fR +.sp +The password to use when connecting to the server\&. If you omit the +\fIpassword\fR +value following the +\fB\-\-password\fR +or +\fB\-p\fR +option on the command line, +\fBmysqlaccess\fR +prompts for one\&. +.sp +Specifying a password on the command line should be considered insecure\&. See +Section\ \&5.3.2.2, \(lqEnd-User Guidelines for Password Security\(rq\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlaccess: plan option +.\" plan option: mysqlaccess +\fB\-\-plan\fR +.sp +Display suggestions and ideas for future releases\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlaccess: preview option +.\" preview option: mysqlaccess +\fB\-\-preview\fR +.sp +Show the privilege differences after making changes to the temporary grant tables\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlaccess: relnotes option +.\" relnotes option: mysqlaccess +\fB\-\-relnotes\fR +.sp +Display the release notes\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlaccess: rhost option +.\" rhost option: mysqlaccess +\fB\-\-rhost=\fR\fB\fIhost_name\fR\fR, +\fB\-H \fR\fB\fIhost_name\fR\fR +.sp +Connect to the MariaDB server on the given host\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlaccess: rollback option +.\" rollback option: mysqlaccess +\fB\-\-rollback\fR +.sp +Undo the most recent changes to the temporary grant tables\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlaccess: spassword option +.\" spassword option: mysqlaccess +\fB\-\-spassword[=\fR\fB\fIpassword\fR\fR\fB]\fR, +\fB\-P[\fR\fB\fIpassword\fR\fR\fB]\fR +.sp +The password to use when connecting to the server as the superuser\&. If you omit the +\fIpassword\fR +value following the +\fB\-\-spassword\fR +or +\fB\-p\fR +option on the command line, +\fBmysqlaccess\fR +prompts for one\&. +.sp +Specifying a password on the command line should be considered insecure\&. See +Section\ \&5.3.2.2, \(lqEnd-User Guidelines for Password Security\(rq\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlaccess: superuser option +.\" superuser option: mysqlaccess +\fB\-\-superuser=\fR\fB\fIuser_name\fR\fR, +\fB\-U \fR\fB\fIuser_name\fR\fR +.sp +Specify the user name for connecting as the superuser\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlaccess: table option +.\" table option: mysqlaccess +\fB\-\-table\fR, +\fB\-t\fR +.sp +Generate reports in table format\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlaccess: user option +.\" user option: mysqlaccess +\fB\-\-user=\fR\fB\fIuser_name\fR\fR, +\fB\-u \fR\fB\fIuser_name\fR\fR +.sp +The user name to use in the access privileges\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlaccess: version option +.\" version option: mysqlaccess +\fB\-\-version\fR, +\fB\-v\fR +.sp +Display version information and exit\&. +.RE +.PP +If your MariaDB distribution is installed in some non\-standard location, you must change the location where +\fBmysqlaccess\fR +expects to find the +\fBmysql\fR +client\&. Edit the +mysqlaccess +script at approximately line 18\&. Search for a line that looks like this: +.sp +.if n \{\ +.RS 4 +.\} +.nf +$MYSQL = '/usr/local/bin/mysql'; # path to mysql executable +.fi +.if n \{\ +.RE +.\} +.PP +Change the path to reflect the location where +\fBmysql\fR +actually is stored on your system\&. If you do not do this, a +Broken pipe +error will occur when you run +\fBmysqlaccess\fR\&. +.SH "COPYRIGHT" +.br +.PP +Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc., 2010-2020 MariaDB Foundation +.PP +This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License. +.PP +This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. +.PP +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-1335 USA or see http://www.gnu.org/licenses/. +.sp +.SH "SEE ALSO" +For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/ +.SH AUTHOR +MariaDB Foundation (http://www.mariadb.org/). diff --git a/man/mysqladmin.1 b/man/mysqladmin.1 new file mode 100644 index 00000000..82c5dfc0 --- /dev/null +++ b/man/mysqladmin.1 @@ -0,0 +1,1536 @@ +'\" t +.\" +.TH "\fBMARIADB-ADMIN\fR" "1" "15 May 2020" "MariaDB 10.11" "MariaDB Database System" +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.\" mysqladmin +.\" administration: server +.\" server administration +.SH "NAME" +mariadb-admin \- client for administering a MariaDB server (mysqladmin is now a symlink to mariadb-admin) +.SH "SYNOPSIS" +.HP \w'\fBmysqladmin\ [\fR\fB\fIoptions\fR\fR\fB]\ \fR\fB\fIcommand\fR\fR\fB\ [\fR\fB\fIcommand\-arg\fR\fR\fB]\ [\fR\fB\fIcommand\fR\fR\fB\ [\fR\fB\fIcommand\-arg\fR\fR\fB]]\ \&.\&.\&.\fR\ 'u +\fBmysqladmin [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fIcommand\fR\fR\fB [\fR\fB\fIcommand\-arg\fR\fR\fB] [\fR\fB\fIcommand\fR\fR\fB [\fR\fB\fIcommand\-arg\fR\fR\fB]] \&.\&.\&.\fR +.SH "DESCRIPTION" +.PP +\fBmysqladmin\fR +is a client for performing administrative operations\&. You can use it to check the server's configuration and current status, to create and drop databases, and more\&. +.PP +Invoke +\fBmysqladmin\fR +like this: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysqladmin [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fIcommand\fR\fR\fB [\fR\fB\fIcommand\-arg\fR\fR\fB] [\fR\fB\fIcommand\fR\fR\fB [\fR\fB\fIcommand\-arg\fR\fR\fB]] \&.\&.\&.\fR +.fi +.if n \{\ +.RE +.\} +.PP +\fBmysqladmin\fR +supports the following commands\&. Some of the commands take an argument following the command name\&. +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +create \fIdb_name\fR +.sp +Create a new database named +\fIdb_name\fR\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +debug +.sp +Tell the server to write debug information to the error log\&. +.sp +This also includes information about the Event Scheduler\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +drop \fIdb_name\fR +.sp +Delete the database named +\fIdb_name\fR +and all its tables\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +extended\-status +.sp +Display the server status variables and their values\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +flush\-all\-statistics +.sp +Flush all statistics tables\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +flush\-all\-status +.sp +Flush all status and statistics\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +flush\-binary\-log +.sp +Flush the binary log\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +flush\-client\-statistics +.sp +Flush client statistics\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +flush\-engine\-log +.sp +Flush engine log\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +flush\-error\-log +.sp +Flush error log\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +flush\-general\-log +.sp +Flush general query log\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +flush\-hosts +.sp +Flush all information in the host cache\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +flush\-index\-statistics +.sp +Flush index statistics\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +flush\-logs +.sp +Flush all logs\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +flush\-privileges +.sp +Reload the grant tables (same as +reload)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +flush\-relay\-log +.sp +Flush relay log\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +flush\-slow\-log +.sp +Flush slow query log\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +flush\-ssl +.sp +Flush SSL certificates\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +flush\-status +.sp +Clear status variables\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +flush\-table\-statistics +.sp +Flush table statistics\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +flush\-tables +.sp +Flush all tables\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +flush\-threads +.sp +Flush the thread cache\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +flush\-user\-resources +.sp +Flush user resources\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +kill \fIid\fR,\fIid\fR,\&.\&.\&. +.sp +Kill server threads\&. If multiple thread ID values are given, there must be no spaces in the list\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +old\-password \fInew\-password\fR +.sp +This is like the +password +command but stores the password using the old (pre MySQL 4\&.1) password\-hashing format\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +password \fInew\-password\fR +.sp +Set a new password\&. This changes the password to +\fInew\-password\fR +for the account that you use with +\fBmysqladmin\fR +for connecting to the server\&. Thus, the next time you invoke +\fBmysqladmin\fR +(or any other client program) using the same account, you will need to specify the new password\&. +.sp +If the +\fInew\-password\fR +value contains spaces or other characters that are special to your command interpreter, you need to enclose it within quotes\&. On Windows, be sure to use double quotes rather than single quotes; single quotes are not stripped from the password, but rather are interpreted as part of the password\&. For example: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysqladmin password "my new password"\fR +.fi +.if n \{\ +.RE +.\} +.if n \{\ +.sp +.\} +.RS 4 +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.ps +1 +\fBCaution\fR +.ps -1 +.br +Do not use this command used if the server was started with the +\fB\-\-skip\-grant\-tables\fR +option\&. No password change will be applied\&. This is true even if you precede the +password +command with +flush\-privileges +on the same command line to re\-enable the grant tables because the flush operation occurs after you connect\&. However, you can use +\fBmysqladmin flush\-privileges\fR +to re\-enable the grant table and then use a separate +\fBmysqladmin password\fR +command to change the password\&. +.sp .5v +.RE +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +ping +.sp +Check whether the server is alive\&. The return status from +\fBmysqladmin\fR +is 0 if the server is running, 1 if it is not\&. This is 0 even in case of an error such as +Access denied, because this means that the server is running but refused the connection, which is different from the server not running\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +processlist +.sp +Show a list of active server threads\&. This is like the output of the +SHOW PROCESSLIST +statement\&. If the +\fB\-\-verbose\fR +option is given, the output is like that of +SHOW FULL PROCESSLIST\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +reload +.sp +Reload the grant tables\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +refresh +.sp +Flush all tables and close and open log files\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +shutdown +.sp +Stop the server\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +start\-all\-slaves +.sp +Start all slaves\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +start\-slave +.sp +Start replication on a slave server\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +status +.sp +Display a short server status message\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +stop\-all\-slaves +.sp +Stop all slaves\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +stop\-slave +.sp +Stop replication on a slave server\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +variables +.sp +Display the server system variables and their values\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +version +.sp +Display version information from the server\&. +.RE +.PP +All commands can be shortened to any unique prefix\&. For example: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysqladmin proc stat\fR ++\-\-\-\-+\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-+\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-+\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+ +| Id | User | Host | db | Command | Time | State | Info | ++\-\-\-\-+\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-+\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-+\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+ +| 51 | monty | localhost | | Query | 0 | | show processlist | ++\-\-\-\-+\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-+\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-+\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+ +Uptime: 1473624 Threads: 1 Questions: 39487 +Slow queries: 0 Opens: 541 Flush tables: 1 +Open tables: 19 Queries per second avg: 0\&.0268 +.fi +.if n \{\ +.RE +.\} +.sp +.\" status command: results +.PP +The +\fBmysqladmin status\fR +command result displays the following values: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" uptime +Uptime +.sp +The number of seconds the MariaDB server has been running\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" threads +Threads +.sp +The number of active threads (clients)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" questions +Questions +.sp +The number of questions (queries) from clients since the server was started\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" slow queries +Slow queries +.sp +The number of queries that have taken more than +log_slow_query_time +seconds\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" opens +Opens +.sp +The number of tables the server has opened\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" flush tables +.\" tables: flush +Flush tables +.sp +The number of +flush\-*, +refresh, and +reload +commands the server has executed\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" open tables +Open tables +.sp +The number of tables that currently are open\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" memory use +Memory in use +.sp +The amount of memory allocated directly by +\fBmysqld\fR\&. This value is displayed only when MariaDB has been compiled with +\fB\-\-with\-debug=full\fR\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" maximum memory used +Maximum memory used +.sp +The maximum amount of memory allocated directly by +\fBmysqld\fR\&. This value is displayed only when MariaDB has been compiled with +\fB\-\-with\-debug=full\fR\&. +.RE +.PP +If you execute +\fBmysqladmin shutdown\fR +when connecting to a local server using a Unix socket file, +\fBmysqladmin\fR +waits until the server's process ID file has been removed, to ensure that the server has stopped properly\&. +.\" mysqladmin command options +.\" command options: mysqladmin +.\" options: command-line: mysqladmin +.\" startup parameters: mysqladmin +.PP +\fBmysqladmin\fR +supports the following options, which can be specified on the command line or in the +[mysqladmin] +and +[client] +option file groups\&. +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqladmin: help option +.\" help option: mysqladmin +\fB\-\-help\fR, +\fB\-?\fR +.sp +Display help and exit\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqladmin: character-sets-dir option +.\" character-sets-dir option: mysqladmin +\fB\-\-character\-sets\-dir=\fR\fB\fIpath\fR\fR +.sp +The directory where character sets are installed\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqladmin: compress option +.\" compress option: mysqladmin +\fB\-\-compress\fR, +\fB\-C\fR +.sp +Compress all information sent between the client and the server if both support compression\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqladmin: connect-timeout option +.\" connect-timeout option: mysqladmin +\fB\-\-connect-timeout=\fR\fB\fItimeout\fR\fR +.sp +Equivalent to \fB\-\-connect_timeout\fR, see the end of this section\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqladmin: count option +.\" count option: mysqladmin +\fB\-\-count=\fR\fB\fIN\fR\fR, +\fB\-c \fR\fB\fIN\fR\fR +.sp +The number of iterations to make for repeated command execution if the +\fB\-\-sleep\fR +option is given\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqladmin: debug option +.\" debug option: mysqladmin +\fB\-\-debug[=\fR\fB\fIdebug_options\fR\fR\fB]\fR, +\fB\-# [\fR\fB\fIdebug_options\fR\fR\fB]\fR +.sp +Write a debugging log\&. A typical +\fIdebug_options\fR +string is 'd:t:o,\fIfile_name\fR'. The default is 'd:t:o,/tmp/mysqladmin.trace'. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqladmin: debug-check option +.\" debug-check option: mysqladmin +\fB\-\-debug\-check\fR +.sp +Check memory and open file usage at exit.\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqladmin: debug-info option +.\" debug-info option: mysqladmin +\fB\-\-debug\-info\fR +.sp +Print debugging information and memory and CPU usage statistics when the program exits\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqladmin: default-auth option +.\" default-auth option: mysqladmin +\fB\-\-default\-auth\fR +.sp +Default authentication client-side plugin to use\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqladmin: default-character-set option +.\" default-character-set option: mysqladmin +\fB\-\-default\-character\-set=\fR\fB\fIcharset_name\fR\fR +.sp +Use +\fIcharset_name\fR +as the default character set\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqladmin: defaults-extra-file option +.\" defaults-extra-file option: mysqladmin +\fB\-\-defaults\-extra\-file=\fR\fB\fIfilename\fR\fR +.sp +Set \fB\fIfilename\fR\fR as the file to read default options from after the global defaults files has been read\&. +Must be given as first option\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqladmin: defaults-file option +.\" defaults-file option: mysqladmin +\fB\-\-defaults\-file=\fR\fB\fIfilename\fR\fR +.sp +Set \fB\fIfilename\fR\fR as the file to read default options from, override global defaults files\&. Must be given as first option\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqladmin: force option +.\" force option: mysqladmin +\fB\-\-force\fR, +\fB\-f\fR +.sp +Do not ask for confirmation for the +drop \fIdb_name\fR +command\&. With multiple commands, continue even if an error occurs\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqladmin: host option +.\" host option: mysqladmin +\fB\-\-host=\fR\fB\fIhost_name\fR\fR, +\fB\-h \fR\fB\fIhost_name\fR\fR +.sp +Connect to the MariaDB server on the given host\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqladmin: local option +.\" local option: mysqladmin +\fB\-\-local\fR, +\fB\-l\fR +.sp +Suppress the SQL command(s) from being written to the binary log by using FLUSH LOCAL or enabling sql_log_bin=0 for the session\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.\" mysqladmin: no-beep option +.\" no-beep option: mysqladmin +\fB\-\-no\-beep\fR, +\fB\-b\fR +.sp +Suppress the warning beep that is emitted by default for errors such as a failure to connect to the server\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqladmin: no-defaults option +.\" no-defaults option: mysqladmin +\fB\-\-no\-defaults\fR +.sp +Do not read default options from any option file\&. This must be given as the first argument\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqladmin: password option +.\" password option: mysqladmin +\fB\-\-password[=\fR\fB\fIpassword\fR\fR\fB]\fR, +\fB\-p[\fR\fB\fIpassword\fR\fR\fB]\fR +.sp +The password to use when connecting to the server\&. If you use the short option form (\fB\-p\fR), you +\fIcannot\fR +have a space between the option and the password\&. If you omit the +\fIpassword\fR +value following the +\fB\-\-password\fR +or +\fB\-p\fR +option on the command line, +\fBmysqladmin\fR +prompts for one\&. +.sp +Specifying a password on the command line should be considered insecure\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqladmin: pipe option +.\" pipe option: mysqladmin +\fB\-\-pipe\fR, +\fB\-W\fR +.sp +On Windows, connect to the server via a named pipe\&. This option applies only if the server supports named\-pipe connections\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqladmin: port option +.\" port option: mysqladmin +\fB\-\-port=\fR\fB\fIport_num\fR\fR, +\fB\-P \fR\fB\fIport_num\fR\fR +.sp +The TCP/IP port number to use for the connection or 0 for default to, +in order of preference, my.cnf, $MYSQL_TCP_PORT, /etc/services, built-in default (3306)\&. +Forces --protocol=tcp when specified on the command line without other connection properties\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqladmin: print-defaults option +.\" print-defaults option: mysqladmin +\fB\-\-print\-defaults\fR +.sp +Print the program argument list and exit\&. This must be given as the first argument\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqladmin: protocol option +.\" protocol option: mysqladmin +\fB\-\-protocol={TCP|SOCKET|PIPE|MEMORY}\fR +.sp +The connection protocol to use for connecting to the server\&. It is useful when the other connection parameters normally would cause a protocol to be used other than the one you want\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqladmin: relative option +.\" relative option: mysqladmin +\fB\-\-relative\fR, +\fB\-r\fR +.sp +Show the difference between the current and previous values when used with the +\fB\-\-sleep\fR +option\&. Currently, this option works only with the +extended\-status +command\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqladmin: shutdown-timeout option +.\" shutdown-timeout option: mysqladmin +\fB\-\-shutdown\-timeout\fR\fB\fItimeout\fR\fR +.sp +Equivalent of \fB\-\-shutdown_timeout\fR, see the end of this section\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqladmin: silent option +.\" silent option: mysqladmin +\fB\-\-silent\fR, +\fB\-s\fR +.sp +Exit silently if a connection to the server cannot be established\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqladmin: sleep option +.\" sleep option: mysqladmin +\fB\-\-sleep=\fR\fB\fIdelay\fR\fR, +\fB\-i \fR\fB\fIdelay\fR\fR +.sp +Execute commands repeatedly, sleeping for +\fIdelay\fR +seconds in between\&. The +\fB\-\-count\fR +option determines the number of iterations\&. If +\fB\-\-count\fR +is not given, +\fBmysqladmin\fR +executes commands indefinitely until interrupted\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqladmin: socket option +.\" socket option: mysqladmin +\fB\-\-socket=\fR\fB\fIpath\fR\fR, +\fB\-S \fR\fB\fIpath\fR\fR +.sp +For connections to +localhost, the Unix socket file to use, or, on Windows, the name of the named pipe to use\&. +Forces --protocol=socket when specified on the command line without other connection properties; on Windows, forces --protocol=pipe\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqladmin: SSL options +.\" SSL options: mysqladmin +\fB\-\-ssl\fR +.sp +Enable SSL for connection (automatically enabled with other flags). Disable with +\fB\-\-skip-ssl\fR\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqladmin: SSL CA option +.\" SSL CA option: mysqladmin +\fB\-\-ssl\-ca=\fIname\fR +.sp +CA file in PEM format (check OpenSSL docs, implies +\fB\-\-ssl\fR)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqladmin: SSL CA Path option +.\" SSL CA Path option: mysqladmin +\fB\-\-ssl\-capath=\fIname\fR +.sp +CA directory (check OpenSSL docs, implies +\fB\-\-ssl\fR)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqladmin: SSL Cert option +.\" SSL Cert option: mysqladmin +\fB\-\-ssl\-cert=\fIname\fR +.sp +X509 cert in PEM format (check OpenSSL docs, implies +\fB\-\-ssl\fR)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqladmin: SSL Cipher option +.\" SSL Cipher option: mysqladmin +\fB\-\-ssl\-cipher=\fIname\fR +.sp +SSL cipher to use (check OpenSSL docs, implies +\fB\-\-ssl\fR)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqladmin: SSL Key option +.\" SSL Key option: mysqladmin +\fB\-\-ssl\-key=\fIname\fR +.sp +X509 key in PEM format (check OpenSSL docs, implies +\fB\-\-ssl\fR)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqladmin: SSL Crl option +.\" SSL CRL option: mysqladmin +\fB\-\-ssl\-crl=\fIname\fR +.sp +Certificate revocation list (check OpenSSL docs, implies +\fB\-\-ssl\fR)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqladmin: SSL Crlpath option +.\" SSL Crlpath option: mysqladmin +\fB\-\-ssl\-crlpath=\fIname\fR +.sp +Certificate revocation list path (check OpenSSL docs, implies +\fB\-\-ssl\fR)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqladmin: SSL Verify Server Cert option +.\" SSL Verify Server Cert option: mysqladmin +\fB\-\-ssl\-verify\-server\-cert\fR +.sp +Verify server's "Common Name" in its cert against hostname used when connecting. This option is disabled by default\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqladmin: TLS Version option +.\" TLS Version option: mysqladmin +\fB\-\-tls\-version=\fR\fB\fIname\fR\fR, +.sp +Accepts a comma-separated list of TLS protocol versions\&. A TLS protocol version will only be enabled if it +is present in this list\&. All other TLS protocol versions will not be permitted\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqladmin: user option +.\" user option: mysqladmin +\fB\-\-user=\fR\fB\fIuser_name\fR\fR, +\fB\-u \fR\fB\fIuser_name\fR\fR +.sp +The MariaDB user name to use when connecting to the server\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqladmin: verbose option +.\" verbose option: mysqladmin +\fB\-\-verbose\fR, +\fB\-v\fR +.sp +Verbose mode\&. Print more information about what the program does\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqladmin: version option +.\" version option: mysqladmin +\fB\-\-version\fR, +\fB\-V\fR +.sp +Display version information and exit\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqladmin: vertical option +.\" vertical option: mysqladmin +\fB\-\-vertical\fR, +\fB\-E\fR +.sp +Print output vertically\&. This is similar to +\fB\-\-relative\fR, but prints output vertically\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqladmin: wait option +.\" wait option: mysqladmin +\fB\-\-wait[=\fR\fB\fIcount\fR\fR\fB]\fR, +\fB\-w[\fR\fB\fIcount\fR\fR\fB]\fR +.sp +If the connection cannot be established, wait and retry instead of aborting\&. If a +\fIcount\fR +value is given, it indicates the number of times to retry\&. The default is one time\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqladmin: --wait-for-all-slaves option +.\" --wait-for-all-slaves option: mysqladmin +\fB\-\-wait\-for\-all\-slaves\fR +.sp +Wait for the last binlog event to be sent to all connected slaves before shutting down\&. +This option is off by default\&. +.RE +.PP +You can also set the following variables by using +\fB\-\-\fR\fB\fIvar_name\fR\fR\fB=\fR\fB\fIvalue\fR\fR +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" connect_timeout variable +.\" timeout: connect_timeout variable +connect_timeout +.sp +The maximum number of seconds before connection timeout\&. The default value is 43200 (12 hours)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" shutdown_timeout variable +.\" timeout: shutdown_timeout variable +shutdown_timeout +.sp +The maximum number of seconds to wait for server shutdown\&. The default value is 3600 (1 hour)\&. +.RE +.SH "COPYRIGHT" +.br +.PP +Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc., 2010-2020 MariaDB Foundation +.PP +This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License. +.PP +This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. +.PP +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-1335 USA or see http://www.gnu.org/licenses/. +.sp +.SH "SEE ALSO" +For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/ +.SH AUTHOR +MariaDB Foundation (http://www.mariadb.org/). diff --git a/man/mysqlbinlog.1 b/man/mysqlbinlog.1 new file mode 100644 index 00000000..70636d55 --- /dev/null +++ b/man/mysqlbinlog.1 @@ -0,0 +1,2132 @@ +'\" t +.\" +.TH "\fBMARIADB-BINLOG\fR" "1" "14 April 2021" "MariaDB 10.11" "MariaDB Database System" +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.\" mysqlbinlog +.SH "NAME" +mariadb-binlog \- utility for processing binary log files (mysqlbinlog is now a symlink to mariadb-binlog) +.SH "SYNOPSIS" +.HP \w'\fBmysqlbinlog\ [\fR\fBoptions\fR\fB]\ \fR\fB\fIlog_file\fR\fR\fB\ \&.\&.\&.\fR\ 'u +\fBmysqlbinlog [\fR\fBoptions\fR\fB] \fR\fB\fIlog_file\fR\fR\fB \&.\&.\&.\fR +.SH "DESCRIPTION" +.PP +The server's binary log consists of files containing +\(lqevents\(rq +that describe modifications to database contents\&. The server writes these files in binary format\&. To display their contents in text format, use the +\fBmysqlbinlog\fR +utility\&. You can also use +\fBmysqlbinlog\fR +to display the contents of relay log files written by a slave server in a replication setup because relay logs have the same format as binary logs\&. +.PP +Invoke +\fBmysqlbinlog\fR +like this: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysqlbinlog [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fIlog_file\fR\fR\fB \&.\&.\&.\fR +.fi +.if n \{\ +.RE +.\} +.PP +For example, to display the contents of the binary log file named +binlog\&.000003, use this command: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysqlbinlog binlog\&.0000003\fR +.fi +.if n \{\ +.RE +.\} +.PP +The output includes events contained in +binlog\&.000003\&. For statement\-based logging, event information includes the SQL statement, the ID of the server on which it was executed, the timestamp when the statement was executed, how much time it took, and so forth\&. For row\-based logging, the event indicates a row change rather than an SQL statement\&. +.PP +Events are preceded by header comments that provide additional information\&. For example: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# at 141 +#100309 9:28:36 server id 123 end_log_pos 245 + Query thread_id=3350 exec_time=11 error_code=0 +.fi +.if n \{\ +.RE +.\} +.PP +In the first line, the number following +at +indicates the starting position of the event in the binary log file\&. +.PP +The second line starts with a date and time indicating when the statement started on the server where the event originated\&. For replication, this timestamp is propagated to slave servers\&. +server id +is the +server_id +value of the server where the event originated\&. +end_log_pos +indicates where the next event starts (that is, it is the end position of the current event + 1)\&. +thread_id +indicates which thread executed the event\&. +exec_time +is the time spent executing the event, on a master server\&. On a slave, it is the difference of the end execution time on the slave minus the beginning execution time on the master\&. The difference serves as an indicator of how much replication lags behind the master\&. +error_code +indicates the result from executing the event\&. Zero means that no error occurred\&. +.PP +The output from +\fBmysqlbinlog\fR +can be re\-executed (for example, by using it as input to +\fBmysql\fR) to redo the statements in the log\&. This is useful for recovery operations after a server crash\&. For other usage examples, see the discussion later in this section\&. +.PP +Normally, you use +\fBmysqlbinlog\fR +to read binary log files directly and apply them to the local MariaDB server\&. It is also possible to read binary logs from a remote server by using the +\fB\-\-read\-from\-remote\-server\fR +option\&. To read remote binary logs, the connection parameter options can be given to indicate how to connect to the server\&. These options are +\fB\-\-host\fR, +\fB\-\-password\fR, +\fB\-\-port\fR, +\fB\-\-protocol\fR, +\fB\-\-socket\fR, and +\fB\-\-user\fR; they are ignored except when you also use the +\fB\-\-read\-from\-remote\-server\fR +option\&. +.PP +\fBmysqlbinlog\fR +supports the following options, which can be specified on the command line or in the +[mysqlbinlog] +and +[client] +option file groups\&. +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlbinlog: help option +.\" help option: mysqlbinlog +\fB\-\-help\fR, +\fB\-?\fR +.sp +Display a help message and exit\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlbinlog: base64-output option +.\" base64-output option: mysqlbinlog +\fB\-\-base64\-output=\fR\fB\fIvalue\fR\fR\fB\fR +.sp +This option determines when events should be displayed encoded as base\-64 strings using +BINLOG +statements\&. The option has these allowable values (not case sensitive): +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +AUTO +("automatic") or +UNSPEC +("unspecified") displays +BINLOG +statements automatically when necessary (that is, for format description events and row events)\&. This is the default if no +\fB\-\-base64\-output\fR +option is given\&. +.if n \{\ +.sp +.\} +.RS 4 +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.ps +1 +\fBNote\fR +.ps -1 +.br +Automatic +BINLOG +display is the only safe behavior if you intend to use the output of +\fBmysqlbinlog\fR +to re\-execute binary log file contents\&. The other option values are intended only for debugging or testing purposes because they may produce output that does not include all events in executable form\&. +.sp .5v +.RE +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +NEVER +causes +BINLOG +statements not to be displayed\&. +\fBmysqlbinlog\fR +exits with an error if a row event is found that must be displayed using +BINLOG\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +DECODE\-ROWS +specifies to +\fBmysqlbinlog\fR +that you intend for row events to be decoded and displayed as commented SQL statements by also specifying the +\fB\-\-verbose\fR +option\&. Like +NEVER, +DECODE\-ROWS +suppresses display of +BINLOG +statements, but unlike +NEVER, it does not exit with an error if a row event is found\&. +.RE +.RS 4 +The +\fB\-\-base64\-output\fR +can be given as +\fB\-\-base64\-output\fR +or +\fB\-\-skip\-base64\-output\fR +(with the sense of +AUTO +or +NEVER)\&. +.sp +For examples that show the effect of +\fB\-\-base64\-output\fR +and +\fB\-\-verbose\fR +on row event output, see +the section called \(lqMYSQLBINLOG ROW EVENT DISPLAY\(rq\&. +.RE +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlbinlog: binlog-row-event-max-size option +.\" binlog-row-event-max-size option: mysqlbinlog +\fB\-\-binlog\-row\-event\-max\-size\=\fR\fB\fIpath\fR\fR +.sp +The directory where character sets are installed\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlbinlog: character-sets-dir option +.\" character-sets-dir option: mysqlbinlog +\fB\-\-character\-sets\-dir=\fR\fB\fIpath\fR\fR +.sp +The directory where character sets are installed\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlbinlog: database option +.\" database option: mysqlbinlog +\fB\-\-database=\fR\fB\fIdb_name\fR\fR, +\fB\-d \fR\fB\fIdb_name\fR\fR +.sp +This option causes +\fBmysqlbinlog\fR +to output entries from the binary log (local log only) that occur while +\fIdb_name\fR +has been selected as the default database by +USE\&. +.sp +The +\fB\-\-database\fR +option for +\fBmysqlbinlog\fR +is similar to the +\fB\-\-binlog\-do\-db\fR +option for +\fBmysqld\fR, but can be used to specify only one database\&. If +\fB\-\-database\fR +is given multiple times, only the last instance is used\&. +.sp +The effects of this option depend on whether the statement\-based or row\-based logging format is in use, in the same way that the effects of +\fB\-\-binlog\-do\-db\fR +depend on whether statement\-based or row\-based logging is in use\&. +.PP +\fBStatement-based logging\fR. The +\fB\-\-database\fR +option works as follows: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +While +\fIdb_name\fR +is the default database, statements are output whether they modify tables in +\fIdb_name\fR +or a different database\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Unless +\fIdb_name\fR +is selected as the default database, statements are not output, even if they modify tables in +\fIdb_name\fR\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +There is an exception for +CREATE DATABASE, +ALTER DATABASE, and +DROP DATABASE\&. The database being +\fIcreated, altered, or dropped\fR +is considered to be the default database when determining whether to output the statement\&. +.RE +.RS 4 +Suppose that the binary log was created by executing these statements using statement\-based\-logging: +.sp +.if n \{\ +.RS 4 +.\} +.nf +INSERT INTO test\&.t1 (i) VALUES(100); +INSERT INTO db2\&.t2 (j) VALUES(200); +USE test; +INSERT INTO test\&.t1 (i) VALUES(101); +INSERT INTO t1 (i) VALUES(102); +INSERT INTO db2\&.t2 (j) VALUES(201); +USE db2; +INSERT INTO test\&.t1 (i) VALUES(103); +INSERT INTO db2\&.t2 (j) VALUES(202); +INSERT INTO t2 (j) VALUES(203); +.fi +.if n \{\ +.RE +.\} +.sp +\fBmysqlbinlog \-\-database=test\fR +does not output the first two +INSERT +statements because there is no default database\&. It outputs the three +INSERT +statements following +USE test, but not the three +INSERT +statements following +USE db2\&. +.sp +\fBmysqlbinlog \-\-database=db2\fR +does not output the first two +INSERT +statements because there is no default database\&. It does not output the three +INSERT +statements following +USE test, but does output the three +INSERT +statements following +USE db2\&. +.PP +\fBRow-based logging\fR. +\fBmysqlbinlog\fR +outputs only entries that change tables belonging to +\fIdb_name\fR\&. The default database has no effect on this\&. Suppose that the binary log just described was created using row\-based logging rather than statement\-based logging\&. +\fBmysqlbinlog \-\-database=test\fR +outputs only those entries that modify +t1 +in the test database, regardless of whether +USE +was issued or what the default database is\&. +If a server is running with +binlog_format +set to +MIXED +and you want it to be possible to use +\fBmysqlbinlog\fR +with the +\fB\-\-database\fR +option, you must ensure that tables that are modified are in the database selected by +USE\&. (In particular, no cross\-database updates should be used\&.) +.if n \{\ +.sp +.\} +.RS 4 +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.ps +1 +\fBNote\fR +.ps -1 +.br +This option did not work correctly for +\fBmysqlbinlog\fR +with row\-based logging prior to MySQL 5\&.1\&.37\&. +.sp .5v +.RE +.RE +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlbinlog: debug option +.\" debug option: mysqlbinlog +\fB\-\-debug[=\fR\fB\fIdebug_options\fR\fR\fB]\fR, +\fB\-# [\fR\fB\fIdebug_options\fR\fR\fB]\fR +.sp +Write a debugging log\&. A typical +\fIdebug_options\fR +string is 'd:t:o,\fIfile_name\fR'. The default is 'd:t:o,/tmp/mysqlbinlog.trace'. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlbinlog: debug-check option +.\" debug-check option: mysqlbinlog +\fB\-\-debug\-check\fR +.sp +Print some debugging information when the program exits\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlbinlog: debug-info option +.\" debug-info option: mysqlbinlog +\fB\-\-debug\-info\fR +.sp +Print debugging information and memory and CPU usage statistics when the program exits\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlbinlog: defaults-extra-file option +.\" defaults-extra-file option: mysqlbinlog +\fB\-\-defaults\-extra\-file=\fR\fB\fIname\fR +.sp +Read this file after the global files are read\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlbinlog: defaults-file option +.\" defaults-file option: mysqlbinlog +\fB\-\-defaults\-file=\fR\fB\fIname\fR +.sp +Only read default options from the given file\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlbinlog: default-auth option +.\" default-auth option: mysqlbinlog +\fB\-\-default\-auth=\fR\fB\fIname\fR +.sp +Default authentication client-side plugin to use\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlbinlog: disable-log-bin option +.\" disable-log-bin option: mysqlbinlog +\fB\-\-disable\-log\-bin\fR, +\fB\-D\fR +.sp +Disable binary logging\&. This is useful for avoiding an endless loop if you use the +\fB\-\-to\-last\-log\fR +option and are sending the output to the same MariaDB server\&. This option also is useful when restoring after a crash to avoid duplication of the statements you have logged\&. +.sp +This option requires that you have the +SUPER +privilege\&. It causes +\fBmysqlbinlog\fR +to include a +SET sql_log_bin = 0 +statement in its output to disable binary logging of the remaining output\&. The +SET +statement is ineffective unless you have the +SUPER +privilege\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlbinlog: force-if-open option +.\" force-if-open option: mysqlbinlog +\fB\-\-force\-if\-open\fR +.sp +Force if binlog was not closed properly. Defaults to on; use \fB--skip-force-if-open\fR to disable\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlbinlog: force-read option +.\" force-read option: mysqlbinlog +\fB\-\-force\-read\fR, +\fB\-f\fR +.sp +With this option, if +\fBmysqlbinlog\fR +reads a binary log event that it does not recognize, it prints a warning, ignores the event, and continues\&. Without this option, +\fBmysqlbinlog\fR +stops if it reads such an event\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlbinlog: hexdump option +.\" hexdump option: mysqlbinlog +\fB\-\-hexdump\fR, +\fB\-H\fR +.sp +Display a hex dump of the log in comments, as described in +the section called \(lqMYSQLBINLOG HEX DUMP FORMAT\(rq\&. The hex output can be helpful for replication debugging\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlbinlog: host option +.\" host option: mysqlbinlog +\fB\-\-host=\fR\fB\fIhost_name\fR\fR, +\fB\-h \fR\fB\fIhost_name\fR\fR +.sp +Get the binary log from the MariaDB server on the given host\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlbinlog: local-load option +.\" local-load option: mysqlbinlog +\fB\-\-local\-load=\fR\fB\fIpath\fR\fR, +\fB\-l \fR\fB\fIpath\fR\fR +.sp +Prepare local temporary files for +LOAD DATA INFILE +in the specified directory\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlbinlog: no-defaults option +.\" no-defaults option: mysqlbinlog +\fB\-\-no\-defaults\fR +.sp +Don't read default options from any option file\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlbinlog: offset option +.\" offset option: mysqlbinlog +\fB\-\-offset=\fR\fB\fIN\fR\fR, +\fB\-o \fR\fB\fIN\fR\fR +.sp +Skip the first +\fIN\fR +entries in the log\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlbinlog: open-files-limit option +.\" open-files-limit option: mysqlbinlog +\fB\-\-open\-files\-limit=\fR\fB\fINUM\fR\fR +.sp +Sets the open_files_limit variable, which is used to reserve file descriptors for +\fBmysqlbinlog\fR\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlbinlog: password option +.\" password option: mysqlbinlog +\fB\-\-password[=\fR\fB\fIpassword\fR\fR\fB]\fR, +\fB\-p[\fR\fB\fIpassword\fR\fR\fB]\fR +.sp +The password to use when connecting to the server\&. If you use the short option form (\fB\-p\fR), you +\fIcannot\fR +have a space between the option and the password\&. If you omit the +\fIpassword\fR +value following the +\fB\-\-password\fR +or +\fB\-p\fR +option on the command line, +\fBmysqlbinlog\fR +prompts for one\&. +.sp +Specifying a password on the command line should be considered insecure\&. You +can use an option file to avoid giving the password on the command line\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlbinlog: plugin-dir option +.\" plugin-dir option: mysqlbinlog +\fB\-\-plugin\-dir=\fIdir_name\fR +.sp +Directory for client-side plugins\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlbinlog: print-defaults option +.\" print-defaults option: mysqlbinlog +\fB\-\-print\-defaults\fR +.sp +Print the program argument list from all option files and exit\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlbinlog: port option +.\" port option: mysqlbinlog +\fB\-\-port=\fR\fB\fIport_num\fR\fR, +\fB\-P \fR\fB\fIport_num\fR\fR +.sp +The TCP/IP port number to use for connecting to a remote server, +or \fB0\fR for default to, in order of preference, \fBmy.cnf\fR, +\fB$MYSQL_TCP_PORT\fR, \fB/etc/services\fR, \fRbuilt-in default (3306)\fR\&. +Forces --protocol=tcp when specified on the command line without other connection properties\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlbinlog: protocol option +.\" protocol option: mysqlbinlog +\fB\-\-protocol={TCP|SOCKET|PIPE|MEMORY}\fR +.sp +The connection protocol to use for connecting to the server\&. It is useful when the other connection parameters normally would cause a protocol to be used other than the one you want\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlbinlog: raw option +.\" raw option: mysqlbinlog +\fB\-\-raw\fR +.sp +Requires \fB-R\fR\&. Output raw binlog data instead of SQL statements\&. Output files named after server logs\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlbinlog: read-from-remote-server option +.\" read-from-remote-server option: mysqlbinlog +\fB\-\-read\-from\-remote\-server\fR, +\fB\-R\fR +.sp +Read the binary log from a MariaDB server rather than reading a local log file\&. Any connection parameter options are ignored unless this option is given as well\&. These options are +\fB\-\-host\fR, +\fB\-\-password\fR, +\fB\-\-port\fR, +\fB\-\-protocol\fR, +\fB\-\-socket\fR, and +\fB\-\-user\fR\&. +.sp +This option requires that the remote server be running\&. It works only for binary log files on the remote server, not relay log files\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlbinlog: result-file option +.\" result-file option: mysqlbinlog +\fB\-\-result\-file=\fR\fB\fIname\fR\fR, +\fB\-r \fR\fB\fIname\fR\fR +.sp +Direct output to the given file\&. With --raw this is a prefix for the file names\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlbinlog: rewrite-db option +.\" rewrite-db option: mysqlbinlog +\fB\-\-rewrite\-db=\fR\fB\fIname\fR\fR, +\fB\-r \fR\fB\fIname\fR\fR +.sp +Updates to a database with a different name than the original. +Example: \fBrewrite-db='from->to'\fR\&. For events that are +binlogged as statements, rewriting the database constitutes changing a +statement's default database from \fIdb1\fB to \fIdb2\fR\&. There is no statement +analysis or rewrite of any kind, that is, if one specifies \fB"db1.tbl"\fR +in the statement explicitly, that occurrence won't be changed to +\fB"db2.tbl"\fR\&. Row-based events are rewritten correctly to use the new +database name\&. Filtering (e.g. with \fB--database=name\fR) happens after +the database rewrites have been performed\&. If you use this option on the +command line and \fB">"\fR has a special meaning to your command interpreter, +quote the value (e.g. \fB--rewrite-db="oldname->newname"\fR\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlbinlog: server-id option +.\" server-id option: mysqlbinlog +\fB\-\-server\-id=\fR\fB\fIid\fR\fR +.sp +Display only those events created by the server having the given server ID\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlbinlog: set-charset option +.\" set-charset option: mysqlbinlog +\fB\-\-set\-charset=\fR\fB\fIcharset_name\fR\fR +.sp +Add a +SET NAMES \fIcharset_name\fR +statement to the output to specify the character set to be used for processing log files\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlbinlog: short-form option +.\" short-form option: mysqlbinlog +\fB\-\-short\-form\fR, +\fB\-s\fR +.sp +Display only the statements contained in the log, no extra info +and no row-based events\&. This is for testing only, and should +not be used in production systems. If you want to suppress +base64-output, consider using \fB--base64-output=never\fR instead\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlbinlog: socket option +.\" socket option: mysqlbinlog +\fB\-\-socket=\fR\fB\fIpath\fR\fR, +\fB\-S \fR\fB\fIpath\fR\fR +.sp +For connections to +localhost, the Unix socket file to use, or, on Windows, the name of the named pipe to use\&. +Forces --protocol=socket when specified on the command line without other connection properties; on Windows, forces --protocol=pipe\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlbinlog: start-datetime option +.\" start-datetime option: mysqlbinlog +\fB\-\-start\-datetime=\fR\fB\fIdatetime\fR\fR +.sp +Start reading the binary log at the first event having a timestamp equal to or later than the +\fIdatetime\fR +argument\&. The +\fIdatetime\fR +value is relative to the local time zone on the machine where you run +\fBmysqlbinlog\fR\&. The value should be in a format accepted for the +DATETIME +or +TIMESTAMP +data types\&. For example: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysqlbinlog \-\-start\-datetime="2014\-12\-25 11:25:56" binlog\&.000003\fR +.fi +.if n \{\ +.RE +.\} +.sp +This option is useful for point\-in\-time recovery\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlbinlog: start-position option +.\" start-position option: mysqlbinlog +\fB\-\-start\-position=\fR\fB\fIN\fR\fR, +\fB\-j \fR\fB\fIN\fR\fR +.sp +Start reading the binary log at \fIN\fR\&. Type can either be a positive +integer or a GTID\& list\&. When using a positive integer, the value only +applies to the first binlog passed on the command line, and the first event +that has a position equal to or greater than \fIN\fR is printed\&. In GTID mode, +multiple GTIDs can be passed as a comma separated list, where each must have a +unique domain id\&. The list represents the gtid binlog state that the client +(another "replica" server) is aware of\&. Therefore, each GTID is exclusive; only +events after a given sequence number will be printed to allow users to receive +events after their current state\&. +.sp +This option is useful for point\-in\-time recovery\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlbinlog: gtid-strict-mode +.\" gtid-strict-mode option: mysqlbinlog +\fB\-\-gtid\-strict\-mode +.sp +Process binlog according to gtid-strict-mode specification\&. The start, stop +positions are verified to satisfy start < stop comparison condition\&. Sequence +numbers of any gtid domain must comprise monotically growing sequence\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlbinlog: stop-datetime option +.\" stop-datetime option: mysqlbinlog +\fB\-\-stop\-datetime=\fR\fB\fIdatetime\fR\fR +.sp +Stop reading the binary log at the first event having a timestamp equal to or later than the +\fIdatetime\fR +argument\&. This option is useful for point\-in\-time recovery\&. See the description of the +\fB\-\-start\-datetime\fR +option for information about the +\fIdatetime\fR +value\&. +.sp +This option is useful for point\-in\-time recovery\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlbinlog: stop-never option +.\" stop-never option: mysqlbinlog +\fB\-\-stop\-never\fR +.sp +Wait for more data from the server instead of stopping at the end of the last log\&. Implies \fB--to-last-log\fR\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlbinlog: stop-never-slave-server-id option +.\" stop-never-slave-server-id option: mysqlbinlog +\fB\-\-stop\-never-slave-server-id\fR +.sp +The slave server_id used for \fB--read-from-remote-server --stop-never\fR\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlbinlog: stop-position option +.\" stop-position option: mysqlbinlog +\fB\-\-stop\-position=\fR\fB\fIN\fR\fR +.sp +Stop reading the binary log at the first event having a position equal to or +greater than \fIN\fR\&. Type can either be a positive integer or a GTID +list\&. When using a positive integer, the value only applies to the last log +file named on the command line\&. When in GTID mode, multiple GTIDs can be +passed as a comma separated list, where each must have a unique domain id\&. +Each GTID is inclusive; only events up to the given sequence numbers are +printed. +.sp +This option is useful for point\-in\-time recovery\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlbinlog: table option +.\" table option: mysqlbinlog +\fB\-\-table\fR, +\fB\-T\fR +.sp +List entries for just this table (local log only)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} + +.\" mysqlbinlog: to-last-log option +.\" to-last-log option: mysqlbinlog +\fB\-\-to\-last\-log\fR, +\fB\-t\fR +.sp +Do not stop at the end of the requested binary log from a MariaDB server, but rather continue printing until the end of the last binary log\&. If you send the output to the same MariaDB server, this may lead to an endless loop, so this option requires +\fB\-\-read\-from\-remote\-server\fR\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlbinlog: user option +.\" user option: mysqlbinlog +\fB\-\-user=\fR\fB\fIuser_name\fR\fR, +\fB\-u \fR\fB\fIuser_name\fR\fR +.sp +The MariaDB username to use when connecting to a remote server\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlbinlog: verbose option +.\" verbose option: mysqlbinlog +\fB\-\-verbose\fR, +\fB\-v\fR +.sp +Reconstruct row events and display them as commented SQL statements\&. If this option is given twice, the output includes comments to indicate column data types and some metadata\&. +If this option is given three times, the output includes diagnostic warnings about event integrity before program exit\&. +.sp +For examples that show the effect of +\fB\-\-base64\-output\fR +and +\fB\-\-verbose\fR +on row event output, see +the section called \(lqMYSQLBINLOG ROW EVENT DISPLAY\(rq\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlbinlog: version option +.\" version option: mysqlbinlog +\fB\-\-version\fR, +\fB\-V\fR +.sp +Display version information and exit\&. +.RE +.PP +You can also set the following variable by using +\fB\-\-\fR\fB\fIvar_name\fR\fR\fB=\fR\fB\fIvalue\fR\fR +syntax: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" open_files_limit variable +open_files_limit +.sp +Specify the number of open file descriptors to reserve\&. +.RE +.PP +You can pipe the output of +\fBmysqlbinlog\fR +into the +\fBmysql\fR +client to execute the events contained in the binary log\&. This technique is used to recover from a crash when you have an old +backup\&. For example: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysqlbinlog binlog\&.000001 | mysql \-u root \-p\fR +.fi +.if n \{\ +.RE +.\} +.PP +Or: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysqlbinlog binlog\&.[0\-9]* | mysql \-u root \-p\fR +.fi +.if n \{\ +.RE +.\} +.PP +You can also redirect the output of +\fBmysqlbinlog\fR +to a text file instead, if you need to modify the statement log first (for example, to remove statements that you do not want to execute for some reason)\&. After editing the file, execute the statements that it contains by using it as input to the +\fBmysql\fR +program: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysqlbinlog binlog\&.000001 > tmpfile\fR +shell> \&.\&.\&. \fIedit tmpfile\fR \&.\&.\&. +shell> \fBmysql \-u root \-p < tmpfile\fR +.fi +.if n \{\ +.RE +.\} +.PP +When +\fBmysqlbinlog\fR +is invoked with the +\fB\-\-start\-position\fR +option, it displays only those events with an offset in the binary log greater than or equal to a given position (the given position must match the start of one event)\&. It also has options to stop and start when it sees an event with a given date and time\&. This enables you to perform point\-in\-time recovery using the +\fB\-\-stop\-datetime\fR +option (to be able to say, for example, +\(lqroll forward my databases to how they were today at 10:30 a\&.m\&.\(rq)\&. +.PP +If you have more than one binary log to execute on the MariaDB server, the safe method is to process them all using a single connection to the server\&. Here is an example that demonstrates what may be +\fIunsafe\fR: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysqlbinlog binlog\&.000001 | mysql \-u root \-p # DANGER!!\fR +shell> \fBmysqlbinlog binlog\&.000002 | mysql \-u root \-p # DANGER!!\fR +.fi +.if n \{\ +.RE +.\} +.PP +Processing binary logs this way using different connections to the server causes problems if the first log file contains a +CREATE TEMPORARY TABLE +statement and the second log contains a statement that uses the temporary table\&. When the first +\fBmysql\fR +process terminates, the server drops the temporary table\&. When the second +\fBmysql\fR +process attempts to use the table, the server reports +\(lqunknown table\&.\(rq +.PP +To avoid problems like this, use a +\fIsingle\fR +\fBmysql\fR +process to execute the contents of all binary logs that you want to process\&. Here is one way to do so: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysqlbinlog binlog\&.000001 binlog\&.000002 | mysql \-u root \-p\fR +.fi +.if n \{\ +.RE +.\} +.PP +Another approach is to write all the logs to a single file and then process the file: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysqlbinlog binlog\&.000001 > /tmp/statements\&.sql\fR +shell> \fBmysqlbinlog binlog\&.000002 >> /tmp/statements\&.sql\fR +shell> \fBmysql \-u root \-p \-e "source /tmp/statements\&.sql"\fR +.fi +.if n \{\ +.RE +.\} +.PP +\fBmysqlbinlog\fR +can produce output that reproduces a +LOAD DATA INFILE +operation without the original data file\&. +\fBmysqlbinlog\fR +copies the data to a temporary file and writes a +LOAD DATA LOCAL INFILE +statement that refers to the file\&. The default location of the directory where these files are written is system\-specific\&. To specify a directory explicitly, use the +\fB\-\-local\-load\fR +option\&. +.PP +Because +\fBmysqlbinlog\fR +converts +LOAD DATA INFILE +statements to +LOAD DATA LOCAL INFILE +statements (that is, it adds +LOCAL), both the client and the server that you use to process the statements must be configured with the +LOCAL +capability enabled\&. +.if n \{\ +.sp +.\} +.RS 4 +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.ps +1 +\fBWarning\fR +.ps -1 +.br +.PP +The temporary files created for +LOAD DATA LOCAL +statements are +\fInot\fR +automatically deleted because they are needed until you actually execute those statements\&. You should delete the temporary files yourself after you no longer need the statement log\&. The files can be found in the temporary file directory and have names like +\fIoriginal_file_name\-#\-#\fR\&. +.sp .5v +.RE +.SH "MYSQLBINLOG HEX DUMP FORMAT" +.PP +The +\fB\-\-hexdump\fR +option causes +\fBmysqlbinlog\fR +to produce a hex dump of the binary log contents: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysqlbinlog \-\-hexdump master\-bin\&.000001\fR +.fi +.if n \{\ +.RE +.\} +.PP +The hex output consists of comment lines beginning with +#, so the output might look like this for the preceding command: +.sp +.if n \{\ +.RS 4 +.\} +.nf +/*!40019 SET @@session\&.max_delayed_threads=0*/; +/*!50003 SET @OLD_COMPLETION_TYPE=@@COMPLETION_TYPE,COMPLETION_TYPE=0*/; +# at 4 +#051024 17:24:13 server id 1 end_log_pos 98 +# Position Timestamp Type Master ID Size Master Pos Flags +# 00000004 9d fc 5c 43 0f 01 00 00 00 5e 00 00 00 62 00 00 00 00 00 +# 00000017 04 00 35 2e 30 2e 31 35 2d 64 65 62 75 67 2d 6c |\&.\&.5\&.0\&.15\&.debug\&.l| +# 00000027 6f 67 00 00 00 00 00 00 00 00 00 00 00 00 00 00 |og\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.| +# 00000037 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 |\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.| +# 00000047 00 00 00 00 9d fc 5c 43 13 38 0d 00 08 00 12 00 |\&.\&.\&.\&.\&.\&.\&.C\&.8\&.\&.\&.\&.\&.\&.| +# 00000057 04 04 04 04 12 00 00 4b 00 04 1a |\&.\&.\&.\&.\&.\&.\&.K\&.\&.\&.| +# Start: binlog v 4, server v 5\&.0\&.15\-debug\-log created 051024 17:24:13 +# at startup +ROLLBACK; +.fi +.if n \{\ +.RE +.\} +.PP +Hex dump output currently contains the elements in the following list\&. This format is subject to change\&. (For more information about binary log format, see +\m[blue]\fB\%http://forge.mysql.com/wiki/MySQL_Internals_Binary_Log\fR\m[]\&.) +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Position: The byte position within the log file\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Timestamp: The event timestamp\&. In the example shown, '9d fc 5c 43' +is the representation of '051024 17:24:13' in hexadecimal\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Type: The event type code\&. In the example shown, '0f' indicates a +FORMAT_DESCRIPTION_EVENT\&. The following table lists the possible type codes\&. +.TS +allbox tab(:); +l l lx. +T{ +Type +T}:T{ +Name +T}:T{ +Meaning +T} +T{ +00 +T}:T{ +UNKNOWN_EVENT +T}:T{ +This event should never be present in the log\&. +T} +T{ +01 +T}:T{ +START_EVENT_V3 +T}:T{ +This indicates the start of a log file written by MySQL 4 or earlier\&. +T} +T{ +02 +T}:T{ +QUERY_EVENT +T}:T{ +The most common type of events\&. These contain statements executed on the +master\&. +T} +T{ +03 +T}:T{ +STOP_EVENT +T}:T{ +Indicates that master has stopped\&. +T} +T{ +04 +T}:T{ +ROTATE_EVENT +T}:T{ +Written when the master switches to a new log file\&. +T} +T{ +05 +T}:T{ +INTVAR_EVENT +T}:T{ +Used for AUTO_INCREMENT values or when the +LAST_INSERT_ID() +function is used in the statement\&. +T} +T{ +06 +T}:T{ +LOAD_EVENT +T}:T{ +Used for LOAD DATA +INFILE in MySQL 3\&.23\&. +T} +T{ +07 +T}:T{ +SLAVE_EVENT +T}:T{ +Reserved for future use\&. +T} +T{ +08 +T}:T{ +CREATE_FILE_EVENT +T}:T{ +Used for LOAD DATA +INFILE statements\&. This indicates the +start of execution of such a statement\&. A temporary +file is created on the slave\&. Used in MySQL 4 only\&. +T} +T{ +09 +T}:T{ +APPEND_BLOCK_EVENT +T}:T{ +Contains data for use in a +LOAD DATA +INFILE statement\&. The data is stored in +the temporary file on the slave\&. +T} +T{ +0a +T}:T{ +EXEC_LOAD_EVENT +T}:T{ +Used for LOAD DATA +INFILE statements\&. The contents of the +temporary file is stored in the table on the slave\&. +Used in MySQL 4 only\&. +T} +T{ +0b +T}:T{ +DELETE_FILE_EVENT +T}:T{ +Rollback of a LOAD DATA +INFILE statement\&. The temporary file +should be deleted on the slave\&. +T} +T{ +0c +T}:T{ +NEW_LOAD_EVENT +T}:T{ +Used for LOAD DATA +INFILE in MySQL 4 and earlier\&. +T} +T{ +0d +T}:T{ +RAND_EVENT +T}:T{ +Used to send information about random values if the +RAND() function is +used in the statement\&. +T} +T{ +0e +T}:T{ +USER_VAR_EVENT +T}:T{ +Used to replicate user variables\&. +T} +T{ +0f +T}:T{ +.nf +FORMAT_DESCRIPTION_EVENT +T}:T{ +This indicates the start of a log file written by MySQL 5 or later\&. +T} +T{ +10 +T}:T{ +XID_EVENT +T}:T{ +Event indicating commit of an XA transaction\&. +T} +T{ +11 +T}:T{ +BEGIN_LOAD_QUERY_EVENT +T}:T{ +Used for LOAD DATA +INFILE statements in MySQL 5 and later\&. +T} +T{ +12 +T}:T{ +EXECUTE_LOAD_QUERY_EVENT +T}:T{ +Used for LOAD DATA +INFILE statements in MySQL 5 and later\&. +T} +T{ +13 +T}:T{ +TABLE_MAP_EVENT +T}:T{ +Information about a table definition\&. Used in MySQL 5\&.1\&.5 and later\&. +T} +T{ +14 +T}:T{ +PRE_GA_WRITE_ROWS_EVENT +T}:T{ +Row data for a single table that should be created\&. Used in MySQL 5\&.1\&.5 +to 5\&.1\&.17\&. +T} +T{ +15 +T}:T{ +PRE_GA_UPDATE_ROWS_EVENT +T}:T{ +Row data for a single table that needs to be updated\&. Used in MySQL +5\&.1\&.5 to 5\&.1\&.17\&. +T} +T{ +16 +T}:T{ +PRE_GA_DELETE_ROWS_EVENT +T}:T{ +Row data for a single table that should be deleted\&. Used in MySQL 5\&.1\&.5 +to 5\&.1\&.17\&. +T} +T{ +17 +T}:T{ +WRITE_ROWS_EVENT +T}:T{ +Row data for a single table that should be created\&. Used in MySQL 5\&.1\&.18 +and later\&. +T} +T{ +18 +T}:T{ +UPDATE_ROWS_EVENT +T}:T{ +Row data for a single table that needs to be updated\&. Used in MySQL +5\&.1\&.18 and later\&. +T} +T{ +19 +T}:T{ +DELETE_ROWS_EVENT +T}:T{ +Row data for a single table that should be deleted\&. Used in MySQL 5\&.1\&.18 +and later\&. +T} +T{ +1a +T}:T{ +INCIDENT_EVENT +T}:T{ +Something out of the ordinary happened\&. Added in MySQL 5\&.1\&.18\&. +T} +.TE +.sp 1 +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Master ID: The server ID of the master that created the event\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Size: The size in bytes of the event\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Master Pos: The position of the next event in the original master log file\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Flags: 16 flags\&. Currently, the following flags are used\&. The others are reserved for future use\&. +.TS +allbox tab(:); +l l lx. +T{ +Flag +T}:T{ +Name +T}:T{ +Meaning +T} +T{ +01 +T}:T{ +.nf +LOG_EVENT_BINLOG_IN_USE_F +T}:T{ +Log file correctly closed\&. (Used only in FORMAT_DESCRIPTION_EVENT\&.) If this +flag is set (if the flags are, for example, '01 00') in a +FORMAT_DESCRIPTION_EVENT, the log file has not been properly closed\&. Most +probably this is because of a master crash (for example, due to power +failure)\&. +T} +T{ +02 +T}:T{ +\ \& +T}:T{ +Reserved for future use\&. +T} +T{ +04 +T}:T{ +.nf +LOG_EVENT_THREAD_SPECIFIC_F +T}:T{ +Set if the event is dependent on the connection it was executed in (for +example, '04 00'), for example, +if the event uses temporary tables\&. +T} +T{ +08 +T}:T{ +LOG_EVENT_SUPPRESS_USE_F +T}:T{ +Set in some circumstances when the event is not dependent on the default +database\&. +T} +.TE +.sp 1 +.RE +.SH "MYSQLBINLOG ROW EVENT DISPLAY" +.\" BINLOG statement: mysqlbinlog output +.PP +The following examples illustrate how +\fBmysqlbinlog\fR +displays row events that specify data modifications\&. These correspond to events with the +WRITE_ROWS_EVENT, +UPDATE_ROWS_EVENT, and +DELETE_ROWS_EVENT +type codes\&. The +\fB\-\-base64\-output=DECODE\-ROWS\fR +and +\fB\-\-verbose\fR +options may be used to affect row event output\&. +.PP +Suppose that the server is using row\-based binary logging and that you execute the following sequence of statements: +.sp +.if n \{\ +.RS 4 +.\} +.nf +CREATE TABLE t +( + id INT NOT NULL, + name VARCHAR(20) NOT NULL, + date DATE NULL +) ENGINE = InnoDB; +START TRANSACTION; +INSERT INTO t VALUES(1, 'apple', NULL); +UPDATE t SET name = 'pear', date = '2009\-01\-01' WHERE id = 1; +DELETE FROM t WHERE id = 1; +COMMIT; +.fi +.if n \{\ +.RE +.\} +.PP +By default, +\fBmysqlbinlog\fR +displays row events encoded as base\-64 strings using +BINLOG +statements\&. Omitting extraneous lines, the output for the row events produced by the preceding statement sequence looks like this: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysqlbinlog \fR\fB\fIlog_file\fR\fR +\&.\&.\&. +# at 218 +#080828 15:03:08 server id 1 end_log_pos 258 Write_rows: table id 17 flags: STMT_END_F +BINLOG 'fAS3SBMBAAAALAAAANoAAAAAABEAAAAAAAAABHRlc3QAAXQAAwMPCgIUAAQ= +fAS3SBcBAAAAKAAAAAIBAAAQABEAAAAAAAEAA//8AQAAAAVhcHBsZQ=='/*!*/; +\&.\&.\&. +# at 302 +#080828 15:03:08 server id 1 end_log_pos 356 Update_rows: table id 17 flags: STMT_END_F +BINLOG 'fAS3SBMBAAAALAAAAC4BAAAAABEAAAAAAAAABHRlc3QAAXQAAwMPCgIUAAQ= +fAS3SBgBAAAANgAAAGQBAAAQABEAAAAAAAEAA////AEAAAAFYXBwbGX4AQAAAARwZWFyIbIP'/*!*/; +\&.\&.\&. +# at 400 +#080828 15:03:08 server id 1 end_log_pos 442 Delete_rows: table id 17 flags: STMT_END_F +BINLOG 'fAS3SBMBAAAALAAAAJABAAAAABEAAAAAAAAABHRlc3QAAXQAAwMPCgIUAAQ= +fAS3SBkBAAAAKgAAALoBAAAQABEAAAAAAAEAA//4AQAAAARwZWFyIbIP'/*!*/; +.fi +.if n \{\ +.RE +.\} +.PP +To see the row events as comments in the form of +\(lqpseudo\-SQL\(rq +statements, run +\fBmysqlbinlog\fR +with the +\fB\-\-verbose\fR +or +\fB\-v\fR +option\&. The output will contain lines beginning with +###: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysqlbinlog \-v \fR\fB\fIlog_file\fR\fR +\&.\&.\&. +# at 218 +#080828 15:03:08 server id 1 end_log_pos 258 Write_rows: table id 17 flags: STMT_END_F +BINLOG 'fAS3SBMBAAAALAAAANoAAAAAABEAAAAAAAAABHRlc3QAAXQAAwMPCgIUAAQ= +fAS3SBcBAAAAKAAAAAIBAAAQABEAAAAAAAEAA//8AQAAAAVhcHBsZQ=='/*!*/; +### INSERT INTO test\&.t +### SET +### @1=1 +### @2='apple' +### @3=NULL +\&.\&.\&. +# at 302 +#080828 15:03:08 server id 1 end_log_pos 356 Update_rows: table id 17 flags: STMT_END_F +BINLOG 'fAS3SBMBAAAALAAAAC4BAAAAABEAAAAAAAAABHRlc3QAAXQAAwMPCgIUAAQ= +fAS3SBgBAAAANgAAAGQBAAAQABEAAAAAAAEAA////AEAAAAFYXBwbGX4AQAAAARwZWFyIbIP'/*!*/; +### UPDATE test\&.t +### WHERE +### @1=1 +### @2='apple' +### @3=NULL +### SET +### @1=1 +### @2='pear' +### @3='2009:01:01' +\&.\&.\&. +# at 400 +#080828 15:03:08 server id 1 end_log_pos 442 Delete_rows: table id 17 flags: STMT_END_F +BINLOG 'fAS3SBMBAAAALAAAAJABAAAAABEAAAAAAAAABHRlc3QAAXQAAwMPCgIUAAQ= +fAS3SBkBAAAAKgAAALoBAAAQABEAAAAAAAEAA//4AQAAAARwZWFyIbIP'/*!*/; +### DELETE FROM test\&.t +### WHERE +### @1=1 +### @2='pear' +### @3='2009:01:01' +.fi +.if n \{\ +.RE +.\} +.PP +Specify +\fB\-\-verbose\fR +or +\fB\-v\fR +twice to also display data types and some metadata for each column\&. The output will contain an additional comment following each column change: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysqlbinlog \-vv \fR\fB\fIlog_file\fR\fR +\&.\&.\&. +# at 218 +#080828 15:03:08 server id 1 end_log_pos 258 Write_rows: table id 17 flags: STMT_END_F +BINLOG 'fAS3SBMBAAAALAAAANoAAAAAABEAAAAAAAAABHRlc3QAAXQAAwMPCgIUAAQ= +fAS3SBcBAAAAKAAAAAIBAAAQABEAAAAAAAEAA//8AQAAAAVhcHBsZQ=='/*!*/; +### INSERT INTO test\&.t +### SET +### @1=1 /* INT meta=0 nullable=0 is_null=0 */ +### @2='apple' /* VARSTRING(20) meta=20 nullable=0 is_null=0 */ +### @3=NULL /* VARSTRING(20) meta=0 nullable=1 is_null=1 */ +\&.\&.\&. +# at 302 +#080828 15:03:08 server id 1 end_log_pos 356 Update_rows: table id 17 flags: STMT_END_F +BINLOG 'fAS3SBMBAAAALAAAAC4BAAAAABEAAAAAAAAABHRlc3QAAXQAAwMPCgIUAAQ= +fAS3SBgBAAAANgAAAGQBAAAQABEAAAAAAAEAA////AEAAAAFYXBwbGX4AQAAAARwZWFyIbIP'/*!*/; +### UPDATE test\&.t +### WHERE +### @1=1 /* INT meta=0 nullable=0 is_null=0 */ +### @2='apple' /* VARSTRING(20) meta=20 nullable=0 is_null=0 */ +### @3=NULL /* VARSTRING(20) meta=0 nullable=1 is_null=1 */ +### SET +### @1=1 /* INT meta=0 nullable=0 is_null=0 */ +### @2='pear' /* VARSTRING(20) meta=20 nullable=0 is_null=0 */ +### @3='2009:01:01' /* DATE meta=0 nullable=1 is_null=0 */ +\&.\&.\&. +# at 400 +#080828 15:03:08 server id 1 end_log_pos 442 Delete_rows: table id 17 flags: STMT_END_F +BINLOG 'fAS3SBMBAAAALAAAAJABAAAAABEAAAAAAAAABHRlc3QAAXQAAwMPCgIUAAQ= +fAS3SBkBAAAAKgAAALoBAAAQABEAAAAAAAEAA//4AQAAAARwZWFyIbIP'/*!*/; +### DELETE FROM test\&.t +### WHERE +### @1=1 /* INT meta=0 nullable=0 is_null=0 */ +### @2='pear' /* VARSTRING(20) meta=20 nullable=0 is_null=0 */ +### @3='2009:01:01' /* DATE meta=0 nullable=1 is_null=0 */ +.fi +.if n \{\ +.RE +.\} +.PP +You can tell +\fBmysqlbinlog\fR +to suppress the +BINLOG +statements for row events by using the +\fB\-\-base64\-output=DECODE\-ROWS\fR +option\&. This is similar to +\fB\-\-base64\-output=NEVER\fR +but does not exit with an error if a row event is found\&. The combination of +\fB\-\-base64\-output=DECODE\-ROWS\fR +and +\fB\-\-verbose\fR +provides a convenient way to see row events only as SQL statements: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysqlbinlog \-v \-\-base64\-output=DECODE\-ROWS \fR\fB\fIlog_file\fR\fR +\&.\&.\&. +# at 218 +#080828 15:03:08 server id 1 end_log_pos 258 Write_rows: table id 17 flags: STMT_END_F +### INSERT INTO test\&.t +### SET +### @1=1 +### @2='apple' +### @3=NULL +\&.\&.\&. +# at 302 +#080828 15:03:08 server id 1 end_log_pos 356 Update_rows: table id 17 flags: STMT_END_F +### UPDATE test\&.t +### WHERE +### @1=1 +### @2='apple' +### @3=NULL +### SET +### @1=1 +### @2='pear' +### @3='2009:01:01' +\&.\&.\&. +# at 400 +#080828 15:03:08 server id 1 end_log_pos 442 Delete_rows: table id 17 flags: STMT_END_F +### DELETE FROM test\&.t +### WHERE +### @1=1 +### @2='pear' +### @3='2009:01:01' +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.sp +.\} +.RS 4 +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.ps +1 +\fBNote\fR +.ps -1 +.br +.PP +You should not suppress +BINLOG +statements if you intend to re\-execute +\fBmysqlbinlog\fR +output\&. +.sp .5v +.RE +.PP +The SQL statements produced by +\fB\-\-verbose\fR +for row events are much more readable than the corresponding +BINLOG +statements\&. However, they do not correspond exactly to the original SQL statements that generated the events\&. The following limitations apply: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +The original column names are lost and replaced by +@\fIN\fR, where +\fIN\fR +is a column number\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Character set information is not available in the binary log, which affects string column display: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +There is no distinction made between corresponding binary and nonbinary string types (BINARY +and +CHAR, +VARBINARY +and +VARCHAR, +BLOB +and +TEXT)\&. The output uses a data type of +STRING +for fixed\-length strings and +VARSTRING +for variable\-length strings\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +For multi\-byte character sets, the maximum number of bytes per character is not present in the binary log, so the length for string types is displayed in bytes rather than in characters\&. For example, +STRING(4) +will be used as the data type for values from either of these column types: +.sp +.if n \{\ +.RS 4 +.\} +.nf +CHAR(4) CHARACTER SET latin1 +CHAR(2) CHARACTER SET ucs2 +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Due to the storage format for events of type +UPDATE_ROWS_EVENT, +UPDATE +statements are displayed with the +WHERE +clause preceding the +SET +clause\&. +.RE +.RE +.PP +Proper interpretation of row events requires the information from the format description event at the beginning of the binary log\&. Because +\fBmysqlbinlog\fR +does not know in advance whether the rest of the log contains row events, by default it displays the format description event using a +BINLOG +statement in the initial part of the output\&. +.PP +If the binary log is known not to contain any events requiring a +BINLOG +statement (that is, no row events), the +\fB\-\-base64\-output=NEVER\fR +option can be used to prevent this header from being written\&. +.SH "COPYRIGHT" +.br +.PP +Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc., 2010-2021 MariaDB Foundation +.PP +This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License. +.PP +This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. +.PP +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-1335 USA or see http://www.gnu.org/licenses/. +.sp +.SH "NOTES" +.IP " 1." 4 +Bug#42941 +.RS 4 +\%http://bugs.mysql.com/bug.php?id=42941 +.RE +.SH "SEE ALSO" +For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/ +.SH AUTHOR +MariaDB Foundation (http://www.mariadb.org/). diff --git a/man/mysqlcheck.1 b/man/mysqlcheck.1 new file mode 100644 index 00000000..6191e933 --- /dev/null +++ b/man/mysqlcheck.1 @@ -0,0 +1,1157 @@ +'\" t +.\" +.TH "\fBMARIADB-CHECK\fR" "1" "15 May 2020" "MariaDB 10.11" "MariaDB Database System" +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.\" mysqlcheck +.\" maintenance: tables +.\" repair: tables +.\" tables: maintenance +.\" tables: repair +.SH "NAME" +mariadb-check \- a table maintenance program (mysqlcheck is now a symlink to mariadb-check) +.SH "SYNOPSIS" +.HP \w'\fBmysqlcheck\ [\fR\fB\fIoptions\fR\fR\fB]\ [\fR\fB\fIdb_name\fR\fR\fB\ [\fR\fB\fItbl_name\fR\fR\fB\ \&.\&.\&.]]\fR\ 'u +\fBmysqlcheck [\fR\fB\fIoptions\fR\fR\fB] [\fR\fB\fIdb_name\fR\fR\fB [\fR\fB\fItbl_name\fR\fR\fB \&.\&.\&.]]\fR +.SH "DESCRIPTION" +.PP +The +\fBmysqlcheck\fR +client performs table maintenance: It checks, repairs, optimizes, or analyzes tables\&. +.PP +Each table is locked and therefore unavailable to other sessions while it is being processed, although for check operations, the table is locked with a +READ +lock only\&. Table maintenance operations can be time\-consuming, particularly for large tables\&. If you use the +\fB\-\-databases\fR +or +\fB\-\-all\-databases\fR +option to process all tables in one or more databases, an invocation of +\fBmysqlcheck\fR +might take a long time\&. (This is also true for +\fBmysql_upgrade\fR +because that program invokes +\fBmysqlcheck\fR +to check all tables and repair them if necessary\&.) +.PP +\fBmysqlcheck\fR +is similar in function to +\fBmyisamchk\fR, but works differently\&. The main operational difference is that +\fBmysqlcheck\fR +must be used when the +\fBmysqld\fR +server is running, whereas +\fBmyisamchk\fR +should be used when it is not\&. The benefit of using +\fBmysqlcheck\fR +is that you do not have to stop the server to perform table maintenance\&. +.PP +\fBmysqlcheck\fR +uses the SQL statements +CHECK TABLE, +REPAIR TABLE, +ANALYZE TABLE, and +OPTIMIZE TABLE +in a convenient way for the user\&. It determines which statements to use for the operation you want to perform, and then sends the statements to the server to be executed\&. +.PP +The +MyISAM +storage engine supports all four maintenance operations, so +\fBmysqlcheck\fR +can be used to perform any of them on +MyISAM +tables\&. Other storage engines do not necessarily support all operations\&. In such cases, an error message is displayed\&. For example, if +test\&.t +is a +MEMORY +table, an attempt to check it produces this result: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysqlcheck test t\fR +test\&.t +note : The storage engine for the table doesn't support check +.fi +.if n \{\ +.RE +.\} +.PP +If +\fBmysqlcheck\fR +is unable to repair a table, see the MariaDB Knowledge Base +for manual table repair strategies\&. This will be the case, for example, for +InnoDB +tables, which can be checked with +CHECK TABLE, but not repaired with +REPAIR TABLE\&. +.PP +The use of +\fBmysqlcheck\fR +with partitioned tables is not supported\&. +.if n \{\ +.sp +.\} +.RS 4 +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.ps +1 +\fBCaution\fR +.ps -1 +.br +.PP +It is best to make a backup of a table before performing a table repair operation; under some circumstances the operation might cause data loss\&. Possible causes include but are not limited to file system errors\&. +.sp .5v +.RE +.PP +There are three general ways to invoke +\fBmysqlcheck\fR: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysqlcheck [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fIdb_name\fR\fR\fB [\fR\fB\fItbl_name\fR\fR\fB \&.\&.\&.]\fR +shell> \fBmysqlcheck [\fR\fB\fIoptions\fR\fR\fB] \-\-databases \fR\fB\fIdb_name\fR\fR\fB \&.\&.\&.\fR +shell> \fBmysqlcheck [\fR\fB\fIoptions\fR\fR\fB] \-\-all\-databases\fR +.fi +.if n \{\ +.RE +.\} +.PP +If you do not name any tables following +\fIdb_name\fR +or if you use the +\fB\-\-databases\fR +or +\fB\-\-all\-databases\fR +option, entire databases are checked\&. +.PP +\fBmysqlcheck\fR +has a special feature compared to other client programs\&. The default behavior of checking tables (\fB\-\-check\fR) can be changed by renaming the binary\&. If you want to have a tool that repairs tables by default, you should just make a copy of +\fBmysqlcheck\fR +named +\fBmysqlrepair\fR, or make a symbolic link to +\fBmysqlcheck\fR +named +\fBmysqlrepair\fR\&. If you invoke +\fBmysqlrepair\fR, it repairs tables\&. +.PP +The following names can be used to change +\fBmysqlcheck\fR +default behavior\&. +.TS +allbox tab(:); +l l +l l +l l. +T{ +\fBmysqlrepair\fR +T}:T{ +The default option is \fB\-\-repair\fR +T} +T{ +\fBmysqlanalyze\fR +T}:T{ +The default option is \fB\-\-analyze\fR +T} +T{ +\fBmysqloptimize\fR +T}:T{ +The default option is \fB\-\-optimize\fR +T} +.TE +.sp 1 +.PP +\fBmysqlcheck\fR +supports the following options, which can be specified on the command line or in the +[mysqlcheck] +and +[client] +option file groups\&. +The \fB-c\fR, \fB-r\fR, \fB-a\fR and \fB-o\fR options are exclusive to each other\&. +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlcheck: help option +.\" help option: mysqlcheck +\fB\-\-help\fR, +\fB\-?\fR +.sp +Display a help message and exit\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlcheck: all-databases option +.\" all-databases option: mysqlcheck +\fB\-\-all\-databases\fR, +\fB\-A\fR +.sp +Check all tables in all databases\&. This is the same as using the +\fB\-\-databases\fR +option and naming all the databases on the command line\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlcheck: all-in-1 option +.\" all-in-1 option: mysqlcheck +\fB\-\-all\-in\-1\fR, +\fB\-1\fR +.sp +Instead of issuing a statement for each table, execute a single statement for each database that names all the tables from that database to be processed\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlcheck: analyze option +.\" analyze option: mysqlcheck +\fB\-\-analyze\fR, +\fB\-a\fR +.sp +Analyze the tables\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlcheck: auto-repair option +.\" auto-repair option: mysqlcheck +\fB\-\-auto\-repair\fR +.sp +If a checked table is corrupted, automatically fix it\&. Any necessary repairs are done after all tables have been checked\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlcheck: character-sets-dir option +.\" character-sets-dir option: mysqlcheck +\fB\-\-character\-sets\-dir=\fR\fB\fIpath\fR\fR +.sp +The directory where character sets are installed\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlcheck: check option +.\" check option: mysqlcheck +\fB\-\-check\fR, +\fB\-c\fR +.sp +Check the tables for errors\&. This is the default operation\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlcheck: check-only-changed option +.\" check-only-changed option: mysqlcheck +\fB\-\-check\-only\-changed\fR, +\fB\-C\fR +.sp +Check only tables that have changed since the last check or that have not been closed properly\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlcheck: check-upgrade option +.\" check-upgrade option: mysqlcheck +\fB\-\-check\-upgrade\fR, +\fB\-g\fR +.sp +Invoke +CHECK TABLE +with the +FOR UPGRADE +option to check tables for incompatibilities with the current version of the server\&. This option automatically enables the +\fB\-\-fix\-db\-names\fR +and +\fB\-\-fix\-table\-names\fR +options\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlcheck: compress option +.\" compress option: mysqlcheck +\fB\-\-compress\fR +.sp +Compress all information sent between the client and the server if both support compression\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlcheck: databases option +.\" databases option: mysqlcheck +\fB\-\-databases\fR, +\fB\-B\fR +.sp +Process all tables in the named databases\&. Normally, +\fBmysqlcheck\fR +treats the first name argument on the command line as a database name and following names as table names\&. With this option, it treats all name arguments as database names\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlcheck: debug option +.\" debug option: mysqlcheck +\fB\-\-debug[=\fR\fB\fIdebug_options\fR\fR\fB]\fR, +\fB\-# [\fR\fB\fIdebug_options\fR\fR\fB]\fR +.sp +Write a debugging log\&. A typical +\fIdebug_options\fR +string is 'd:t:o,\fIfile_name\fR'. The default is 'd:t:o'. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlcheck: debug-check option +.\" debug-check option: mysqlcheck +\fB\-\-debug\-check\fR +.sp +Print some debugging information when the program exits\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlcheck: debug-info option +.\" debug-info option: mysqlcheck +\fB\-\-debug\-info\fR +.sp +Print debugging information and memory and CPU usage statistics when the program exits\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlcheck: default-auth option +.\" default-auth option: mysqlcheck +\fB\-\-default\-auth=\fR\fB\fIname\fR\fR +.sp +Default authentication client-side plugin to use\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlcheck: default-character-set option +.\" default-character-set option: mysqlcheck +\fB\-\-default\-character\-set=\fR\fB\fIcharset_name\fR\fR +.sp +Use +\fIcharset_name\fR +as the default character set\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlcheck: defaults-extra-file option +.\" defaults-extra-file option: mysqlcheck +\fB\-\-defaults\-extra\-file=\fR\fB\fIfilename\fR\fR +.sp +Set \fB\fIfilename\fR\fR as the file to read default options from after the global defaults files has been read\&. +Must be given as first option\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlcheck: defaults-file option +.\" defaults-file option: mysqlcheck +\fB\-\-defaults\-file=\fR\fB\fIfilename\fR\fR +.sp +Set \fB\fIfilename\fR\fR as the file to read default options from, override global defaults files\&. +Must be given as first option\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlcheck: extended option +.\" extended option: mysqlcheck +\fB\-\-extended\fR, +\fB\-e\fR +.sp +If you are using this option to check tables, it ensures that they are 100% consistent but takes a long time\&. +.sp +If you are using this option to repair tables, it will force using the old, slow, repair with keycache method, +instead of the much faster repair by sorting. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlcheck: fast option +.\" fast option: mysqlcheck +\fB\-\-fast\fR, +\fB\-F\fR +.sp +Check only tables that have not been closed properly\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlcheck: fix-db-names option +.\" fix-db-names option: mysqlcheck +\fB\-\-fix\-db\-names\fR +.sp +Convert database names to the format used since MySQL 5\&.1\&. Only database names that contain special characters are affected\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlcheck: fix-table-names option +.\" fix-table-names option: mysqlcheck +\fB\-\-fix\-table\-names\fR +.sp +Convert table names (including views) to the format used since MySQL 5\&.1\&. Only table names that contain special characters are affected\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlcheck: flush option +.\" flush option: mysqlcheck +\fB\-\-flush\fR, +.sp +Flush each table after check. This is useful if you don't +want to have the checked tables take up space in the caches after the check\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlcheck: force option +.\" force option: mysqlcheck +\fB\-\-force\fR, +\fB\-f\fR +.sp +Continue even if an SQL error occurs\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlcheck: host option +.\" host option: mysqlcheck +\fB\-\-host=\fR\fB\fIhost_name\fR\fR, +\fB\-h \fR\fB\fIhost_name\fR\fR +.sp +Connect to the MariaDB server on the given host\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlcheck: medium-check option +.\" medium-check option: mysqlcheck +\fB\-\-medium\-check\fR, +\fB\-m\fR +.sp +Do a check that is faster than an +\fB\-\-extended\fR +operation\&. This finds only 99\&.99% of all errors, which should be good enough in most cases\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlcheck: no-defaults option +.\" no-defaults option: mysqlcheck +\fB\-\-no\-defaults\fR +.sp +Do not read default options from any option file\&. This must be given as the first argument\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlcheck: optimize option +.\" optimize option: mysqlcheck +\fB\-\-optimize\fR, +\fB\-o\fR +.sp +Optimize the tables\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlcheck: password option +.\" password option: mysqlcheck +\fB\-\-password[=\fR\fB\fIpassword\fR\fR\fB]\fR, +\fB\-p[\fR\fB\fIpassword\fR\fR\fB]\fR +.sp +The password to use when connecting to the server\&. If you use the short option form (\fB\-p\fR), you +\fIcannot\fR +have a space between the option and the password\&. If you omit the +\fIpassword\fR +value following the +\fB\-\-password\fR +or +\fB\-p\fR +option on the command line, +\fBmysqlcheck\fR +prompts for one\&. +.sp +Specifying a password on the command line should be considered insecure\&. You can use an option file to avoid giving the password on the command line\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlcheck: persisent option +.\" persistent option: mysql +\fB\-\-persistent\fR, +\fB\-Z\fR +.sp +Used with ANALYZE TABLE to append the option PERSISENT FOR ALL. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlcheck: pipe option +.\" pipe option: mysql +\fB\-\-pipe\fR, +\fB\-W\fR +.sp +On Windows, connect to the server via a named pipe\&. This option applies only if the server supports named\-pipe connections\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlcheck: plugin-dir option +.\" plugin-dir option: mysqlcheck +\fB\-\-plugin\-dir=\fR\fB\fIname\fR\fR +.sp + Directory for client-side plugins\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlcheck: port option +.\" port option: mysqlcheck +\fB\-\-port=\fR\fB\fIport_num\fR\fR, +\fB\-P \fR\fB\fIport_num\fR\fR +.sp +The TCP/IP port number to use for the connection\&. +Forces --protocol=tcp when specified on the command line without other connection properties\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlcheck: print-defaults option +.\" print-defaults option: mysqlcheck +\fB\-\-print\-defaults\fR +.sp +Print the program argument list and exit\&. +This must be given as the first argument\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlcheck: process-tables option +.\" process-tables option: mysqlcheck +\fB\-\-process\-tables\fR +.sp +Perform the requested operation on tables. Defaults to on; use \fB--skip-process-tables\fR to disable\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlcheck: process-views option +.\" process-views option: mysqlcheck +\fB\-\-process\-views=\fB\fIval\fR +.sp +Perform the requested operation (only CHECK VIEW or REPAIR VIEW). Possible values are NO, YES (correct the checksum, if necessary, add the mariadb-version field), UPGRADE_FROM_MYSQL (same as YES and toggle the algorithm MERGE<->TEMPTABLE\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlcheck: protocol option +.\" protocol option: mysqlcheck +\fB\-\-protocol={TCP|SOCKET|PIPE|MEMORY}\fR +.sp +The connection protocol to use for connecting to the server\&. It is useful when the other connection parameters normally would cause a protocol to be used other than the one you want\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlcheck: quick option +.\" quick option: mysqlcheck +\fB\-\-quick\fR, +\fB\-q\fR +.sp +If you are using this option to check tables, it prevents the check from scanning the rows to check for incorrect links\&. This is the fastest check method\&. +.sp +If you are using this option to repair tables, it tries to repair only the index tree\&. This is the fastest repair method\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlcheck: repair option +.\" repair option: mysqlcheck +\fB\-\-repair\fR, +\fB\-r\fR +.sp +Perform a repair that can fix almost anything except unique keys that are not unique\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlcheck: silent option +.\" silent option: mysqlcheck +\fB\-\-silent\fR, +\fB\-s\fR +.sp +Silent mode\&. Print only error messages\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlcheck: skip-database option +.\" skip-database option: mysqlcheck +\fB\-\-skip\-database=\fB\fIdb_name\fR +.sp +Don't process the database (case-sensitive) specified as argument\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlcheck: socket option +.\" socket option: mysqlcheck +\fB\-\-socket=\fR\fB\fIpath\fR\fR, +\fB\-S \fR\fB\fIpath\fR\fR +.sp +For connections to +localhost, the Unix socket file to use, or, on Windows, the name of the named pipe to use\&. +Forces --protocol=socket when specified on the command line without other connection properties; on Windows, forces --protocol=pipe\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqladmin: SSL options +.\" SSL options: mysqladmin +\fB\-\-ssl\fR +.sp +Enable SSL for connection (automatically enabled with other flags). Disable with +\fB\-\-skip-ssl\fR\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqladmin: SSL CA option +.\" SSL CA option: mysqladmin +\fB\-\-ssl\-ca=\fIname\fR +.sp +CA file in PEM format (check OpenSSL docs, implies +\fB\-\-ssl\fR)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqladmin: SSL CA Path option +.\" SSL CA Path option: mysqladmin +\fB\-\-ssl\-capath=\fIname\fR +.sp +CA directory (check OpenSSL docs, implies +\fB\-\-ssl\fR)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqladmin: SSL Cert option +.\" SSL Cert option: mysqladmin +\fB\-\-ssl\-cert=\fIname\fR +.sp +X509 cert in PEM format (check OpenSSL docs, implies +\fB\-\-ssl\fR)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqladmin: SSL Cipher option +.\" SSL Cipher option: mysqladmin +\fB\-\-ssl\-cipher=\fIname\fR +.sp +SSL cipher to use (check OpenSSL docs, implies +\fB\-\-ssl\fR)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqladmin: SSL Key option +.\" SSL Key option: mysqladmin +\fB\-\-ssl\-key=\fIname\fR +.sp +X509 key in PEM format (check OpenSSL docs, implies +\fB\-\-ssl\fR)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqladmin: SSL Crl option +.\" SSL CRL option: mysqladmin +\fB\-\-ssl\-crl=\fIname\fR +.sp +Certificate revocation list (check OpenSSL docs, implies +\fB\-\-ssl\fR)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqladmin: SSL Crlpath option +.\" SSL Crlpath option: mysqladmin +\fB\-\-ssl\-crlpath=\fIname\fR +.sp +Certificate revocation list path (check OpenSSL docs, implies +\fB\-\-ssl\fR)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqladmin: SSL Verify Server Cert option +.\" SSL Verify Server Cert option: mysqladmin +\fB\-\-ssl\-verify\-server\-cert\fR +.sp +Verify server's "Common Name" in its cert against hostname used when connecting. This option is disabled by default\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlcheck: tables option +.\" tables option: mysqlcheck +\fB\-\-tables\fR +.sp +Override the +\fB\-\-databases\fR +or +\fB\-B\fR +option\&. All name arguments following the option are regarded as table names\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlcheck: use-frm option +.\" use-frm option: mysqlcheck +\fB\-\-use\-frm\fR +.sp +For repair operations on +MyISAM +tables, get the table structure from the +\&.frm +file so that the table can be repaired even if the +\&.MYI +header is corrupted\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlcheck: user option +.\" user option: mysqlcheck +\fB\-\-user=\fR\fB\fIuser_name\fR\fR, +\fB\-u \fR\fB\fIuser_name\fR\fR +.sp +The MariaDB user name to use when connecting to the server\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlcheck: verbose option +.\" verbose option: mysqlcheck +\fB\-\-verbose\fR, +\fB\-v\fR +.sp +Verbose mode\&. Print information about the various stages of program operation\&. +Using one \fB--verbose\fR option will give you more information about what mysqlcheck is +doing\&. +.sp +Using two \fB--verbose\fR options will also give you connection information\&. +.sp +Using it 3 times will print out all CHECK, RENAME and ALTER TABLE during +the check phase\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlcheck: version option +.\" version option: mysqlcheck +\fB\-\-version\fR, +\fB\-V\fR +.sp +Display version information and exit\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlcheck: write-binlog option +.\" write-binlog option: mysqlcheck +\fB\-\-write\-binlog\fR +.sp +This option is enabled by default, so that +ANALYZE TABLE, +OPTIMIZE TABLE, and +REPAIR TABLE +statements generated by +\fBmysqlcheck\fR +are written to the binary log\&. Use +\fB\-\-skip\-write\-binlog\fR +to cause +NO_WRITE_TO_BINLOG +to be added to the statements so that they are not logged\&. Use the +\fB\-\-skip\-write\-binlog\fR +when these statements should not be sent to replication slaves or run when using the binary logs for recovery from backup\&. +.RE +.SH "COPYRIGHT" +.br +.PP +Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc., 2010-2020 MariaDB Foundation +.PP +This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License. +.PP +This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. +.PP +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-1335 USA or see http://www.gnu.org/licenses/. +.sp +.SH "SEE ALSO" +For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/ +.SH AUTHOR +MariaDB Foundation (http://www.mariadb.org/). diff --git a/man/mysqld.8 b/man/mysqld.8 new file mode 100644 index 00000000..16280234 --- /dev/null +++ b/man/mysqld.8 @@ -0,0 +1,59 @@ +'\" t +.\" +.TH "\fBMARIADBD\fR" "8" "15 May 2020" "MariaDB 10.11" "MariaDB Database System" +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.\" mysqld: MariaDB server +.\" MariaDB server: mysqld +.SH "NAME" +mariadbd \- the MariaDB server (mysqld is now a symlink to mariadbd) +.SH "SYNOPSIS" +.HP \w'\fBmysqld\ [\fR\fB\fIoptions\fR\fR\fB]\fR\ 'u +\fBmysqld [\fR\fB\fIoptions\fR\fR\fB]\fR +.SH "DESCRIPTION" +.PP +\fBmysqld\fR, also known as MariaDB Server, is the main program that does most of the work in a MariaDB installation\&. MariaDB Server manages access to the MariaDB data directory that contains databases and tables\&. The data directory is also the default location for other information such as log files and status files\&. +.PP +When MariaDB server starts, it listens for network connections from client programs and manages access to databases on behalf of those clients\&. +.PP +The +\fBmysqld\fR +program has many options that can be specified at startup\&. For a complete list of options, run this command: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysqld \-\-verbose \-\-help\fR +.fi +.if n \{\ +.RE +.\} +.PP +MariaDB Server also has a set of system variables that affect its operation as it runs\&. System variables can be set at server startup, and many of them can be changed at runtime to effect dynamic server reconfiguration\&. MariaDB Server also has a set of status variables that provide information about its operation\&. You can monitor these status variables to access runtime performance characteristics\&. +.PP +For a full description of MariaDB Server command options, system variables, and status variables, see +the MariaDB Knowledge Base\&. +.SH "COPYRIGHT" +.br +.PP +Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc., 2010-2020 MariaDB Foundation +.PP +This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License. +.PP +This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. +.PP +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-1335 USA or see http://www.gnu.org/licenses/. +.sp +.SH "SEE ALSO" +For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/ +.SH AUTHOR +MariaDB Foundation (http://www.mariadb.org/). diff --git a/man/mysqld_multi.1 b/man/mysqld_multi.1 new file mode 100644 index 00000000..aebae5dd --- /dev/null +++ b/man/mysqld_multi.1 @@ -0,0 +1,682 @@ +'\" t +.\" +.TH "\fBMARIADBD-MULTI\fR" "1" "15 May 2020" "MariaDB 10.11" "MariaDB Database System" +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.\" mysqld_multi +.\" tools: mysqld_multi +.\" scripts +.\" multi mysqld +.SH "NAME" +mariadbd-multi \- manage multiple MariaDB servers (mysqld_multi is now a symlink to mariadbd-multi) +.SH "SYNOPSIS" +.HP \w'\fBmysqld_multi\ [\fR\fB\fIoptions\fR\fR\fB]\ {start|stop|report}\ [\fR\fB\fIGNR\fR\fR\fB[,\fR\fB\fIGNR\fR\fR\fB]\ \&.\&.\&.]\fR\ 'u +\fBmysqld_multi [\fR\fB\fIoptions\fR\fR\fB] {start|stop|report} [\fR\fB\fIGNR\fR\fR\fB[,\fR\fB\fIGNR\fR\fR\fB] \&.\&.\&.]\fR +.SH "DESCRIPTION" +.PP +\fBmysqld_multi\fR +is designed to manage several +\fBmysqld\fR +processes that listen for connections on different Unix socket files and TCP/IP ports\&. It can start or stop servers, or report their current status\&. +.PP +\fBmysqld_multi\fR +searches for groups named +[mysqld\fIN\fR] +in +my\&.cnf +(or in the file named by the +\fB\-\-config\-file\fR +option)\&. +\fIN\fR +can be any positive integer\&. This number is referred to in the following discussion as the option group number, or +\fIGNR\fR\&. Group numbers distinguish option groups from one another and are used as arguments to +\fBmysqld_multi\fR +to specify which servers you want to start, stop, or obtain a status report for\&. Options listed in these groups are the same that you would use in the +[mysqld] +group used for starting +\fBmysqld\fR\&. However, when using multiple servers, it is necessary that each one use its own value for options such as the Unix socket file and TCP/IP port number\&. +.PP +To invoke +\fBmysqld_multi\fR, use the following syntax: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysqld_multi [\fR\fB\fIoptions\fR\fR\fB] {start|stop|report} [\fR\fB\fIGNR\fR\fR\fB[,\fR\fB\fIGNR\fR\fR\fB] \&.\&.\&.]\fR +.fi +.if n \{\ +.RE +.\} +.PP +start, +stop, and +report +indicate which operation to perform\&. You can perform the designated operation for a single server or multiple servers, depending on the +\fIGNR\fR +list that follows the option name\&. If there is no list, +\fBmysqld_multi\fR +performs the operation for all servers in the option file\&. +.PP +Each +\fIGNR\fR +value represents an option group number or range of group numbers\&. The value should be the number at the end of the group name in the option file\&. For example, the +\fIGNR\fR +for a group named +[mysqld17] +is +17\&. To specify a range of numbers, separate the first and last numbers by a dash\&. The +\fIGNR\fR +value +10\-13 +represents groups +[mysqld10] +through +[mysqld13]\&. Multiple groups or group ranges can be specified on the command line, separated by commas\&. There must be no whitespace characters (spaces or tabs) in the +\fIGNR\fR +list; anything after a whitespace character is ignored\&. +.PP +This command starts a single server using option group +[mysqld17]: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysqld_multi start 17\fR +.fi +.if n \{\ +.RE +.\} +.PP +This command stops several servers, using option groups +[mysqld8] +and +[mysqld10] +through +[mysqld13]: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysqld_multi stop 8,10\-13\fR +.fi +.if n \{\ +.RE +.\} +.PP +For an example of how you might set up an option file, use this command: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysqld_multi \-\-example\fR +.fi +.if n \{\ +.RE +.\} +.PP +\fBmysqld_multi\fR +searches for option files as follows: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqld_multi: no-defaults option +.\" no-defaults option: mysqld_multi +With +\fB\-\-no\-defaults\fR, no option files are read\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqld_multi: defaults-file option +.\" defaults-file option: mysqld_multi +With +\fB\-\-defaults\-file=\fR\fB\fIfile_name\fR\fR, only the named file is read\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqld_multi: defaults-extra-file option +.\" defaults-extra-file option: mysqld_multi +Otherwise, option files in the standard list of locations are read, including any file named by the +\fB\-\-defaults\-extra\-file=\fR\fB\fIfile_name\fR\fR +option, if one is given\&. (If the option is given multiple times, the last value is used\&.) +.RE +.PP +Option files read are searched for +[mysqld_multi] +and +[mysqld\fIN\fR] +option groups\&. The +[mysqld_multi] +group can be used for options to +\fBmysqld_multi\fR +itself\&. +[mysqld\fIN\fR] +groups can be used for options passed to specific +\fBmysqld\fR +instances\&. +.PP +The +[mysqld] +or +[mysqld_safe] +groups can be used for common options read by all instances of +\fBmysqld\fR +or +\fBmysqld_safe\fR\&. You can specify a +\fB\-\-defaults\-file=\fR\fB\fIfile_name\fR\fR +option to use a different configuration file for that instance, in which case the +[mysqld] +or +[mysqld_safe] +groups from that file will be used for that instance\&. +.PP +\fBmysqld_multi\fR +supports the following options\&. +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqld_multi: help option +.\" help option: mysqld_multi +\fB\-\-help\fR +.sp +Display a help message and exit\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqld_multi: example option +.\" example option: mysqld_multi +\fB\-\-example\fR +.sp +Display a sample option file\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqld_multi: log option +.\" log option: mysqld_multi +\fB\-\-log=\fR\fB\fIfile_name\fR\fR +.sp +Specify the name of the log file\&. If the file exists, log output is appended to it\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqld_multi: mysqladmin option +.\" mysqladmin option: mysqld_multi +\fB\-\-mysqladmin=\fR\fB\fIprog_name\fR\fR +.sp +The +\fBmysqladmin\fR +binary to be used to stop servers\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqld_multi: mysqld option +.\" mysqld option: mysqld_multi +\fB\-\-mysqld=\fR\fB\fIprog_name\fR\fR +.sp +The +\fBmysqld\fR +binary to be used\&. Note that you can specify +\fBmysqld_safe\fR +as the value for this option also\&. If you use +\fBmysqld_safe\fR +to start the server, you can include the +mysqld +or +ledir +options in the corresponding +[mysqld\fIN\fR] +option group\&. These options indicate the name of the server that +\fBmysqld_safe\fR +should start and the path name of the directory where the server is located\&. (See the descriptions for these options in +\fBmysqld_safe\fR(1)\&.) Example: +.sp +.if n \{\ +.RS 4 +.\} +.nf +[mysqld38] +mysqld = mysqld\-debug +ledir = /opt/local/mysql/libexec +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqld_multi: no-log option +.\" no-log option: mysqld_multi +\fB\-\-no\-log\fR +.sp +Print log information to +stdout +rather than to the log file\&. By default, output goes to the log file\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqld_multi: password option +.\" password option: mysqld_multi +\fB\-\-password=\fR\fB\fIpassword\fR\fR +.sp +The password of the MariaDB account to use when invoking +\fBmysqladmin\fR\&. Note that the password value is not optional for this option, unlike for other MariaDB programs\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqld_multi: silent option +.\" silent option: mysqld_multi +\fB\-\-silent\fR +.sp +Silent mode; disable warnings\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqld_multi: tcp-ip option +.\" tcp-ip option: mysqld_multi +\fB\-\-tcp\-ip\fR +.sp +Connect to the MariaDB server(s) via the TCP/IP port instead of the UNIX socket\&. This affects stopping +and reporting. If a socket file is missing, the server may still be running, but can be accessed only +via the TCP/IP port\&. By default connecting is done via the UNIX socket\&. This option affects +stop and report operations\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqld_multi: user option +.\" user option: mysqld_multi +\fB\-\-user=\fR\fB\fIuser_name\fR\fR +.sp +The user name of the MariaDB account to use when invoking +\fBmysqladmin\fR\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqld_multi: verbose option +.\" verbose option: mysqld_multi +\fB\-\-verbose\fR +.sp +Be more verbose\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqld_multi: version option +.\" version option: mysqld_multi +\fB\-\-version\fR +.sp +Display version information and exit\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqld_multi: wsrep-new-cluster option +.\" wsrep-new-cluster option: mysqld_multi +\fB\-\-wsrep\-new\-cluster\fR +.sp +Bootstrap a cluster\&. +.RE +.PP +Some notes about +\fBmysqld_multi\fR: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fBMost important\fR: Before using +\fBmysqld_multi\fR +be sure that you understand the meanings of the options that are passed to the +\fBmysqld\fR +servers and +\fIwhy\fR +you would want to have separate +\fBmysqld\fR +processes\&. Beware of the dangers of using multiple +\fBmysqld\fR +servers with the same data directory\&. Use separate data directories, unless you +\fIknow\fR +what you are doing\&. Starting multiple servers with the same data directory does +\fInot\fR +give you extra performance in a threaded system\&. +.sp .5v +.RE +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fBImportant\fR: Make sure that the data directory for each server is fully accessible to the Unix account that the specific +\fBmysqld\fR +process is started as\&. +\fIDo not\fR +use the Unix +\fIroot\fR +account for this, unless you +\fIknow\fR +what you are doing\&. +.sp .5v +.RE +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Make sure that the MariaDB account used for stopping the +\fBmysqld\fR +servers (with the +\fBmysqladmin\fR +program) has the same user name and password for each server\&. Also, make sure that the account has the +SHUTDOWN +privilege\&. If the servers that you want to manage have different user names or passwords for the administrative accounts, you might want to create an account on each server that has the same user name and password\&. For example, you might set up a common +multi_admin +account by executing the following commands for each server: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysql \-u root \-S /tmp/mysql\&.sock \-p\fR +Enter password: +mysql> \fBGRANT SHUTDOWN ON *\&.*\fR + \-> \fBTO 'multi_admin'@'localhost' IDENTIFIED BY 'multipass';\fR +.fi +.if n \{\ +.RE +.\} +.sp +Change the connection parameters appropriately when connecting to each one\&. Note that the host name part of the account name must allow you to connect as +multi_admin +from the host where you want to run +\fBmysqld_multi\fR\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +The Unix socket file and the TCP/IP port number must be different for every +\fBmysqld\fR\&. (Alternatively, if the host has multiple network addresses, you can use +\fB\-\-bind\-address\fR +to cause different servers to listen to different interfaces\&.) +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +The +\fB\-\-pid\-file\fR +option is very important if you are using +\fBmysqld_safe\fR +to start +\fBmysqld\fR +(for example, +\fB\-\-mysqld=mysqld_safe\fR) Every +\fBmysqld\fR +should have its own process ID file\&. The advantage of using +\fBmysqld_safe\fR +instead of +\fBmysqld\fR +is that +\fBmysqld_safe\fR +monitors its +\fBmysqld\fR +process and restarts it if the process terminates due to a signal sent using +kill \-9 +or for other reasons, such as a segmentation fault\&. Please note that the +\fBmysqld_safe\fR +script might require that you start it from a certain place\&. This means that you might have to change location to a certain directory before running +\fBmysqld_multi\fR\&. If you have problems starting, please see the +\fBmysqld_safe\fR +script\&. Check especially the lines: +.sp +.if n \{\ +.RS 4 +.\} +.nf +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +MY_PWD=`pwd` +# Check if we are starting this relative (for the binary release) +if test \-d $MY_PWD/data/mysql \-a \e + \-f \&./share/mysql/english/errmsg\&.sys \-a \e + \-x \&./bin/mysqld +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +.fi +.if n \{\ +.RE +.\} +.sp +The test performed by these lines should be successful, or you might encounter problems\&. See +\fBmysqld_safe\fR(1)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +You might want to use the +\fB\-\-user\fR +option for +\fBmysqld\fR, but to do this you need to run the +\fBmysqld_multi\fR +script as the Unix +root +user\&. Having the option in the option file doesn't matter; you just get a warning if you are not the superuser and the +\fBmysqld\fR +processes are started under your own Unix account\&. +.RE +.PP +The following example shows how you might set up an option file for use with +\fBmysqld_multi\fR\&. The order in which the +\fBmysqld\fR +programs are started or stopped depends on the order in which they appear in the option file\&. Group numbers need not form an unbroken sequence\&. The first and fifth +[mysqld\fIN\fR] +groups were intentionally omitted from the example to illustrate that you can have +\(lqgaps\(rq +in the option file\&. This gives you more flexibility\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +# This file should probably be in your home dir (~/\&.my\&.cnf) +# or /etc/my\&.cnf +# Version 2\&.1 by Jani Tolonen +[mysqld_multi] +mysqld = /usr/local/bin/mysqld_safe +mysqladmin = /usr/local/bin/mysqladmin +user = multi_admin +password = multipass +[mysqld2] +socket = /tmp/mysql\&.sock2 +port = 3307 +pid\-file = /usr/local/mysql/var2/hostname\&.pid2 +datadir = /usr/local/mysql/var2 +language = /usr/local/share/mysql/english +user = john +[mysqld3] +socket = /tmp/mysql\&.sock3 +port = 3308 +pid\-file = /usr/local/mysql/var3/hostname\&.pid3 +datadir = /usr/local/mysql/var3 +language = /usr/local/share/mysql/swedish +user = monty +[mysqld4] +socket = /tmp/mysql\&.sock4 +port = 3309 +pid\-file = /usr/local/mysql/var4/hostname\&.pid4 +datadir = /usr/local/mysql/var4 +language = /usr/local/share/mysql/estonia +user = tonu +[mysqld6] +socket = /tmp/mysql\&.sock6 +port = 3311 +pid\-file = /usr/local/mysql/var6/hostname\&.pid6 +datadir = /usr/local/mysql/var6 +language = /usr/local/share/mysql/japanese +user = jani +.fi +.if n \{\ +.RE +.\} +.PP +.SH "COPYRIGHT" +.br +.PP +Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc., 2010-2020 MariaDB Foundation +.PP +This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License. +.PP +This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. +.PP +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-1335 USA or see http://www.gnu.org/licenses/. +.sp +.SH "SEE ALSO" +For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/ +.SH AUTHOR +MariaDB Foundation (http://www.mariadb.org/). diff --git a/man/mysqld_safe.1 b/man/mysqld_safe.1 new file mode 100644 index 00000000..ffd1d691 --- /dev/null +++ b/man/mysqld_safe.1 @@ -0,0 +1,871 @@ +'\" t +.\" +.TH "\fBMARIADBD-SAFE\fR" "1" "15 May 2020" "MariaDB 10.11" "MariaDB Database System" +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.\" mysqld_safe +.\" tools: mysqld_safe +.\" scripts +.SH "NAME" +mariadbd-safe \- MariaDB server startup script (mysqld_safe is now a symlink to mariadbd-safe) +.SH "SYNOPSIS" +.HP \w'\fBmysqld_safe\ \fR\fB\fIoptions\fR\fR\ 'u +\fBmysqld_safe \fR\fB\fIoptions\fR\fR +.SH "DESCRIPTION" +.PP +\fBmysqld_safe\fR +is the recommended way to start a +\fBmysqld\fR +server on Unix\&. +\fBmysqld_safe\fR +adds some safety features such as restarting the server when an error occurs and logging runtime information to an error log file\&. Descriptions of error logging is given later in this section\&. +.sp +\fBmysqld_safe\fR +tries to start an executable named +\fBmysqld\fR\&. To override the default behavior and specify explicitly the name of the server you want to run, specify a +\fB\-\-mysqld\fR +or +\fB\-\-mysqld\-version\fR +option to +\fBmysqld_safe\fR\&. You can also use +\fB\-\-ledir\fR +to indicate the directory where +\fBmysqld_safe\fR +should look for the server\&. +.PP +Many of the options to +\fBmysqld_safe\fR +are the same as the options to +\fBmysqld\fR\&. +.PP +Options unknown to +\fBmysqld_safe\fR +are passed to +\fBmysqld\fR +if they are specified on the command line, but ignored if they are specified in the +[mysqld_safe] or [mariadb_safe] +groups of an option file\&. +.PP +\fBmysqld_safe\fR +reads all options from the +[mysqld], +[server], +[mysqld_safe], and [mariadb_safe] +sections in option files\&. For example, if you specify a +[mysqld] +section like this, +\fBmysqld_safe\fR +will find and use the +\fB\-\-log\-error\fR +option: +.sp +.if n \{\ +.RS 4 +.\} +.nf +[mysqld] +log\-error=error\&.log +.fi +.if n \{\ +.RE +.\} +.PP +For backward compatibility, +\fBmysqld_safe\fR +also reads +[safe_mysqld] +sections, although you should rename such sections to +[mysqld_safe] +in current installations\&. +.PP +\fBmysqld_safe\fR +supports the options in the following list\&. It also reads option files and supports the options for processing them. +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqld_safe: help option +.\" help option: mysqld_safe +\fB\-\-help\fR +.sp +Display a help message and exit\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqld_safe: basedir option +.\" basedir option: mysqld_safe +\fB\-\-basedir=\fR\fB\fIpath\fR\fR +.sp +The path to the MariaDB installation directory\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqld_safe: core-file-size option +.\" core-file-size option: mysqld_safe +\fB\-\-core\-file\-size=\fR\fB\fIsize\fR\fR +.sp +The size of the core file that +\fBmysqld\fR +should be able to create\&. The option value is passed to +\fBulimit \-c\fR\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqld_safe: crash-script option +.\" crash-script option: mysqld_safe +\fB\-\-crash\-script=\fR\fB\fIfile\fR\fR +.sp +Script to call in the event of mysqld crashing\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqld_safe: datadir option +.\" datadir option: mysqld_safe +\fB\-\-datadir=\fR\fB\fIpath\fR\fR +.sp +The path to the data directory\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqld_safe: defaults-extra-file option +.\" defaults-extra-file option: mysqld_safe +\fB\-\-defaults\-extra\-file=\fR\fB\fIpath\fR\fR +.sp +The name of an option file to be read in addition to the usual option files\&. This must be the first option on the command line if it is used\&. If the file does not exist or is otherwise inaccessible, the server will exit with an error\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqld_safe: defaults-file option +.\" defaults-file option: mysqld_safe +\fB\-\-defaults\-file=\fR\fB\fIfile_name\fR\fR +.sp +The name of an option file to be read instead of the usual option files\&. This must be the first option on the command line if it is used\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqld_safe: flush-caches option +.\" flush-caches option: mysqld_safe +\fB\-\-flush\-caches\fR +.sp +Flush and purge buffers/caches before starting the server\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqld_safe: ledir option +.\" ledir option: mysqld_safe +\fB\-\-ledir=\fR\fB\fIpath\fR\fR +.sp +If +\fBmysqld_safe\fR +cannot find the server, use this option to indicate the path name to the directory where the server is located\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqld_safe: log-error option +.\" log-error option: mysqld_safe +\fB\-\-log\-error=\fR\fB\fIfile_name\fR\fR +.sp +Write the error log to the given file\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqld_safe: malloc-lib option +.\" malloc-lib option: mysqld_safe +\fB\-\-malloc\-lib=\fR\fB\fIlib\fR\fR +.sp +Preload shared library lib if available\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqld_safe: mysqld option +.\" mysqld option: mysqld_safe +\fB\-\-mysqld=\fR\fB\fIprog_name\fR\fR +.sp +The name of the server program (in the +ledir +directory) that you want to start\&. This option is needed if you use the MariaDB binary distribution but have the data directory outside of the binary distribution\&. If +\fBmysqld_safe\fR +cannot find the server, use the +\fB\-\-ledir\fR +option to indicate the path name to the directory where the server is located\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqld_safe: mysqld-version option +.\" mysqld-version option: mysqld_safe +\fB\-\-mysqld\-version=\fR\fB\fIsuffix\fR\fR +.sp +This option is similar to the +\fB\-\-mysqld\fR +option, but you specify only the suffix for the server program name\&. The basename is assumed to be +\fBmysqld\fR\&. For example, if you use +\fB\-\-mysqld\-version=debug\fR, +\fBmysqld_safe\fR +starts the +\fBmysqld\-debug\fR +program in the +ledir +directory\&. If the argument to +\fB\-\-mysqld\-version\fR +is empty, +\fBmysqld_safe\fR +uses +\fBmysqld\fR +in the +ledir +directory\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqld_safe: nice option +.\" nice option: mysqld_safe +\fB\-\-nice=\fR\fB\fIpriority\fR\fR +.sp +Use the +nice +program to set the server's scheduling priority to the given value\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqld_safe: no-auto-restart option +.\" no-auto-restart option: mysqld_safe +\fB\-\-no\-auto\-restart\fR, +\fB\-\-nowatch\fR, +\fB\-\-no\-watch\fR +.sp +Exit after starting mysqld\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqld_safe: no-defaults option +.\" no-defaults option: mysqld_safe +\fB\-\-no\-defaults\fR +.sp +Do not read any option files\&. This must be the first option on the command line if it is used\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqld_safe: numa-interleave option +.\" numa-interleave option: mysqld_safe +\fB\-\-numa\-interleave\fR +.sp +Run mysqld with its memory interleaved on all NUMA nodes\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqld_safe: open-files-limit option +.\" open-files-limit option: mysqld_safe +\fB\-\-open\-files\-limit=\fR\fB\fIcount\fR\fR +.sp +The number of files that +\fBmysqld\fR +should be able to open\&. The option value is passed to +\fBulimit \-n\fR\&. Note that you need to start +\fBmysqld_safe\fR +as +root +for this to work properly! +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqld_safe: pid-file option +.\" pid-file option: mysqld_safe +\fB\-\-pid\-file=\fR\fB\fIfile_name\fR\fR +.sp +The path name of the process ID file\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqld_safe: plugin-dir option +.\" plugin-dir option: mysqld_safe +\fB\-\-plugin\-dir=\fIdir_name\fR +.sp +Directory for client-side plugins\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqld_safe: port option +.\" port option: mysqld_safe +\fB\-\-port=\fR\fB\fIport_num\fR\fR +.sp +The port number that the server should use when listening for TCP/IP connections\&. The port number must be 1024 or higher unless the server is started by the +root +system user\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqld_safe: skip-kill-mysqld option +.\" skip-kill-mysqld option: mysqld_safe +\fB\-\-skip\-kill\-mysqld\fR +.sp +Do not try to kill stray +\fBmysqld\fR +processes at startup\&. This option works only on Linux\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqld_safe: socket option +.\" socket option: mysqld_safe +\fB\-\-socket=\fR\fB\fIpath\fR\fR +.sp +The Unix socket file that the server should use when listening for local connections\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqld_safe: syslog option +.\" syslog option: mysqld_safe +.\" mysqld_safe: skip-syslog option +.\" skip-syslog option: mysqld_safe +\fB\-\-syslog\fR, +\fB\-\-skip\-syslog\fR +.sp +\fB\-\-syslog\fR +causes error messages to be sent to +syslog +on systems that support the +\fBlogger\fR +program\&. +\-\-skip\-syslog +suppresses the use of +syslog; messages are written to an error log file\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqld_safe: syslog-tag option +.\" syslog-tag option: mysqld_safe +\fB\-\-syslog\-tag=\fR\fB\fItag\fR\fR +.sp +For logging to +syslog, messages from +\fBmysqld_safe\fR +and +\fBmysqld\fR +are written with a tag of +mysqld_safe +and +mysqld, respectively\&. To specify a suffix for the tag, use +\fB\-\-syslog\-tag=\fR\fB\fItag\fR\fR, which modifies the tags to be +mysqld_safe\-\fItag\fR +and +mysqld\-\fItag\fR\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqld_safe: timezone option +.\" timezone option: mysqld_safe +\fB\-\-timezone=\fR\fB\fItimezone\fR\fR +.sp +Set the +TZ +time zone environment variable to the given option value\&. Consult your operating system documentation for legal time zone specification formats\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqld_safe: user option +.\" user option: mysqld_safe +\fB\-\-user={\fR\fB\fIuser_name\fR\fR\fB|\fR\fB\fIuser_id\fR\fR\fB}\fR +.sp +Run the +\fBmysqld\fR +server as the user having the name +\fIuser_name\fR +or the numeric user ID +\fIuser_id\fR\&. (\(lqUser\(rq +in this context refers to a system login account, not a MariaDB user listed in the grant tables\&.) +.RE +.PP +If you execute +\fBmysqld_safe\fR +with the +\fB\-\-defaults\-file\fR +or +\fB\-\-defaults\-extra\-file\fR +option to name an option file, the option must be the first one given on the command line or the option file will not be used\&. For example, this command will not use the named option file: +.sp +.if n \{\ +.RS 4 +.\} +.nf +mysql> \fBmysqld_safe \-\-port=\fR\fB\fIport_num\fR\fR\fB \-\-defaults\-file=\fR\fB\fIfile_name\fR\fR +.fi +.if n \{\ +.RE +.\} +.PP +Instead, use the following command: +.sp +.if n \{\ +.RS 4 +.\} +.nf +mysql> \fBmysqld_safe \-\-defaults\-file=\fR\fB\fIfile_name\fR\fR\fB \-\-port=\fR\fB\fIport_num\fR\fR +.fi +.if n \{\ +.RE +.\} +.PP +The +\fBmysqld_safe\fR +script is written so that it normally can start a server that was installed from either a source or a binary distribution of MariaDB, even though these types of distributions typically install the server in slightly different locations\&. +\fBmysqld_safe\fR +expects one of the following conditions to be true: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +The server and databases can be found relative to the working directory (the directory from which +\fBmysqld_safe\fR +is invoked)\&. For binary distributions, +\fBmysqld_safe\fR +looks under its working directory for +bin +and +data +directories\&. For source distributions, it looks for +libexec +and +var +directories\&. This condition should be met if you execute +\fBmysqld_safe\fR +from your MariaDB installation directory (for example, +/usr/local/mysql +for a binary distribution)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +If the server and databases cannot be found relative to the working directory, +\fBmysqld_safe\fR +attempts to locate them by absolute path names\&. Typical locations are +/usr/local/libexec +and +/usr/local/var\&. The actual locations are determined from the values configured into the distribution at the time it was built\&. They should be correct if MariaDB is installed in the location specified at configuration time\&. +.RE +.PP +Because +\fBmysqld_safe\fR +tries to find the server and databases relative to its own working directory, you can install a binary distribution of MariaDB anywhere, as long as you run +\fBmysqld_safe\fR +from the MariaDB installation directory: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBcd \fR\fB\fImysql_installation_directory\fR\fR +shell> \fBbin/mysqld_safe &\fR +.fi +.if n \{\ +.RE +.\} +.PP +If +\fBmysqld_safe\fR +fails, even when invoked from the MariaDB installation directory, you can specify the +\fB\-\-ledir\fR +and +\fB\-\-datadir\fR +options to indicate the directories in which the server and databases are located on your system\&. +.PP +When you use +\fBmysqld_safe\fR +to start +\fBmysqld\fR, +\fBmysqld_safe\fR +arranges for error (and notice) messages from itself and from +\fBmysqld\fR +to go to the same destination\&. +.PP +There are several +\fBmysqld_safe\fR +options for controlling the destination of these messages: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fB\-\-syslog\fR: Write error messages to +syslog +on systems that support the +\fBlogger\fR +program\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fB\-\-skip\-syslog\fR: Do not write error messages to +syslog\&. Messages are written to the default error log file (\fIhost_name\fR\&.err +in the data directory), or to a named file if the +\fB\-\-log\-error\fR +option is given\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fB\-\-log\-error=\fR\fB\fIfile_name\fR\fR: Write error messages to the named error file\&. +.RE +.PP +If none of these options is given, the default is +\fB\-\-skip\-syslog\fR\&. +.if n \{\ +.sp +.\} +.RS 4 +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.ps +1 +\fBNote\fR +.ps -1 +.br +.PP +.sp .5v +.RE +.PP +If +\fB\-\-syslog\fR +and +\fB\-\-log\-error\fR +are both given, a warning is issued and +\fB\-\-log\-error\fR +takes precedence\&. +.PP +When +\fBmysqld_safe\fR +writes a message, notices go to the logging destination (syslog +or the error log file) and +stdout\&. Errors go to the logging destination and +stderr\&. +.PP +Normally, you should not edit the +\fBmysqld_safe\fR +script\&. Instead, configure +\fBmysqld_safe\fR +by using command\-line options or options in the +[mysqld_safe] +section of a +my\&.cnf +option file\&. In rare cases, it might be necessary to edit +\fBmysqld_safe\fR +to get it to start the server properly\&. However, if you do this, your modified version of +\fBmysqld_safe\fR +might be overwritten if you upgrade MariaDB in the future, so you should make a copy of your edited version that you can reinstall\&. +.PP +On NetWare, +\fBmysqld_safe\fR +is a NetWare Loadable Module (NLM) that is ported from the original Unix shell script\&. It starts the server as follows: +.sp +.RS 4 +.ie n \{\ +\h'-04' 1.\h'+01'\c +.\} +.el \{\ +.sp -1 +.IP " 1." 4.2 +.\} +Runs a number of system and option checks\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04' 2.\h'+01'\c +.\} +.el \{\ +.sp -1 +.IP " 2." 4.2 +.\} +Runs a check on +MyISAM +tables\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04' 3.\h'+01'\c +.\} +.el \{\ +.sp -1 +.IP " 3." 4.2 +.\} +Provides a screen presence for the MariaDB server\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04' 4.\h'+01'\c +.\} +.el \{\ +.sp -1 +.IP " 4." 4.2 +.\} +Starts +\fBmysqld\fR, monitors it, and restarts it if it terminates in error\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04' 5.\h'+01'\c +.\} +.el \{\ +.sp -1 +.IP " 5." 4.2 +.\} +Sends error messages from +\fBmysqld\fR +to the +\fIhost_name\fR\&.err +file in the data directory\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04' 6.\h'+01'\c +.\} +.el \{\ +.sp -1 +.IP " 6." 4.2 +.\} +Sends +\fBmysqld_safe\fR +screen output to the +\fIhost_name\fR\&.safe +file in the data directory\&. +.RE +.SH "COPYRIGHT" +.br +.PP +Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc., 2010-2020 MariaDB Foundation +.PP +This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License. +.PP +This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. +.PP +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-1335 USA or see http://www.gnu.org/licenses/. +.sp +.SH "SEE ALSO" +For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/ +.SH AUTHOR +MariaDB Foundation (http://www.mariadb.org/). diff --git a/man/mysqld_safe_helper.1 b/man/mysqld_safe_helper.1 new file mode 100644 index 00000000..24bb980c --- /dev/null +++ b/man/mysqld_safe_helper.1 @@ -0,0 +1,16 @@ +'\" t +.\" +.TH "\fBMARIADBD-SAFE-HELPER\fR" "1" "15 May 2020" "MariaDB 10.11" "MariaDB Database System" +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH NAME +mariadbd-safe-helper \- helper script (mysqld_safe_helper is now a symlink to mariadbd-safe-helper) +.SH DESCRIPTION +Use: Helper script\. +.PP +For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/ diff --git a/man/mysqldump.1 b/man/mysqldump.1 new file mode 100644 index 00000000..06ffd651 --- /dev/null +++ b/man/mysqldump.1 @@ -0,0 +1,2847 @@ +'\" t +.\" +.TH "\fBMARIADB-DUMP\fR" "1" "24 October 2020" "MariaDB 10.11" "MariaDB Database System" +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.\" mysqldump +.\" dumping: databases and tables +.\" backups: databases and tables +.\" databases: dumping +.\" tables: dumping +.SH "NAME" +mariadb-dump \- a database backup program (mysqldump is now a symlink to mariadb-dump) +.SH "SYNOPSIS" +.HP \w'\fBmysqldump\ [\fR\fB\fIoptions\fR\fR\fB]\ [\fR\fB\fIdb_name\fR\fR\fB\ [\fR\fB\fItbl_name\fR\fR\fB\ \&.\&.\&.]]\fR\ 'u +\fBmysqldump [\fR\fB\fIoptions\fR\fR\fB] [\fR\fB\fIdb_name\fR\fR\fB [\fR\fB\fItbl_name\fR\fR\fB \&.\&.\&.]]\fR +.SH "DESCRIPTION" +.PP +The +\fBmysqldump\fR +client is a backup program originally written by Igor Romanenko\&. It can be used to dump a database or a collection of databases for backup or transfer to another SQL server (not necessarily a MariaDB server)\&. The dump typically contains SQL statements to create the table, populate it, or both\&. However, +\fBmysqldump\fR +can also be used to generate files in CSV, other delimited text, or XML format\&. +.PP +If you are doing a backup on the server and your tables all are +MyISAM +tables, consider using the +\fBmysqlhotcopy\fR +instead because it can accomplish faster backups and faster restores\&. See +\fBmysqlhotcopy\fR(1)\&. +.PP +There are four general ways to invoke +\fBmysqldump\fR: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysqldump [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fIdb_name\fR\fR\fB [\fR\fB\fItbl_name\fR\fR\fB \&.\&.\&.]\fR +shell> \fBmysqldump [\fR\fB\fIoptions\fR\fR\fB] \-\-databases \fR\fB\fIdb_name\fR\fR\fB \&.\&.\&.\fR +shell> \fBmysqldump [\fR\fB\fIoptions\fR\fR\fB] \-\-all\-databases\fR +shell> \fBmysqldump [\fR\fB\fIoptions\fR\fR\fB] \-\-system={options}\fR +.fi +.if n \{\ +.RE +.\} +.PP +If you do not name any tables following +\fIdb_name\fR +or if you use the +\fB\-\-databases\fR +or +\fB\-\-all\-databases\fR +option, entire databases are dumped\&. +.PP +\fBmysqldump\fR +does not dump the +INFORMATION_SCHEMA or performance_schema +databases by default\&. To dump these, +name them explicitly on the command line, although you must also use the +\fB\-\-skip\-lock\-tables\fR +option\&. +.PP +To see a list of the options your version of +\fBmysqldump\fR +supports, execute +\fBmysqldump \-\-help\fR\&. +.PP +Some +\fBmysqldump\fR +options are shorthand for groups of other options: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Use of +\fB\-\-opt\fR +is the same as specifying +\fB\-\-add\-drop\-table\fR, +\fB\-\-add\-locks\fR, +\fB\-\-create\-options\fR, +\fB\-\-disable\-keys\fR, +\fB\-\-extended\-insert\fR, +\fB\-\-lock\-tables\fR, +\fB\-\-quick\fR, and +\fB\-\-set\-charset\fR\&. All of the options that +\fB\-\-opt\fR +stands for also are on by default because +\fB\-\-opt\fR +is on by default\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Use of +\fB\-\-compact\fR +is the same as specifying +\fB\-\-skip\-add\-drop\-table\fR, +\fB\-\-skip\-add\-locks\fR, +\fB\-\-skip\-comments\fR, +\fB\-\-skip\-disable\-keys\fR, and +\fB\-\-skip\-set\-charset\fR +options\&. +.RE +.PP +To reverse the effect of a group option, uses its +\fB\-\-skip\-\fR\fB\fIxxx\fR\fR +form (\fB\-\-skip\-opt\fR +or +\fB\-\-skip\-compact\fR)\&. It is also possible to select only part of the effect of a group option by following it with options that enable or disable specific features\&. Here are some examples: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +To select the effect of +\fB\-\-opt\fR +except for some features, use the +\fB\-\-skip\fR +option for each feature\&. To disable extended inserts and memory buffering, use +\fB\-\-opt\fR +\fB\-\-skip\-extended\-insert\fR +\fB\-\-skip\-quick\fR\&. (Actually, +\fB\-\-skip\-extended\-insert\fR +\fB\-\-skip\-quick\fR +is sufficient because +\fB\-\-opt\fR +is on by default\&.) +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +To reverse +\fB\-\-opt\fR +for all features except index disabling and table locking, use +\fB\-\-skip\-opt\fR +\fB\-\-disable\-keys\fR +\fB\-\-lock\-tables\fR\&. +.RE +.PP +When you selectively enable or disable the effect of a group option, order is important because options are processed first to last\&. For example, +\fB\-\-disable\-keys\fR +\fB\-\-lock\-tables\fR +\fB\-\-skip\-opt\fR +would not have the intended effect; it is the same as +\fB\-\-skip\-opt\fR +by itself\&. +.PP +\fBmysqldump\fR +can retrieve and dump table contents row by row, or it can retrieve the entire content from a table and buffer it in memory before dumping it\&. Buffering in memory can be a problem if you are dumping large tables\&. To dump tables row by row, use the +\fB\-\-quick\fR +option (or +\fB\-\-opt\fR, which enables +\fB\-\-quick\fR)\&. The +\fB\-\-opt\fR +option (and hence +\fB\-\-quick\fR) is enabled by default, so to enable memory buffering, use +\fB\-\-skip\-quick\fR\&. +.PP +If you are using a recent version of +\fBmysqldump\fR +to generate a dump to be reloaded into a very old MySQL server, you should not use the +\fB\-\-opt\fR +or +\fB\-\-extended\-insert\fR +option\&. Use +\fB\-\-skip\-opt\fR +instead\&. +.RE +.PP +\fBmysqldump\fR +supports the following options, which can be specified on the command line or in the +[mysqldump] +and +[client] +option file groups\&. +\fBmysqldump\fR +also supports the options for processing option file\&. +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: help option +.\" help option: mysqldump +\fB\-\-help\fR, +\fB\-?\fR +.sp +Display a help message and exit\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: add-drop-database option +.\" add-drop-database option: mysqldump +\fB\-\-add\-drop\-database\fR +.sp +Add a +DROP DATABASE +statement before each +CREATE DATABASE +statement\&. This option is typically used in conjunction with the +\fB\-\-all\-databases\fR +or +\fB\-\-databases\fR +option because no +CREATE DATABASE +statements are written unless one of those options is specified\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: add-drop-table option +.\" add-drop-table option: mysqldump +\fB\-\-add\-drop\-table\fR +.sp +Add a +DROP TABLE +statement before each +CREATE TABLE +statement\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: add-drop-trigger option +.\" add-drop-trigger option: mysqldump +\fB\-\-add\-drop\-trigger\fR +.sp +Add a +DROP TRIGGER +statement before each +CREATE TRIGGER +statement\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: add-locks option +.\" add-locks option: mysqldump +\fB\-\-add\-locks\fR +.sp +Surround each table dump with +LOCK TABLES +and +UNLOCK TABLES +statements\&. This results in faster inserts when the dump file is reloaded\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: all-databases option +.\" all-databases option: mysqldump +\fB\-\-all\-databases\fR, +\fB\-A\fR +.sp +Dump all tables in all databases\&. This is the same as using the +\fB\-\-databases\fR +option and naming all the databases on the command line\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: all-tablespaces option +.\" all-tablespaces option: mysqldump +\fB\-\-all\-tablespaces\fR, +\fB\-Y\fR +.sp +Adds to a table dump all SQL statements needed to create any tablespaces used by an +NDBCLUSTER +table\&. This information is not otherwise included in the output from +\fBmysqldump\fR\&. This option is currently relevant only to MySQL Cluster tables\&. +.sp +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: allow-keywords option +.\" allow-keywords option: mysqldump +\fB\-\-allow\-keywords\fR +.sp +Allow creation of column names that are keywords\&. This works by prefixing each column name with the table name\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: apply-slave-statements option +.\" apply-slave-statements option: mysqldump +\fB\-\-apply\-slave\-statements\fR +.sp +Adds 'STOP SLAVE' prior to 'CHANGE MASTER' and 'START SLAVE' to bottom of dump\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: character-sets-dir option +.\" character-sets-dir option: mysqldump +\fB\-\-character\-sets\-dir=\fR\fB\fIpath\fR\fR +.sp +The directory where character sets are installed\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: comments option +.\" comments option: mysqldump +\fB\-\-comments\fR, +\fB\-i\fR +.sp +Write additional information in the dump file such as program version, server version, and host\&. This option is enabled by default\&. To suppress this additional information, use +\fB\-\-skip\-comments\fR\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: compact option +.\" compact option: mysqldump +\fB\-\-compact\fR +.sp +Produce more compact output\&. This option enables the +\fB\-\-skip\-add\-drop\-table\fR, +\fB\-\-skip\-add\-locks\fR, +\fB\-\-skip\-comments\fR, +\fB\-\-skip\-disable\-keys\fR, and +\fB\-\-skip\-set\-charset\fR +options\&. +.RE +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: compatible option +.\" compatible option: mysqldump +\fB\-\-compatible=\fR\fB\fIname\fR\fR +.sp +Produce output that is more compatible with other database systems or with older MySQL servers\&. The value of +\fIname\fR +can be +ansi, +mysql323, +mysql40, +postgresql, +oracle, +mssql, +db2, +maxdb, +no_key_options, +no_table_options, or +no_field_options\&. To use several values, separate them by commas\&. These values have the same meaning as the corresponding options for setting the server SQL mode\&. +.sp +This option does not guarantee compatibility with other servers\&. It only enables those SQL mode values that are currently available for making dump output more compatible\&. For example, +\fB\-\-compatible=oracle\fR +does not map data types to Oracle types or use Oracle comment syntax\&. +.sp +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: complete-insert option +.\" complete-insert option: mysqldump +\fB\-\-complete\-insert\fR, +\fB\-c\fR +.sp +Use complete +INSERT +statements that include column names\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: compress option +.\" compress option: mysqldump +\fB\-\-compress\fR, +\fB\-C\fR +.sp +Compress all information sent between the client and the server if both support compression\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: copy-s3-tables option +.\" copy-s3-tables option: mysqldump +\fB\-\-copy\-s3\-tables\fR +.sp +By default S3 tables are ignored\&. With this option set, the result file will contain a CREATE statement +for a similar Aria table, followed by the table data and ending with an ALTER TABLE xxx ENGINE=S3\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: create-options option +.\" create-options option: mysqldump +\fB\-\-create\-options\fR, +\fB\-a\fR +.sp +Include all MariaDB\-specific table options in the +CREATE TABLE +statements\&. Use \fB\-\-skip-create-options\fR to disable. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: databases option +.\" databases option: mysqldump +\fB\-\-databases\fR, +\fB\-B\fR +.sp +Dump several databases\&. Normally, +\fBmysqldump\fR +treats the first name argument on the command line as a database name and following names as table names\&. With this option, it treats all name arguments as database names\&. +CREATE DATABASE +and +USE +statements are included in the output before each new database\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: debug option +.\" debug option: mysqldump +\fB\-\-debug[=\fR\fB\fIdebug_options\fR\fR\fB]\fR, +\fB\-# [\fR\fB\fIdebug_options\fR\fR\fB]\fR +.sp +Write a debugging log\&. A typical +\fIdebug_options\fR +string is 'd:t:o,\fIfile_name\fR'. The default value is 'd:t:o,/tmp/mysqldump.trace'. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: debug-check option +.\" debug-check option: mysqldump +\fB\-\-debug\-check\fR +.sp +Print some debugging information when the program exits\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: debug-info option +.\" debug-info option: mysqldump +\fB\-\-debug\-info\fR +.sp +Print debugging information and memory and CPU usage statistics when the program exits\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: default-auth option +.\" default-auth option: mysqldump +\fB\-\-default\-auth\fR +.sp +Default authentication client-side plugin to use\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: default-character-set option +.\" default-character-set option: mysqldump +\fB\-\-default\-character\-set=\fR\fB\fIcharset_name\fR\fR +.sp +Use +\fIcharset_name\fR +as the default character set\&. If no character set is specified, +\fBmysqldump\fR +uses +utf8\&. +.sp +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: defaults-extra-file option +.\" defaults-extra-file option: mysqldump +\fB\-\-defaults\-extra\-file=\fR\fB\fIfilename\fR\fR +.sp +Set \fB\fIfilename\fR\fR as the file to read default options from after the global defaults files has been read\&. +Must be given as first option\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: defaults-file option +.\" defaults-file option: mysqldump +\fB\-\-defaults\-file=\fR\fB\fIfilename\fR\fR +.sp +Set \fB\fIfilename\fR\fR as the file to read default options from, override global defaults files\&. +Must be given as first option\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" my_print_defaults: defaults-group-suffix option +.\" defaults-group-suffix option: my_print_defaults +\fB\-\-defaults\-group\-suffix=\fR\fB\fIstr\fR\fR, +.sp +Also read groups with a suffix of \fIstr\fR\&. For example, since mysqldump normally reads the [client] and [mysqldump] groups, \-\-defaults\-group\-suffix=x would cause it to also read the groups [mysqldump_x] and [client_x]\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: delayed-insert option +.\" delayed-insert option: mysqldump +\fB\-\-delayed\-insert\fR +.sp +Write +INSERT DELAYED +statements rather than +INSERT +statements\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: delete-master-logs option +.\" delete-master-logs option: mysqldump +\fB\-\-delete\-master\-logs\fR +.sp +On a master replication server, delete the binary logs by sending a +PURGE BINARY LOGS +statement to the server after performing the dump operation\&. This option automatically enables +\fB\-\-master\-data\fR\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: disable-keys option +.\" disable-keys option: mysqldump +\fB\-\-disable\-keys\fR, +\fB\-K\fR +.sp +For each table, surround the +INSERT +statements with +/*!40000 ALTER TABLE \fItbl_name\fR DISABLE KEYS */; +and +/*!40000 ALTER TABLE \fItbl_name\fR ENABLE KEYS */; +statements\&. This makes loading the dump file faster because the indexes are created after all rows are inserted\&. This option is effective only for nonunique indexes of +MyISAM +tables\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: dump-date option +.\" dump-date option: mysqldump +\fB\-\-dump\-date\fR +.sp +If the +\fB\-\-comments\fR +option is given, +\fBmysqldump\fR +produces a comment at the end of the dump of the following form: +.sp +.if n \{\ +.RS 4 +.\} +.nf +\-\- Dump completed on \fIDATE\fR +.fi +.if n \{\ +.RE +.\} +.sp +However, the date causes dump files taken at different times to appear to be different, even if the data are otherwise identical\&. +\fB\-\-dump\-date\fR +and +\fB\-\-skip\-dump\-date\fR +control whether the date is added to the comment\&. The default is +\fB\-\-dump\-date\fR +(include the date in the comment)\&. +\fB\-\-skip\-dump\-date\fR +suppresses date printing\& +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: dump-slave option +.\" dump-slave option: mysqldump +\fB\-\-dump\-slave[=\fR\fB\fIvalue\fR\fR\fB]\fR +.sp +Used for producing a dump file from a replication slave server that can be used to set up another slave server +with the same master\&. Causes the binary log position and filename of the master to be appended to the dumped +data output\&. Setting the value to 1 (the default) will print it as a CHANGE MASTER command in the dumped data +output; if set to 2, that command will be prefixed with a comment symbol\&. This option will turn +\-\-lock\-all\-tables on, unless \-\-single-transaction is specified too (in which case a global read lock is only +taken a short time at the beginning of the dump \- don't forget to read about \-\-single-transaction below)\&. In +all cases any action on logs will happen at the exact moment of the dump\&. Option automatically turns +\-\-lock\-tables off\&. Using this option causes mysqldump to stop the slave SQL thread before beginning the dump, +and restart it again after completion\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: events option +.\" events option: mysqldump +\fB\-\-events\fR, +\fB\-E\fR +.sp +Include Event Scheduler events for the dumped databases in the output\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: extended-insert option +.\" extended-insert option: mysqldump +\fB\-\-extended\-insert\fR, +\fB\-e\fR +.sp +Use multiple\-row +INSERT +syntax that include several +VALUES +lists\&. This results in a smaller dump file and speeds up inserts when the file is reloaded\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: fields-terminated-by option +.\" fields-terminated-by option: mysqldump +\fB\-\-fields\-terminated\-by=\&.\&.\&.\fR, +.\" mysqldump: fields-enclosed-by option +.\" fields-enclosed-by option: mysqldump +\fB\-\-fields\-enclosed\-by=\&.\&.\&.\fR, +.\" mysqldump: fields-optionally-enclosed-by option +.\" fields-optionally-enclosed-by option: mysqldump +\fB\-\-fields\-optionally\-enclosed\-by=\&.\&.\&.\fR, +.\" mysqldump: fields-escaped-by option +.\" fields-escaped-by option: mysqldump +\fB\-\-fields\-escaped\-by=\&.\&.\&.\fR +.sp +These options are used with the +\fB\-\-tab\fR +option and have the same meaning as the corresponding +FIELDS +clauses for +LOAD DATA INFILE\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: first-slave option +.\" first-slave option: mysqldump +\fB\-\-first\-slave\fR +.sp +Removed in MariaDB 5.5\&. Use +\fB\-\-lock\-all\-tables\fR +instead\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: flashback option +.\" flashback option: mysqldump +\fB\-\-flashback\fR, +\fB\-B\fR +.sp +Support flashback mode\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: flush-logs option +.\" flush-logs option: mysqldump +\fB\-\-flush\-logs\fR, +\fB\-F\fR +.sp +Flush the MariaDB server log files before starting the dump\&. This option requires the +RELOAD +privilege\&. If you use this option in combination with the +\fB\-\-all\-databases\fR +option, the logs are flushed +\fIfor each database dumped\fR\&. The exception is when using +\fB\-\-lock\-all\-tables\fR +or +\fB\-\-master\-data\fR: In this case, the logs are flushed only once, corresponding to the moment that all tables are locked\&. If you want your dump and the log flush to happen at exactly the same moment, you should use +\fB\-\-flush\-logs\fR +together with either +\fB\-\-lock\-all\-tables\fR +or +\fB\-\-master\-data\fR\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: flush-privileges option +.\" flush-privileges option: mysqldump +\fB\-\-flush\-privileges\fR +.sp +Send a +FLUSH PRIVILEGES +statement to the server after dumping the +mysql +database\&. This option should be used any time the dump contains the +mysql +database and any other database that depends on the data in the +mysql +database for proper restoration\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: force option +.\" force option: mysqldump +\fB\-\-force\fR, +\fB\-f\fR +.sp +Continue even if an SQL error occurs during a table dump\&. +.sp +One use for this option is to cause +\fBmysqldump\fR +to continue executing even when it encounters a view that has become invalid because the definition refers to a table that has been dropped\&. Without +\fB\-\-force\fR, +\fBmysqldump\fR +exits with an error message\&. With +\fB\-\-force\fR, +\fBmysqldump\fR +prints the error message, but it also writes an SQL comment containing the view definition to the dump output and continues executing\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: gtid option +.\" gtid option: mysqldump +\fB\-\-gtid\fR +.sp +Available from MariaDB 10.0.13, and is used together with \fB\-\-master\-data\fR and \fB\-\-dump\-slave\fR to more conveniently set up a new GTID slave\&. It causes those options to output SQL statements that configure the slave to use the global transaction ID to connect to the master instead of old-style filename/offset positions\&. The old-style positions are still included in comments when \fB\-\-gtid\fR is used; likewise the GTID position is included in comments even if \fB\-\-gtid\fR is not used\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: header option +.\" header option: mysqldump +\fB\-\-header\fR +.sp +Used together with --tab. When enabled, adds header with column names to the top of output txt files. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: hex-blob option +.\" hex-blob option: mysqldump +\fB\-\-hex\-blob\fR +.sp +Dump binary columns using hexadecimal notation (for example, 'abc' becomes +0x616263)\&. The affected data types are +BINARY, +VARBINARY, the +BLOB +types, and +BIT\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: host option +.\" host option: mysqldump +\fB\-\-host=\fR\fB\fIhost_name\fR\fR, +\fB\-h \fR\fB\fIhost_name\fR\fR +.sp +Dump data from the MariaDB server on the given host\&. The default host is +localhost\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: ignore-table option +.\" ignore-table option: mysqldump +\fB\-\-ignore\-table=\fR\fB\fIdb_name\&.tbl_name\fR\fR +.sp +Do not dump the given table, which must be specified using both the database and table names\&. To ignore multiple tables, use this option multiple times\&. This option also can be used to ignore views\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: include-master-host-port option +.\" include-master-host-port option: mysqldump +\fB\-\-include\-master\-host\-port\fR +.sp +Add the MASTER_HOST and MASTER_PORT options for the CHANGE MASTER TO statement when using +the \fB--dump-slave\fR option for a slave dump\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: insert-ignore option +.\" insert-ignore option: mysqldump +\fB\-\-insert\-ignore\fR +.sp +Write +INSERT IGNORE +statements rather than +INSERT +statements\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: lines-terminated-by option +.\" lines-terminated-by option: mysqldump +\fB\-\-lines\-terminated\-by=\&.\&.\&.\fR +.sp +This option is used with the +\fB\-\-tab\fR +option and has the same meaning as the corresponding +LINES +clause for +LOAD DATA INFILE\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: lock-all-tables option +.\" lock-all-tables option: mysqldump +\fB\-\-lock\-all\-tables\fR, +\fB\-x\fR +.sp +Lock all tables across all databases\&. This is achieved by acquiring a global read lock for the duration of the whole dump\&. This option automatically turns off +\fB\-\-single\-transaction\fR +and +\fB\-\-lock\-tables\fR\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: lock-tables option +.\" lock-tables option: mysqldump +\fB\-\-lock\-tables\fR, +\fB\-l\fR +.sp +For each dumped database, lock all tables to be dumped before dumping them\&. The tables are locked with +READ LOCAL +to allow concurrent inserts in the case of +MyISAM +tables\&. For transactional tables such as +InnoDB, +\fB\-\-single\-transaction\fR +is a much better option than +\fB\-\-lock\-tables\fR +because it does not need to lock the tables at all\&. +.sp +Because +\fB\-\-lock\-tables\fR +locks tables for each database separately, this option does not guarantee that the tables in the dump file are logically consistent between databases\&. Tables in different databases may be dumped in completely different states\&. +.sp +Use \fB--skip-lock-tables\fR to disable\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: log-error option +.\" log-error option: mysqldump +\fB\-\-log\-error=\fR\fB\fIfile_name\fR\fR +.sp +Log warnings and errors by appending them to the named file\&. The default is to do no logging\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: log-queries option +.\" log-queries option: mysqldump +\fB\-\-log\-queries\fR\fR +.sp +When restoring the dump, the server will, if logging is turned on, log the queries to the general and slow query log\&. +Defaults to on; use \fB--skip-log-queries\fR to disable\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: master-data option +.\" master-data option: mysqldump +\fB\-\-master\-data[=\fR\fB\fIvalue\fR\fR\fB]\fR +.sp +Use this option to dump a master replication server to produce a dump file that can be used to set up another server as a slave of the master\&. It causes the dump output to include a +CHANGE MASTER TO +statement that indicates the binary log coordinates (file name and position) of the dumped server\&. These are the master server coordinates from which the slave should start replicating after you load the dump file into the slave\&. +.sp +If the option value is 2, the +CHANGE MASTER TO +statement is written as an SQL comment, and thus is informative only; it has no effect when the dump file is reloaded\&. If the option value is 1, the statement is not written as a comment and takes effect when the dump file is reloaded\&. If no option value is specified, the default value is 1\&. +.sp +This option requires the +RELOAD +privilege and the binary log must be enabled\&. +.sp +The +\fB\-\-master\-data\fR +option automatically turns off +\fB\-\-lock\-tables\fR\&. It also turns on +\fB\-\-lock\-all\-tables\fR, unless +\fB\-\-single\-transaction\fR +also is specified\&. In all cases, any action on logs happens at the exact moment of the dump\&. +.sp +It is also possible to set up a slave by dumping an existing slave of the master\&. To do this, use the following procedure on the existing slave: +.sp +.RS 4 +.ie n \{\ +\h'-04' 1.\h'+01'\c +.\} +.el \{\ +.sp -1 +.IP " 1." 4.2 +.\} +Stop the slave's SQL thread and get its current status: +.sp +.if n \{\ +.RS 4 +.\} +.nf +mysql> \fBSTOP SLAVE SQL_THREAD;\fR +mysql> \fBSHOW SLAVE STATUS;\fR +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04' 2.\h'+01'\c +.\} +.el \{\ +.sp -1 +.IP " 2." 4.2 +.\} +From the output of the +SHOW SLAVE STATUS +statement, the binary log coordinates of the master server from which the new slave should start replicating are the values of the +Relay_Master_Log_File +and +Exec_Master_Log_Pos +fields\&. Denote those values as +\fIfile_name\fR +and +\fIfile_pos\fR\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04' 3.\h'+01'\c +.\} +.el \{\ +.sp -1 +.IP " 3." 4.2 +.\} +Dump the slave server: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysqldump \-\-master\-data=2 \-\-all\-databases > dumpfile\fR +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04' 4.\h'+01'\c +.\} +.el \{\ +.sp -1 +.IP " 4." 4.2 +.\} +Restart the slave: +.sp +.if n \{\ +.RS 4 +.\} +.nf +mysql> \fBSTART SLAVE;\fR +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04' 5.\h'+01'\c +.\} +.el \{\ +.sp -1 +.IP " 5." 4.2 +.\} +On the new slave, load the dump file: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysql < dumpfile\fR +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04' 6.\h'+01'\c +.\} +.el \{\ +.sp -1 +.IP " 6." 4.2 +.\} +On the new slave, set the replication coordinates to those of the master server obtained earlier: +.sp +.if n \{\ +.RS 4 +.\} +.nf +mysql> \fBCHANGE MASTER TO\fR + \-> \fBMASTER_LOG_FILE = '\fR\fB\fIfile_name\fR\fR\fB', MASTER_LOG_POS = \fR\fB\fIfile_pos\fR\fR\fB;\fR +.fi +.if n \{\ +.RE +.\} +.sp +The +CHANGE MASTER TO +statement might also need other parameters, such as +MASTER_HOST +to point the slave to the correct master server host\&. Add any such parameters as necessary\&. +.RE +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: max-allowed-packet option +.\" max-allowed-packet option: mysqldump +\fB\-\-max\-allowed\-packet=\fR\fB\fIlength\fR\fR +.sp +Sets the maximum packet length to send to or receive from server\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: max-statement-time option +.\" max-statement-time option: mysqldump +\fB\-\-max\-statement\-time=\fR\fB\fIseconds\fR\fR +.sp +Sets the maximum time any statement can run before being timed out by the server. (Default value is 0 (no limit))\& +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: net-buffer-length option +.\" net-buffer-length option: mysqldump +\fB\-\-net\-buffer\-length=\fR\fB\fIlength\fR\fR +.sp +Sets the buffer size for TCP/IP and socket communication\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: no-autocommit option +.\" no-autocommit option: mysqldump +\fB\-\-no\-autocommit\fR +.sp +Enclose the +INSERT +statements for each dumped table within +SET autocommit = 0 +and +COMMIT +statements\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: no-create-db option +.\" no-create-db option: mysqldump +\fB\-\-no\-create\-db\fR, +\fB\-n\fR +.sp +This option suppresses the +CREATE DATABASE +statements that are otherwise included in the output if the +\fB\-\-databases\fR +or +\fB\-\-all\-databases\fR +option is given\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: no-create-info option +.\" no-create-info option: mysqldump +\fB\-\-no\-create\-info\fR, +\fB\-t\fR +.sp +Do not write +CREATE TABLE +statements that re\-create each dumped table\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: no-data option +.\" no-data option: mysqldump +\fB\-\-no\-data\fR, +\fB\-d\fR +.sp +Do not write any table row information (that is, do not dump table contents)\&. This is useful if you want to dump only the +CREATE TABLE +statement for the table (for example, to create an empty copy of the table by loading the dump file)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: no-defaults option +.\" no-defaults option: mysqldump +\fB\-\-no\-defaults\fR +.sp +Do not read default options from any option file\&. This must be given as the first argument\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: no-set-names option +.\" no-set-names option: mysqldump +\fB\-\-no\-set\-names\fR, +\fB\-N\fR +.sp +This has the same effect as +\fB\-\-skip\-set\-charset\fR\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: opt option +.\" opt option: mysqldump +\fB\-\-opt\fR +.sp +This option is shorthand\&. It is the same as specifying +\fB\-\-add\-drop\-table\fR +\fB\-\-add\-locks\fR +\fB\-\-create\-options\fR +\fB\-\-disable\-keys\fR +\fB\-\-extended\-insert\fR +\fB\-\-lock\-tables\fR +\fB\-\-quick\fR +\fB\-\-set\-charset\fR\&. It should give you a fast dump operation and produce a dump file that can be reloaded into a MariaDB server quickly\&. +.sp +\fIThe \fR\fI\fB\-\-opt\fR\fR\fI option is enabled by default\&. Use \fR\fI\fB\-\-skip\-opt\fR\fR\fI to disable it\&.\fR +See the discussion at the beginning of this section for information about selectively enabling or disabling a subset of the options affected by +\fB\-\-opt\fR\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: order-by-primary option +.\" order-by-primary option: mysqldump +\fB\-\-order\-by\-primary\fR +.sp +Dump each table's rows sorted by its primary key, or by its first unique index, if such an index exists\&. This is useful when dumping a +MyISAM +table to be loaded into an +InnoDB +table, but will make the dump operation take considerably longer\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: password option +.\" password option: mysqldump +\fB\-\-password[=\fR\fB\fIpassword\fR\fR\fB]\fR, +\fB\-p[\fR\fB\fIpassword\fR\fR\fB]\fR +.sp +The password to use when connecting to the server\&. If you use the short option form (\fB\-p\fR), you +\fIcannot\fR +have a space between the option and the password\&. If you omit the +\fIpassword\fR +value following the +\fB\-\-password\fR +or +\fB\-p\fR +option on the command line, +\fBmysqldump\fR +prompts for one\&. +.sp +Specifying a password on the command line should be considered insecure\&. You can use an option file to avoid giving the password on the command line\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: pipe option +.\" pipe option: mysqldump +\fB\-\-pipe\fR, +\fB\-W\fR +.sp +On Windows, connect to the server via a named pipe\&. This option applies only if the server supports named\-pipe connections\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: plugin-dir option +.\" plugin-dir option: mysqldump +\fB\-\-plugin\-dir\fR +.sp +Directory for client-side plugins\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: port option +.\" port option: mysqldump +\fB\-\-port=\fR\fB\fIport_num\fR\fR, +\fB\-P \fR\fB\fIport_num\fR\fR +.sp +The TCP/IP port number to use for the connection\&. +Forces --protocol=tcp when specified on the command line without other connection properties\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: protocol option +.\" protocol option: mysqldump +\fB\-\-protocol={TCP|SOCKET|PIPE|MEMORY}\fR +.sp +The connection protocol to use for connecting to the server\&. It is useful when the other connection parameters normally would cause a protocol to be used other than the one you want\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: quick option +.\" quick option: mysqldump +\fB\-\-quick\fR, +\fB\-q\fR +.sp +This option is useful for dumping large tables\&. It forces +\fBmysqldump\fR +to retrieve rows for a table from the server a row at a time rather than retrieving the entire row set and buffering it in memory before writing it out\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: print-defaults option +.\" print-defaults option: mysqldump +\fB\-\-print\-defaults\fR +.sp +Print the program argument list and exit\&. This must be given as the first argument\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: quote-names option +.\" quote-names option: mysqldump +\fB\-\-quote\-names\fR, +\fB\-Q\fR +.sp +Quote identifiers (such as database, table, and column names) within +\(lq`\(rq +characters\&. If the +ANSI_QUOTES +SQL mode is enabled, identifiers are quoted within +\(lq"\(rq +characters\&. This option is enabled by default\&. It can be disabled with +\fB\-\-skip\-quote\-names\fR, but this option should be given after any option such as +\fB\-\-compatible\fR +that may enable +\fB\-\-quote\-names\fR\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: replace option +.\" replace option: mysqldump +\fB\-\-replace\fR +.sp +Write +REPLACE +statements rather than +INSERT +statements\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: result-file option +.\" result-file option: mysqldump +\fB\-\-result\-file=\fR\fB\fIfile_name\fR\fR, +\fB\-r \fR\fB\fIfile_name\fR\fR +.sp +Direct output to a given file\&. This option should be used on Windows to prevent newline +\(lq\en\(rq +characters from being converted to +\(lq\er\en\(rq +carriage return/newline sequences\&. The result file is created and its previous contents overwritten, even if an error occurs while generating the dump\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: routines option +.\" routines option: mysqldump +\fB\-\-routines\fR, +\fB\-R\fR +.sp +Included stored routines (procedures and functions) for the dumped databases in the output\&. Use of this option requires the +SELECT +privilege for the +mysql\&.proc +table\&. The output generated by using +\fB\-\-routines\fR +contains +CREATE PROCEDURE +and +CREATE FUNCTION +statements to re\-create the routines\&. However, these statements do not include attributes such as the routine creation and modification timestamps\&. This means that when the routines are reloaded, they will be created with the timestamps equal to the reload time\&. +.sp +If you require routines to be re\-created with their original timestamp attributes, do not use +\fB\-\-routines\fR\&. Instead, dump and reload the contents of the +mysql\&.proc +table directly, using a MariaDB account that has appropriate privileges for the +mysql +database\&. +.sp +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: set-charset option +.\" set-charset option: mysqldump +\fB\-\-set\-charset\fR +.sp +Add +SET NAMES \fIdefault_character_set\fR +to the output\&. This option is enabled by default\&. To suppress the +SET NAMES +statement, use +\fB\-\-skip\-set\-charset\fR\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: single-transaction option +.\" single-transaction option: mysqldump +\fB\-\-single\-transaction\fR +.sp +This option sends a +START TRANSACTION +SQL statement to the server before dumping data\&. It is useful only with transactional tables such as +InnoDB, because then it dumps the consistent state of the database at the time when +BEGIN +was issued without blocking any applications\&. +.sp +When using this option, you should keep in mind that only +InnoDB +tables are dumped in a consistent state\&. For example, any +MyISAM +or +MEMORY +tables dumped while using this option may still change state\&. +.sp +While a +\fB\-\-single\-transaction\fR +dump is in process, to ensure a valid dump file (correct table contents and binary log coordinates), no other connection should use the following statements: +ALTER TABLE, +CREATE TABLE, +DROP TABLE, +RENAME TABLE, +TRUNCATE TABLE\&. A consistent read is not isolated from those statements, so use of them on a table to be dumped can cause the +SELECT +that is performed by +\fBmysqldump\fR +to retrieve the table contents to obtain incorrect contents or fail\&. +.sp +The +\fB\-\-single\-transaction\fR +option and the +\fB\-\-lock\-tables\fR +option are mutually exclusive because +LOCK TABLES +causes any pending transactions to be committed implicitly\&. +.sp +To dump large tables, you should combine the +\fB\-\-single\-transaction\fR +option with +\fB\-\-quick\fR\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: skip-add-drop-table option +.\" skip-add-drop-table option: mysqldump +\fB\-\-skip\-add\-drop\-table\fR +.sp +Disable the +\fB\-\-add\-drop\-table\fR +option\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: skip-add-locks option +.\" skip-add-locks option: mysqldump +\fB\-\-skip\-add\-locks\fR +.sp +Disable the +\fB\-\-add\-locks\fR +option\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: skip-comments option +.\" skip-comments option: mysqldump +\fB\-\-skip\-comments\fR +.sp +Disable the +\fB\-\-comments\fR +option\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: skip-compact option +.\" skip-compact option: mysqldump +\fB\-\-skip\-compact\fR +.sp +Disable the +\fB\-\-compact\fR +option\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: skip-disable-keys option +.\" skip-disable-keys option: mysqldump +\fB\-\-skip\-disable\-keys\fR +.sp +Disable the +\fB\-\-disable\-keys\fR +option\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: skip-extended-insert option +.\" skip-extended-insert option: mysqldump +\fB\-\-skip\-extended\-insert\fR +.sp +Disable the +\fB\-\-extended\-insert\fR +option\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: skip-opt option +.\" skip-opt option: mysqldump +\fB\-\-skip\-opt\fR +.sp +Disable the +\fB\-\-opt\fR +option\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: skip-quick option +.\" skip-quick option: mysqldump +\fB\-\-skip\-quick\fR +.sp +Disable the +\fB\-\-quick\fR +option\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: skip-quote-names option +.\" skip-quote-names option: mysqldump +\fB\-\-skip\-quote\-names\fR +.sp +Disable the +\fB\-\-quote\-names\fR +option\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: skip-set-charset option +.\" skip-set-charset option: mysqldump +\fB\-\-skip\-set\-charset\fR +.sp +Disable the +\fB\-\-set\-charset\fR +option\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: skip-triggers option +.\" skip-triggers option: mysqldump +\fB\-\-skip\-triggers\fR +.sp +Disable the +\fB\-\-triggers\fR +option\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: skip-tz-utc option +.\" skip-tz-utc option: mysqldump +\fB\-\-skip\-tz\-utc\fR +.sp +Disable the +\fB\-\-tz\-utc\fR +option\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: socket option +.\" socket option: mysqldump +\fB\-\-socket=\fR\fB\fIpath\fR\fR, +\fB\-S \fR\fB\fIpath\fR\fR +.sp +For connections to +localhost, the Unix socket file to use, or, on Windows, the name of the named pipe to use\&. +Forces --protocol=socket when specified on the command line without other connection properties; on Windows, forces --protocol=pipe\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqladmin: SSL options +.\" SSL options: mysqladmin +\fB\-\-ssl\fR +.sp +Enable SSL for connection (automatically enabled with other flags). Disable with +\fB\-\-skip-ssl\fR\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqladmin: SSL CA option +.\" SSL CA option: mysqladmin +\fB\-\-ssl\-ca=\fIname\fR +.sp +CA file in PEM format (check OpenSSL docs, implies +\fB\-\-ssl\fR)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqladmin: SSL CA Path option +.\" SSL CA Path option: mysqladmin +\fB\-\-ssl\-capath=\fIname\fR +.sp +CA directory (check OpenSSL docs, implies +\fB\-\-ssl\fR)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqladmin: SSL Cert option +.\" SSL Cert option: mysqladmin +\fB\-\-ssl\-cert=\fIname\fR +.sp +X509 cert in PEM format (check OpenSSL docs, implies +\fB\-\-ssl\fR)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqladmin: SSL Cipher option +.\" SSL Cipher option: mysqladmin +\fB\-\-ssl\-cipher=\fIname\fR +.sp +SSL cipher to use (check OpenSSL docs, implies +\fB\-\-ssl\fR)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqladmin: SSL Key option +.\" SSL Key option: mysqladmin +\fB\-\-ssl\-key=\fIname\fR +.sp +X509 key in PEM format (check OpenSSL docs, implies +\fB\-\-ssl\fR)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqladmin: SSL Crl option +.\" SSL CRL option: mysqladmin +\fB\-\-ssl\-crl=\fIname\fR +.sp +Certificate revocation list (check OpenSSL docs, implies +\fB\-\-ssl\fR)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqladmin: SSL Crlpath option +.\" SSL Crlpath option: mysqladmin +\fB\-\-ssl\-crlpath=\fIname\fR +.sp +Certificate revocation list path (check OpenSSL docs, implies +\fB\-\-ssl\fR)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqladmin: SSL Verify Server Cert option +.\" SSL Verify Server Cert option: mysqladmin +\fB\-\-ssl\-verify\-server\-cert\fR +.sp +Verify server's "Common Name" in its cert against hostname used when connecting. This option is disabled by default\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqladmin: Dump system tables option +.\" Dump system tables option: mysqladmin +\fB\-\-system=\fR\fB\fI{all, users, plugins, udfs, servers, stats, timezones}\fR\fR +.sp +Dump the system tables in the mysql database in a logical form\&. This option is an empty set by default\&. +.sp +One or more options can be listed in comma separated list\&. +.sp +The options here are: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +all \- an alias to enabling all of the below options\&. +.RE +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +users \- the users, roles and their grants outputed as \fBCREATE USER\fB, \fBCREATE ROLE\fR, \fBGRANT\fR, and \fBSET DEFAULT ROLE\fR (\fBALTER USER\fR for MySQL-8.0+)\&. +.RE +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +plugins \- active plugins of the server outputed as \fBINSTALL PLUGIN\fR\&. +.RE +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +udfs \- user define functions outputed as \fBCREATE FUNCTION\fR\&. +.RE +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +servers \- remote (federated) servers as \fBCREATE SERVER\fR\&. +.RE +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +stats \- statistics tables, InnoDB and Engine Independent Table Statistics (EITS), are dumped as \fBREPLACE INTO\fR (or \fBINSERT IGNORE\fR if \fB\-\-insert\-ignore\fR is specified) statements without (re)creating tables\&. +.RE +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +timezones \- timezone related system tables dumped as \fBREPLACE INTO\fR (or \fBINSERT IGNORE\fR if \fB\-\-insert\-ignore\fR is specified) statements without (re)creating tables\&. +.RE +.sp +The format of the output is affected by \fB\-\-replace\fR and \fB\-\-insert\-ignore\fR\&. The \fB\-\-replace\fR option will output \fBCREATE OR REPLACE\fR +forms of SQL, and also \fBDROP IF EXISTS\fR prior to \fBCREATE\fR, if a \fBCREATE OR REPLACE\fR option isn't available. +.sp +With \fB\-\-system=user\fR (or \fBall\fR), and \fB\-\-replace\fR, SQL is generated to generate an error if attempting to import the dump with a connection user that is being replaced within the dump\&. +.sp +The \fB\-\-insert\-ignore\fR option will cause \fBCREATE IF NOT EXIST\fR forms of SQL to generated if available. +.sp +For stats, and timezones, \fB\-\-replace\fR and \fB\-\-insert\-ignore\fR have the usual effects. +.sp +Enabling specific options here will cause the relevant tables in the mysql database to be ignored when dumping the mysql database or \fB\-\-all\-databases\fR\&. +.sp +To help in migrating from MySQL to MariaDB, this option is designed to be able to dump system information from MySQL-5\&.7 and 8\&.0 servers\&. SQL generated is also experimentally compatible with MySQL-5\&.7/8\&.0. Mappings of implementation specific grants/plugins isn't always one-to-one however between MariaDB and MySQL and will require manual changes\&. +.sp +.RE +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: tab option +.\" tab option: mysqldump +\fB\-\-tab=\fR\fB\fIpath\fR\fR, +\fB\-T \fR\fB\fIpath\fR\fR +.sp +Produce tab\-separated text\-format data files\&. For each dumped table, +\fBmysqldump\fR +creates a +\fItbl_name\fR\&.sql +file that contains the +CREATE TABLE +statement that creates the table, and the server writes a +\fItbl_name\fR\&.txt +file that contains its data\&. The option value is the directory in which to write the files\&. +.if n \{\ +.sp +.\} +.RS 4 +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.ps +1 +\fBNote\fR +.ps -1 +.br +This option should be used only when +\fBmysqldump\fR +is run on the same machine as the +\fBmysqld\fR +server\&. You must have the +FILE +privilege, and the server must have permission to write files in the directory that you specify\&. +.sp .5v +.RE +By default, the +\&.txt +data files are formatted using tab characters between column values and a newline at the end of each line\&. The format can be specified explicitly using the +\fB\-\-fields\-\fR\fB\fIxxx\fR\fR +and +\fB\-\-lines\-terminated\-by\fR +options\&. +.sp +Column values are converted to the character set specified by the +\fB\-\-default\-character\-set\fR +option\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: tables option +.\" tables option: mysqldump +\fB\-\-tables\fR +.sp +Override the +\fB\-\-databases\fR +or +\fB\-B\fR +option\&. +\fBmysqldump\fR +regards all name arguments following the option as table names\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: triggers option +.\" triggers option: mysqldump +\fB\-\-triggers\fR +.sp +Include triggers for each dumped table in the output\&. This option is enabled by default; disable it with +\fB\-\-skip\-triggers\fR\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: tz-utc option +.\" tz-utc option: mysqldump +\fB\-\-tz\-utc\fR +.sp +This option enables +TIMESTAMP +columns to be dumped and reloaded between servers in different time zones\&. +\fBmysqldump\fR +sets its connection time zone to UTC and adds +SET TIME_ZONE='+00:00' +to the dump file\&. Without this option, +TIMESTAMP +columns are dumped and reloaded in the time zones local to the source and destination servers, which can cause the values to change if the servers are in different time zones\&. +\fB\-\-tz\-utc\fR +also protects against changes due to daylight saving time\&. +\fB\-\-tz\-utc\fR +is enabled by default\&. To disable it, use +\fB\-\-skip\-tz\-utc\fR\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: user option +.\" user option: mysqldump +\fB\-\-user=\fR\fB\fIuser_name\fR\fR, +\fB\-u \fR\fB\fIuser_name\fR\fR +.sp +The MariaDB user name to use when connecting to the server\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: verbose option +.\" verbose option: mysqldump +\fB\-\-verbose\fR, +\fB\-v\fR +.sp +Verbose mode\&. Print more information about what the program does\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: version option +.\" version option: mysqldump +\fB\-\-version\fR, +\fB\-V\fR +.sp +Display version information and exit\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: where option +.\" where option: mysqldump +\fB\-\-where='\fR\fB\fIwhere_condition\fR\fR\fB'\fR, +\fB\-w '\fR\fB\fIwhere_condition\fR\fR\fB'\fR +.sp +Dump only rows selected by the given +WHERE +condition\&. Quotes around the condition are mandatory if it contains spaces or other characters that are special to your command interpreter\&. +.sp +Examples: +.sp +.if n \{\ +.RS 4 +.\} +.nf +\-\-where="user='jimf'" +\-w"userid>1" +\-w"userid<1" +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldump: xml option +.\" xml option: mysqldump +\fB\-\-xml\fR, +\fB\-X\fR +.sp +Write dump output as well\-formed XML\&. +.sp +\fBNULL\fR\fB, \fR\fB'NULL'\fR\fB, and Empty Values\fR: For a column named +\fIcolumn_name\fR, the NULL value, an empty string, and the string value 'NULL' +are distinguished from one another in the output generated by this option as follows\&. +.TS +allbox tab(:); +l lx. +T{ +\fBValue\fR: +T}:T{ +\fBXML Representation\fR: +T} +T{ +NULL (\fIunknown value\fR) +T}:T{ +<field name="\fIcolumn_name\fR" xsi:nil="true" /> +T} +T{ +\(aq\(aq (\fIempty string\fR) +T}:T{ +<field name="\fIcolumn_name\fR"></field> +T} +T{ +\(aqNULL\(aq (\fIstring value\fR) +T}:T{ +<field name="\fIcolumn_name\fR">NULL</field> +T} +.TE +.sp 1 +The output from the +\fBmysql\fR +client when run using the +\fB\-\-xml\fR +option also follows the preceding rules\&. (See +the section called \(lqMYSQL OPTIONS\(rq\&.) +.sp +XML output from +\fBmysqldump\fR +includes the XML namespace, as shown here: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysqldump \-\-xml \-u root world City\fR +<?xml version="1\&.0"?> +<mysqldump xmlns:xsi="http://www\&.w3\&.org/2001/XMLSchema\-instance"> +<database name="world"> +<table_structure name="City"> +<field Field="ID" Type="int(11)" Null="NO" Key="PRI" Extra="auto_increment" /> +<field Field="Name" Type="char(35)" Null="NO" Key="" Default="" Extra="" /> +<field Field="CountryCode" Type="char(3)" Null="NO" Key="" Default="" Extra="" /> +<field Field="District" Type="char(20)" Null="NO" Key="" Default="" Extra="" /> +<field Field="Population" Type="int(11)" Null="NO" Key="" Default="0" Extra="" /> +<key Table="City" Non_unique="0" Key_name="PRIMARY" Seq_in_index="1" Column_name="ID" +Collation="A" Cardinality="4079" Null="" Index_type="BTREE" Comment="" /> +<options Name="City" Engine="MyISAM" Version="10" Row_format="Fixed" Rows="4079" +Avg_row_length="67" Data_length="273293" Max_data_length="18858823439613951" +Index_length="43008" Data_free="0" Auto_increment="4080" +Create_time="2007\-03\-31 01:47:01" Update_time="2007\-03\-31 01:47:02" +Collation="latin1_swedish_ci" Create_options="" Comment="" /> +</table_structure> +<table_data name="City"> +<row> +<field name="ID">1</field> +<field name="Name">Kabul</field> +<field name="CountryCode">AFG</field> +<field name="District">Kabol</field> +<field name="Population">1780000</field> +</row> +\fI\&.\&.\&.\fR +<row> +<field name="ID">4079</field> +<field name="Name">Rafah</field> +<field name="CountryCode">PSE</field> +<field name="District">Rafah</field> +<field name="Population">92020</field> +</row> +</table_data> +</database> +</mysqldump> +.fi +.if n \{\ +.RE +.\} +.sp +.RE +.PP +You can also set the following variables by using +\fB\-\-\fR\fB\fIvar_name\fR\fR\fB=\fR\fB\fIvalue\fR\fR +syntax: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +max_allowed_packet +.sp +The maximum size of the buffer for client/server communication\&. The maximum is 1GB\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +max_statement_time +.sp +A query that has taken more than max_statement_time seconds will be aborted and the backup will +fail\&. The argument will be treated as a decimal value with microsecond precision\&. A value +of 0 (default) means no timeout\&. The maximum timeout is 31536000 seconds\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +net_buffer_length +.sp +The initial size of the buffer for client/server communication\&. When creating multiple\-row +INSERT +statements (as with the +\fB\-\-extended\-insert\fR +or +\fB\-\-opt\fR +option), +\fBmysqldump\fR +creates rows up to +net_buffer_length +length\&. If you increase this variable, you should also ensure that the +net_buffer_length +variable in the MariaDB server is at least this large\&. +.RE +.PP +A common use of +\fBmysqldump\fR +is for making a backup of an entire database: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysqldump \fR\fB\fIdb_name\fR\fR\fB > \fR\fB\fIbackup\-file\&.sql\fR\fR +.fi +.if n \{\ +.RE +.\} +.PP +You can load the dump file back into the server like this: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysql \fR\fB\fIdb_name\fR\fR\fB < \fR\fB\fIbackup\-file\&.sql\fR\fR +.fi +.if n \{\ +.RE +.\} +.PP +Or like this: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysql \-e "source \fR\fB\fI/path\-to\-backup/backup\-file\&.sql\fR\fR\fB" \fR\fB\fIdb_name\fR\fR +.fi +.if n \{\ +.RE +.\} +.PP +\fBmysqldump\fR +is also very useful for populating databases by copying data from one MariaDB server to another: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysqldump \-\-opt \fR\fB\fIdb_name\fR\fR\fB | mysql \-\-host=\fR\fB\fIremote_host\fR\fR\fB \-C \fR\fB\fIdb_name\fR\fR +.fi +.if n \{\ +.RE +.\} +.PP +It is possible to dump several databases with one command: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysqldump \-\-databases \fR\fB\fIdb_name1\fR\fR\fB [\fR\fB\fIdb_name2\fR\fR\fB \&.\&.\&.] > my_databases\&.sql\fR +.fi +.if n \{\ +.RE +.\} +.PP +To dump all databases, use the +\fB\-\-all\-databases\fR +option: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysqldump \-\-all\-databases > all_databases\&.sql\fR +.fi +.if n \{\ +.RE +.\} +.PP +For +InnoDB +tables, +\fBmysqldump\fR +provides a way of making an online backup: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysqldump \-\-all\-databases \-\-single\-transaction > all_databases\&.sql\fR +.fi +.if n \{\ +.RE +.\} +.PP +This backup acquires a global read lock on all tables (using +FLUSH TABLES WITH READ LOCK) at the beginning of the dump\&. As soon as this lock has been acquired, the binary log coordinates are read and the lock is released\&. If long updating statements are running when the +FLUSH +statement is issued, the MariaDB server may get stalled until those statements finish\&. After that, the dump becomes lock free and does not disturb reads and writes on the tables\&. If the update statements that the MariaDB server receives are short (in terms of execution time), the initial lock period should not be noticeable, even with many updates\&. +.PP +For point\-in\-time recovery (also known as +\(lqroll\-forward,\(rq +when you need to restore an old backup and replay the changes that happened since that backup), it is often useful to rotate the binary log or at least know the binary log coordinates to which the dump corresponds: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysqldump \-\-all\-databases \-\-master\-data=2 > all_databases\&.sql\fR +.fi +.if n \{\ +.RE +.\} +.PP +Or: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysqldump \-\-all\-databases \-\-flush\-logs \-\-master\-data=2\fR + \fB> all_databases\&.sql\fR +.fi +.if n \{\ +.RE +.\} +.PP +The +\fB\-\-master\-data\fR +and +\fB\-\-single\-transaction\fR +options can be used simultaneously, which provides a convenient way to make an online backup suitable for use prior to point\-in\-time recovery if tables are stored using the +InnoDB +storage engine\&. +.PP +.\" mysqldump: views +.\" mysqldump: problems +.\" mysqldump: workarounds +.PP +If you encounter problems backing up views, please read the section that covers restrictions on views which describes a workaround for backing up views when this fails due to insufficient privileges\&. +.SH "COPYRIGHT" +.br +.PP +Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc., 2010-2020 MariaDB Foundation +.PP +This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License. +.PP +This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. +.PP +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-1335 USA or see http://www.gnu.org/licenses/. +.sp +.SH "SEE ALSO" +For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/ +.SH AUTHOR +MariaDB Foundation (http://www.mariadb.org/). diff --git a/man/mysqldumpslow.1 b/man/mysqldumpslow.1 new file mode 100644 index 00000000..960c634d --- /dev/null +++ b/man/mysqldumpslow.1 @@ -0,0 +1,332 @@ +'\" t +.\" +.TH "\fBMARIADB-DUMPSLOW\fR" "1" "15 May 2020" "MariaDB 10.11" "MariaDB Database System" +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.\" mysqldumpslow +.SH "NAME" +mariadb-dumpslow \- Summarize slow query log files (mysqldumpslow is now a symlink to mariadb-dumpslow) +.SH "SYNOPSIS" +.HP \w'\fBmysqldumpslow\ [\fR\fBoptions\fR\fB]\ [\fR\fB\fIlog_file\fR\fR\fB\ \&.\&.\&.]\fR\ 'u +\fBmysqldumpslow [\fR\fBoptions\fR\fB] [\fR\fB\fIlog_file\fR\fR\fB \&.\&.\&.]\fR +.SH "DESCRIPTION" +.PP +The MariaDB slow query log contains information about queries that take a long time to execute\&. +\fBmysqldumpslow\fR +parses MariaDB slow query log files and prints a summary of their contents\&. +.PP +Normally, +\fBmysqldumpslow\fR +groups queries that are similar except for the particular values of number and string data values\&. It +\(lqabstracts\(rq +these values to N and 'S' when displaying summary output\&. The +\fB\-a\fR +and +\fB\-n\fR +options can be used to modify value abstracting behavior\&. +.PP +Invoke +\fBmysqldumpslow\fR +like this: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysqldumpslow [\fR\fB\fIoptions\fR\fR\fB] [\fR\fB\fIlog_file\fR\fR\fB \&.\&.\&.]\fR +.fi +.if n \{\ +.RE +.\} +.PP +\fBmysqldumpslow\fR +supports the following options\&. +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldumpslow: help option +.\" help option: mysqldumpslow +\fB\-\-help\fR +.sp +Display a help message and exit\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fB\-a\fR +.sp +Do not abstract all numbers to N and strings to 'S'. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldumpslow: debug option +.\" debug option: mysqldumpslow +\fB\-\-debug\fR, +\fB\-d\fR +.sp +Run in debug mode\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fB\-g \fR\fB\fIpattern\fR\fR +.sp +Consider only queries that match the (\fBgrep\fR\-style) pattern\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fB\-h \fR\fB\fIhost_name\fR\fR +.sp +Host name of MariaDB server for +*\-slow\&.log +file name\&. The value can contain a wildcard\&. The default is +* +(match all)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fB\-i \fR\fB\fIname\fR\fR +.sp +Name of server instance (if using +\fBmysql\&.server\fR +startup script)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fB\-l\fR +.sp +Do not subtract lock time from total time\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fB\-n \fR\fB\fIN\fR\fR +.sp +Abstract numbers with at least +\fIN\fR +digits within names\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fB\-r\fR +.sp +Reverse the sort order\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fB\-s \fR\fB\fIsort_type\fR\fR +.sp +How to sort the output\&. The value of +\fIsort_type\fR +should be chosen from the following list: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +t, +aa: Sort by rows affected or average rows affected +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +l, +ae: Sort by rows examined or aggregate rows examined +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +l, +at: Sort by query time or average query time +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +l, +al: Sort by lock time or average lock time +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +s, +as: Sort by rows sent or average rows sent +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +c: Sort by count +.RE +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fB\-t \fR\fB\fIN\fR\fR +.sp +Display only the first +\fIN\fR +queries in the output\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqldumpslow: verbose option +.\" verbose option: mysqldumpslow +\fB\-\-verbose\fR, +\fB\-v\fR +.sp +Verbose mode\&. Print more information about what the program does\&. +.RE +.PP +Example of usage: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysqldumpslow\fR +Reading mysql slow query log from /usr/local/mysql/data/mysqld51\-apple\-slow\&.log +Count: 1 Time=4\&.32s (4s) Lock=0\&.00s (0s) Rows=0\&.0 (0), root[root]@localhost + insert into t2 select * from t1 +Count: 3 Time=2\&.53s (7s) Lock=0\&.00s (0s) Rows=0\&.0 (0), root[root]@localhost + insert into t2 select * from t1 limit N +Count: 3 Time=2\&.13s (6s) Lock=0\&.00s (0s) Rows=0\&.0 (0), root[root]@localhost + insert into t1 select * from t1 +.fi +.if n \{\ +.RE +.\} +.SH "COPYRIGHT" +.br +.PP +Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc., 2010-2020 MariaDB Foundation +.PP +This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License. +.PP +This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. +.PP +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-1335 USA or see http://www.gnu.org/licenses/. +.sp +.SH "SEE ALSO" +For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/ +.SH AUTHOR +MariaDB Foundation (http://www.mariadb.org/). diff --git a/man/mysqlhotcopy.1 b/man/mysqlhotcopy.1 new file mode 100644 index 00000000..01f26c15 --- /dev/null +++ b/man/mysqlhotcopy.1 @@ -0,0 +1,534 @@ +'\" t +.\" +.TH "\fBMARIADB-HOTCOPY\fR" "1" "15 May 2020" "MariaDB 10.11" "MariaDB Database System" +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.\" mysqlhotcopy +.\" dumping: databases and tables +.\" backups: databases and tables +.\" databases: dumping +.\" tables: dumping +.SH "NAME" +mariadb-hotcopy \- a database backup program (mysqlhotcopy is now a symlink to mariadb-hotcopy) +.SH "SYNOPSIS" +.HP \w'\fBmysqlhotcopy\ \fR\fB\fIarguments\fR\fR\ 'u +\fBmysqlhotcopy \fR\fB\fIarguments\fR\fR +.SH "DESCRIPTION" +.PP +\fBmysqlhotcopy\fR +is a Perl script that was originally written and contributed by Tim Bunce\&. It uses +FLUSH TABLES, +LOCK TABLES, and +cp +or +scp +to make a database backup\&. It is a fast way to make a backup of the database or single tables, but it can be run only on the same machine where the database directories are located\&. +\fBmysqlhotcopy\fR +works only for backing up +MyISAM +and +ARCHIVE +tables\&. It runs on Unix and NetWare\&. +.PP +To use +\fBmysqlhotcopy\fR, you must have read access to the files for the tables that you are backing up, the +SELECT +privilege for those tables, the +RELOAD +privilege (to be able to execute +FLUSH TABLES), and the +LOCK TABLES +privilege (to be able to lock the tables)\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysqlhotcopy \fR\fB\fIdb_name\fR\fR\fB [\fR\fB\fI/path/to/new_directory\fR\fR\fB]\fR +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysqlhotcopy \fR\fB\fIdb_name_1\fR\fR\fB \&.\&.\&. \fR\fB\fIdb_name_n\fR\fR\fB \fR\fB\fI/path/to/new_directory\fR\fR +.fi +.if n \{\ +.RE +.\} +.PP +Back up tables in the given database that match a regular expression: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysqlhotcopy \fR\fB\fIdb_name\fR\fR\fB\&./\fR\fB\fIregex\fR\fR\fB/\fR +.fi +.if n \{\ +.RE +.\} +.PP +The regular expression for the table name can be negated by prefixing it with a tilde (\(lq~\(rq): +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysqlhotcopy \fR\fB\fIdb_name\fR\fR\fB\&./~\fR\fB\fIregex\fR\fR\fB/\fR +.fi +.if n \{\ +.RE +.\} +.PP +\fBmysqlhotcopy\fR +supports the following options, which can be specified on the command line or in the +[mysqlhotcopy] +and +[client] +option file groups\&. +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlhotcopy: help option +.\" help option: mysqlhotcopy +\fB\-\-help\fR, +\fB\-?\fR +.sp +Display a help message and exit\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlhotcopy: addtodest option +.\" addtodest option: mysqlhotcopy +\fB\-\-addtodest\fR +.sp +Do not rename target directory (if it exists); merely add files to it\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlhotcopy: allowold option +.\" allowold option: mysqlhotcopy +\fB\-\-allowold\fR +.sp +Do not abort if a target exists; rename it by adding an +_old +suffix\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlhotcopy: checkpoint option +.\" checkpoint option: mysqlhotcopy +\fB\-\-checkpoint=\fR\fB\fIdb_name\fR\fR\fB\&.\fR\fB\fItbl_name\fR\fR +.sp +Insert checkpoint entries into the specified database +\fIdb_name\fR +and table +\fItbl_name\fR\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlhotcopy: chroot option +.\" chroot option: mysqlhotcopy +\fB\-\-chroot=\fR\fB\fIpath\fR\fR +.sp +Base directory of the +\fBchroot\fR +jail in which +\fBmysqld\fR +operates\&. The +\fIpath\fR +value should match that of the +\fB\-\-chroot\fR +option given to +\fBmysqld\fR\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlhotcopy: debug option +.\" debug option: mysqlhotcopy +\fB\-\-debug\fR +.sp +Enable debug output\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlhotcopy: dryrun option +.\" dryrun option: mysqlhotcopy +\fB\-\-dryrun\fR, +\fB\-n\fR +.sp +Report actions without performing them\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlhotcopy: flushlog option +.\" flushlog option: mysqlhotcopy +\fB\-\-flushlog\fR +.sp +Flush logs after all tables are locked\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlhotcopy: host option +.\" host option: mysqlhotcopy +\fB\-\-host=\fR\fB\fIhost_name\fR\fR, +\fB\-h \fR\fB\fIhost_name\fR\fR +.sp +The host name of the local host to use for making a TCP/IP connection to the local server\&. By default, the connection is made to +localhost +using a Unix socket file\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlhotcopy: keepold option +.\" keepold option: mysqlhotcopy +\fB\-\-keepold\fR +.sp +Do not delete previous (renamed) target when done\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlhotcopy: method option +.\" method option: mysqlhotcopy +\fB\-\-method=\fR\fB\fIcommand\fR\fR +.sp +The method for copying files (cp +or +scp)\&. The default is +cp\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlhotcopy: noindices option +.\" noindices option: mysqlhotcopy +\fB\-\-noindices\fR +.sp +Do not include full index files for +MyISAM +tables in the backup\&. This makes the backup smaller and faster\&. The indexes for reloaded tables can be reconstructed later with +\fBmyisamchk \-rq\fR\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlhotcopy: old-server option +.\" old-server option: mysqlhotcopy +\fB\-\-old\-server\fR +.sp +Connect to old MySQL-server (before v5.5) which doesn't have FLUSH TABLES WITH READ LOCK fully implemented.\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlhotcopy: password option +.\" password option: mysqlhotcopy +\fB\-\-password=\fR\fB\fIpassword\fR\fR, +\fB\-p\fR\fB\fIpassword\fR\fR +.sp +The password to use when connecting to the server\&. The password value is not optional for this option, unlike for other MariaDB programs\&. +.sp +Specifying a password on the command line should be considered insecure\&. You can use an option file to avoid giving the password on the command line\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlhotcopy: port option +.\" port option: mysqlhotcopy +\fB\-\-port=\fR\fB\fIport_num\fR\fR, +\fB\-P \fR\fB\fIport_num\fR\fR +.sp +The TCP/IP port number to use when connecting to the local server\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlhotcopy: quiet option +.\" quiet option: mysqlhotcopy +\fB\-\-quiet\fR, +\fB\-q\fR +.sp +Be silent except for errors\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlhotcopy: record_log_pos option +.\" record_log_pos option: mysqlhotcopy +\fB\-\-record_log_pos=\fR\fB\fIdb_name\fR\fR\fB\&.\fR\fB\fItbl_name\fR\fR +.sp +Record master and slave status in the specified database +\fIdb_name\fR +and table +\fItbl_name\fR\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlhotcopy: regexp option +.\" regexp option: mysqlhotcopy +\fB\-\-regexp=\fR\fB\fIexpr\fR\fR +.sp +Copy all databases with names that match the given regular expression\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlhotcopy: resetmaster option +.\" resetmaster option: mysqlhotcopy +\fB\-\-resetmaster\fR +.sp +Reset the binary log after locking all the tables\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlhotcopy: resetslave option +.\" resetslave option: mysqlhotcopy +\fB\-\-resetslave\fR +.sp +Reset the +master\&.info +file after locking all the tables\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlhotcopy: socket option +.\" socket option: mysqlhotcopy +\fB\-\-socket=\fR\fB\fIpath\fR\fR, +\fB\-S \fR\fB\fIpath\fR\fR +.sp +The Unix socket file to use for connections to +localhost\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlhotcopy: suffix option +.\" suffix option: mysqlhotcopy +\fB\-\-suffix=\fR\fB\fIstr\fR\fR +.sp +The suffix to use for names of copied databases\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlhotcopy: tmpdir option +.\" tmpdir option: mysqlhotcopy +\fB\-\-tmpdir=\fR\fB\fIpath\fR\fR +.sp +The temporary directory\&. The default is +/tmp\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlhotcopy: user option +.\" user option: mysqlhotcopy +\fB\-\-user=\fR\fB\fIuser_name\fR\fR, +\fB\-u \fR\fB\fIuser_name\fR\fR +.sp +The MariaDB user name to use when connecting to the server\&. +.RE +.PP +Use +perldoc +for additional +\fBmysqlhotcopy\fR +documentation, including information about the structure of the tables needed for the +\fB\-\-checkpoint\fR +and +\fB\-\-record_log_pos\fR +options: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBperldoc mysqlhotcopy\fR +.fi +.if n \{\ +.RE +.\} +.SH "COPYRIGHT" +.br +.PP +Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc., 2010-2020 MariaDB Foundation +.PP +This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License. +.PP +This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. +.PP +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-1335 USA or see http://www.gnu.org/licenses/. +.sp +.SH "SEE ALSO" +For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/ +.SH AUTHOR +MariaDB Foundation (http://www.mariadb.org/). diff --git a/man/mysqlimport.1 b/man/mysqlimport.1 new file mode 100644 index 00000000..99578950 --- /dev/null +++ b/man/mysqlimport.1 @@ -0,0 +1,877 @@ +'\" t +.\" +.TH "\fBMARIADB-IMPORT\fR" "1" "15 May 2020" "MariaDB 10.11" "MariaDB Database System" +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.\" mysqlimport +.\" importing: data +.\" data: importing +.\" files: text +.\" text files: importing +.SH "NAME" +mariadb-import \- a data import program (mysqlimport is now a symlink to mariadb-import) +.SH "SYNOPSIS" +.HP \w'\fBmysqlimport\ [\fR\fB\fIoptions\fR\fR\fB]\ \fR\fB\fIdb_name\fR\fR\fB\ \fR\fB\fItextfile1\fR\fR\fB\ \&.\&.\&.\fR\ 'u +\fBmysqlimport [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fIdb_name\fR\fR\fB \fR\fB\fItextfile1\fR\fR\fB \&.\&.\&.\fR +.SH "DESCRIPTION" +.PP +The +\fBmysqlimport\fR +client provides a command\-line interface to the +LOAD DATA INFILE +SQL statement\&. Most options to +\fBmysqlimport\fR +correspond directly to clauses of +LOAD DATA INFILE +syntax\&. +.PP +Invoke +\fBmysqlimport\fR +like this: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysqlimport [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fIdb_name\fR\fR\fB \fR\fB\fItextfile1\fR\fR\fB [\fR\fB\fItextfile2\fR\fR\fB \&.\&.\&.]\fR +.fi +.if n \{\ +.RE +.\} +.PP +For each text file named on the command line, +\fBmysqlimport\fR +strips any extension from the file name and uses the result to determine the name of the table into which to import the file's contents\&. For example, files named +patient\&.txt, +patient\&.text, and +patient +all would be imported into a table named +patient\&. +.PP +.PP +\fBmysqlimport\fR +supports the following options, which can be specified on the command line or in the +[mysqlimport] +and +[client] +option file groups\&. +\fBmysqlimport\fR +also supports the options for processing option files\&. +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlimport: help option +.\" help option: mysqlimport +\fB\-\-help\fR, +\fB\-?\fR +.sp +Display a help message and exit\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlimport: character-sets-dir option +.\" character-sets-dir option: mysqlimport +\fB\-\-character\-sets\-dir=\fR\fB\fIpath\fR\fR +.sp +The directory where character sets are installed\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlimport: columns option +.\" columns option: mysqlimport +\fB\-\-columns=\fR\fB\fIcolumn_list\fR\fR, +\fB\-c \fR\fB\fIcolumn_list\fR\fR +.sp +This option takes a comma\-separated list of column names as its value\&. The order of the column names indicates how to match data file columns with table columns\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlimport: compress option +.\" compress option: mysqlimport +\fB\-\-compress\fR, +\fB\-C\fR +.sp +Compress all information sent between the client and the server if both support compression\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlimport: debug option +.\" debug option: mysqlimport +\fB\-\-debug[=\fR\fB\fIdebug_options\fR\fR\fB]\fR, +\fB\-# [\fR\fB\fIdebug_options\fR\fR\fB]\fR +.sp +Write a debugging log\&. A typical +\fIdebug_options\fR +string is 'd:t:o,\fIfile_name\fR'. The default is 'd:t:o'. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlimport: debug-check option +.\" debug-check option: mysqlimport +\fB\-\-debug\-check\fR +.sp +Print some debugging information when the program exits\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlimport: debug-info option +.\" debug-info option: mysqlimport +\fB\-\-debug\-info\fR +.sp +Print debugging information and memory and CPU usage statistics when the program exits\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlimport: default-auth option +.\" default-auth option: mysqlimport +\fB\-\-default\-auth=\fIplugin_name\fR +.sp +Default authentication client-side plugin to use\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlimport: default-character-set option +.\" default-character-set option: mysqlimport +\fB\-\-default\-character\-set=\fR\fB\fIcharset_name\fR\fR +.sp +Use +\fIcharset_name\fR +as the default character set\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlimport: defaults-extra-file option +.\" defaults-extra-file option: mysqlimport +\fB\-\-defaults\-extra\-file=\fR\fB\fIfilename\fR\fR +.sp +Set \fB\fIfilename\fR\fR as the file to read default options from after the global defaults files has been +read\&. Must be given as first option\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlimport: defaults-file option +.\" defaults-file option: mysqlimport +\fB\-\-defaults\-file=\fR\fB\fIfilename\fR\fR +.sp +Set \fB\fIfilename\fR\fR as the file to read default options from, override global defaults files\&. +Must be given as first option\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlimport: delete option +.\" delete option: mysqlimport +\fB\-\-delete\fR, +\fB\-d\fR +.sp +Empty the table before importing the text file\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlimport: fields-terminated-by option +.\" fields-terminated-by option: mysqlimport +\fB\-\-fields\-terminated\-by=\&.\&.\&.\fR, +.\" mysqlimport: fields-enclosed-by option +.\" fields-enclosed-by option: mysqlimport +\fB\-\-fields\-enclosed\-by=\&.\&.\&.\fR, +.\" mysqlimport: fields-optionally-enclosed-by option +.\" fields-optionally-enclosed-by option: mysqlimport +\fB\-\-fields\-optionally\-enclosed\-by=\&.\&.\&.\fR, +.\" mysqlimport: fields-escaped-by option +.\" fields-escaped-by option: mysqlimport +\fB\-\-fields\-escaped\-by=\&.\&.\&.\fR +.sp +These options have the same meaning as the corresponding clauses for +LOAD DATA INFILE\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlimport: force option +.\" force option: mysqlimport +\fB\-\-force\fR, +\fB\-f\fR +.sp +Ignore errors\&. For example, if a table for a text file does not exist, continue processing any remaining files\&. Without +\fB\-\-force\fR, +\fBmysqlimport\fR +exits if a table does not exist\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlimport: host option +.\" host option: mysqlimport +\fB\-\-host=\fR\fB\fIhost_name\fR\fR, +\fB\-h \fR\fB\fIhost_name\fR\fR +.sp +Import data to the MariaDB server on the given host\&. The default host is +localhost\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlimport: ignore option +.\" ignore option: mysqlimport +\fB\-\-ignore\fR, +\fB\-i\fR +.sp +See the description for the +\fB\-\-replace\fR +option\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlimport: ignore-foreign-keys option +.\" ignore-foreign-keys option: mysqlimport +\fB\-\-ignore\-foreign\-keys\fR, +\fB\-k\fR +.sp +Disable foreign key checks while importing the data\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlimport: ignore-lines option +.\" ignore-lines option: mysqlimport +\fB\-\-ignore\-lines=\fR\fB\fIN\fR\fR +.sp +Ignore the first +\fIN\fR +lines of the data file\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlimport: lines-terminated-by option +.\" lines-terminated-by option: mysqlimport +\fB\-\-lines\-terminated\-by=\&.\&.\&.\fR +.sp +This option has the same meaning as the corresponding clause for +LOAD DATA INFILE\&. For example, to import Windows files that have lines terminated with carriage return/linefeed pairs, use +\fB\-\-lines\-terminated\-by="\er\en"\fR\&. (You might have to double the backslashes, depending on the escaping conventions of your command interpreter\&.)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlimport: local option +.\" local option: mysqlimport +\fB\-\-local\fR, +\fB\-L\fR +.sp +Read input files locally from the client host\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlimport: lock-tables option +.\" lock-tables option: mysqlimport +\fB\-\-lock\-tables\fR, +\fB\-l\fR +.sp +Lock +\fIall\fR +tables for writing before processing any text files\&. This ensures that all tables are synchronized on the server\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlimport: low-priority option +.\" low-priority option: mysqlimport +\fB\-\-low\-priority\fR +.sp +Use +LOW_PRIORITY +when loading the table\&. This affects only storage engines that use only table\-level locking (such as +MyISAM, +MEMORY, and +MERGE)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlimport: no-defaults option +.\" no-defaults option: mysqlimport +\fB\-\-no\-defaults\fR +.sp +Do not read default options from any option file\&. This must be given as the +first argument\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlimport: password option +.\" password option: mysqlimport +\fB\-\-password[=\fR\fB\fIpassword\fR\fR\fB]\fR, +\fB\-p[\fR\fB\fIpassword\fR\fR\fB]\fR +.sp +The password to use when connecting to the server\&. If you use the short option form (\fB\-p\fR), you +\fIcannot\fR +have a space between the option and the password\&. If you omit the +\fIpassword\fR +value following the +\fB\-\-password\fR +or +\fB\-p\fR +option on the command line, +\fBmysqlimport\fR +prompts for one\&. +.sp +Specifying a password on the command line should be considered insecure\&. You can use an option file to avoid giving the password on the command line\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlimport: pipe option +.\" pipe option: mysqlimport +\fB\-\-pipe\fR, +\fB\-W\fR +.sp +On Windows, connect to the server via a named pipe\&. This option applies only if the server supports named\-pipe connections\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlimport: plugin-dir option +.\" plugin-dir option: mysqlimport +\fB\-\-plugin\-dir=\fR\fB\fIname\fR\fR +.sp + Directory for client-side plugins\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlimport: port option +.\" port option: mysqlimport +\fB\-\-port=\fR\fB\fIport_num\fR\fR, +\fB\-P \fR\fB\fIport_num\fR\fR +.sp +The TCP/IP port number to use for the connection\&. +Forces --protocol=tcp when specified on the command line without other connection properties\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlimport: protocol option +.\" protocol option: mysqlimport +\fB\-\-protocol={TCP|SOCKET|PIPE|MEMORY}\fR +.sp +The connection protocol to use for connecting to the server\&. It is useful when the other connection parameters normally would cause a protocol to be used other than the one you want\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlimport: print-defaults option +.\" print-defaults option: mysqlimport +\fB\-\-print\-defaults\fR +.sp +Print the program argument list and exit\&. +This must be given as the first argument\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlimport: replace option +.\" replace option: mysqlimport +\fB\-\-replace\fR, +\fB\-r\fR +.sp +The +\fB\-\-replace\fR +and +\fB\-\-ignore\fR +options control handling of input rows that duplicate existing rows on unique key values\&. If you specify +\fB\-\-replace\fR, new rows replace existing rows that have the same unique key value\&. If you specify +\fB\-\-ignore\fR, input rows that duplicate an existing row on a unique key value are skipped\&. If you do not specify either option, an error occurs when a duplicate key value is found, and the rest of the text file is ignored\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlimport: silent option +.\" silent option: mysqlimport +\fB\-\-silent\fR, +\fB\-s\fR +.sp +Silent mode\&. Produce output only when errors occur\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlimport: socket option +.\" socket option: mysqlimport +\fB\-\-socket=\fR\fB\fIpath\fR\fR, +\fB\-S \fR\fB\fIpath\fR\fR +.sp +For connections to +localhost, the Unix socket file to use, or, on Windows, the name of the named pipe to use\&. +Forces --protocol=socket when specified on the command line without other connection properties; on Windows, forces --protocol=pipe\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqladmin: SSL options +.\" SSL options: mysqladmin +\fB\-\-ssl\fR +.sp +Enable SSL for connection (automatically enabled with other flags). Disable with +\fB\-\-skip-ssl\fR\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqladmin: SSL CA option +.\" SSL CA option: mysqladmin +\fB\-\-ssl\-ca=\fIname\fR +.sp +CA file in PEM format (check OpenSSL docs, implies +\fB\-\-ssl\fR)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqladmin: SSL CA Path option +.\" SSL CA Path option: mysqladmin +\fB\-\-ssl\-capath=\fIname\fR +.sp +CA directory (check OpenSSL docs, implies +\fB\-\-ssl\fR)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqladmin: SSL Cert option +.\" SSL Cert option: mysqladmin +\fB\-\-ssl\-cert=\fIname\fR +.sp +X509 cert in PEM format (check OpenSSL docs, implies +\fB\-\-ssl\fR)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqladmin: SSL Cipher option +.\" SSL Cipher option: mysqladmin +\fB\-\-ssl\-cipher=\fIname\fR +.sp +SSL cipher to use (check OpenSSL docs, implies +\fB\-\-ssl\fR)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqladmin: SSL Key option +.\" SSL Key option: mysqladmin +\fB\-\-ssl\-key=\fIname\fR +.sp +X509 key in PEM format (check OpenSSL docs, implies +\fB\-\-ssl\fR)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqladmin: SSL Crl option +.\" SSL CRL option: mysqladmin +\fB\-\-ssl\-crl=\fIname\fR +.sp +Certificate revocation list (check OpenSSL docs, implies +\fB\-\-ssl\fR)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqladmin: SSL Crlpath option +.\" SSL Crlpath option: mysqladmin +\fB\-\-ssl\-crlpath=\fIname\fR +.sp +Certificate revocation list path (check OpenSSL docs, implies +\fB\-\-ssl\fR)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqladmin: SSL Verify Server Cert option +.\" SSL Verify Server Cert option: mysqladmin +\fB\-\-ssl\-verify\-server\-cert\fR +.sp +Verify server's "Common Name" in its cert against hostname used when connecting. This option is disabled by default\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlimport: user option +.\" user option: mysqlimport +\fB\-\-user=\fR\fB\fIuser_name\fR\fR, +\fB\-u \fR\fB\fIuser_name\fR\fR +.sp +The MariaDB user name to use when connecting to the server\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlimport: use-threads option +.\" use-threads option: mysqlimport +\fB\-\-use\-threads=\fR\fB\fIN\fR\fR +.sp +Load files in parallel using +\fIN\fR +threads\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlimport: verbose option +.\" verbose option: mysqlimport +\fB\-\-verbose\fR, +\fB\-v\fR +.sp +Verbose mode\&. Print more information about what the program does\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlimport: version option +.\" version option: mysqlimport +\fB\-\-version\fR, +\fB\-V\fR +.sp +Display version information and exit\&. +.RE +.PP +Here is a sample session that demonstrates use of +\fBmysqlimport\fR: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysql \-e 'CREATE TABLE imptest(id INT, n VARCHAR(30))' test\fR +shell> \fBed\fR +a +100 Max Sydow +101 Count Dracula +\&. +w imptest\&.txt +32 +q +shell> \fBod \-c imptest\&.txt\fR +0000000 1 0 0 \et M a x S y d o w \en 1 0 +0000020 1 \et C o u n t D r a c u l a \en +0000040 +shell> \fBmysqlimport \-\-local test imptest\&.txt\fR +test\&.imptest: Records: 2 Deleted: 0 Skipped: 0 Warnings: 0 +shell> \fBmysql \-e 'SELECT * FROM imptest' test\fR ++\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+ +| id | n | ++\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+ +| 100 | Max Sydow | +| 101 | Count Dracula | ++\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+ +.fi +.if n \{\ +.RE +.\} +.SH "COPYRIGHT" +.br +.PP +Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc., 2010-2020 MariaDB Foundation +.PP +This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License. +.PP +This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. +.PP +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-1335 USA or see http://www.gnu.org/licenses/. +.sp +.SH "SEE ALSO" +For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/ +.SH AUTHOR +MariaDB Foundation (http://www.mariadb.org/). diff --git a/man/mysqlshow.1 b/man/mysqlshow.1 new file mode 100644 index 00000000..85b20a97 --- /dev/null +++ b/man/mysqlshow.1 @@ -0,0 +1,719 @@ +'\" t +.\" +.TH "\fBMARIADB-SHOW\fR" "1" "15 May 2020" "MariaDB 10.11" "MariaDB Database System" +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.\" mysqlshow +.\" databases: displaying +.\" displaying: database information +.\" tables: displaying +.\" columns: displaying +.\" showing: database information +.SH "NAME" +mariadb-show \- display database, table, and column information (mysqlshow is now a symlink to mariadb-show) +.SH "SYNOPSIS" +.HP \w'\fBmysqlshow\ [\fR\fB\fIoptions\fR\fR\fB]\ [\fR\fB\fIdb_name\fR\fR\fB\ [\fR\fB\fItbl_name\fR\fR\fB\ [\fR\fB\fIcol_name\fR\fR\fB]]]\fR\ 'u +\fBmysqlshow [\fR\fB\fIoptions\fR\fR\fB] [\fR\fB\fIdb_name\fR\fR\fB [\fR\fB\fItbl_name\fR\fR\fB [\fR\fB\fIcol_name\fR\fR\fB]]]\fR +.SH "DESCRIPTION" +.PP +The +\fBmysqlshow\fR +client can be used to quickly see which databases exist, their tables, or a table's columns or indexes\&. +.PP +\fBmysqlshow\fR +provides a command\-line interface to several SQL +SHOW +statements\&. The same information can be obtained by using those statements directly\&. For example, you can issue them from the +\fBmysql\fR +client program\&. +.PP +Invoke +\fBmysqlshow\fR +like this: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysqlshow [\fR\fB\fIoptions\fR\fR\fB] [\fR\fB\fIdb_name\fR\fR\fB [\fR\fB\fItbl_name\fR\fR\fB [\fR\fB\fIcol_name\fR\fR\fB]]]\fR +.fi +.if n \{\ +.RE +.\} +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +If no database is given, a list of database names is shown\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +If no table is given, all matching tables in the database are shown\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +If no column is given, all matching columns and column types in the table are shown\&. +.RE +.PP +The output displays only the names of those databases, tables, or columns for which you have some privileges\&. +.PP +If the last argument contains shell or SQL wildcard characters (\(lq*\(rq, +\(lq?\(rq, +\(lq%\(rq, or +\(lq_\(rq), only those names that are matched by the wildcard are shown\&. If a database name contains any underscores, those should be escaped with a backslash (some Unix shells require two) to get a list of the proper tables or columns\&. +\(lq*\(rq +and +\(lq?\(rq +characters are converted into SQL +\(lq%\(rq +and +\(lq_\(rq +wildcard characters\&. This might cause some confusion when you try to display the columns for a table with a +\(lq_\(rq +in the name, because in this case, +\fBmysqlshow\fR +shows you only the table names that match the pattern\&. This is easily fixed by adding an extra +\(lq%\(rq +last on the command line as a separate argument\&. +.PP +\fBmysqlshow\fR +supports the following options, which can be specified on the command line or in the +[mysqlshow] +and +[client] +option file groups\&. +\fBmysqlshow\fR +also supports the options for processing option files described. +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlshow: help option +.\" help option: mysqlshow +\fB\-\-help\fR, +\fB\-?\fR +.sp +Display a help message and exit\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlshow: character-sets-dir option +.\" character-sets-dir option: mysqlshow +\fB\-\-character\-sets\-dir=\fR\fB\fIpath\fR\fR, +\fB\-c\fR \fIpath\fR\fR +.sp +The directory where character sets are installed\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlshow: compress option +.\" compress option: mysqlshow +\fB\-\-compress\fR, +\fB\-C\fR +.sp +Compress all information sent between the client and the server if both support compression\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlshow: count option +.\" count option: mysqlshow +\fB\-\-count\fR +.sp +Show the number of rows per table\&. This can be slow for non\-MyISAM +tables\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlshow: debug option +.\" debug option: mysqlshow +\fB\-\-debug[=\fR\fB\fIdebug_options\fR\fR\fB]\fR, +\fB\-# [\fR\fB\fIdebug_options\fR\fR\fB]\fR +.sp +Write a debugging log\&. A typical +\fIdebug_options\fR +string is 'd:t:o,\fIfile_name\fR'. The default is 'd:t:o'. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlshow: debug-check option +.\" debug-check option: mysqlshow +\fB\-\-debug\-check\fR +.sp +Print some debugging information when the program exits\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlshow: debug-info option +.\" debug-info option: mysqlshow +\fB\-\-debug\-info\fR +.sp +Print debugging information and memory and CPU usage statistics when the program exits\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlshow: default-auth option +.\" default-auth option: mysqlshow +\fB\-\-default\-auth=\fR\fB\fIname\fR +.sp +Default authentication client-side plugin to use\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlshow: default-character-set option +.\" default-character-set option: mysqlshow +\fB\-\-default\-character\-set=\fR\fB\fIcharset_name\fR\fR +.sp +Use +\fIcharset_name\fR +as the default character set\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlshow: defaults-extra-file option +.\" defaults-extra-file option: mysqlshow +\fB\-\-defaults\-extra\-file=\fR\fB\fIfilename\fR\fR +.sp +Set \fB\fIfilename\fR\fR as the file to read default options from after the global defaults files has been +read\&. Must be given as first option\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlshow: defaults-file option +.\" defaults-file option: mysqlshow +\fB\-\-defaults\-file=\fR\fB\fIfilename\fR\fR +.sp +Set \fB\fIfilename\fR\fR as the file to read default options from, override global defaults files\&. +Must be given as first option\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlshow: defaults-group-suffix option +.\" defaults-group-suffix option: mysqlshow +\fB\-\-defaults\-group\-suffix=\fR\fB\fIsuffix\fR\fR +.sp +In addition to the groups named on the command line, read groups that have the given suffix\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlshow: host option +.\" host option: mysqlshow +\fB\-\-host=\fR\fB\fIhost_name\fR\fR, +\fB\-h \fR\fB\fIhost_name\fR\fR +.sp +Connect to the MariaDB server on the given host\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlshow: keys option +.\" keys option: mysqlshow +\fB\-\-keys\fR, +\fB\-k\fR +.sp +Show table indexes\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlshow: no-defaults option +.\" no-defaults option: mysqlshow +\fB\-\-no\-defaults\fR +.sp +Do not read default options from any option file\&. This must be given as the +first argument\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlshow: password option +.\" password option: mysqlshow +\fB\-\-password[=\fR\fB\fIpassword\fR\fR\fB]\fR, +\fB\-p[\fR\fB\fIpassword\fR\fR\fB]\fR +.sp +The password to use when connecting to the server\&. If you use the short option form (\fB\-p\fR), you +\fIcannot\fR +have a space between the option and the password\&. If you omit the +\fIpassword\fR +value following the +\fB\-\-password\fR +or +\fB\-p\fR +option on the command line, +\fBmysqlshow\fR +prompts for one\&. +.sp +Specifying a password on the command line should be considered insecure\&. You can use an option file to avoid giving the password on the command line\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlshow: pipe option +.\" pipe option: mysqlshow +\fB\-\-pipe\fR, +\fB\-W\fR +.sp +On Windows, connect to the server via a named pipe\&. This option applies only if the server supports named\-pipe connections\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlshow: plugin-dir option +.\" plugin-dir option: mysqlshow +\fB\-\-plugin\-dir=\fIdir_name\fR +.sp +Directory for client-side plugins\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlshow: port option +.\" port option: mysqlshow +\fB\-\-port=\fR\fB\fIport_num\fR\fR, +\fB\-P \fR\fB\fIport_num\fR\fR +.sp +The TCP/IP port number to use for the connection\&. +Forces --protocol=tcp when specified on the command line without other connection properties\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlshow: protocol option +.\" protocol option: mysqlshow +\fB\-\-protocol={TCP|SOCKET|PIPE|MEMORY}\fR +.sp +The connection protocol to use for connecting to the server\&. It is useful when the other connection parameters normally would cause a protocol to be used other than the one you want\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlshow: print-defaults option +.\" print-defaults option: mysqlshow +\fB\-\-print\-defaults\fR +.sp +Print the program argument list and exit\&. +This must be given as the first argument\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlshow: show-table-type option +.\" show-table-type option: mysqlshow +\fB\-\-show\-table\-type\fR, +\fB\-t\fR +.sp +Show a column indicating the table type, as in +SHOW FULL TABLES\&. The type is +BASE TABLE +or +VIEW\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlshow: socket option +.\" socket option: mysqlshow +\fB\-\-socket=\fR\fB\fIpath\fR\fR, +\fB\-S \fR\fB\fIpath\fR\fR +.sp +For connections to +localhost, the Unix socket file to use, or, on Windows, the name of the named pipe to use\&. +Forces --protocol=socket when specified on the command line without other connection properties; on Windows, forces --protocol=pipe\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlshow: SSL options +.\" SSL options: mysqlshow +\fB\-\-ssl\fR +.sp +Enable SSL for connection (automatically enabled with other flags). Disable with +\fB\-\-skip-ssl\fR\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlshow: SSL CA option +.\" SSL CA option: mysqlshow +\fB\-\-ssl\-ca=\fIname\fR +.sp +CA file in PEM format (check OpenSSL docs, implies +\fB\-\-ssl\fR)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlshow: SSL CA Path option +.\" SSL CA Path option: mysqlshow +\fB\-\-ssl\-capath=\fIname\fR +.sp +CA directory (check OpenSSL docs, implies +\fB\-\-ssl\fR)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlshow: SSL Cert option +.\" SSL Cert option: mysqlshow +\fB\-\-ssl\-cert=\fIname\fR +.sp +X509 cert in PEM format (check OpenSSL docs, implies +\fB\-\-ssl\fR)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlshow: SSL Cipher option +.\" SSL Cipher option: mysqlshow +\fB\-\-ssl\-cipher=\fIname\fR +.sp +SSL cipher to use (check OpenSSL docs, implies +\fB\-\-ssl\fR)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlshow: SSL Key option +.\" SSL Key option: mysqlshow +\fB\-\-ssl\-key=\fIname\fR +.sp +X509 key in PEM format (check OpenSSL docs, implies +\fB\-\-ssl\fR)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlshow: SSL Crl option +.\" SSL CRL option: mysqlshow +\fB\-\-ssl\-crl=\fIname\fR +.sp +Certificate revocation list (check OpenSSL docs, implies +\fB\-\-ssl\fR)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlshow: SSL Crlpath option +.\" SSL Crlpath option: mysqlshow +\fB\-\-ssl\-crlpath=\fIname\fR +.sp +Certificate revocation list path (check OpenSSL docs, implies +\fB\-\-ssl\fR)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlshow: SSL Verify Server Cert option +.\" SSL Verify Server Cert option: mysqlshow +\fB\-\-ssl\-verify\-server\-cert\fR +.sp +Verify server's "Common Name" in its cert against hostname used when connecting. This option is disabled by default\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlshow: status option +.\" status option: mysqlshow +\fB\-\-status\fR, +\fB\-i\fR +.sp +Display extra information about each table\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlshow: user option +.\" user option: mysqlshow +\fB\-\-user=\fR\fB\fIuser_name\fR\fR, +\fB\-u \fR\fB\fIuser_name\fR\fR +.sp +The MariaDB user name to use when connecting to the server\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlshow: verbose option +.\" verbose option: mysqlshow +\fB\-\-verbose\fR, +\fB\-v\fR +.sp +Verbose mode\&. Print more information about what the program does\&. This option can be used multiple times to increase the amount of information\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlshow: version option +.\" version option: mysqlshow +\fB\-\-version\fR, +\fB\-V\fR +.sp +Display version information and exit\&. +.RE +.SH "COPYRIGHT" +.br +.PP +Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc., 2010-2020 MariaDB Foundation +.PP +This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License. +.PP +This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. +.PP +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-1335 USA or see http://www.gnu.org/licenses/. +.sp +.SH "SEE ALSO" +For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/ +.SH AUTHOR +MariaDB Foundation (http://www.mariadb.org/). diff --git a/man/mysqlslap.1 b/man/mysqlslap.1 new file mode 100644 index 00000000..dbb458ce --- /dev/null +++ b/man/mysqlslap.1 @@ -0,0 +1,1165 @@ +'\" t +.\" +.TH "\fBMARIADB-SLAP\fR" "1" "15 May 2020" "MariaDB 10.11" "MariaDB Database System" +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.\" mysqlslap +.\" load emulation +.SH "NAME" +mariadb-slap \- load emulation client (mysqlslap is now a symlink to mariadb-slap) +.SH "SYNOPSIS" +.HP \w'\fBmysqlslap\ [\fR\fB\fIoptions\fR\fR\fB]\fR\ 'u +\fBmysqlslap [\fR\fB\fIoptions\fR\fR\fB]\fR +.SH "DESCRIPTION" +.PP +\fBmysqlslap\fR +is a diagnostic program designed to emulate client load for a MariaDB server and to report the timing of each stage\&. It works as if multiple clients are accessing the server\&. +.PP +Invoke +\fBmysqlslap\fR +like this: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysqlslap [\fR\fB\fIoptions\fR\fR\fB]\fR +.fi +.if n \{\ +.RE +.\} +.PP +Some options such as +\fB\-\-create\fR +or +\fB\-\-query\fR +enable you to specify a string containing an SQL statement or a file containing statements\&. If you specify a file, by default it must contain one statement per line\&. (That is, the implicit statement delimiter is the newline character\&.) Use the +\fB\-\-delimiter\fR +option to specify a different delimiter, which enables you to specify statements that span multiple lines or place multiple statements on a single line\&. You cannot include comments in a file; +\fBmysqlslap\fR +does not understand them\&. +.PP +\fBmysqlslap\fR +runs in three stages: +.sp +.RS 4 +.ie n \{\ +\h'-04' 1.\h'+01'\c +.\} +.el \{\ +.sp -1 +.IP " 1." 4.2 +.\} +Create schema, table, and optionally any stored programs or data you want to using for the test\&. This stage uses a single client connection\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04' 2.\h'+01'\c +.\} +.el \{\ +.sp -1 +.IP " 2." 4.2 +.\} +Run the load test\&. This stage can use many client connections\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04' 3.\h'+01'\c +.\} +.el \{\ +.sp -1 +.IP " 3." 4.2 +.\} +Clean up (disconnect, drop table if specified)\&. This stage uses a single client connection\&. +.RE +.PP +Examples: +.PP +Supply your own create and query SQL statements, with 50 clients querying and 200 selects for each: +.sp +.if n \{\ +.RS 4 +.\} +.nf +mysqlslap \-\-delimiter=";" \e + \-\-create="CREATE TABLE a (b int);INSERT INTO a VALUES (23)" \e + \-\-query="SELECT * FROM a" \-\-concurrency=50 \-\-iterations=200 +.fi +.if n \{\ +.RE +.\} +.PP +Let +\fBmysqlslap\fR +build the query SQL statement with a table of two +INT +columns and three +VARCHAR +columns\&. Use five clients querying 20 times each\&. Do not create the table or insert the data (that is, use the previous test's schema and data): +.sp +.if n \{\ +.RS 4 +.\} +.nf +mysqlslap \-\-concurrency=5 \-\-iterations=20 \e + \-\-number\-int\-cols=2 \-\-number\-char\-cols=3 \e + \-\-auto\-generate\-sql +.fi +.if n \{\ +.RE +.\} +.PP +Tell the program to load the create, insert, and query SQL statements from the specified files, where the create\&.sql +file has multiple table creation statements delimited by ';' and multiple insert statements delimited by ';'\&. The +\fB\-\-query\fR +file will have multiple queries delimited by ';'\&. Run all the load statements, +then run all the queries in the query file with five clients (five times each): +.sp +.if n \{\ +.RS 4 +.\} +.nf +mysqlslap \-\-concurrency=5 \e + \-\-iterations=5 \-\-query=query\&.sql \-\-create=create\&.sql \e + \-\-delimiter=";" +.fi +.if n \{\ +.RE +.\} +.PP +\fBmysqlslap\fR +supports the following options, which can be specified on the command line or in the +[mysqlslap] +and +[client] +option file groups\&. +\fBmysqlslap\fR +also supports the options for processing option files\&. +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlslap: help option +.\" help option: mysqlslap +\fB\-\-help\fR, +\fB\-?\fR +.sp +Display a help message and exit\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlslap: auto-generate-sql option +.\" auto-generate-sql option: mysqlslap +\fB\-\-auto\-generate\-sql\fR, +\fB\-a\fR +.sp +Generate SQL statements automatically when they are not supplied in files or via command options\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlslap: auto-generate-sql-add-autoincrement option +.\" auto-generate-sql-add-autoincrement option: mysqlslap +\fB\-\-auto\-generate\-sql\-add\-autoincrement\fR +.sp +Add an +AUTO_INCREMENT +column to automatically generated tables\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlslap: auto-generate-sql-execute-number option +.\" auto-generate-sql-execute-number option: mysqlslap +\fB\-\-auto\-generate\-sql\-execute\-number=\fR\fB\fIN\fR\fR +.sp +Specify how many queries to generate automatically\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlslap: auto-generate-sql-guid-primary option +.\" auto-generate-sql-guid-primary option: mysqlslap +\fB\-\-auto\-generate\-sql\-guid\-primary\fR +.sp +Add a GUID\-based primary key to automatically generated tables\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlslap: auto-generate-sql-load-type option +.\" auto-generate-sql-load-type option: mysqlslap +\fB\-\-auto\-generate\-sql\-load\-type=\fR\fB\fItype\fR\fR +.sp +Specify the test load type\&. The allowable values are +read +(scan tables), +write +(insert into tables), +key +(read primary keys), +update +(update primary keys), or +mixed +(half inserts, half scanning selects)\&. The default is +mixed\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlslap: auto-generate-sql-secondary-indexes option +.\" auto-generate-sql-secondary-indexes option: mysqlslap +\fB\-\-auto\-generate\-sql\-secondary\-indexes=\fR\fB\fIN\fR\fR +.sp +Specify how many secondary indexes to add to automatically generated tables\&. By default, none are added\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlslap: auto-generate-sql-unique-query-number option +.\" auto-generate-sql-unique-query-number option: mysqlslap +\fB\-\-auto\-generate\-sql\-unique\-query\-number=\fR\fB\fIN\fR\fR +.sp +How many different queries to generate for automatic tests\&. For example, if you run a +key +test that performs 1000 selects, you can use this option with a value of 1000 to run 1000 unique queries, or with a value of 50 to perform 50 different selects\&. The default is 10\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlslap: auto-generate-sql-unique-write-number option +.\" auto-generate-sql-unique-write-number option: mysqlslap +\fB\-\-auto\-generate\-sql\-unique\-write\-number=\fR\fB\fIN\fR\fR +.sp +How many different queries to generate for +\fB\-\-auto\-generate\-sql\-write\-number\fR\&. The default is 10\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlslap: auto-generate-sql-write-number option +.\" auto-generate-sql-write-number option: mysqlslap +\fB\-\-auto\-generate\-sql\-write\-number=\fR\fB\fIN\fR\fR +.sp +How many row inserts to perform on each thread\&. The default is 100\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlslap: commit option +.\" commit option: mysqlslap +\fB\-\-commit=\fR\fB\fIN\fR\fR +.sp +How many statements to execute before committing\&. The default is 0 (no commits are done)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlslap: compress option +.\" compress option: mysqlslap +\fB\-\-compress\fR, +\fB\-C\fR +.sp +Compress all information sent between the client and the server if both support compression\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlslap: concurrency option +.\" concurrency option: mysqlslap +\fB\-\-concurrency=\fR\fB\fIN\fR\fR, +\fB\-c \fR\fB\fIN\fR\fR +.sp +The number of clients to simulate when issuing the +SELECT +statement\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlslap: create option +.\" create option: mysqlslap +\fB\-\-create=\fR\fB\fIvalue\fR\fR +.sp +The file or string containing the statement to use for creating the table\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlslap: create-schema option +.\" create-schema option: mysqlslap +\fB\-\-create\-schema=\fR\fB\fIvalue\fR\fR +.sp +The schema in which to run the tests\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlslap: csv option +.\" csv option: mysqlslap +\fB\-\-csv[=\fR\fB\fIfile_name\fR\fR\fB]\fR +.sp +Generate output in comma\-separated values format\&. The output goes to the named file, or to the standard output if no file is given\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlslap: debug option +.\" debug option: mysqlslap +\fB\-\-debug[=\fR\fB\fIdebug_options\fR\fR\fB]\fR, +\fB\-# [\fR\fB\fIdebug_options\fR\fR\fB]\fR +.sp +Write a debugging log\&. A typical +\fIdebug_options\fR +string is 'd:t:o,\fIfile_name\fR'. The default is 'd:t:o,/tmp/mysqlslap.trace'. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlslap: debug-check option +.\" debug-check option: mysqlslap +\fB\-\-debug\-check\fR +.sp +Print some debugging information when the program exits\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlslap: debug-info option +.\" debug-info option: mysqlslap +\fB\-\-debug\-info\fR, +\fB\-T\fR +.sp +Print debugging information and memory and CPU usage statistics when the program exits\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlslap: default-auth option +.\" default-auth option: mysqlslap +\fB\-\-default\-auth=\fR\fB\fIname\fR +.sp +Default authentication client-side plugin to use\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlslap: defaults-extra-file option +.\" defaults-extra-file option: mysqlslap +\fB\-\-defaults\-extra\-file=\fR\fB\fIfilename\fR\fR +.sp +Set \fB\fIfilename\fR\fR as the file to read default options from after the global defaults files has been +read\&. Must be given as first option\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlslap: defaults-file option +.\" defaults-file option: mysqlslap +\fB\-\-defaults\-file=\fR\fB\fIfilename\fR\fR +.sp +Set \fB\fIfilename\fR\fR as the file to read default options from, override global defaults files\&. +Must be given as first option\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlslap: delimiter option +.\" delimiter option: mysqlslap +\fB\-\-delimiter=\fR\fB\fIstr\fR\fR, +\fB\-F \fR\fB\fIstr\fR\fR +.sp +The delimiter to use in SQL statements supplied in files or via command options\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlslap: detach option +.\" detach option: mysqlslap +\fB\-\-detach=\fR\fB\fIN\fR\fR +.sp +Detach (close and reopen) each connection after each +\fIN\fR +statements\&. The default is 0 (connections are not detached)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlslap: engine option +.\" engine option: mysqlslap +\fB\-\-engine=\fR\fB\fIengine_name\fR\fR, +\fB\-e \fR\fB\fIengine_name\fR\fR +.sp +Comma separated list of storage engines to use for creating the table\&. The test is run for +each engine\&. You can also specify an option for an engine after a colon, for example +\fBmemory:max_row=2300\fR\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlslap: host option +.\" host option: mysqlslap +\fB\-\-host=\fR\fB\fIhost_name\fR\fR, +\fB\-h \fR\fB\fIhost_name\fR\fR +.sp +Connect to the MariaDB server on the given host\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlslap: init-command option +.\" init-command option: mysqlslap +\fB\-\-init\-command=str\fR +.sp +SQL Command to execute when connecting to MariaDB server\&. Will automatically be re\-executed when reconnecting\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlslap: iterations option +.\" iterations option: mysqlslap +\fB\-\-iterations=\fR\fB\fIN\fR\fR, +\fB\-i \fR\fB\fIN\fR\fR +.sp +The number of times to run the tests\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlslap: no-defaults option +.\" no-defaults option: mysqlslap +\fB\-\-no\-defaults\fR +.sp +Do not read default options from any option file\&. This must be given as the +first argument\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlslap: no-drop option +.\" no-drop option: mysqlslap +\fB\-\-no\-drop\fR +.sp +Do not drop any schema created during the test after the test is complete\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlslap: number-char-cols option +.\" number-char-cols option: mysqlslap +\fB\-\-number\-char\-cols=\fR\fB\fIN\fR\fR, +\fB\-x \fR\fB\fIN\fR\fR +.sp +The number of +VARCHAR +columns to use if +\fB\-\-auto\-generate\-sql\fR +is specified\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlslap: number-int-cols option +.\" number-int-cols option: mysqlslap +\fB\-\-number\-int\-cols=\fR\fB\fIN\fR\fR, +\fB\-y \fR\fB\fIN\fR\fR +.sp +The number of +INT +columns to use if +\fB\-\-auto\-generate\-sql\fR +is specified\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlslap: number-of-queries option +.\" number-of-queries option: mysqlslap +\fB\-\-number\-of\-queries=\fR\fB\fIN\fR\fR +.sp +Limit each client to approximately this many queries\&. Query counting takes into account the statement delimiter\&. For example, if you invoke +\fBmysqlslap\fR +as follows, the +; +delimiter is recognized so that each instance of the query string counts as two queries\&. As a result, 5 rows (not 10) are inserted\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysqlslap \-\-delimiter=";" \-\-number\-of\-queries=10\fR + \fB\-\-query="use test;insert into t values(null)"\fR +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlslap: only-print option +.\" only-print option: mysqlslap +\fB\-\-only\-print\fR +.sp +Do not connect to databases\&. +\fBmysqlslap\fR +only prints what it would have done\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlslap: password option +.\" password option: mysqlslap +\fB\-\-password[=\fR\fB\fIpassword\fR\fR\fB]\fR, +\fB\-p[\fR\fB\fIpassword\fR\fR\fB]\fR +.sp +The password to use when connecting to the server\&. If you use the short option form (\fB\-p\fR), you +\fIcannot\fR +have a space between the option and the password\&. If you omit the +\fIpassword\fR +value following the +\fB\-\-password\fR +or +\fB\-p\fR +option on the command line, +\fBmysqlslap\fR +prompts for one\&. +.sp +Specifying a password on the command line should be considered insecure\&. You can use an option file to avoid giving the password on the command line\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlslap: pipe option +.\" pipe option: mysqlslap +\fB\-\-pipe\fR, +\fB\-W\fR +.sp +On Windows, connect to the server via a named pipe\&. This option applies only if the server supports named\-pipe connections\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlslap: plugin-dir option +.\" plugin-dir option: mysqlslap +\fB\-\-plugin\-dir=\fIdir_name\fR +.sp +Directory for client-side plugins\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlslap: port option +.\" port option: mysqlslap +\fB\-\-port=\fR\fB\fIport_num\fR\fR, +\fB\-P \fR\fB\fIport_num\fR\fR +.sp +The TCP/IP port number to use for the connection\&. +Forces --protocol=tcp when specified on the command line without other connection properties\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlslap: post-query option +.\" post-query option: mysqlslap +\fB\-\-post\-query=\fR\fB\fIvalue\fR\fR +.sp +The file or string containing the statement to execute after the tests have completed\&. This execution is not counted for timing purposes\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlslap: post-system option +.\" post-system option: mysqlslap +\fB\-\-post\-system=\fR\fB\fIstr\fR\fR +.sp +The string to execute via +system() +after the tests have completed\&. This execution is not counted for timing purposes\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlslap: pre-query option +.\" pre-query option: mysqlslap +\fB\-\-pre\-query=\fR\fB\fIvalue\fR\fR +.sp +The file or string containing the statement to execute before running the tests\&. This execution is not counted for timing purposes\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlslap: pre-system option +.\" pre-system option: mysqlslap +\fB\-\-pre\-system=\fR\fB\fIstr\fR\fR +.sp +The string to execute via +system() +before running the tests\&. This execution is not counted for timing purposes\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlslap: print-defaults option +.\" print-defaults option: mysqlslap +\fB\-\-print\-defaults\fR +.sp +Print the program argument list and exit\&. +This must be given as the first argument\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlslap: protocol option +.\" protocol option: mysqlslap +\fB\-\-protocol={TCP|SOCKET|PIPE|MEMORY}\fR +.sp +The connection protocol to use for connecting to the server\&. It is useful when the other connection parameters normally would cause a protocol to be used other than the one you want\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlslap: query option +.\" query option: mysqlslap +\fB\-\-query=\fR\fB\fIvalue\fR\fR, +\fB\-q \fR\fB\fIvalue\fR\fR +.sp +The file or string containing the +SELECT +statement to use for retrieving data\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlslap: shared-memory-base-name option +.\" shared-memory-base-name option: mysqlslap +\fB\-\-shared\-memory\-base\-name=\fR\fB\fIname\fR\fR +.sp +On Windows, the shared\-memory name to use, for connections made via shared memory to a local server\&. This option applies only if the server supports shared\-memory connections\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlslap: silent option +.\" silent option: mysqlslap +\fB\-\-silent\fR, +\fB\-s\fR +.sp +Silent mode\&. No output\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlslap: socket option +.\" socket option: mysqlslap +\fB\-\-socket=\fR\fB\fIpath\fR\fR, +\fB\-S \fR\fB\fIpath\fR\fR +.sp +For connections to +localhost, the Unix socket file to use, or, on Windows, the name of the named pipe to use\&. +Forces --protocol=socket when specified on the command line without other connection properties; on Windows, forces --protocol=pipe\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlshow: SSL options +.\" SSL options: mysqlshow +\fB\-\-ssl\fR +.sp +Enable SSL for connection (automatically enabled with other flags). Disable with +\fB\-\-skip-ssl\fR\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlshow: SSL CA option +.\" SSL CA option: mysqlshow +\fB\-\-ssl\-ca=\fIname\fR +.sp +CA file in PEM format (check OpenSSL docs, implies +\fB\-\-ssl\fR)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlshow: SSL CA Path option +.\" SSL CA Path option: mysqlshow +\fB\-\-ssl\-capath=\fIname\fR +.sp +CA directory (check OpenSSL docs, implies +\fB\-\-ssl\fR)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlshow: SSL Cert option +.\" SSL Cert option: mysqlshow +\fB\-\-ssl\-cert=\fIname\fR +.sp +X509 cert in PEM format (check OpenSSL docs, implies +\fB\-\-ssl\fR)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlshow: SSL Cipher option +.\" SSL Cipher option: mysqlshow +\fB\-\-ssl\-cipher=\fIname\fR +.sp +SSL cipher to use (check OpenSSL docs, implies +\fB\-\-ssl\fR)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlshow: SSL Key option +.\" SSL Key option: mysqlshow +\fB\-\-ssl\-key=\fIname\fR +.sp +X509 key in PEM format (check OpenSSL docs, implies +\fB\-\-ssl\fR)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlshow: SSL Crl option +.\" SSL CRL option: mysqlshow +\fB\-\-ssl\-crl=\fIname\fR +.sp +Certificate revocation list (check OpenSSL docs, implies +\fB\-\-ssl\fR)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlshow: SSL Crlpath option +.\" SSL Crlpath option: mysqlshow +\fB\-\-ssl\-crlpath=\fIname\fR +.sp +Certificate revocation list path (check OpenSSL docs, implies +\fB\-\-ssl\fR)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlshow: SSL Verify Server Cert option +.\" SSL Verify Server Cert option: mysqlshow +\fB\-\-ssl\-verify\-server\-cert\fR +.sp +Verify server's "Common Name" in its cert against hostname used when connecting. This option is disabled by default\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlslap: user option +.\" user option: mysqlslap +\fB\-\-user=\fR\fB\fIuser_name\fR\fR, +\fB\-u \fR\fB\fIuser_name\fR\fR +.sp +The MariaDB user name to use when connecting to the server\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlslap: verbose option +.\" verbose option: mysqlslap +\fB\-\-verbose\fR, +\fB\-v\fR +.sp +Verbose mode\&. Print more information about what the program does\&. This option can be used multiple times to increase the amount of information\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqlslap: version option +.\" version option: mysqlslap +\fB\-\-version\fR, +\fB\-V\fR +.sp +Display version information and exit\&. +.RE +.SH "COPYRIGHT" +.br +.PP +Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc., 2010-2020 MariaDB Foundation +.PP +This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License. +.PP +This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. +.PP +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-1335 USA or see http://www.gnu.org/licenses/. +.sp +.SH "SEE ALSO" +For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/ +.SH AUTHOR +MariaDB Foundation (http://www.mariadb.org/). diff --git a/man/mysqltest.1 b/man/mysqltest.1 new file mode 100644 index 00000000..b1326ba8 --- /dev/null +++ b/man/mysqltest.1 @@ -0,0 +1,1083 @@ +'\" t +.\" +.TH "\fBMARIADB-TEST\fR" "1" "15 May 2020" "MariaDB 10.11" "MariaDB Database System" +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.\" mysqltest +.\" mysqltest_embedded +.SH "NAME" +mariadb-test \- program to run test cases (mysqltest is now a symlink to mariadb-test) +.br +mysqltest_embedded \- program to run embedded test cases +.SH "SYNOPSIS" +.HP \w'\fBmysqltest\ [\fR\fB\fIoptions\fR\fR\fB]\ [\fR\fB\fIdb_name\fR\fR\fB]\fR\ 'u +\fBmysqltest [\fR\fB\fIoptions\fR\fR\fB] [\fR\fB\fIdb_name\fR\fR\fB]\fR +.HP \w'\fBmysqltest_embedded\ [\fR\fB\fIoptions\fR\fR\fB]\ [\fR\fB\fIdb_name\fR\fR\fB]\fR\ 'u +\fBmysqltest_embedded [\fR\fB\fIoptions\fR\fR\fB] [\fR\fB\fIdb_name\fR\fR\fB]\fR +.SH "DESCRIPTION" +.PP +The +\fBmysqltest\fR +program runs a test case against a MariaDB server and optionally compares the output with a result file\&. This program reads input written in a special test language\&. Typically, you invoke +\fBmysqltest\fR +via +\fBmysql\-test\-run\&.pl\fR +rather than invoking it directly\&. +.PP +\fBmysqltest_embedded\fR +is similar but is built with support for the +libmysqld +embedded server\&. +.PP +Features of +\fBmysqltest\fR: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Can send SQL statements to MariaDB servers for execution +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Can execute external shell commands +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Can test whether the result from an SQL statement or shell command is as expected +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Can connect to one or more standalone +\fBmysqld\fR +servers and switch between connections +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Can connect to an embedded server (libmysqld), if MariaDB is compiled with support for +libmysqld\&. (In this case, the executable is named +\fBmysqltest_embedded\fR +rather than +\fBmysqltest\fR\&.) +.RE +.PP +By default, +\fBmysqltest\fR +reads the test case on the standard input\&. To run +\fBmysqltest\fR +this way, you normally invoke it like this: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmysqltest [\fR\fB\fIoptions\fR\fR\fB] [\fR\fB\fIdb_name\fR\fR\fB] < \fR\fB\fItest_file\fR\fR +.fi +.if n \{\ +.RE +.\} +.PP +You can also name the test case file with a +\fB\-\-test\-file=\fR\fB\fIfile_name\fR\fR +option\&. +.PP +The exit value from +\fBmysqltest\fR +is 0 for success, 1 for failure, and 62 if it skips the test case (for example, if after checking some preconditions it decides not to run the test)\&. +.PP +\fBmysqltest\fR +supports the following options: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqltest: help option +.\" help option: mysqltest +\fB\-\-help\fR, +\fB\-?\fR +.sp +Display a help message and exit\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqltest: basedir option +.\" basedir option: mysqltest +\fB\-\-basedir=\fR\fB\fIdir_name\fR\fR, +\fB\-b \fR\fB\fIdir_name\fR\fR +.sp +The base directory for tests\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqltest: character-sets-dir option +.\" character-sets-dir option: mysqltest +\fB\-\-character\-sets\-dir=\fR\fB\fIpath\fR\fR +.sp +The directory where character sets are installed\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqltest: compress option +.\" compress option: mysqltest +\fB\-\-compress\fR, +\fB\-C\fR +.sp +Compress all information sent between the client and the server if both support compression\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqltest: connect-timeout option +.\" connect-timeout option: mysqltest +\fB\-\-connect\-timeout=\fInum\fR +.sp +This can be used to set the MYSQL_OPT_CONNECT_TIMEOUT parameter of mysql_options to change the number of seconds before an unsuccessful connection attempt times out\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqltest: continue-on-error option +.\" continue-on-error option: mysqltest +\fB\-\-continue\-on\-error\fR +.sp +Continue test even if we got an error\&. This is mostly +useful when testing a storage engine to see what from a +test file it can execute, or to find all syntax errors in +a newly created big test file\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqltest: cursor-protocol option +.\" cursor-protocol option: mysqltest +\fB\-\-cursor\-protocol\fR +.sp +Use cursors for prepared statements\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqltest: database option +.\" database option: mysqltest +\fB\-\-database=\fR\fB\fIdb_name\fR\fR, +\fB\-D \fR\fB\fIdb_name\fR\fR +.sp +The default database to use\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqltest: debug option +.\" debug option: mysqltest +\fB\-\-debug[=\fR\fB\fIdebug_options\fR\fR\fB]\fR, +\fB\-#[\fR\fB\fIdebug_options\fR\fR\fB]\fR +.sp +Write a debugging log if MariaDB is built with debugging support\&. The default +\fIdebug_options\fR +value is 'd:t:S:i:O,/tmp/mysqltest.trace'. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqltest: debug-check option +.\" debug-check option: mysqltest +\fB\-\-debug\-check\fR +.sp +Print some debugging information when the program exits\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqltest: debug-info option +.\" debug-info option: mysqltest +\fB\-\-debug\-info\fR +.sp +Print debugging information and memory and CPU usage statistics when the program exits\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqltest: host option +.\" host option: mysqltest +\fB\-\-host=\fR\fB\fIhost_name\fR\fR, +\fB\-h \fR\fB\fIhost_name\fR\fR +.sp +Connect to the MariaDB server on the given host\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqltest: logdir option +.\" logdir option: mysqltest +\fB\-\-logdir=\fR\fB\fIdir_name\fR\fR +.sp +The directory to use for log files\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqltest: mark-progress option +.\" mark-progress option: mysqltest +\fB\-\-mark\-progress\fR +.sp +Write the line number and elapsed time to +\fItest_file\fR\&.progress\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqltest: max-connect-retries option +.\" max-connect-retries option: mysqltest +\fB\-\-max\-connect\-retries=\fR\fB\fInum\fR\fR +.sp +The maximum number of connection attempts when connecting to server\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqltest: max-connections option +.\" max-connections option: mysqltest +\fB\-\-max\-connections=\fR\fB\fInum\fR\fR +.sp +The maximum number of simultaneous server connections per client (that is, per test)\&. If not set, the maximum is 128\&. Minimum allowed limit is 8, maximum is 5120\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqltest: no-defaults option +.\" no-defaults option: mysqltest +\fB\-\-no\-defaults\fR +.sp +Do not read default options from any option files\&. If used, this must be the first option\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqltest: non-blocking-api option +.\" non-blocking-api option: mysqltest +\fB\-\-non\-blocking\-api\fR +.sp +Use the non-blocking client API for communication\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqltest: overlay-dir option +.\" overlay-dir option: mysqltest +\fB\-\-overlay\-dir=\fIdir_name\fR +.sp +Overlay directory\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqltest: password option +.\" password option: mysqltest +\fB\-\-password[=\fR\fB\fIpassword\fR\fR\fB]\fR, +\fB\-p[\fR\fB\fIpassword\fR\fR\fB]\fR +.sp +The password to use when connecting to the server\&. If you use the short option form (\fB\-p\fR), you +\fIcannot\fR +have a space between the option and the password\&. If you omit the +\fIpassword\fR +value following the +\fB\-\-password\fR +or +\fB\-p\fR +option on the command line, you are prompted for one\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqltest: plugin-dir option +.\" plugin-dir option: mysqltest +\fB\-\-plugin\-dir=\fIdir_name\fR +.sp +Directory for client-side plugins\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqltest: port option +.\" port option: mysqltest +\fB\-\-port=\fR\fB\fIport_num\fR\fR, +\fB\-P \fR\fB\fIport_num\fR\fR +.sp +The TCP/IP port number to use for the connection or 0 for default to, in order of preference, +my.cnf, $MYSQL_TCP_PORT, /etc/services, built-in default (3306)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqltest: prologue option +.\" prologue option: mysqltest +\fB\-\-prologue=\fR\fB\fIname\fR\fR +.sp +Include the contents of the given file before processing the contents of the test file\&. The included file should have the same format as other +\fBmysqltest\fR +test files\&. This option has the same effect as putting a +\-\-source \fIfile_name\fR +command as the first line of the test file\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqltest: protocol option +.\" protocol option: mysqltest +\fB\-\-protocol={TCP|SOCKET|PIPE|MEMORY}\fR +.sp +The connection protocol to use for connecting to the server\&. It is useful when the other connection parameters normally would cause a protocol to be used other than the one you want\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqltest: ps-protocol option +.\" ps-protocol option: mysqltest +\fB\-\-ps\-protocol\fR +.sp +Use the prepared\-statement protocol for communication\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqltest: quiet option +.\" quiet option: mysqltest +\fB\-\-quiet\fR +.sp +Suppress all normal output\&. This is a synonym for +.\" mysqltest: silent option +.\" silent option: mysqltest +\fB\-\-silent\fR\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqltest: record option +.\" record option: mysqltest +\fB\-\-record\fR, +\fB\-r\fR +.sp +Record the output that results from running the test file into the file named by the +\fB\-\-result\-file\fR +option, if that option is given\&. It is an error to use this option without also using +\fB\-\-result\-file\fR\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqltest: result-file option +.\" result-file option: mysqltest +\fB\-\-result\-file=\fR\fB\fIfile_name\fR\fR, +\fB\-R \fR\fB\fIfile_name\fR\fR +.sp +This option specifies the file for test case expected results\&. +\fB\-\-result\-file\fR, together with +\fB\-\-record\fR, determines how +\fBmysqltest\fR +treats the test actual and expected results for a test case: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +If the test produces no results, +\fBmysqltest\fR +exits with an error message to that effect, unless +\fB\-\-result\-file\fR +is given and the named file is an empty file\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Otherwise, if +\fB\-\-result\-file\fR +is not given, +\fBmysqltest\fR +sends test results to the standard output\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +With +\fB\-\-result\-file\fR +but not +\fB\-\-record\fR, +\fBmysqltest\fR +reads the expected results from the given file and compares them with the actual results\&. If the results do not match, +\fBmysqltest\fR +writes a +\&.reject +file in the same directory as the result file, outputs a diff of the two files, and exits with an error\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +With both +\fB\-\-result\-file\fR +and +\fB\-\-record\fR, +\fBmysqltest\fR +updates the given file by writing the actual test results to it\&. +.RE +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqltest: result-format-version option +.\" result-format-version option: mysqltest +\fB\-\-result\-format\-version=\fI#\fR +.sp +Version of the result file format to use\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqltest: server-arg option +.\" server-arg option: mysqltest +\fB\-\-server\-arg=\fR\fB\fIvalue\fR\fR, +\fB\-A \fR\fB\fIvalue\fR\fR +.sp +Pass the argument as an argument to the embedded server\&. For example, +\fB\-\-server\-arg=\-\-tmpdir=/tmp\fR +or +\fB\-\-server\-arg=\-\-core\fR\&. Up to 64 arguments can be given\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqltest: server-file option +.\" server-file option: mysqltest +\fB\-\-server\-file=\fR\fB\fIfile_name\fR\fR, +\fB\-F \fR\fB\fIfile_name\fR\fR +.sp +Read arguments for the embedded server from the given file\&. The file should contain one argument per line\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqltest: silent option +.\" silent option: mysqltest +\fB\-\-silent\fR, +\fB\-s\fR +.sp +Suppress all normal output\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqltest: sleep option +.\" sleep option: mysqltest +\fB\-\-sleep=\fR\fB\fInum\fR\fR, +\fB\-T \fR\fB\fInum\fR\fR +.sp +Cause all +sleep +commands in the test case file to sleep +\fInum\fR +seconds\&. This option does not affect +real_sleep +commands\&. +.sp +An option value of 0 can be used, which effectively disables sleep +commands in the test case\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqltest: socket option +.\" socket option: mysqltest +\fB\-\-socket=\fR\fB\fIpath\fR\fR, +\fB\-S \fR\fB\fIpath\fR\fR +.sp +The socket file to use when connecting to +localhost +(which is the default host)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqltest: sp-protocol option +.\" sp-protocol option: mysqltest +\fB\-\-sp\-protocol\fR +.sp +Execute DML statements within a stored procedure\&. For every DML statement, +\fBmysqltest\fR +creates and invokes a stored procedure that executes the statement rather than executing the statement directly\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqltest: SSL options +.\" SSL options: mysqltest +\fB\-\-ssl\fR +.sp +Enable SSL for connection (automatically enabled with other flags). Disable with +\fB\-\-skip-ssl\fR\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqltest: SSL CA option +.\" SSL CA option: mysqltest +\fB\-\-ssl\-ca=\fIname\fR +.sp +CA file in PEM format (check OpenSSL docs, implies +\fB\-\-ssl\fR)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqltest: SSL CA Path option +.\" SSL CA Path option: mysqltest +\fB\-\-ssl\-capath=\fIname\fR +.sp +CA directory (check OpenSSL docs, implies +\fB\-\-ssl\fR)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqltest: SSL Cert option +.\" SSL Cert option: mysqltest +\fB\-\-ssl\-cert=\fIname\fR +.sp +X509 cert in PEM format (check OpenSSL docs, implies +\fB\-\-ssl\fR)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqltest: SSL Cipher option +.\" SSL Cipher option: mysqltest +\fB\-\-ssl\-cipher=\fIname\fR +.sp +SSL cipher to use (check OpenSSL docs, implies +\fB\-\-ssl\fR)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqltest: SSL Key option +.\" SSL Key option: mysqltest +\fB\-\-ssl\-key=\fIname\fR +.sp +X509 key in PEM format (check OpenSSL docs, implies +\fB\-\-ssl\fR)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqltest: SSL Crl option +.\" SSL CRL option: mysqltest +\fB\-\-ssl\-crl=\fIname\fR +.sp +Certificate revocation list (check OpenSSL docs, implies +\fB\-\-ssl\fR)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqltest: SSL Crlpath option +.\" SSL Crlpath option: mysqltest +\fB\-\-ssl\-crlpath=\fIname\fR +.sp +Certificate revocation list path (check OpenSSL docs, implies +\fB\-\-ssl\fR)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqltest: SSL Verify Server Cert option +.\" SSL Verify Server Cert option: mysqltest +\fB\-\-ssl\-verify\-server\-cert\fR +.sp +Verify server's "Common Name" in its cert against hostname used when connecting. This option is disabled by default\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqltest: suite-dir option +.\" suite-dir option: mysqltest +\fB\-\-suite\-dir=\fIdir_name\fR +.sp +Suite directory\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqltest: tail-lines option +.\" tail-lines option: mysqltest +\fB\-\-tail\-lines=\fR\fB\fInn\fR\fR +.sp +Specify how many lines of the result to include in the output if the test fails because an SQL statement fails\&. The default is 0, meaning no lines of result printed\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqltest: test-file option +.\" test-file option: mysqltest +\fB\-\-test\-file=\fR\fB\fIfile_name\fR\fR, +\fB\-x \fR\fB\fIfile_name\fR\fR +.sp +Read test input from this file\&. The default is to read from the standard input\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqltest: timer-file option +.\" timer-file option: mysqltest +\fB\-\-timer\-file=\fR\fB\fIfile_name\fR\fR, +\fB\-m \fR\fB\fIfile_name\fR\fR +.sp +If given, the number of microseconds spent running the test will be written to this file\&. This is used by +\fBmysql\-test\-run\&.pl\fR +for its reporting\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqltest: tmpdir option +.\" tmpdir option: mysqltest +\fB\-\-tmpdir=\fR\fB\fIdir_name\fR\fR, +\fB\-t \fR\fB\fIdir_name\fR\fR +.sp +The temporary directory where socket files are created\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqltest: user option +.\" user option: mysqltest +\fB\-\-user=\fR\fB\fIuser_name\fR\fR, +\fB\-u \fR\fB\fIuser_name\fR\fR +.sp +The MariaDB user name to use when connecting to the server\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqltest: verbose option +.\" verbose option: mysqltest +\fB\-\-verbose\fR, +\fB\-v\fR +.sp +Verbose mode\&. Print out more information about what the program does\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqltest: version option +.\" version option: mysqltest +\fB\-\-version\fR, +\fB\-V\fR +.sp +Display version information and exit\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysqltest: view-protocol option +.\" view-protocol option: mysqltest +\fB\-\-view\-protocol\fR +.sp +Every +SELECT +statement is wrapped inside a view\&. +.RE +.SH "COPYRIGHT" +.br +.PP +Copyright \(co 2007, 2010, Oracle and/or its affiliates, 2010-2020 MariaDB Foundation +.PP +This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License. +.PP +This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. +.PP +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-1335 USA or see http://www.gnu.org/licenses/. +.sp +.SH "SEE ALSO" +For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/ +.SH AUTHOR +MariaDB Foundation (http://www.mariadb.org/). diff --git a/man/mysqltest_embedded.1 b/man/mysqltest_embedded.1 new file mode 100644 index 00000000..a0048932 --- /dev/null +++ b/man/mysqltest_embedded.1 @@ -0,0 +1 @@ +.so man1/mysqltest.1 diff --git a/man/mytop.1 b/man/mytop.1 new file mode 100644 index 00000000..6585439f --- /dev/null +++ b/man/mytop.1 @@ -0,0 +1,7 @@ +.TH MYTOP "1" "15 May 2020" "MariaDB 10.11" "MariaDB Database System" +.SH NAME +mytop \- display MariaDB server performance info like 'top' +.SH "SEE ALSO" +For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/ +.SH AUTHOR +MariaDB Foundation (http://www.mariadb.org/). diff --git a/man/perror.1 b/man/perror.1 new file mode 100644 index 00000000..94a4bdb3 --- /dev/null +++ b/man/perror.1 @@ -0,0 +1,157 @@ +'\" t +.\" +.TH "\fBPERROR\fR" "1" "15 May 2020" "MariaDB 10.11" "MariaDB Database System" +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.\" perror +.\" error messages: displaying +.\" errno +.\" Errcode +.SH "NAME" +perror \- explain error codes +.SH "SYNOPSIS" +.HP \w'\fBperror\ [\fR\fB\fIoptions\fR\fR\fB]\ \fR\fB\fIerrorcode\fR\fR\fB\ \&.\&.\&.\fR\ 'u +\fBperror [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fIerrorcode\fR\fR\fB \&.\&.\&.\fR +.SH "DESCRIPTION" +.PP +For most system errors, MariaDB displays, in addition to an internal text message, the system error code in one of the following styles: +.sp +.if n \{\ +.RS 4 +.\} +.nf +message \&.\&.\&. (errno: #) +message \&.\&.\&. (Errcode: #) +.fi +.if n \{\ +.RE +.\} +.PP +You can find out what the error code means by examining the documentation for your system or by using the +\fBperror\fR +utility\&. +.PP +\fBperror\fR +prints a description for a system error code or for a storage engine (table handler) error code\&. +.PP +Invoke +\fBperror\fR +like this: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBperror [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fIerrorcode\fR\fR\fB \&.\&.\&.\fR +.fi +.if n \{\ +.RE +.\} +.PP +Example: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBperror 13 64\fR +OS error code 13: Permission denied +OS error code 64: Machine is not on the network +.fi +.if n \{\ +.RE +.\} +.PP +Note that the meaning of system error messages may be dependent on your operating system\&. A given error code may mean different things on different operating systems\&. +.PP +\fBperror\fR +supports the following options\&. +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" perror: help option +.\" help option: perror +\fB\-\-help\fR, +\fB\-\-info\fR, +\fB\-I\fR, +\fB\-?\fR +.sp +Display a help message and exit\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" perror: silent option +.\" silent option: perror +\fB\-\-silent\fR, +\fB\-s\fR +.sp +Silent mode\&. Print only the error message\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" perror: verbose option +.\" verbose option: perror +\fB\-\-verbose\fR, +\fB\-v\fR +.sp +Verbose mode\&. Print error code and message\&. This is the default behavior\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" perror: version option +.\" version option: perror +\fB\-\-version\fR, +\fB\-V\fR +.sp +Display version information and exit\&. +.RE +.SH "COPYRIGHT" +.br +.PP +Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc., 2010-2020 MariaDB Foundation +.PP +This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License. +.PP +This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. +.PP +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-1335 USA or see http://www.gnu.org/licenses/. +.sp +.SH "SEE ALSO" +For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/ +.SH AUTHOR +MariaDB Foundation (http://www.mariadb.org/). diff --git a/man/replace.1 b/man/replace.1 new file mode 100644 index 00000000..f5327815 --- /dev/null +++ b/man/replace.1 @@ -0,0 +1,167 @@ +'\" t +.\" +.TH "\fBREPLACE\fR" "1" "15 May 2020" "MariaDB 10.11" "MariaDB Database System" +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.\" replace utility +.\" string replacement: replace utility +.SH "NAME" +replace \- a string\-replacement utility +.SH "SYNOPSIS" +.HP \w'\fBreplace\ \fR\fB\fIarguments\fR\fR\ 'u +\fBreplace \fR\fB\fIarguments\fR\fR +.SH "DESCRIPTION" +.PP +The +\fBreplace\fR +utility program changes strings in place in files or on the standard input\&. +.PP +Invoke +\fBreplace\fR +in one of the following ways: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBreplace \fR\fB\fIfrom\fR\fR\fB \fR\fB\fIto\fR\fR\fB [\fR\fB\fIfrom\fR\fR\fB \fR\fB\fIto\fR\fR\fB] \&.\&.\&. \-\- \fR\fB\fIfile_name\fR\fR\fB [\fR\fB\fIfile_name\fR\fR\fB] \&.\&.\&.\fR +shell> \fBreplace \fR\fB\fIfrom\fR\fR\fB \fR\fB\fIto\fR\fR\fB [\fR\fB\fIfrom\fR\fR\fB \fR\fB\fIto\fR\fR\fB] \&.\&.\&. < \fR\fB\fIfile_name\fR\fR +.fi +.if n \{\ +.RE +.\} +.PP +\fIfrom\fR +represents a string to look for and +\fIto\fR +represents its replacement\&. There can be one or more pairs of strings\&. +.PP +Use the +\fB\-\-\fR +option to indicate where the string\-replacement list ends and the file names begin\&. In this case, any file named on the command line is modified in place, so you may want to make a copy of the original before converting it\&. +\fIreplace\fR +prints a message indicating which of the input files it actually modifies\&. +.PP +If the +\fB\-\-\fR +option is not given, +\fBreplace\fR +reads the standard input and writes to the standard output\&. +.PP +\fBreplace\fR +uses a finite state machine to match longer strings first\&. It can be used to swap strings\&. For example, the following command swaps +a +and +b +in the given files, +file1 +and +file2: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBreplace a b b a \-\- file1 file2 \&.\&.\&.\fR +.fi +.if n \{\ +.RE +.\} +.PP +The +\fBreplace\fR +program is used by +\fBmsql2mysql\fR\&. See +\fBmsql2mysql\fR(1)\&. +.PP +\fBreplace\fR +supports the following options\&. +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fB\-?\fR, +\fB\-I\fR +.sp +Display a help message and exit\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fB\-#\fR\fB\fIdebug_options\fR\fR +.sp +Enable debugging\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fB\-s\fR +.sp +Silent mode\&. Print less information what the program does\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fB\-v\fR +.sp +Verbose mode\&. Print more information about what the program does\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fB\-V\fR +.sp +Display version information and exit\&. +.RE +.SH "COPYRIGHT" +.br +.PP +Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc., 2010-2020 MariaDB Foundation +.PP +This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License. +.PP +This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. +.PP +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-1335 USA or see http://www.gnu.org/licenses/. +.sp +.SH "SEE ALSO" +For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/ +.SH AUTHOR +MariaDB Foundation (http://www.mariadb.org/). diff --git a/man/resolve_stack_dump.1 b/man/resolve_stack_dump.1 new file mode 100644 index 00000000..df97e405 --- /dev/null +++ b/man/resolve_stack_dump.1 @@ -0,0 +1,124 @@ +'\" t +.\" +.TH "\fBRESOLVE_STACK_DUMP\fR" "1" "15 May 2020" "MariaDB 10.11" "MariaDB Database System" +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.\" resolve_stack_dump +.SH "NAME" +resolve_stack_dump \- resolve numeric stack trace dump to symbols +.SH "SYNOPSIS" +.HP \w'\fBresolve_stack_dump\ [\fR\fB\fIoptions\fR\fR\fB]\ \fR\fB\fIsymbols_file\fR\fR\fB\ [\fR\fB\fInumeric_dump_file\fR\fR\fB]\fR\ 'u +\fBresolve_stack_dump [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fIsymbols_file\fR\fR\fB [\fR\fB\fInumeric_dump_file\fR\fR\fB]\fR +.SH "DESCRIPTION" +.PP +\fBresolve_stack_dump\fR +resolves a numeric stack dump to symbols\&. +.PP +Invoke +\fBresolve_stack_dump\fR +like this: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBresolve_stack_dump [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fIsymbols_file\fR\fR\fB [\fR\fB\fInumeric_dump_file\fR\fR\fB]\fR +.fi +.if n \{\ +.RE +.\} +.PP +The symbols file should include the output from the +\fBnm \-\-numeric\-sort mysqld\fR +command\&. The numeric dump file should contain a numeric stack track from +\fBmysqld\fR\&. If no numeric dump file is named on the command line, the stack trace is read from the standard input\&. +.PP +\fBresolve_stack_dump\fR +supports the following options\&. +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" resolve_stack_dump: help option +.\" help option: resolve_stack_dump +\fB\-\-help\fR, +\fB\-h\fR +.sp +Display a help message and exit\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" resolve_stack_dump: numeric-dump-file option +.\" numeric-dump-file option: resolve_stack_dump +\fB\-\-numeric\-dump\-file=\fR\fB\fIfile_name\fR\fR, +\fB\-n \fR\fB\fIfile_name\fR\fR +.sp +Read the stack trace from the given file\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" resolve_stack_dump: symbols-file option +.\" symbols-file option: resolve_stack_dump +\fB\-\-symbols\-file=\fR\fB\fIfile_name\fR\fR, +\fB\-s \fR\fB\fIfile_name\fR\fR +.sp +Use the given symbols file\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" resolve_stack_dump: version option +.\" version option: resolve_stack_dump +\fB\-\-version\fR, +\fB\-V\fR +.sp +Display version information and exit\&. +.RE +.SH "COPYRIGHT" +.br +.PP +Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc., 2010-2020 MariaDB Foundation +.PP +This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License. +.PP +This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. +.PP +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-1335 USA or see http://www.gnu.org/licenses/. +.sp +.SH "SEE ALSO" +For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/ +.SH AUTHOR +MariaDB Foundation (http://www.mariadb.org/). diff --git a/man/resolveip.1 b/man/resolveip.1 new file mode 100644 index 00000000..8abc823b --- /dev/null +++ b/man/resolveip.1 @@ -0,0 +1,106 @@ +'\" t +.\" +.TH "\fBRESOLVEIP\fR" "1" "15 May 2020" "MariaDB 10.11" "MariaDB Database System" +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.\" resolveip +.SH "NAME" +resolveip \- resolve host name to IP address or vice versa +.SH "SYNOPSIS" +.HP \w'\fBresolveip\ [\fR\fB\fIoptions\fR\fR\fB]\ {\fR\fB\fIhost_name\fR\fR\fB|\fR\fB\fIip\-addr\fR\fR\fB}\ \&.\&.\&.\fR\ 'u +\fBresolveip [\fR\fB\fIoptions\fR\fR\fB] {\fR\fB\fIhost_name\fR\fR\fB|\fR\fB\fIip\-addr\fR\fR\fB} \&.\&.\&.\fR +.SH "DESCRIPTION" +.PP +The +\fBresolveip\fR +utility resolves host names to IP addresses and vice versa\&. +.PP +Invoke +\fBresolveip\fR +like this: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBresolveip [\fR\fB\fIoptions\fR\fR\fB] {\fR\fB\fIhost_name\fR\fR\fB|\fR\fB\fIip\-addr\fR\fR\fB} \&.\&.\&.\fR +.fi +.if n \{\ +.RE +.\} +.PP +\fBresolveip\fR +supports the following options\&. +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" resolveip: help option +.\" help option: resolveip +\fB\-\-help\fR, +\fB\-\-info\fR, +\fB\-?\fR, +\fB\-I\fR +.sp +Display a help message and exit\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" resolveip: silent option +.\" silent option: resolveip +\fB\-\-silent\fR, +\fB\-s\fR +.sp +Silent mode\&. Produce less output\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" resolveip: version option +.\" version option: resolveip +\fB\-\-version\fR, +\fB\-V\fR +.sp +Display version information and exit\&. +.RE +.SH "COPYRIGHT" +.br +.PP +Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc., 2010-2020 MariaDB Foundation +.PP +This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License. +.PP +This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. +.PP +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-1335 USA or see http://www.gnu.org/licenses/. +.sp +.SH "SEE ALSO" +For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/ +.SH AUTHOR +MariaDB Foundation (http://www.mariadb.org/). diff --git a/man/wsrep_sst_common.1 b/man/wsrep_sst_common.1 new file mode 100644 index 00000000..9fd5122c --- /dev/null +++ b/man/wsrep_sst_common.1 @@ -0,0 +1,16 @@ +'\" t +.\" +.TH "\fBWSREP_SST_COMMON\fR" "1" "15 May 2020" "MariaDB 10.11" "MariaDB Database System" +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH NAME +wsrep_sst_common \- common command line parser to be sourced by other SST scripts +.SH DESCRIPTION +Use: Common command line parser to be sourced by other SST scripts\. +.PP +For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/ diff --git a/man/wsrep_sst_mariabackup.1 b/man/wsrep_sst_mariabackup.1 new file mode 100644 index 00000000..7259b028 --- /dev/null +++ b/man/wsrep_sst_mariabackup.1 @@ -0,0 +1,16 @@ +'\" t +.\" +.TH "\fBWSREP_SST_MARIABACKUP\fR" "1" "15 May 2020" "MariaDB 10.11" "MariaDB Database System" +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH NAME +wsrep_sst_mariabackup \- mariabackup\-based state snapshot transfer +.SH DESCRIPTION +Use: mariabackup-based state snapshot transfer\. +.PP +For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/ diff --git a/man/wsrep_sst_mysqldump.1 b/man/wsrep_sst_mysqldump.1 new file mode 100644 index 00000000..56581ae8 --- /dev/null +++ b/man/wsrep_sst_mysqldump.1 @@ -0,0 +1,16 @@ +'\" t +.\" +.TH "\fBWSREP_SST_MYSQLDUMP\fR" "1" "15 May 2020" "MariaDB 10.11" "MariaDB Database System" +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH NAME +wsrep_sst_mysqldump \- mysqldump\-based state snapshot transfer +.SH DESCRIPTION +Use: mysqldump-based state snapshot transfer\. +.PP +For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/ diff --git a/man/wsrep_sst_rsync.1 b/man/wsrep_sst_rsync.1 new file mode 100644 index 00000000..155cb8ce --- /dev/null +++ b/man/wsrep_sst_rsync.1 @@ -0,0 +1,16 @@ +'\" t +.\" +.TH "\fBWSREP_SST_RSYNC\fR" "1" "15 May 2020" "MariaDB 10.11" "MariaDB Database System" +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH NAME +wsrep_sst_rsync \- rsync-based state snapshot transfer +.SH DESCRIPTION +Use: rsync-based state snapshot transfer\. +.PP +For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/ diff --git a/man/wsrep_sst_rsync_wan.1 b/man/wsrep_sst_rsync_wan.1 new file mode 100644 index 00000000..3eb67b3d --- /dev/null +++ b/man/wsrep_sst_rsync_wan.1 @@ -0,0 +1,16 @@ +'\" t +.\" +.TH "\fBWSREP_SST_RSYNC_WAN\fR" "1" "15 May 2020" "MariaDB 10.11" "MariaDB Database System" +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH NAME +wsrep_sst_rsync_wan \- rsync_wan (rsync with delta transfers)\-based state snapshot transfer +.SH DESCRIPTION +Use: rsync_wan\-based state snapshot transfer\. +.PP +For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/ |