matrixone

README

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 hyper-converged cloud & edge native distributed database with a structure that separates storage, computation, and transactions to form a consolidated HSTAP data engine. This engine enables a single database system to accommodate diverse business loads such as OLTP, OLAP, and stream computing. It also supports deployment and utilization across public, private, and edge clouds, ensuring compatibility with diverse infrastructures.

🎯 Key Features

💥 Hyper-converged Engine

Monolithic Engine

HTAP data engine that supports a mix of workloads such as TP, AP, time series, and machine learning within a single database.

Built-in Streaming Engine

Built-in stream computing engine that enables real-time data inflow, transformation, and querying.

☁️ Cloud & Edge Native

Storage-Computation Separation Structure

Separates the storage, computation, and transaction layers, leveraging a containerized design for ultimate scalability.

Multi-Infrastructure Compatibility

MatrixOne provides industry-leading latency control with optimized consistency protocol.

🚀 Extreme Performance

High-Performance Execution Engine

The flexible combination of Compute Node and Transaction node accommodates point queries and batch processing, delivering peak performance for OLTP and OLAP.

Enterprise-Grade High Availability

Establishes a consistently shared log under a leading Multi-Raft replication state machine model. It ensures high cluster availability while preventing data duplication, thus achieving RTO=0.

🖊️ Ease of Use

Built-in Multi-Tenancy Capability

Offers inherent multi-tenancy, where tenants are isolated from each other, independently scalable yet uniformly manageable. This feature simplifies the complexity of multi-tenancy design in upper-level applications.

High Compatibility with MySQL

MatrixOne exhibits high compatibility with MySQL 8.0, including transmission protocol, SQL syntax, and ecosystem tools, lowering usage and migration barriers.

💰 Cost-Effective

Efficient Storage Design

Employs cost-effective object storage as primary storage. High availability can be achieved through erasure coding technology with only about 150% data redundancy. It also provides high-speed caching capabilities, balancing cost and performance via a multi-tiered storage strategy that separates hot and cold data.

Flexible Resource Allocation

Users can adjust the resource allocation ratio for OLTP and OLAP according to business conditions, maximizing resource utilization.

🔒 Enterprise-Level Security and Compliance

MatrixOne employs Role-Based Access Control (RBAC), TLS connections, and data encryption to establish a multi-tiered security defense system, safeguarding enterprise-level data security and compliance.

💎 User Values

Simplify Database Management and Maintenance

With business evolution, the number of data engines and middleware enterprises employ increases. Each data engine relies on 5+ essential components and stores 3+ data replicas. Each engine must be independently installed, monitored, patched, and upgraded. This results in high and uncontrollable data engine selection, development, and operations costs. Under MatrixOne's unified architecture, users can employ a single database to serve multiple data applications, reducing the number of introduced data components and technology stacks by 80% and significantly simplifying database management and maintenance costs.

Reduce Data Fragmentation and Inconsistency

Data flow and copy between databases make data sync and consistency increasingly tricky. The unified and incrementally materialized view of MatrixOne allows the downstream to support real-time upstream updates and achieve end-to-end data processing without redundant ETL processes.

Decoupling Data Architecture From Infrastructure

Currently, the architecture design across different infrastructures is complicated, causing new data silos between cloud and edge, cloud and on-premise. MatrixOne is designed with a unified architecture to support simplified data management and operations across different infrastructures.

Extremely Fast Complex Query Performance

Poor business agility results from slow, complex queries and redundant intermediate tables in current data warehousing solutions. MatrixOne supports blazing-fast experience even for star and snowflake schema queries, improving business agility with real-time analytics.

Solid OLTP-like OLAP Experience

Current data warehousing solutions have the following problems: high latency and absence of immediate visibility for data updates. MatrixOne brings OLTP (Online Transactional Processing) level consistency and high availability to CRUD operations in OLAP (Online Analytical Processing).

Seamless and Non-disruptive Scalability

It is challenging to balance performance and scalability to achieve an optimum price-performance ratio in current data warehousing solutions. MatrixOne's disaggregated storage and compute architecture makes it fully automated and efficient to scale in/out and up/down without disrupting applications.

🔎 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.

Step 1.Install Dependency

• Building from source

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.

2. Install GCC/Clang

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

3. Install Git

   Install Git via the Official Documentation.

4. Install and configure MySQL Client

   Click MySQL Community Downloads to enter into the MySQL client download and installation page. According to your operating system and hardware environment.Configure the MySQL client environment variables.

• Using docker

1. Download and install Docker

Click Get Docker, enter into the Docker's official document page, depending on your operating system, download and install the corresponding Docker. It is recommended to choose Docker version 20.10.18 or later and strive to maintain consistency between the Docker client and Docker server versions.

1. Install and configure MySQL Client

Click MySQL Community Downloads to enter into the MySQL client download and installation page. According to your operating system and hardware environment.Configure the MySQL client environment variables.

Note: MySQL client version 8.0.30 or later is recommended.

Step 2. Install the mo_ctl tool

mo_ctl is a command-line tool for deploying, installing, and managing MatrixOne. It is very convenient to perform various operations on MatrixOne.

The mo_ctl tool can be installed through the following command:

wget https://raw.githubusercontent.com/matrixorigin/mo_ctl_standalone/main/install.sh && sudo -u $(whoami) bash +x ./install.sh

See mo_ctl Tool for complete usage details.

Step 3. Set mo_ctl parameters

• Building from source

mo_ctl set_conf MO_PATH="yourpath" # Set custom MatrixOne download path
mo_ctl set_conf MO_DEPLOY_MODE=git # Set MatrixOne deployment method

• Using docker

mo_ctl set_conf MO_CONTAINER_DATA_HOST_PATH="/yourpath/mo/" # Set the data directory for host
mo_ctl set_conf MO_DEPLOY_MODE=docker # Set MatrixOne deployment method

Step 4. One-click install 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)

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

mo_ctl deploy main

• Option 2: Get the MatrixOne(Stable Version)

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

mo_ctl deploy v1.1.3

Step 5. Launch MatrixOne server

Launch the MatrixOne service through the mo_ctl start command.

Tips: The initial startup of MatrixOne approximately takes 20 to 30 seconds. After a brief wait, you can connect to MatrixOne using the MySQL client.

Step 6. Connect to MatrixOne

One-click connection to MatrixOne service through mo_ctl connect command.

Note: The login account in the above code snippet is the initial account; please change the initial password after logging in to MatrixOne; see Password Management.

🙌 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.