watson/umami
1
0
Fork 0
mirror of https://github.com/umami-software/umami.git synced 2026-02-16 02:25:35 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Adding Mermaid database diagram to README

Browse source
This commit is contained in:
Eric K Wu 2025-12-03 22:22:06 -08:00
parent 6b50d518ff
commit 536a4657b6
1 changed files with 158 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

158
README.md
View file

@ -106,6 +106,164 @@ docker compose pull
docker compose up --force-recreate -d docker compose up --force-recreate -d
``` ```
---
## Database ERD
```mermaid
erDiagram
WEBSITE_EVENT {
uuid website_id
uuid session_id
uuid visit_id
uuid event_id
string hostname
string browser
string os
string device
string screen
string language
string country
string region
string city
string url_path
string url_query
string utm_source
string utm_medium
string utm_campaign
string utm_content
string utm_term
string referrer_path
string referrer_query
string referrer_domain
string page_title
string gclid
string fbclid
string msclkid
string ttclid
string li_fat_id
string twclid
uint event_type
string event_name
string tag
string distinct_id
datetime created_at
uuid job_id
}
EVENT_DATA {
uuid website_id
uuid session_id
uuid event_id
string url_path
string event_name
string data_key
string string_value
decimal number_value
datetime date_value
uint data_type
datetime created_at
uuid job_id
}
SESSION_DATA {
uuid website_id
uuid session_id
string data_key
string string_value
decimal number_value
datetime date_value
uint data_type
string distinct_id
datetime created_at
uuid job_id
}
WEBSITE_EVENT_STATS_HOURLY {
uuid website_id
uuid session_id
uuid visit_id
string[] hostname
string browser
string os
string device
string screen
string language
string country
string region
string city
string entry_url
string exit_url
string[] url_path
string[] url_query
string[] utm_source
string[] utm_medium
string[] utm_campaign
string[] utm_content
string[] utm_term
string[] referrer_domain
string[] page_title
string[] gclid
string[] fbclid
string[] msclkid
string[] ttclid
string[] li_fat_id
string[] twclid
uint event_type
string[] event_name
uint views
datetime min_time
datetime max_time
string[] tag
string distinct_id
datetime created_at
}
WEBSITE_REVENUE {
uuid website_id
uuid session_id
uuid event_id
string event_name
string currency
decimal revenue
datetime created_at
}
%% RELATIONSHIPS
%% One website_event can have many event_data rows (KV payload for events)
WEBSITE_EVENT ||--o{ EVENT_DATA : "has event data"
%% One session (via website_event) can have many session_data rows (session-level KV)
WEBSITE_EVENT ||--o{ SESSION_DATA : "has session data"
%% Hourly stats are aggregated from raw events
WEBSITE_EVENT ||--o{ WEBSITE_EVENT_STATS_HOURLY : "aggregated into"
%% Revenue is per event
WEBSITE_EVENT ||--o{ WEBSITE_REVENUE : "has revenue"
%% Revenue rows are derived from a subset of event_data rows
EVENT_DATA ||--o{ WEBSITE_REVENUE : "revenue from"
```
--- ---
## 🛟 Support ## 🛟 Support