mirror of
https://github.com/MariaDB/server.git
synced 2025-11-04 04:46:15 +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.
429 lines
8.6 KiB
Groff
429 lines
8.6 KiB
Groff
'\" t
|
|
.\"
|
|
.TH "\FBMARIADB-ACCESS\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 *
|
|
.\" -----------------------------------------------------------------
|
|
.\" 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-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/).
|