MatrixOne Documentation

Official documentation repository for MatrixOne Database

📖 Documentation | 🚀 Quick Start | 🤝 Contributing | 💬 Discussions

---

📚 About

This repository contains all the source files for the MatrixOne documentation website.

What is MatrixOne?

MatrixOne is a hyperconverged cloud-edge native database designed to consolidate transactional (TP), analytical (AP), and streaming workloads into a single system. It features:

🎯 Core Capabilities

• 🔄 Hyper-Converged Engine: Single database supporting OLTP, OLAP, time-series, and machine learning workloads
• ☁️ Cloud-Edge Native: Deploy across public clouds, private clouds, edge, and on-premises with seamless scalability
• ⚡ Extreme Performance: Vectorized execution engine with high-performance distributed transactions
• 🌍 Multi-Tenancy: Complete tenant isolation with independent resource management
• 📊 Real-time HTAP: Handle mixed transactional and analytical workloads with real-time consistency
• 🔌 MySQL Compatibility: Compatible with MySQL protocol and syntax for easy migration

💡 Key Benefits

• Simplify Architecture: Replace multiple databases (MySQL, PostgreSQL, ClickHouse, etc.) with one unified system
• Reduce Costs: Lower infrastructure and operational costs through consolidation
• Accelerate Development: Faster development with unified data platform
• Ensure Consistency: Global distributed transactions guarantee data consistency
• Scale Effortlessly: Separate storage and compute for elastic scaling

MatrixOne is ideal for scenarios requiring real-time data processing, large-scale analytics, multi-cloud deployment, and mixed workloads.

🌐 Live Documentation

Visit our documentation at: docs.matrixorigin.cn

🐛 Found an Issue?

We appreciate your feedback! If you find any documentation issues:

• 📝 Create an Issue to let us know
• 🔧 Submit a Pull Request to help fix it directly

🚀 Quick Start

Prerequisites

• Python 3.8+
• Node.js 18+ and pnpm

Get Started

# Install dependencies
make install

# Start development server
make serve

Open http://127.0.0.1:8000 to preview the documentation.

Common Commands

Command	Description
make install	Install all dependencies
make serve	Start local server
make build	Build static site
make lint	Check code style
make lint-fix	Auto-fix style issues
make clean	Clean build artifacts

Run make help to see all available commands.

📝 Development Workflow

# 1. Make changes to documentation files

# 2. Preview your changes locally
make serve

# 3. Before committing, run checks
make lint-fix   # Auto-fix style issues
make check      # Lint + build test

# 4. Commit and push
git add .
git commit -m "Your message"
git push

🤝 Contributing

We welcome contributions! See Contributing Guide for details.

📜 License

Apache License 2.0 - see LICENSE for details.

---

Built with ❤️ by the MatrixOne Team

⭐ Star us on GitHub! ⭐

Website • Documentation • GitHub • Community