Développer sur ClickHouse avec Moose OLAP

Moose OLAP est un module clé de la Moose Stack, une boîte à outils open source destinée aux développeurs pour créer des backends analytiques en temps réel en Typescript et Python. Moose OLAP propose des abstractions adaptées aux développeurs et des fonctionnalités de type ORM, conçues nativement pour ClickHouse.

Principales fonctionnalités de Moose OLAP

Schémas sous forme de code : Définissez vos tables ClickHouse en TypeScript ou en Python avec typage sûr et autocomplétion dans l’IDE
Requêtes avec typage sûr : Écrivez des requêtes SQL avec vérification des types et autocomplétion
Développement local : Développez et testez sur des instances ClickHouse locales sans affecter la production
Gestion des migrations : Versionnez vos modifications de schéma et gérez les migrations dans le code
Streaming en temps réel : Prise en charge intégrée pour associer ClickHouse à Kafka ou Redpanda pour l’ingestion en streaming
API REST : Générez facilement des API REST entièrement documentées à partir de vos tables et vues ClickHouse

Premiers pas en moins de 5 minutes

Pour les guides d’installation et de prise en main les plus récents et les plus complets, consultez la documentation Moose Stack. Ou suivez ce guide pour démarrer avec Moose OLAP sur un déploiement ClickHouse ou ClickHouse Cloud existant en moins de 5 minutes.

Prérequis

Node.js 20+ ou Python 3.12+ - Requis pour le développement en TypeScript ou en Python
Docker Desktop - Pour l’environnement de développement local
macOS/Linux - Windows fonctionne via WSL2

Installer Moose

Installez la CLI Moose à l’échelle du système :

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

Configurer votre projet

Option A : utiliser votre déploiement ClickHouse existant

Important : votre ClickHouse de production restera intact. Cette opération initialise simplement un nouveau projet Moose OLAP avec des modèles de données dérivés de vos tables ClickHouse.

# 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

Votre chaîne de connexion ClickHouse doit respecter ce format :

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

Option B : utiliser ClickHouse Playground

Vous n’avez pas encore de déploiement ClickHouse opérationnel ? Utilisez le ClickHouse Playground pour essayer 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

Installer les dépendances

# TypeScript
cd my-project
npm install

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

Vous devriez voir : Successfully generated X models from ClickHouse tables

Explorer vos modèles générés

La CLI Moose génère automatiquement des interfaces TypeScript ou des modèles Pydantic Python à partir de vos tables ClickHouse existantes.Consultez vos nouveaux modèles de données dans le fichier app/index.ts.

Démarrer le développement

Démarrez votre serveur de développement pour lancer une instance ClickHouse locale avec toutes vos tables de production automatiquement recréées à partir de vos définitions de code :

moose dev

Important : votre ClickHouse de production restera intact. Cette commande crée un environnement de développement local.

Peupler votre base de données locale

Importez vos données dans votre instance ClickHouse locale :

Depuis votre propre ClickHouse

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

Depuis ClickHouse Playground

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

Développer avec Moose OLAP

Maintenant que vos tables sont définies dans le code, vous bénéficiez des mêmes avantages que les modèles de données ORM dans les applications web : sécurité de typage et autocomplétion pour créer des API et des vues matérialisées à partir de vos données analytiques. Pour aller plus loin, vous pouvez par exemple :

Créer une API REST avec Moose API
Ingérer ou transformer des données avec Moose Workflows ou Moose Streaming
Explorer le passage en production avec Moose Build et Moose Migrate

Obtenir de l’aide et rester en contact

Application de référence : Découvrez l’application de référence open source, Area Code : un dépôt de départ avec tous les composants nécessaires pour créer une application complète, prête pour l’entreprise, qui nécessite une infrastructure spécialisée. Deux exemples d’application sont proposés : User Facing Analytics et Operational Data Warehouse.
Communauté Slack : Échangez avec les mainteneurs de Moose Stack sur Slack pour obtenir de l’aide et partager vos retours
Voir les tutoriels : Tutoriels vidéo, démos et présentations approfondies des fonctionnalités de Moose Stack sur YouTube
Contribuer : Consultez le code, contribuez à Moose Stack et signalez des issues sur GitHub

​Principales fonctionnalités de Moose OLAP

​Premiers pas en moins de 5 minutes

​Prérequis

​Installer Moose

​Configurer votre projet

​Option A : utiliser votre déploiement ClickHouse existant

​Option B : utiliser ClickHouse Playground

​Installer les dépendances

​Explorer vos modèles générés

​Démarrer le développement

​Peupler votre base de données locale

​Depuis votre propre ClickHouse

​Depuis ClickHouse Playground

​Développer avec Moose OLAP

​Obtenir de l’aide et rester en contact