关于 mz-docs
mz-docs 是面向 Materialize 用户的文档技能，提供流式数据库和 SQL 相关指导。内容涵盖数据接入、转换、运维、部署及结果提供。
主要功能
- 01Materialize SQL 命令参考
- 02数据接入与导出指南
- 03集群和部署文档
- 04监控与故障排查主题
适用场景
- 01查找 Materialize SQL 命令语法
- 02规划数据接入或导出
- 03配置或排查集群
- 04查阅部署和监控指导
MCP 相关
文档索引包含 Materialize MCP 服务和 Agent 技能章节，但未说明 MCP 能力或行为。
安装
复制下面的命令，在终端中运行。
$
npx skills add https:/安装后在 Claude Code 中输入/mz-docs确认已加载。
包含的文件
除 SKILL.md 外，安装时一起下载的参考资料和脚本。
clusters/index.mdclusters/autoscaling/index.mdclusters/m1-cc-mapping/index.mdclusters/operational-guidelines/index.mdclusters/operational-guidelines/appendix-alternative-cluster-architectures/index.mdclusters/optimize-hydration-requirements/index.mdclusters/sizing/index.mdclusters/system-clusters/index.mdclusters/troubleshoot-clusters/index.mdclusters/troubleshoot-clusters/cpu-troubleshooting/index.mdclusters/troubleshoot-clusters/hydration-failures/index.mdclusters/troubleshoot-clusters/memory-spike/index.mddeveloper-tools/index.mddeveloper-tools/console/index.mddeveloper-tools/console/admin/index.mddeveloper-tools/console/clusters/index.mddeveloper-tools/console/connect/index.mddeveloper-tools/console/create-new/index.mddeveloper-tools/console/data/index.mddeveloper-tools/console/integrations/index.mddeveloper-tools/console/monitoring/index.mddeveloper-tools/console/sql-shell/index.mddeveloper-tools/console/user-profile/index.mddeveloper-tools/dbt/index.mddeveloper-tools/dbt/blue-green-deployments/index.mddeveloper-tools/dbt/development-workflows/index.mddeveloper-tools/dbt/get-started/index.mddeveloper-tools/dbt/slim-deployments/index.mddeveloper-tools/install-materialize-emulator/index.mddeveloper-tools/integrations/index.md详细介绍
Materialize 文档
此技能提供 Materialize 的全面文档。Materialize 是一个用于实时分析的流式数据库。
如何使用此技能
当用户询问 Materialize 相关问题时：
- 关于 SQL 语法/命令：阅读
sql/目录中的文件 - 关于核心概念：阅读
fundamentals/concepts/目录中的文件 - 关于数据摄取：阅读
ingest-data/目录中的文件 - 关于数据转换：阅读
transform-data/目录中的文件
文档章节
集群
配置和运行 Materialize 集群的指南。
- 用于数据水合的自动扩缩容：
clusters/autoscaling/index.md - M.1 到 cc 规格的映射：
clusters/m1-cc-mapping/index.md - 运维指南：
clusters/operational-guidelines/index.md - 优化数据水合需求：
clusters/optimize-hydration-requirements/index.md - 为数据水合选择集群规格：
clusters/sizing/index.md - 系统集群：
clusters/system-clusters/index.md - 排查集群问题：
clusters/troubleshoot-clusters/index.md
开发者工具
用于开发、部署和管理 Materialize 的工具。
- 下载并运行 Materialize Emulator：
developer-tools/install-materialize-emulator/index.md - 管理 Materialize：
developer-tools/manage/index.md - Materialize 控制台：
developer-tools/console/index.md - MCP 服务和 Agent 技能：
developer-tools/mcp-server/index.md - mz-debug：
developer-tools/mz-debug/index.md - 工具和集成：
developer-tools/integrations/index.md - 使用 dbt 管理 Materialize：
developer-tools/dbt/index.md - 使用 mz-deploy 管理 Materialize：
developer-tools/mz-deploy/index.md - 使用 Terraform 管理 Materialize：
developer-tools/terraform/index.md
数据摄取
从外部系统向 Materialize 摄取数据的最佳实践。
- Amazon EventBridge：
ingest-data/webhooks/amazon-eventbridge/index.md - AWS PrivateLink 连接（仅限 Cloud）：
ingest-data/network-security/privatelink/index.md - 更改 webhook 源中包含的标头：
ingest-data/webhooks/change-included-headers/index.md - 使用 Kafka 和 Changefeeds 实现 CockroachDB CDC：
ingest-data/cdc-cockroachdb/index.md - Debezium：
ingest-data/debezium/index.md - Fivetran：
ingest-data/fivetran/index.md - HubSpot：
ingest-data/webhooks/hubspot/index.md - 摄取性能：
ingest-data/performance/index.md - Kafka：
ingest-data/kafka/index.md - MongoDB：
ingest-data/mongodb/index.md - (本章节还有 16 个文件)
Materialize Cloud
运行 Materialize Cloud 的指南。
- 客户责任模型（Cloud）：
materialize-cloud/customer-responsibilities/index.md - 灾难恢复（Cloud）：
materialize-cloud/disaster-recovery/index.md - 免费试用：
materialize-cloud/free-trials/index.md - 使用量和账单（Cloud）：
materialize-cloud/billing/index.md
监控和告警
使用 Datadog 和 Grafana 监控 Materialize 区域的性能。
- 附录：指标：
observability/appendix-metrics/index.md - Cloud：
observability/cloud/index.md - 关键指标：
observability/essential-metrics/index.md - 副本资源使用情况：
observability/replica-resource-usage/index.md - 自管理：
observability/self-managed/index.md
概览
了解如何使用 Materialize SQL 高效地转换数据。
- 数据流故障排查：
transform-data/dataflow-troubleshooting/index.md - 字典压缩：
transform-data/dictionary-compression/index.md - 常见问题：索引：
transform-data/faq/index.md - 数据新鲜度故障排查：
transform-data/freshness-troubleshooting/index.md - 如何在 Materialize 中监控数据新鲜度：
transform-data/monitor-freshness/index.md - 符合惯用写法的 Materialize SQL：
transform-data/idiomatic-materialize-sql/index.md - 优化：
transform-data/optimization/index.md - 模式：
transform-data/patterns/index.md - 更新物化视图：
transform-data/updating-materialized-views/index.md
安全
- 附录：
security/appendix/index.md - 云：
security/cloud/index.md - 模式：
security/patterns/index.md - 自托管：
security/self-managed/index.md
自托管部署
了解自托管 Materialize 部署的关键组件和架构。
- 附录：
self-managed-deployments/appendix/index.md - 配置单点登录：
self-managed-deployments/sso/index.md - 配置系统参数：
self-managed-deployments/configuration-system-parameters/index.md - 部署指南：
self-managed-deployments/deployment-guidelines/index.md - 常见问题：
self-managed-deployments/faq/index.md - 安装：
self-managed-deployments/installation/index.md - Materialize CRD 字段说明：
self-managed-deployments/materialize-crd-field-descriptions/index.md - Materialize Operator 配置：
self-managed-deployments/operator-configuration/index.md - 查询历史记录：
self-managed-deployments/query-history/index.md - 自托管版本发布：
self-managed-deployments/release-versions/index.md - （本节还有 3 个文件）
提供结果
从 Materialize 提供结果
SELECT和SUBSCRIBE：serve-results/query-results/index.md- ADBC（Arrow 数据库连接）：
serve-results/adbc/index.md - 客户端库：
serve-results/client-libraries/index.md - 通过 HTTP 连接到 Materialize：
serve-results/http-api/index.md - 通过 WebSocket 连接到 Materialize：
serve-results/websocket-api/index.md - 连接池：
serve-results/connection-pooling/index.md - 持久订阅：
serve-results/durable-subscriptions/index.md - **外部数据包装器（FDW） **：
serve-results/fdw-setup/index.md - 隔离级别：
serve-results/isolation-level/index.md - SQL 客户端：
serve-results/sql-clients/index.md - （本节还有 4 个文件）
写入结果
将结果从 Materialize 写入外部系统。
- Amazon S3：
export-data/s3/index.md - Apache Iceberg：
export-data/iceberg/index.md - AWS S3 Tables：
export-data/iceberg-aws/index.md - Census：
export-data/census/index.md - 从 Snowflake 使用 AWS S3 Tables：
export-data/iceberg-aws-snowflake/index.md - Databricks Unity Catalog：
export-data/iceberg-databricks/index.md - Elasticsearch：
export-data/elasticsearch/index.md - GCP BigLake：
export-data/iceberg-gcp/index.md - Kafka 和 Redpanda：
export-data/kafka/index.md - OpenSearch：
export-data/opensearch/index.md - （本节还有 5 个文件）
SQL 命令
SQL 命令参考。
- 命名空间：
sql/namespaces/index.md - ALTER CLUSTER：
sql/alter-cluster/index.md - ALTER CLUSTER REPLICA：
sql/alter-cluster-replica/index.md - ALTER CONNECTION：
sql/alter-connection/index.md - ALTER DATABASE：
sql/alter-database/index.md - ALTER DEFAULT PRIVILEGES：
sql/alter-default-privileges/index.md - ALTER INDEX：
sql/alter-index/index.md - ALTER MATERIALIZED VIEW：
sql/alter-materialized-view/index.md - ALTER NETWORK POLICY (Cloud)：
sql/alter-network-policy/index.md - ALTER ROLE：
sql/alter-role/index.md - (本节还有 111 个文件)
什么是 Materialize？
进一步了解 Materialize
- 架构模式：
fundamentals/architecture-patterns/index.md - 概念：
fundamentals/concepts/index.md
快速参考
常用 SQL 命令
| 命令 | 描述 |
|---|---|
CREATE SOURCE | 连接到外部数据源（Kafka、PostgreSQL、MySQL） |
CREATE MATERIALIZED VIEW | 创建增量维护的视图 |
CREATE INDEX | 在视图上创建索引，以加快查询 |
CREATE SINK | 将数据导出到外部系统 |
SELECT | 查询来源、视图和表中的数据 |
核心概念
- 来源：连接到外部数据系统，将数据流式传输到 Materialize
- 物化视图：随着来源数据变化而增量维护的视图
- 索引：在内存中组织数据，以便快速进行点查找
- 集群：用于运行数据流的隔离计算资源
- 接收器：将数据从 Materialize 导出到外部系统的连接
评论
支持 Markdown