mariadb & mysql for MariaDB Enterprise Server 10.5

Overview

The mariadb utility, which is also called MariaDB Client, provides SQL shell access to MariaDB Enterprise Server 10.5. It supports both interactive and non-interactive use.

MariaDB Enterprise Server 10.5 also provides a symbolic link to the utility's legacy name (mysql).

mariadb Options for MariaDB Enterprise Server 10.5

Option

Description

--abort-source-on-error

Abort 'source filename' operations in case of errors

--auto-rehash

Enable automatic rehashing. One doesn't need to use 'rehash' to get table and field completion, but startup and reconnecting may take a longer time. Disable with --disable-auto-rehash. (Defaults to on; use --skip-auto-rehash to disable.)

--auto-vertical-output

Automatically switch to vertical output mode if the result is wider than the terminal width.

--batch (-B)

Don't use history file. Disable interactive behavior. (Enables --silent.)

--binary-as-hex

Print binary data as hex

--binary-mode

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 \C 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 '\r\n' and ASCII '\0' are preserved within strings, whereas by default, '\r\n' is translated to '\n' and '\0' is disallowed in user input.

--character-sets-dir

Directory for character set files.

--column-names

Write column names in results. (Defaults to on; use --skip-column-names to disable.)

--column-type-info

Display column type information.

--comments (-c)

Preserve comments. Send comments to the server. The default is --skip-comments (discard comments), enable with --comments.

--compress (-C)

Use compression in server/client protocol.

--connect-expired-password

Notify the server that this client is prepared to handle expired password sandbox mode even if --batch was specified.

--connect-timeout

Number of seconds before connection timeout.

--database (-D)

Database to use.

--debug (-#)

This is a non-debug version. Catch this and exit.

--debug-check

Check memory and open file usage at exit.

--debug-info (-T)

Print some debug info at exit.

--default-auth

Default authentication client-side plugin to use.

--default-character-set

Set the default character set.

--defaults-extra-file

Read this file after the global files are read.

--defaults-file

Only read default options from the given file #.

--defaults-group-suffix

Additionally read default groups with # appended as a suffix.

--delimiter

Delimiter to be used.

--enable-cleartext-plugin

Obsolete option. Exists only for MySQL compatibility.

--execute (-e)

Execute command and quit. (Disables --force and history file.)

--force (-f)

Continue even if we get an SQL error. Sets abort-source-on-error to 0

--help (-?, -I)

Display this help and exit.

--host (-h)

Connect to host.

--html (-H)

Produce HTML output.

--i-am-a-dummy (-U)

Synonym for option --safe-updates, -U.

--ignore-spaces (-i)

Ignore space after function names.

--init-command

SQL Command to execute when connecting to MariaDB server. Will automatically be re-executed when reconnecting.

--line-numbers

Write line numbers for errors. (Defaults to on; use --skip-line-numbers to disable.)

--local-infile

Enable/disable LOAD DATA LOCAL INFILE.

--max-allowed-packet

The maximum packet length to send to or receive from server.

--max-join-size

Automatic limit for rows in a join when using --safe-updates.

--named-commands (-G)

Enable named commands. Named commands mean this program's internal commands; see mysql> help . When enabled, the named commands can be used from any line of the query, otherwise only from the first line, before an enter. Disable with --disable-named-commands. This option is disabled by default.

--net-buffer-length

The buffer size for TCP/IP and socket communication.

--no-auto-rehash (-A)

No automatic rehashing. One has to use 'rehash' to get table and field completion. This gives a quicker start of mysql and disables rehashing on reconnect.

--no-beep (-b)

Turn off beep on error.

--no-defaults

Don't read default options from any option file.

--one-database (-o)

Ignore statements except those that occur while the default database is the one named at the command line.

--pager

Pager to use to display results. If you don't supply an option, the default pager is taken from your ENV variable PAGER. Valid pagers are less, more, cat [> filename], etc. See interactive help (\h) also. This option does not work in batch mode. Disable with --disable-pager. This option is disabled by default.

--password (-p)

Password to use when connecting to server. If password is not given it's asked from the tty.

--plugin-dir

Directory for client-side plugins.

--port (-P)

Port number to use for connection or 0 for default to, in order of preference, my.cnf, $MYSQL_TCP_PORT, /etc/services, built-in default (3306).

--print-defaults

Print the program argument list and exit.

--progress-reports

Get progress reports for long running commands (like ALTER TABLE) (Defaults to on; use --skip-progress-reports to disable.)

--prompt

Set the command line prompt to this value.

--protocol

The protocol to use for connection (tcp, socket, pipe).

--quick (-q)

Don't cache result, print it row by row. This may slow down the server if the output is suspended. Doesn't use history file.

--raw (-r)

Write fields without conversion. Used with --batch.

--reconnect

Reconnect if the connection is lost. Disable with --disable-reconnect. This option is enabled by default. (Defaults to on; use --skip-reconnect to disable.)

--safe-updates (-U)

Only allow UPDATE and DELETE that uses keys.

--secure-auth

Refuse client connecting to server if it uses old (pre-4.1.1) protocol.

--select-limit

Automatic limit for SELECT when using --safe-updates.

--server-arg

Send embedded server this as a parameter.

--show-warnings

Show warnings after every statement.

--sigint-ignore

Ignore SIGINT (CTRL-C).

--silent (-s)

Be more silent. Print results with a tab as separator, each row on new line.

--skip-column-names (-N)

Don't write column names in results.

--skip-line-numbers (-L)

Don't write line number for errors.

--socket (-S)

The socket file to use for connection.

--ssl

Enable SSL for connection (automatically enabled with other flags).

--ssl-ca

CA file in PEM format (check OpenSSL docs, implies --ssl).

--ssl-capath

CA directory (check OpenSSL docs, implies --ssl).

--ssl-cert

X509 cert in PEM format (implies --ssl).

--ssl-cipher

SSL cipher to use (implies --ssl).

--ssl-crl

Certificate revocation list (implies --ssl).

--ssl-crlpath

Certificate revocation list path (implies --ssl).

--ssl-key

X509 key in PEM format (implies --ssl).

--ssl-verify-server-cert

Verify server's "Common Name" in its cert against hostname used when connecting. This option is disabled by default.

--table (-t)

Output in table format.

--tee

Append everything into outfile. See interactive help (\h) also. Does not work in batch mode. Disable with --disable-tee. This option is disabled by default.

--tls-version

TLS protocol version for secure connection.

--unbuffered (-n)

Flush buffer after each query.

--user (-u)

User for login if not current user.

--verbose (-v)

Write more. (-v -v -v gives the table output format).

--version (-V)

Output version information and exit.

--vertical (-E)

Print the output of a query (rows) vertically.

--wait (-w)

Wait and retry if connection is down.

--xml (-X)

Produce XML output.

To see options supported in other versions, see "mariadb & mysql Options by MariaDB Server Version".