Quick onboard
Deployment
Data Modeling
Connecting
Migration
Query
Operations and Maintenance
Common Maintenance
Partition
Backup and Restore
Expansion
Mirroring
Resource Management
Security
Monitoring
Performance Tuning
Troubleshooting
Reference Guide
Tool guide
Data type
Storage Engine
Executor
Stream
DR (Disaster Recovery)
Configuration
Index
Extension
SQL Reference
This document provides an overview of how to use MatrixUI in YMatrix, enabling users to quickly navigate and utilize its features.
Starting from cluster deployment, MatrixUI is designed to provide operations engineers with a comprehensive, simple, and user-friendly cluster management tool. In addition to basic functions such as real-time cluster monitoring, data table information queries, and SQL execution, MatrixUI also offers advanced features like cluster inspection, quick Kafka ingestion configuration, and load analysis.

Click the titles in the navigation panel to quickly access detailed content for each feature.
| Feature | Description |
|---|---|
| Quick Installation | Deploy a single-node cluster using a graphical interface for a quick YMatrix experience |
| Standard Deployment | Step-by-step guide for standard cluster deployment via graphical interface, suitable for enterprise production environments |
| Asymmetric Deployment | Graphical interface guidance for asymmetric deployment to meet high-availability requirements under constrained resources |
| Getting Started | Detailed steps from data stream generation, data ingestion, query execution, to result visualization—helping users get started quickly |
| Enable Mirroring | Instructions on enabling mirroring via the graphical interface after database deployment |
| Kafka Integration | Steps to integrate Kafka with YMatrix, including environment preparation and data stream creation |
| Query Monitoring | View and manage active and blocked sessions in the database |
| Load Analysis | Analyze SQL execution frequency, total execution time, and detailed SQL information; supports modifying data collection parameters |
| Data Tables | Display databases, tables, and details such as table size, type, and last access time |
| Cluster Management | View cluster and metric information through three modes: metric view, instance view, and list view |
| Cluster Expansion | Step-by-step instructions for expanding the cluster using the graphical interface |
| Health Monitoring | Enable or disable monitoring items, configure email notifications, and view event history |
| Self-Service Inspection | Supports creating inspection plans and generating inspection reports |