Docs || Official Website
English || 简体中文

Connect with us:

If you are interested in MatrixOne project, please kindly give MatrixOne a triple `Star`, `Fork` and `Watch`, Thanks!

Contents

• What is MatrixOne
• KeyFeatures
• User Values
• Architecture
• Quick start
• Contributing
• License

What is MatrixOne?

MatrixOne is a future-oriented hyper-converged cloud and edge native DBMS that supports transactional, analytical, and streaming workloads with a simplified and distributed database engine, across multiple data centers, clouds, edges and other heterogeneous infrastructures.

🎯 Key Features

💥 Hyper-converged Engine

☁️ Cloud & Edge Native

🚀 Extreme Performance

💎 User Values

🔎 Architecture

MatrixOne's architecture is as below:

For more details, you can checkout MatrixOne Architecture Design.

⚡️ Quick start

⚙️ Install MatrixOne

MatrixOne supports Linux and MacOS. You can install MatrixOne either by building from source or using docker. For other installation types, please refer to MatrixOne installation for more details.

Building from source

Step 1. Install Go (version 1.20 is required)

Click Go Download and install to enter its official documentation, and follow the installation steps to complete the Go installation.

Step 2. Get the MatrixOne code to build MatrixOne

Depending on your needs, choose whether you want to keep your code up to date, or if you want to get the latest stable version of the code.

• Option 1: Get the MatrixOne(Develop Version) code, build MatrixOne

The main branch is the default branch, the code on the main branch is always up-to-date but not stable enough.

1. Get the MatrixOne(Develop Version) code:

   git clone https://github.com/matrixorigin/matrixone.git
   cd matrixone
   

2. Run make build to compile the MatrixOne file:

   make build
   

   Tips: You can also run make debug, make clean, or anything else our Makefile offers, make debug can be used to debug the build process, and make clean can be used to clean up the build process.

• Option 2: Get the MatrixOne(Stable Version) code, build MatrixOne

1. If you want to get the latest stable version code released by MatrixOne, please switch to the branch of version 0.8.0 first.

   git clone https://github.com/matrixorigin/matrixone.git
   git checkout 0.8.0
   cd matrixone
   

2. Run make config and make build to compile the MatrixOne file:

   make config
   make build
   

   Tips: You can also run make debug, make clean, or anything else our Makefile offers, make debug can be used to debug the build process, and make clean can be used to clean up the build process.

Step 3. Launch MatrixOne server

Launch MatrixOne server in the frontend or backend as 3. Launch MatrixOne server suggests in Building from source code.

• Launch in the frontend"

  This launch method will keep the mo-service process running in the frontend, the system log will be printed in real time. If you'd like to stop MatrixOne server, just make a CTRL+C or close your current terminal.

  # Start mo-service in the frontend
  ./mo-service -launch ./etc/quickstart/launch.toml
  

• Launch in the backend"

  This launch method will put the mo-service process running in the backend, the system log will be redirected to the test.log file. If you'd like to stop MatrixOne server, you need to find out its PID by and kill it by the following commands. Below is a full example of the whole process.

  # Start mo-service in the backend
  ./mo-service --daemon --launch ./etc/quickstart/launch.toml &> test.log &
  
  # Find mo-service PID
  ps aux | grep mo-service
  
  [root@VM-0-10-centos ~]# ps aux | grep mo-service
  root       15277  2.8 16.6 8870276 5338016 ?     Sl   Nov25 156:59 ./mo-service -launch ./etc/quickstart/launch.toml
  root      836740  0.0  0.0  12136  1040 pts/0    S+   10:39   0:00 grep --color=auto mo-service
  
  # Kill the mo-service process
  kill -9 15277
  

  Tips: As shown in the above example, use the command ps aux | grep mo-service to find out that the process number running on MatrixOne is 15277, and kill -9 15277 means to stop MatrixOne with the process number 15277.

Using docker

1. Make sure Docker is installed, verify Docker daemon is running in the background:

$ docker --version

The successful installation results are as follows:

Docker version 20.10.17, build 100c701

2. Create and run the container for the latest release of MatrixOne. It will pull the image from Docker Hub if not exists.

It will pull the image from Docker Hub if not exists. You can choose to pull the stable version image or the develop version image.

• Stable Version Image(0.8.0 version)

docker pull matrixorigin/matrixone:0.8.0
docker run -d -p 6001:6001 --name matrixone matrixorigin/matrixone:0.8.0

If you are using the network in mainland China, you can pull the MatrixOne stable version image on Alibaba Cloud:

docker pull registry.cn-shanghai.aliyuncs.com/matrixorigin/matrixone:0.8.0
docker run -d -p 6001:6001 --name matrixone registry.cn-shanghai.aliyuncs.com/matrixorigin/matrixone:0.8.0

• If you want to pull the develop version image, see Docker Hub, get the image tag. An example as below:

  Develop Version Image

  docker pull matrixorigin/matrixone:nightly-commitnumber
  docker run -d -p 6001:6001 --name matrixone matrixorigin/matrixone:nightly-commitnumber

  If you are using the network in mainland China, you can pull the MatrixOne develop version image on Alibaba Cloud:

  docker pull registry.cn-shanghai.aliyuncs.com/matrixorigin/matrixone:nightly-commitnumber
  docker run -d -p 6001:6001 --name matrixone registry.cn-shanghai.aliyuncs.com/matrixorigin/matrixone:nightly-commitnumber

  !!! info The nightly version is updated once a day.

🌟 Connecting to MatrixOne server

1. Install MySQL client.

   MatrixOne supports the MySQL wire protocol, so you can use MySQL client drivers to connect from various languages. Currently, MatrixOne is only compatible with Oracle MySQL client. This means that some features might not work with MariaDB client.

   To install MySQL client, enter into the MySQL Community Downloads download page:

   • According to your System, Select Select Operating System.

   • Click Select OS Version from the drop-down list. Version 8.0.30 or later is recommended.

   You can follow the Installing and Upgrading MySQL official document to configure the MySQL client environment variables.

2. Connect to MatrixOne server:

   When you finish installing and starting MatrixOne, many logs are generated in startup mode. Then you can start a new terminal and connect to a matrixone.

   mysql -h IP -P PORT -uUsername -p
   

   After you enter the preceding command, the terminal will prompt you to provide the username and password. You can use our built-in account:

   • user: dump
   • password: 111

   You can also use the following command line on the MySQL client to connect to the MatrixOne service:

   mysql -h 127.0.0.1 -P 6001 -udump -p
   Enter password:
   

Now, MatrixOne only supports the TCP listener.

🙌 Contributing

Contributions to MatrixOne are welcome from everyone.
See Contribution Guide for details on submitting patches and the contribution workflow.

👏 All contributors

Nnsgmsone	XuPeng-SH	Fagongzi	Reusee	Ouyuanning	Daviszhen
BRong Njam	Maomao	Iamlinjunhong	Jiangxinmeng1	Jianwan0214	GreatRiver
Wei Ziran	Chenmingsong	Dengn	Aptend	Lni	Jackson
YANGGMM	Qingxinhome	Nitao	BroccoliSpicy	Mooleetzi	Fengttt
Kutori	Prinz	Brown	Dongdongyang	Boyu Tan	Cui Guoke
Jin Hai	Matthew	Bbbearxyz	Tianyahui-python	Wanglei	Triump2020
Heni02	Wanhanbo	IceTTTT	LiuBo	刘陶峰	Ariznawlll
GoodMan-code	Yingfeng	Mklzl	Jensen	DomingoZhang	Arjun Sunil Kumar
Nuo Xu	Aressu1985	Mo-bot	Zengyan1	Aylei	NoneBack
Otter	Richelle Guice	Ryan	Elijah	MatrixAdventurer	NTH19
Anitajjx	Whileskies	BePPPower	Jiajun Huang	Morranto	Y7n05h
Songjiayang	Abirdcfly	Binglin Chang	Charlie17Li	DanielZhangQD	Eng Zer Jun
Eric Shen	Fungx	Kirito	Jason Peng	O2	RinChanNOW!
TheR1sing3un	XuQing Chai	Yiliang Qiu	ZeYu Zhao	ZheNing Hu	Zijie Lu
Zoran Pandovski	Ajian	Binxxi	Coderzc	ColdWater	Dr-lab
Florashi181	Hiyoyolumi	Jinfu	Liuguangliang	Lokax	Lyfer233
Sundyli	Supermario1990	Tjie	Toms	Wuliuqii	Xiyuedong
Yclchuxue	Zt

License

MatrixOne is licensed under the Apache License, Version 2.0.