materialize-docs について
materialize-docsは、Materializeを利用する人向けのドキュメントスキルです。ストリーミングデータベースのSQL、概念、データ取り込み、運用に加え、統合、デプロイ、トラブルシューティングも扱います。
主な機能
- 01MaterializeのSQLコマンドリファレンス
- 02コア概念とアーキテクチャの解説
- 03外部データ取り込みガイド
- 04データ変換と最適化
- 05デプロイ、管理、セキュリティの文書
活用シーン
- 01MaterializeのSQL構文を調べる
- 02外部データの取り込み方法を計画する
- 03データフローや鮮度の問題を調査する
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ materializeinc/ agent-skills --skill materialize-docsインストール後、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 について質問された場合:
- 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 - シンク:
concepts/sinks/index.md - スナップショットの取得:
concepts/snapshotting/index.md - ソース:
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 ソースに含めるヘッダーを変更する:
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 の概要です。
- 管理者(クラウドのみ):
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 シェル:
console/sql-shell/index.md - ユーザープロフィール:
console/user-profile/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/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 - 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/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- シンクの結果:
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 - エージェントスキル:
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 サーバーとエージェントスキル:
integrations/mcp-server/index.md - mz - Materialize CLI:
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 対応