mo_ctl tool is a tool designed to help you easily manage your standalone MatrixOne server, such as deploying, starting, stopping, connect and much more fun admin operations for you to discover!
Depending on whether your machine has access to the Internet or not, you can choose to install mo_ctl online or offline. Please remember to run the commands as root or a user with sudo privileges (and add sudo to each command). Also install.sh will use unzip command to extract mo_ctl, thus please make sure unzip is installed.
# Option-A. install with the Internet
wget https://raw.githubusercontent.com/matrixorigin/mo_ctl_standalone/main/install.sh && bash +x ./install.sh
# download from gitee.com
# wget https://gitee.com/matrixorigin/mo_ctl_standalone/blob/main/install.sh && bash +x ./install.sh
# Option-B. install without the Internet
# 1. download them to your local pc first, then upload them to your server machine
wget https://raw.githubusercontent.com/matrixorigin/mo_ctl_standalone/main/install.sh
wget https://github.com/matrixorigin/mo_ctl_standalone/archive/refs/heads/main.zip -O mo_ctl.zip
# 2. install from offline pacakge
bash +x ./install.sh mo_ctl.zipIn case you have network issues accessing above address, you can use the backup address below.
# backup address
# Option-A. install with the Internet
wget https://mirror.ghproxy.com/https://github.com/matrixorigin/mo_ctl_standalone/blob/main/install.sh && bash +x install.sh
# Option-B. install without the Internet
# 1. download them to your pc first, then upload them to your machine
wget https://mirror.ghproxy.com/https://github.com/matrixorigin/mo_ctl_standalone/blob/main/install.sh
wget https://mirror.ghproxy.com/https://github.com/matrixorigin/mo_ctl_standalone/archive/refs/heads/main.zip -O mo_ctl.zip
# 2. install from offline pacakge
bash +x ./install.sh mo_ctl.zipYou can uninstall mo_ctl using below command.
wget https://raw.githubusercontent.com/matrixorigin/mo_ctl_standalone/main/uninstall.sh && bash +x ./uninstall.sh
# backup address
wget https://mirror.ghproxy.com/https://github.com/matrixorigin/mo_ctl_standalone/blob/main/uninstall.sh && bash +x uninstall.sh
# on Ubuntu, MacOS or any other Linux with a non-root user with sudo privilges
wget https://mirror.ghproxy.com/https://github.com/matrixorigin/mo_ctl_standalone/blob/main/uninstall.sh && sudo bash +x uninstall.shAfter mo_ctl is installed, you can use mo_ctl help to print help info on how to use.
- Take a quick look at the tool guide.
mo_ctl help- Note that some pre-requisites are required by
mo_ctl, and usemo_ctl precheckto check if your machine meets them. Refer to chapter Reference for more info on how to install them. - Set some configurations
mo_ctl get_conf MO_PATH # check default value of mo path to be installed
mo_ctl set_conf MO_PATH="/data/mo/20230701/matrixone" # set your own mo path
mo_ctl set_conf MO_GIT_URL="https://mirror.ghproxy.com/https://github.com/matrixorigin/matrixone.git" # in case have network issues, you can set this conf by overwritting default value MO_GIT_URL="https://github.com/matrixorigin/matrixone.git"- Deploy a standalone mo instance of latest stable release version(current: 0.8.0)
mo_ctl deploy- Check mo-service status
mo_ctl status- Connect to mo-service after a few seconds when mo-service's initialization is finished
mo_ctl connect- Now enjoy your journey with MatrixOne via mo_ctl! For more help, please check chapter Reference
Use mo_ctl help to get help on how to use mo_ctl
Usage : mo_ctl [option_1] [option_2]
[option_1] : available: connect | csv_convert | ddl_connect | deploy | get_branch | get_cid | get_conf | help | pprof | precheck | restart | set_conf | sql | start | status | stop | uninstall | upgrade | version | watchdog
1) connect : connect to mo via mysql client using connection info configured
2) csv_convert : convert a csv file to a sql file in format "insert into values" or "load data inline format='csv'"
3) ddl_convert : convert a ddl file to mo format from other types of database
4) deploy : deploy mo onto the path configured
5) get_branch : upgrade or downgrade mo from current version to a target commit id or stable version
6) get_cid : print mo git commit id from the path configured
7) get_conf : get configurations
8) help : print help information
9) pprof : collect pprof information
10) precheck : check pre-requisites for mo_ctl
11) restart : a combination operation of stop and start
12) set_conf : set configurations
13) sql : execute sql from string, or a file or a path containg multiple files
14) start : start mo-service from the path configured
15) status : check if there's any mo process running on this machine
16) stop : stop all mo-service processes found on this machine
17) uninstall : uninstall mo from path MO_PATH=/data/mo//matrixone
18) upgrade : upgrade or downgrade mo from current version to a target commit id or stable version
19) version : show mo_ctl and mo version
20) watchdog : setup a watchdog crontab task for mo-service to keep it alive
e.g. : mo_ctl status
[option_2] : Use " mo_ctl [option_1] help " to get more info
e.g. : mo_ctl deploy helpUse mo_ctl [option_1] help to get more help on how to use mo_ctl [option_1].
Use mo_ctl connect to connect to mo via mysql client using connection info configured.
mo_ctl connect help
Usage : mo_ctl connect # connect to mo via mysql client using connection info configuredUse mo_ctl ddl_convert [options] [src_file] [tgt_file] to convert a ddl file to mo format from other types of database. Currently, only mysql_to_mo is supported.
mo_ctl ddl_convert help
Usage : mo_ctl ddl_convert [options] [src_file] [tgt_file] # convert a ddl file to mo format from other types of database
[options] : available: mysql_to_mo
[src_file] : source file to be converted, will use env DDL_SRC_FILE from conf file by default
[tgt_file] : target file of converted output, will use env DDL_TGT_FILE from conf file by default
e.g. : mo_ctl ddl_convert mysql_to_mo /tmp/mysql.sql /tmp/mo.sqlNote： some types of column definition might not have yet been supported in mo, please refer to https://docs.matrixorigin.cn/0.8.0/MatrixOne/Overview/feature/mysql-compatibility/#_1 for more info.
Use mo_ctl deploy [mo_version] [force] to deploy a stable version of mo release, or a specific development version.
mo_ctl deploy help
Usage : mo_ctl deploy [mo_version] [force] # deploy mo onto the path configured
[mo_version]: optional, specify an mo version to deploy
[force] : optional, if specified will delete all content under MO_PATH and deploy from beginning
Note : 'deploy' is valid only when MO_DEPLOY_MODE is set to 'git' or 'docker'
e.g. : mo_ctl deploy # default, same as mo_ctl deploy 0.8.0
: mo_ctl deploy main # deploy development latest version
: mo_ctl deploy d29764a # deploy development version d29764a
: mo_ctl deploy 0.8.0 # deploy stable verson 0.8.0
: mo_ctl deploy force # delete all under MO_PATH and deploy verson 0.8.0
: mo_ctl deploy 0.8.0 force # delete all under MO_PATH and deploy stable verson 0.8.0 from beginningUse mo_ctl get_branch to print which git branch mo is currently on.
mo_ctl get_branch help
Usage : mo_ctl get_branch # print git branch where mo is currently onUse mo_ctl get_cid to print mo commit id from the path from conf MO_PATH.
mo_ctl get_cid help
Usage : mo_ctl get_cid # print mo commit id from the path configuredUse mo_ctl get_conf [conf_list] to get one or more configuration items.
mo_ctl get_conf help
Usage : mo_ctl getconf [conf_list] # get configurations
[conf_list] : optional, configuration list in key, seperated by comma.
: use 'all' or leave it as blank to print all configurations
e.g. : mo_ctl getconf MO_PATH,MO_PW,MO_PORT # get multiple configurations
: mo_ctl getconf MO_PATH # get single configuration
: mo_ctl getconf all # get all configurations
: mo_ctl getconf # get all configurationsUse mo_ctl pprof [item] [duration] to collect pprof information, which is usefully when debugging issues.
mo_ctl pprof help
Usage : mo_ctl pprof [item] [duration] # collect pprof information
[item] : optional, specify what pprof to collect, available: profile | heap | allocs
1) profile : default, collect profile pprof for 30 seconds
2) heap : collect heap pprof at current moment
3) allocs : collect allocs pprof at current moment
[duration] : optional, only valid when [item]=profile, specifiy duration to collect profile
e.g. : mo_ctl pprof
: mo_ctl pprof profile # collect duration will use conf value PPROF_PROFILE_DURATION from conf file or 30 if it's not set
: mo_ctl pprof profile 30
: mo_ctl pprof heapUse mo_ctl precheck before deploying your MatrixOne standalone instance. Currently the required pre-requsites are: go/gcc/ git/mysql(client).
mo_ctl precheck help
Usage : mo_ctl precheck # check pre-requisites for mo_ctl
Check list : go gcc git mysql Use mo_ctl restart [force] to stop any mo-service found on current machine, and start mo-service which is built under conf MO_PATH.
mo_ctl restart help
Usage : mo_ctl restart [force] # a combination operation of stop and start
[force] : optional, if specified, will try to kill mo-services with -9 option, so be very carefully
e.g. : mo_ctl restart # default, stop all mo-service processes found on this machine and start mo-serivce under path of conf MO_PATH
: mo_ctl restart force # stop all mo-services with kill -9 command and start mo-serivce under path of conf MO_PATHUse mo_ctl set_conf [conf_list] to set one or more configuration items.
mo_ctl set_conf help
Usage : mo_ctl setconf [conf_list] # set configurations
[conf_list] : configuration list in key=value format, seperated by comma
e.g. : mo_ctl setconf MO_PATH=/data/mo/20230629/matrixone,MO_PW=M@trix0riginR0cks,MO_PORT=6101 # set multiple configurations
: mo_ctl setconf MO_PATH=/data/mo/20230629/matrixone # set single configuration
# Note:
# in case you want to set a conf whose value contains a '$', e.g. MO_CONF_FILE="${MO_PATH}/matrixone/etc/launch-tae-CN-tae-DN/launch.toml", please add \ before $, like this:
# mo_ctl set_conf MO_CONF_FILE="\${MO_PATH}/matrixone/etc/launch-tae-CN-tae-DN/launch.toml"Use mo_ctl sql [sql] to execute sql queries.
mo_ctl sql help
Usage : mo_ctl sql [sql] # execute sql from string, or a file or a path containg multiple files
[sql] : a string quote by "", or a file, or a path
e.g. : mo_ctl sql "use test;select 1;" # execute sql "use test;select 1"
: mo_ctl sql /data/q1.sql # execute sql in file /data/q1.sql
: mo_ctl sql /data/ # execute all sql files with .sql postfix in /data/Use mo_ctl start to startup mo-service, which is built under conf MO_PATH.
mo_ctl start help
Note : when MO_DEPLOY_MODE is set to 'git', mo_ctl finds mo-service under path MO_PATH/matrixone/ (currently set as /data/mo/matrixone/)
: when MO_DEPLOY_MODE is set to 'binary', mo_ctl finds mo-service under path MO_PATH/ (currently set as /data/mo/)
: when MO_DEPLOY_MODE is set to 'docker', mo_ctl creates a container from image MO_CONTAINER_IMAGE (currently set as matrixorigin/matrixone:1.1.1)
Usage : mo_ctl start # start mo-service from the path configuredUse mo_ctl status to check if there's any mo process running on this machine.
mo_ctl start help
Usage : mo_ctl start # start mo-service from the path configuredUse mo_ctl stop [force] to stop any mo-service found on current machine.
mo_ctl stop help
Usage : mo_ctl stop [force] # stop all mo-service processes found on this machine
[force] : optional, if specified, will try to kill mo-services with -9 option, so be very carefully
e.g. : mo_ctl stop # default, stop all mo-service processes found on this machine
: mo_ctl stop force # stop all mo-services with kill -9 commandUse mo_ctl upgrade [version_or_commitid] to upgrade or downgrade mo from current version to a target commit id or stable version.
mo_ctl upgrade help
Usage : mo_ctl upgrade [version_commitid] # upgrade or downgrade mo from current version to a target commit id or stable version
[commitid] : a commit id such as '38888f7', or a stable version such as '0.8.0'
: use 'latest' to upgrade to latest commit on main branch if you don't know the id
e.g. : mo_ctl upgrade 38888f7 # upgrade/downgrade to commit id 38888f7 on main branch
: mo_ctl upgrade latest # upgrade/downgrade to latest commit on main branch
: mo_ctl upgrade 0.8.0 # upgrade/downgrade to stable version 0.8.0Use mo_ctl watchdog [options]setup a watchdog crontab task for mo-service to keep it alive.
mo_ctl watchdog help
Usage : mo_ctl watchdog [options] # setup a watchdog crontab task for mo-service to keep it alive
[options] : available: enable | disable | status
e.g. : mo_ctl watchdog enable # enable watchdog service for mo, by default it will check if mo-servie is alive and pull it up if it's dead every one minute
: mo_ctl watchdog disable # disable watchdog
: mo_ctl watchdog status # check if watchdog is enabled or disabled
: mo_ctl watchdog # same as mo_ctl watchdog statusUse mo_ctl build_image build an MO image and save it to local path.
Usage : mo_ctl build_image # build an MO image from source code
Note : please set below configurations first before you run the [enable] option
1. MO_PATH [OPTIONAL, default: /data/mo]: Path to MO source codes. e.g. mo_ctl set_conf MO_PATH=/data/mo
2. GOPROXY [OPTIONAL, default: https://goproxy.cn,direct]: Path to save target MO image
3. MO_BUILD_IMAGE_PATH [OPTIONAL, default: /tmp]: go proxy settinggcc is required for building and running MatrixOne. Version 8.5 or higher is recommended. Please refer to https://gcc.gnu.org/install/ on how to install it.
go is required for building and running MatrixOne. Version 1.20 or higher is recommended. Please refer to https://go.dev/doc/install on how to install it.
git is used to perform actions when deploying, getting commit id, etc on MatrixOne. Latest version is recommended. Please refer to https://github.com/git-guides/install-git on how to install it.
mysql command is used as a client tool for connecting MatrixOne server. Version 8.0.30 or higher is recommended. Please refer to https://dev.mysql.com/downloads/ on how to install it.
