MaxScale Sub-commands for MariaDB Shell
This page is part of MariaDB's MariaDB Documentation.
The parent of this page is: MariaDB Shell
Topics on this page:
Overview
MariaDB Shell supports the max
sub-command for use with MaxScale.
The mxs
sub-command is an alias for the max
sub-command.
Compatibility
MariaDB Shell (mariadb-shell
) has been tested by MariaDB to properly connect and execute commands with:
MariaDB Enterprise ColumnStore 6
MariaDB Enterprise ColumnStore 22.08
MariaDB Enterprise ColumnStore 23.02
MariaDB Enterprise Server 10.4
MariaDB Enterprise Server 10.5
MariaDB Enterprise Server 10.6
MariaDB MaxScale 2.4
MariaDB MaxScale 2.5
MariaDB MaxScale 6
MariaDB MaxScale 22.08
MariaDB MaxScale 23.02
MariaDB Xpand 5.3
MariaDB Xpand 6.0
MariaDB Xpand 6.1
Supported Operating Systems
Apple macOS (x86_
64 / M1) CentOS 7 (x86_
64) Debian 10 (x86_
64) Debian 11 (x86_
64) Microsoft Windows (x86_
64) Red Hat Enterprise Linux 7 (x86_
64) Red Hat Enterprise Linux 8 (x86_
64) Red Hat Enterprise Linux 9 (x86_
64) Rocky Linux 8 (x86_
64) Rocky Linux 9 (x86_
64) Ubuntu 18.04 (x86_
64) Ubuntu 20.04 (x86_
64) Ubuntu 22.04 (x86_
64)
Execute via Interactive Shell
MaxScale sub-commands can be executed from an interactive shell:
MariaDB (No Database) » max gui
Execute via CLI
MaxScale sub-commands can also be executed using CLI commands:
$ mariadb-shell \
max gui
alter
The max alter
sub-command is used to alter objects.
It is used similar to the alter
commands provided by MaxCtrl.
call
The max call
sub-command is used to call module commands.
It is used similar to the call
commands provided by MaxCtrl.
clear
The max clear
sub-command is used to clear object states.
It is used similar to the clear
commands provided by MaxCtrl.
create
The max create
sub-command is used to create objects.
It is used similar to the create
commands provided by MaxCtrl.
destroy
The max destroy
sub-command is used to destroy objects.
It is used similar to the destroy
commands provided by MaxCtrl.
gui
The max gui
sub-command is used to interact with MaxGUI.
To use this sub-command, Docker must be installed. When MaxGUI is started with MariaDB Shell, it pulls the latest mariadb/maxscale
image and creates a local container.
The following sub-commands are available to start and stop MaxGUI:
start
stop
link
The max link
sub-command is used to link objects.
It is used similar to the link
commands provided by MaxCtrl.
list
The max list
sub-command is used to list objects.
It is used similar to the list
commands provided by MaxCtrl.
reload
The max reload
sub-command is used to reload objects.
It is used similar to the reload
commands provided by MaxCtrl.
rotate
The max rotate
sub-command is used to rotate logs.
It is used similar to the rotate
commands provided by MaxCtrl.
set
The max set
sub-command is used to set object states.
It is used similar to the set
commands provided by MaxCtrl.
show
The max show
sub-command is used to show objects.
It is used similar to the show
commands provided by MaxCtrl.
start
The max start
sub-command is used to start objects.
It is used similar to the start
commands provided by MaxCtrl.
stop
The max stop
sub-command is used to stop objects.
It is used similar to the stop
commands provided by MaxCtrl.
unlink
The max unlink
sub-command is used to unlink objects.
It is used similar to the unlink
commands provided by MaxCtrl.