MariaDB ColumnStore Administrative Console (mcsadmin) for MariaDB Enterprise ColumnStore
This page is part of MariaDB's Documentation.
The parent of this page is: Reference for MariaDB Enterprise ColumnStore
Topics on this page:
Overview
MariaDB Enterprise ColumnStore 1.4 and earlier includes the MariaDB ColumnStore Administrative Console (mcsadmin
), which is a command-line interface that can configure, monitor, and manage MariaDB Enterprise ColumnStore.
In MariaDB Enterprise ColumnStore 1.5 and later, CMAPI is used to configure and manage MariaDB Enterprise ColumnStore instead.
Reference material is available for MariaDB Enterprise ColumnStore.
MariaDB Enterprise ColumnStore is included with MariaDB Enterprise Server.
USAGE
The mcsadmin
utility can execute many different commands. There are two primary ways to execute commands using mcsadmin
.
mcsadmin
can be used to run a command by providing the command name and its parameters as command-line arguments:
$ mcsadmin COMMAND [PARAMETER ...]
Alternatively, you can open the administrative console by running mcsadmin
without the command name:
$ mcsadmin
Once the administrative console is opened, it can be used to run a command by providing the command name and its parameters:
mcsadmin> COMMAND [PARAMETER ...]
...
mcsadmin> COMMAND [PARAMETER ...]
DETAILS
The MariaDB ColumnStore Administrative Console (mcsadmin
) can configure, monitor, and manage MariaDB Enterprise ColumnStore. Once Enterprise ColumnStore has been deployed, you can invoke the console from any of the UM or PM nodes.
mcsadmin Commands by MariaDB Enterprise ColumnStore Version
Choose a version of MariaDB Enterprise ColumnStore to see the commands supported by that version:
mcsadmin Command Summary
Command | In 23.10? |
| In 1.4? |
---|---|---|---|
EXAMPLES
Get System Status
To get the system status:
$ mcsadmin getSystemStatus