mz-docs について
mz-docs は、Materialize の利用者向けにストリーミングデータベースと SQL の情報を提供するドキュメントスキルです。データ取り込み、変換、運用、デプロイ、結果の提供を扱います。
主な機能
- 01Materialize SQLコマンドリファレンス
- 02データ取り込みとエクスポートの案内
- 03クラスターとデプロイのドキュメント
- 04監視とトラブルシューティング
活用シーン
- 01Materialize SQLコマンドの構文確認
- 02データ取り込みやエクスポートの計画
- 03クラスターの設定や問題調査
- 04デプロイと監視の情報確認
MCP 対応
ドキュメントの索引には Materialize MCP サーバーとエージェントスキルの項目がありますが、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 について質問された場合：
- 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 サーバーとエージェントスキル：
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 - FAQ：インデックス：
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 - FAQ：
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 Database Connectivity）：
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 - AWS S3 Tables 上の Snowflake からの利用：
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 対応