From a185a5676243a4310deb7e9d44851a3c6dbd85f0 Mon Sep 17 00:00:00 2001 From: Dmitry Dementev Date: Sun, 8 Feb 2026 19:57:11 +0300 Subject: [PATCH] docs(readme): add DBeaver guide and move DE-task to docs - Why: - simplify first data checks for interview/demo audience - keep task reference in a stable docs location - What: - add short DBeaver connection section with ready-to-use params and quick SQL checks - update DE-task links in README to docs path - move DE-task from data/ to docs/ - Check: - README links resolve to docs/DE-task.md - git shows file move data/DE-task.md -> docs/DE-task.md --- README.md | 28 ++++++++++++++++++++++++++-- {data => docs}/DE-task.md | 0 2 files changed, 26 insertions(+), 2 deletions(-) rename {data => docs}/DE-task.md (100%) diff --git a/README.md b/README.md index cb84c58..99fca16 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ [![Layers](https://img.shields.io/badge/layers-STG%20→%20ODS%20→%20DDS%20→%20DM-green)](./docs/ARCHITECTURE.md) [![License](https://img.shields.io/badge/license-Educational-orange)]() -Мини-демо для решения задания [DE-task.md](./data/DE-task.md): развернуть инфраструктуру на своей машине, прогнать кликстрим через Kafka в ClickHouse, сделать регулярный расчёт в Airflow и подготовить витрины под дашборд. +Мини-демо для решения задания [DE-task.md](./docs/DE-task.md): развернуть инфраструктуру на своей машине, прогнать кликстрим через Kafka в ClickHouse, сделать регулярный расчёт в Airflow и подготовить витрины под дашборд. Фокус проекта: быстро показать работающий end-to-end сценарий и понятным языком объяснить, как устроены слои и почему пайплайн не падает на "грязных" данных. @@ -77,6 +77,30 @@ docker compose exec -T clickhouse clickhouse-client --user=default --password=12 --- +## Подключение DBeaver (кратко) + +После прогона `ddl_init -> kafka_load -> etl_pipeline` можно быстро проверить витрины в DBeaver (удобно для демо бизнесу). + +1. `Database -> New Database Connection -> ClickHouse` +2. Параметры: + - `Host`: `localhost` + - `Port`: `9123` (HTTP) + - `Database`: `default` + - `Username`: `default` + - `Password`: `123456` +3. Нажать `Test Connection` -> `Finish` + +Если ваш драйвер просит native-протокол, используйте порт `8002`. + +Полезные быстрые запросы для первичного анализа: +```sql +SELECT count() AS rows FROM dm.v_events_enriched; +SELECT * FROM dm.v_daily_traffic ORDER BY event_date DESC LIMIT 20; +SELECT * FROM dm.v_utm_effectiveness ORDER BY clicks DESC LIMIT 20; +``` + +--- + ## Архитектура (в двух словах) ```mermaid @@ -231,4 +255,4 @@ flowchart LR ## Документация - [Архитектура и слои](./docs/ARCHITECTURE.md) — подробное описание STG/ODS/DDS/DM, ER-диаграммы, обоснование решений -- [DE-task.md](./data/DE-task.md) — исходное задание +- [DE-task.md](./docs/DE-task.md) — исходное задание diff --git a/data/DE-task.md b/docs/DE-task.md similarity index 100% rename from data/DE-task.md rename to docs/DE-task.md