Moose OLAP を使った ClickHouse 上での開発

Moose OLAP は Moose Stack の中核モジュールで、TypeScript と Python で real-time な分析バックエンドを構築するためのオープンソースの開発者向けツールキットです。 Moose OLAP は、ClickHouse 向けにネイティブに設計されており、開発者にとって使いやすい抽象化レイヤーと ORM ライクな機能を提供します。

Moose OLAP の主な機能

コードとしてのスキーマ: 型安全性と IDE の自動補完を備えた、TypeScript または Python で ClickHouse テーブルを定義できます
型安全なクエリ: 型チェックと自動補完を利用して SQL クエリを記述できます
ローカル開発: 本番環境に影響を与えることなく、ローカルの ClickHouse インスタンスを使って開発およびテストを行えます
移行管理: スキーマ変更をバージョン管理し、コードを通じて移行を管理できます
リアルタイムストリーミング: ストリーミング取り込み向けに、ClickHouse と Kafka または Redpanda を組み合わせる機能を標準でサポートしています
REST API: ClickHouse のテーブルやビューを基に、完全なドキュメント付きの REST API を簡単に生成できます

5分以内で始める

最新のインストールガイドと Getting Started ガイドについては、Moose Stack ドキュメントを参照してください。または、このガイドに従って、既存の ClickHouse または ClickHouse Cloud デプロイメントで 5 分以内に Moose OLAP を使い始めることもできます。

前提条件

Node.js 20+ または Python 3.12+ - TypeScript または Python での開発に必要です
Docker Desktop - ローカル開発環境で使用します
macOS/Linux - Windows は WSL2 経由で利用できます

Moose をインストールする

Moose CLI をシステム全体で使えるようにグローバルインストールします。

bash -i <(curl -fsSL https://fiveonefour.com/install.sh) moose

プロジェクトをセットアップする

オプション A: 既存の ClickHouse デプロイメントを使う

重要: 本番の ClickHouse には変更は加えられません。既存の ClickHouse テーブルから導出したデータモデルを使って、新しい Moose OLAP プロジェクトを初期化するだけです。

# TypeScript
moose init my-project --from-remote <YOUR_CLICKHOUSE_CONNECTION_STRING> --language typescript

# Python
moose init my-project --from-remote <YOUR_CLICKHOUSE_CONNECTION_STRING> --language python

ClickHouse の接続文字列は次の形式にしてください。

https://username:password@host:port/?database=database_name

オプション B: ClickHouse Playground を使う

まだ ClickHouse を利用できる環境がない場合は、ClickHouse Playground で Moose OLAP を試せます。

# TypeScript
moose init my-project --from-remote https://explorer:@play.clickhouse.com:443/?database=default --language typescript

# Python
moose init my-project --from-remote https://explorer:@play.clickhouse.com:443/?database=default --language python

依存関係をインストールする

# TypeScript
cd my-project
npm install

# Python
cd my-project
python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt

次のメッセージが表示されるはずです: Successfully generated X models from ClickHouse tables

生成されたモデルを確認する

Moose CLI は、既存の ClickHouse テーブルから TypeScript のインターフェイスまたは Python の Pydantic モデルを自動生成します。新しいデータモデルは app/index.ts ファイルで確認できます。

開発を始める

dev サーバーを起動すると、コード定義に基づいて本番テーブルを自動的に再現したローカルの ClickHouse インスタンスが立ち上がります。

moose dev

重要: 本番の ClickHouse には変更は加えられません。作成されるのはローカルの開発環境です。

ローカルデータベースをシードする

ローカルの ClickHouse インスタンスにデータをシードします。

独自の ClickHouse から

moose seed --connection-string <YOUR_CLICKHOUSE_CONNECTION_STRING> --limit 100

ClickHouse Playground から

moose seed --connection-string https://explorer:@play.clickhouse.com:443/?database=default --limit 100

Moose OLAP で構築する

これで Tables をコードで定義できたので、Web アプリの ORM データモデルと同じ利点、つまり分析データ上に API や Materialized Views を構築する際の型安全性や自動補完を活用できます。次のステップとして、以下を試してみてください。

Moose API で REST API を構築する
Moose Workflows または Moose Streaming でデータを取り込んだり変換したりする
Moose Build と Moose Migrate を使って本番環境への移行を進める

サポートを受け、つながりを維持する

リファレンスアプリケーション: オープンソースのリファレンスアプリケーション Area Code をご覧ください。専用のインフラストラクチャを必要とする、高機能でエンタープライズ対応のアプリケーションに必要な構成要素がすべてそろったスターターリポジトリです。サンプルアプリケーションは 2 つあり、User Facing Analytics と Operational Data Warehouse です。
Slack コミュニティ: サポートやフィードバックについては、Slack で Moose Stack のメンテナーにご連絡ください
チュートリアルを見る: Moose Stack の機能に関するビデオチュートリアル、デモ、詳細な解説を YouTube でご覧ください
貢献: コードを確認し、Moose Stack への貢献や Issue の報告を GitHub で行ってください

​Moose OLAP の主な機能

​5分以内で始める

​前提条件

​オプション A: 既存の ClickHouse デプロイメントを使う

​オプション B: ClickHouse Playground を使う

​独自の ClickHouse から

​ClickHouse Playground から

​サポートを受け、つながりを維持する