关于 materialize-docs
materialize-docs 是面向 Materialize 用户的文档技能，涵盖流式数据库的 SQL、概念、数据接入和运维。按主题组织的参考内容也涉及集成、部署与故障排查。
主要功能
- 01Materialize SQL 命令参考
- 02核心概念与架构说明
- 03外部数据接入指南
- 04数据转换与性能优化
- 05部署、管理和安全文档
适用场景
- 01查找 Materialize SQL 语法
- 02规划外部数据接入方式
- 03排查数据流或新鲜度问题
安装
复制下面的命令，在终端中运行。
$
npx skills add https:/安装后在 Claude Code 中输入/materialize-docs确认已加载。
包含的文件
除 SKILL.md 外，安装时一起下载的参考资料和脚本。
administration/index.mdadministration/billing/index.mdadministration/usage/index.mdarchitecture-patterns/index.mdarchitecture-patterns/live-context-graph/index.mdarchitecture-patterns/ontology/index.mdconcepts/index.mdconcepts/clusters/index.mdconcepts/hydration/index.mdconcepts/indexes/index.mdconcepts/namespaces/index.mdconcepts/reaction-time/index.mdconcepts/sinks/index.mdconcepts/snapshotting/index.mdconcepts/sources/index.mdconcepts/views/index.mdconsole/index.mdconsole/admin/index.mdconsole/clusters/index.mdconsole/connect/index.mdconsole/create-new/index.mdconsole/data/index.mdconsole/integrations/index.mdconsole/monitoring/index.mdconsole/sql-shell/index.mdconsole/user-profile/index.mdcustomer-responsibilities/index.mdfaqs/index.mdget-started/index.mdget-started/arrangements/index.md详细介绍
Materialize 文档
此技能提供 Materialize 的全面文档。Materialize 是一个用于实时分析的流式数据库。
如何使用此技能
用户询问 Materialize 相关问题时：
- 有关 SQL 语法/命令：阅读
sql/目录中的文件 - 有关核心概念：阅读
concepts/目录中的文件 - 有关数据摄取：阅读
ingest-data/目录中的文件 - 有关数据转换：阅读
transform-data/目录中的文件
文档章节
管理
- 用法（自托管）：
administration/usage/index.md - 用量与账单（云端）：
administration/billing/index.md
架构模式
使用 Materialize 构建时可采用的模式。
- 实时上下文图谱：
architecture-patterns/live-context-graph/index.md - 使用本体表：
architecture-patterns/ontology/index.md
概念
了解 Materialize 的核心概念。
- 命名空间：
concepts/namespaces/index.md - 集群：
concepts/clusters/index.md - 水合：
concepts/hydration/index.md - 索引：
concepts/indexes/index.md - 反应时间、新鲜度和查询延迟：
concepts/reaction-time/index.md - Sink：
concepts/sinks/index.md - 快照：
concepts/snapshotting/index.md - Source：
concepts/sources/index.md - 视图：
concepts/views/index.md
数据摄取
从外部系统向 Materialize 摄取数据的最佳实践。
- Amazon EventBridge：
ingest-data/webhooks/amazon-eventbridge/index.md - AWS PrivateLink 连接（仅限云端）：
ingest-data/network-security/privatelink/index.md - 更改 Webhook Source 包含的标头：
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 - Kafka：
ingest-data/kafka/index.md - MongoDB：
ingest-data/mongodb/index.md - 监控数据摄取：
ingest-data/monitoring-data-ingestion/index.md - (本章节中还有 14 个文件)
管理 Materialize
- 附录：替代集群架构：
manage/appendix-alternative-cluster-architectures/index.md - 灾难恢复（云端）：
manage/disaster-recovery/index.md - 监控与告警：
manage/monitor/index.md - 运维指南：
manage/operational-guidelines/index.md - 使用 dbt 管理 Materialize：
manage/dbt/index.md - 使用 mz-deploy 管理 Materialize：
manage/mz-deploy/index.md - 使用 Terraform 管理 Materialize：
manage/terraform/index.md
Materialize 控制台
Materialize 控制台简介：Materialize 的用户界面
- 管理（仅限云端）：
console/admin/index.md - 集群：
console/clusters/index.md - 连接（仅限云端）：
console/connect/index.md - 新建：
console/create-new/index.md - 数据库对象浏览器：
console/data/index.md - 集成：
console/integrations/index.md - 监控：
console/monitoring/index.md - SQL Shell：
console/sql-shell/index.md - 用户资料：
console/user-profile/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/troubleshooting/index.md - 更新物化视图：
transform-data/updating-materialized-views/index.md
参考
- Explain 计划运算符：
reference/explain-plan-operators/index.md - 摄取性能：
reference/performance/index.md - 隔离级别：
reference/isolation-level/index.md - M.1 到 cc 大小映射：
reference/m1-cc-mapping/index.md - 系统目录：
reference/system-catalog/index.md - 系统集群：
reference/system-clusters/index.md
安全
- 附录：
security/appendix/index.md - 云：
security/cloud/index.md - 自管理：
security/self-managed/index.md
自管理部署
了解自管理 Materialize 部署的关键组件和架构。
- 附录：
self-managed-deployments/appendix/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/release-versions/index.md - 故障排查：
self-managed-deployments/troubleshooting/index.md - 升级：
self-managed-deployments/upgrading/index.md
提供结果
从 Materialize 提供结果
SELECT和SUBSCRIBE：serve-results/query-results/index.md- Sink 结果：
serve-results/sink/index.md - 使用 BI/数据协作工具：
serve-results/bi-tools/index.md - 使用外部数据包装器 (FDW)：
serve-results/fdw/index.md
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 - (本节还有 109 个文件)
工具和集成
了解 Materialize 支持的第三方工具和集成
- ADBC（Arrow Database Connectivity）：
integrations/adbc/index.md - Agent Skills：
integrations/coding-agent-skills/index.md - 客户端库：
integrations/client-libraries/index.md - 通过 HTTP 连接到 Materialize：
integrations/http-api/index.md - 通过 WebSocket 连接到 Materialize：
integrations/websocket-api/index.md - 连接池：
integrations/connection-pooling/index.md - 外部数据包装器（FDW）：
integrations/fdw/index.md - MCP 服务和 Agent Skills：
integrations/mcp-server/index.md - mz - Materialize 命令行工具：
integrations/cli/index.md - mz-debug：
integrations/mz-debug/index.md - （此部分还有 1 个文件）
快速参考
常用 SQL 命令
| 命令 | 描述 |
|---|---|
CREATE SOURCE | 连接到外部数据源（Kafka、PostgreSQL、MySQL） |
CREATE MATERIALIZED VIEW | 创建增量维护的视图 |
CREATE INDEX | 在视图上创建索引，以加快查询速度 |
CREATE SINK | 将数据导出到外部系统 |
SELECT | 查询源、视图和表中的数据 |
核心概念
- 数据源：连接到外部数据系统，将数据流式传入 Materialize
- 物化视图：随着源数据变化而增量维护的视图
- 索引：内存中用于快速点查的数据排列结构
- 集群：用于运行数据流的隔离计算资源
- 数据接收器：将数据从 Materialize 导出到外部系统的连接
评论
支持 Markdown