mz-docs

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Materialize Documentation

Materialize 文档

This skill provides comprehensive documentation for Materialize, a streaming database for real-time analytics.

本技能提供 Materialize（一款用于实时分析的流数据库）的全面文档。

How to Use This Skill

如何使用本技能

When a user asks about Materialize:

For SQL syntax/commands: Read files in the
```
sql/
```
directory
For core concepts: Read files in the
```
fundamentals/concepts/
```
directory
For data ingestion: Read files in the
```
ingest-data/
```
directory
For transformations: Read files in the
```
transform-data/
```
directory

当用户询问 Materialize 相关问题时：

SQL 语法/命令相关：阅读
```
sql/
```
目录下的文件
核心概念相关：阅读
```
fundamentals/concepts/
```
目录下的文件
数据接入相关：阅读
```
ingest-data/
```
目录下的文件
数据转换相关：阅读
```
transform-data/
```
目录下的文件

Documentation Sections

文档章节

Clusters

集群

Guidance for configuring and operating Materialize clusters.

Autoscaling for hydration:
```
clusters/autoscaling/index.md
```
M.1 to cc size mapping:
```
clusters/m1-cc-mapping/index.md
```

Operational guidelines:

clusters/operational-guidelines/index.md

Optimize hydration requirements:

clusters/optimize-hydration-requirements/index.md

Size clusters for hydration:
```
clusters/sizing/index.md
```
System clusters:
```
clusters/system-clusters/index.md
```
Troubleshoot clusters:
```
clusters/troubleshoot-clusters/index.md
```

配置与运维 Materialize 集群的指南。

Hydration 自动扩缩容：
```
clusters/autoscaling/index.md
```
M.1 与 cc 规格映射：
```
clusters/m1-cc-mapping/index.md
```

运维指南：

clusters/operational-guidelines/index.md

优化 Hydration 需求：

clusters/optimize-hydration-requirements/index.md

Hydration 集群规格配置：
```
clusters/sizing/index.md
```
系统集群：
```
clusters/system-clusters/index.md
```
集群故障排查：
```
clusters/troubleshoot-clusters/index.md
```

Developer tools

开发者工具

Tools for developing, deploying, and managing Materialize.

Download and run Materialize Emulator:

developer-tools/install-materialize-emulator/index.md

Manage Materialize:
```
developer-tools/manage/index.md
```
Materialize console:
```
developer-tools/console/index.md
```
MCP Servers and agent skills:
```
developer-tools/mcp-server/index.md
```
mz-debug:
```
developer-tools/mz-debug/index.md
```
Tools and integrations:
```
developer-tools/integrations/index.md
```
Use dbt to manage Materialize:
```
developer-tools/dbt/index.md
```
Use mz-deploy to manage Materialize:
```
developer-tools/mz-deploy/index.md
```
Use Terraform to manage Materialize:
```
developer-tools/terraform/index.md
```

用于开发、部署和管理 Materialize 的工具。

下载并运行 Materialize 模拟器：

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
```

Ingest data

数据接入

Best practices for ingesting data into Materialize from external systems.

Amazon EventBridge:

ingest-data/webhooks/amazon-eventbridge/index.md

AWS PrivateLink connections (Cloud-only):

ingest-data/network-security/privatelink/index.md

Change a webhook source's included headers:

ingest-data/webhooks/change-included-headers/index.md

CockroachDB CDC using Kafka and Changefeeds:
```
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
```
Ingestion performance:
```
ingest-data/performance/index.md
```
Kafka:
```
ingest-data/kafka/index.md
```
MongoDB:
```
ingest-data/mongodb/index.md
```
(and 16 more files in this section)

从外部系统接入数据到 Materialize 的最佳实践。

Amazon EventBridge：

ingest-data/webhooks/amazon-eventbridge/index.md

AWS PrivateLink 连接（仅云服务版）：

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 云服务

Guidance for operating Materialize Cloud.

Customer responsibility model (Cloud):

materialize-cloud/customer-responsibilities/index.md

Disaster recovery (Cloud):

materialize-cloud/disaster-recovery/index.md

Free Trials:
```
materialize-cloud/free-trials/index.md
```
Usage & billing (Cloud):
```
materialize-cloud/billing/index.md
```

运维 Materialize 云服务的指南。

客户责任模型（云服务版）：

materialize-cloud/customer-responsibilities/index.md

灾难恢复（云服务版）：

materialize-cloud/disaster-recovery/index.md

免费试用：
```
materialize-cloud/free-trials/index.md
```
使用与计费（云服务版）：
```
materialize-cloud/billing/index.md
```

Monitoring and alerting

监控与告警

Monitor the performance of your Materialize region with Datadog and Grafana.

Appendix: Metrics:
```
observability/appendix-metrics/index.md
```
Cloud:
```
observability/cloud/index.md
```

Essential metrics:

observability/essential-metrics/index.md

Replica resource usage:

observability/replica-resource-usage/index.md

Self-Managed:
```
observability/self-managed/index.md
```

使用 Datadog 和 Grafana 监控你的 Materialize 区域性能。

附录：指标：
```
observability/appendix-metrics/index.md
```
云服务版：
```
observability/cloud/index.md
```

核心指标：

observability/essential-metrics/index.md

副本资源使用情况：

observability/replica-resource-usage/index.md

自托管版：
```
observability/self-managed/index.md
```

Overview

概览

Learn how to efficiently transform data using Materialize SQL.

Dataflow troubleshooting:

transform-data/dataflow-troubleshooting/index.md

Dictionary compression:

transform-data/dictionary-compression/index.md

FAQ: Indexes:
```
transform-data/faq/index.md
```

Freshness troubleshooting:

transform-data/freshness-troubleshooting/index.md

How to monitor freshness in Materialize:

transform-data/monitor-freshness/index.md

Idiomatic Materialize SQL:

transform-data/idiomatic-materialize-sql/index.md

Optimization:
```
transform-data/optimization/index.md
```
Patterns:
```
transform-data/patterns/index.md
```

Updating materialized views:

transform-data/updating-materialized-views/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:
```
security/appendix/index.md
```
Cloud:
```
security/cloud/index.md
```
Patterns:
```
security/patterns/index.md
```
Self-managed:
```
security/self-managed/index.md
```

附录：
```
security/appendix/index.md
```
云服务版：
```
security/cloud/index.md
```
模式：
```
security/patterns/index.md
```
自托管版：
```
security/self-managed/index.md
```

Self-Managed Deployments

自托管部署

Learn about the key components and architecture of self-managed Materialize deployments.

Appendix:

self-managed-deployments/appendix/index.md

Configure single sign-on:
```
self-managed-deployments/sso/index.md
```

Configuring System Parameters:

self-managed-deployments/configuration-system-parameters/index.md

Deployment guidelines:

self-managed-deployments/deployment-guidelines/index.md

FAQ:
```
self-managed-deployments/faq/index.md
```

Installation:

self-managed-deployments/installation/index.md

Materialize CRD Field Descriptions:

self-managed-deployments/materialize-crd-field-descriptions/index.md

Materialize Operator Configuration:

self-managed-deployments/operator-configuration/index.md

Query History:

self-managed-deployments/query-history/index.md

Self-managed release versions:

self-managed-deployments/release-versions/index.md

(and 3 more files in this section)

了解自托管 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 个文件）

Serve results

结果服务

Serving results from Materialize

SELECT
and
SUBSCRIBE
:

serve-results/query-results/index.md

ADBC (Arrow Database Connectivity):
```
serve-results/adbc/index.md
```
Client libraries:
```
serve-results/client-libraries/index.md
```
Connect to Materialize via HTTP:
```
serve-results/http-api/index.md
```
Connect to Materialize via WebSocket:
```
serve-results/websocket-api/index.md
```

Connection Pooling:

serve-results/connection-pooling/index.md

Durable subscriptions:

serve-results/durable-subscriptions/index.md

**Foreign data wrapper (FDW) **:
```
serve-results/fdw-setup/index.md
```
Isolation levels:
```
serve-results/isolation-level/index.md
```
SQL clients:
```
serve-results/sql-clients/index.md
```
(and 3 more files in this section)

从 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
```
（本章节还有 3 个文件）

Sink results

Sink 结果输出

Sinking results from Materialize to external systems.

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
```

Consume from Snowflake on 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 and Redpanda:
```
export-data/kafka/index.md
```
OpenSearch:
```
export-data/opensearch/index.md
```
(and 5 more files in this section)

将 Materialize 的结果通过 Sink 输出到外部系统。

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 commands

SQL 命令

SQL commands reference.

Namespaces:
```
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
```
(and 111 more files in this section)

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（云服务版）：
```
sql/alter-network-policy/index.md
```
ALTER ROLE：
```
sql/alter-role/index.md
```
（本章节还有 111 个文件）

What is Materialize?

什么是 Materialize？

Learn more about Materialize

Architecture Patterns:

fundamentals/architecture-patterns/index.md

Concepts:
```
fundamentals/concepts/index.md
```

了解更多关于 Materialize 的信息

架构模式：

fundamentals/architecture-patterns/index.md

核心概念：
```
fundamentals/concepts/index.md
```

Quick Reference

快速参考

Common SQL Commands

常用 SQL 命令

Command	Description
`CREATE SOURCE`	Connect to external data sources (Kafka, PostgreSQL, MySQL)
`CREATE MATERIALIZED VIEW`	Create incrementally maintained views
`CREATE INDEX`	Create indexes on views for faster queries
`CREATE SINK`	Export data to external systems
`SELECT`	Query data from sources, views, and tables

命令	描述
`CREATE SOURCE`	连接外部数据源（Kafka、PostgreSQL、MySQL）
`CREATE MATERIALIZED VIEW`	创建增量维护的视图
`CREATE INDEX`	在视图上创建索引以加速查询
`CREATE SINK`	将数据导出到外部系统
`SELECT`	从数据源、视图和表中查询数据

Key Concepts

核心概念

Sources: Connections to external data systems that stream data into Materialize
Materialized Views: Views that are incrementally maintained as source data changes
Indexes: Arrangements of data in memory for fast point lookups
Clusters: Isolated compute resources for running dataflows
Sinks: Connections that export data from Materialize to external systems

Sources（数据源）：连接外部数据系统、将数据流式接入 Materialize 的连接
物化视图：随源数据变化增量维护的视图
索引：内存中的数据排列结构，用于快速点查询
集群：用于运行数据流的隔离计算资源
Sinks（接收器）：将数据从 Materialize 导出到外部系统的连接