YMatrix 官方文档使用说明

本文档介绍了 YMatrix 官方文档内容逻辑及代码使用说明。

内容说明

此文档是 YMatrix 数据库产品的官方文档,它包含了当前版本中官方支持的所有功能。为令所有关于 YMatrix 的内容成为清晰的体系,此文档按照功能被划分为几个章节:

  • 版本发布历史

此章节包含了 YMatrix 5.X 的迭代版本,并提供了相关发布介绍、错误修复介绍和发布日期。

  • 系统需求

此章节介绍了安装部署 YMatrix 数据库的最低系统环境需求。

  • 关于 YMatrix

此章节是关于 YMatrix 数据库产品方向及技术功能方向的全局介绍。任何对 YMatrix 感兴趣的朋友都不应错过此部分。

  • 快速上手

此章节介绍了 YMatrix 快速单机部署,基本特性体验及常用场景的构建,适用于新手用户或想要快速体验 YMatrix 功能的朋友。

  • 标准集群部署

此章节介绍了 YMatrix 在不同软硬件环境,不同网络环境下集群部署、升级及卸载重装的步骤与注意事项。如果你是企业技术人员,请参照此章节完成生产集群的构建与基本管理。

  • 数据建模

此章节引入了数据模型的定义,以及 YMatrix 集群在时序场景下建模的思路、要点、场景示例及 DDL 最佳实践。个人用户、企业技术人员或数据库爱好者均可以参照此章节完成简单的时序建模及查询,在此基础上针对具体业务场景做延伸。

  • 连接到数据库

此章节介绍了用户如何通过不同客户端或编程语言连接到 YMatrix 数据库。

  • 数据写入

此章节介绍了时序场景下的数据写入特征,以及 YMatrix 如何接入不同数据源,并高速写入数据。

  • 数据迁移

此章节介绍了 YMatrix 中数据迁移的思路与工具,并给出了数据从 Greenplum 5/6 迁移到 YMatrix 5 ,从 YMatrix 4 迁移到 YMatrix 5 等场景示例。

  • 数据查询

此章节介绍了 YMatrix 如何高效查询数据。除基本查询语句外,也提供了高级查询语句及联邦查询。

  • 运维监控

此章节介绍了 YMatrix 如何采用统计、备份、恢复、扩容、迁移、清理等多种方案完成日常运维,还介绍了多种监控及报警设置的方法。任何正式运行 YMatrix 的朋友都需要阅读此章节,以确保数据及系数据库系统的安全。

  • 性能调优

此章节介绍了 YMatrix 中的性能调优思路,涵盖服务器系统资源调优、数据库资源调优及 SQL 调优,还包含对于查询处理机制及查询计划的介绍。有一定的阅读难度,适合有一定数据库知识基础或调优经验的朋友。

  • 故障诊断

此章节介绍了 YMatrix 如何通过日志等工具对集群故障进行分析诊断。

  • 参考指南

此章节为 YMatrix 功能的使用提供基本的原理参考与使用指南,包含镜像分布策略、自动化分区管理、持续聚集、滑动窗口、Grafana/Prometheus 监控指标解读、集群管理工具、存储引擎、执行引擎、数据类型等。

  • SQL 参考

此章节提供了 YMatrix 支持的 SQL 语句的详细参考信息,支持其他章节的使用。

  • 常见问题(FAQ)

此章节分类总结了 YMatrix 在实际应用中遇到的常见问题,建议你通过搜索关键词或 “command / control + F” 定位问题位置。

  • 场景应用

此章节以图文配合的方式详细介绍了 YMatrix 的主要应用场景。

代码使用说明

  • 代码前 “$” 代表此代码需要在服务器中实现
  • 代码前 “~” 代表此代码需要在本机实现
  • 代码前 “#” 代表此代码需要使用 root 用户实现
  • “< >” 中是示意内容,需要据情况将 “< >” 及其中示意内容一同替换为相应具体信息
  • 代码中 “#”、“##”、 “/”、“//” 后内容为代码注释