MariaDB Tools Sub-commands for MariaDB Shell

Overview

MariaDB Shell supports sub-commands that call utilities from MariaDB Tools.

MariaDB Tools must be installed.

Compatibility

MariaDB Shell (mariadb-shell) has been tested by MariaDB to properly connect and execute commands with:

  • Distributed Transactions

  • Multi-Node Analytics

  • Replicated Transactions

  • Single Node Analytics

  • Single Node Transactions

  • 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)

  • 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

MariaDB Tools sub-commands can be executed from an interactive shell:

MariaDB (No Database) » summary

Execute via CLI

MariaDB Tools sub-commands can also be executed using CLI commands:

$ mariadb-shell \
   --host HOSTNAME --port TCP_PORT \
   --user DATABASE_USER --password USER_PASSWORD \
   summary \
   > ~/mariadb-summary-output.log

summary

If MariaDB Tools is installed, MariaDB Shell can call the the mariadb-summary tool using the summary command:

$ mariadb-shell \
   --host HOSTNAME --port TCP_PORT \
   --user DATABASE_USER --password USER_PASSWORD \
   summary \
   > ~/mariadb-summary-output.log

system-summary

If MariaDB Tools is installed, MariaDB Shell can call the the mariadb-system-summary tool using the system-summary command:

$ mariadb-shell \
   --host HOSTNAME --port TCP_PORT \
   --user DATABASE_USER --password USER_PASSWORD \
   system-summary \
   > ~/mariadb-system-summary-output.log