mirror of
https://github.com/MariaDB/server.git
synced 2025-01-16 12:02:42 +01:00
4145618103
Continue the effort of a previous commit (PR#2114) which changed the man
pages titles from MariaDB to MySQL, to further update the man pages.
Update the man page NAME sections to use mariadb-* instead of mysql* for
MariaDB binaries that are drop-in replacements for MySQL equivalents,
indicating that the commands are actually of the MariaDB version.
Before:
NAME
mysql_upgrade - check tables for MariaDB upgrade
...
After:
NAME
mariadb-upgrade - check tables for MariaDB upgrade (mysql_upgrade
is now a symlink to mariadb-upgrade)
...
All new code of the whole pull request, including one or several files
that are either new files or modified ones, are contributed under the
BSD-new license. I am contributing on behalf of my employer Amazon Web
Services, Inc.
383 lines
8.7 KiB
Groff
383 lines
8.7 KiB
Groff
'\" t
|
|
.\"
|
|
.TH "\FBMARIADB-INSTALL-DB\FR" "1" "27 June 2019" "MariaDB 10\&.5" "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: 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-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/).
|