docs/getting-started/README.md
This directory contains complete, standalone examples to help you get started with TimescaleDB using real-world use cases. Each example includes sample data and analytical queries to showcase TimescaleDB's capabilities.
Analyze New York City taxi trip data to understand transportation patterns. Great for learning about location-based analytics and high-volume time-series data.
What you'll learn:
time_bucket()Use cases: Transportation analytics, ride-sharing platforms, logistics optimization, urban planning
Work with financial tick and candlestick data for market analysis. Ideal for understanding high-frequency time-series data and multi-timeframe aggregations.
What you'll learn:
Use cases: Trading platforms, market data analysis, portfolio analytics, algorithmic trading
Track and analyze application events using modern UUIDv7 identifiers. Perfect for understanding event-driven analytics and user behavior tracking.
What you'll learn:
to_uuidv7_boundary()Use cases: Application monitoring, user behavior analytics, audit logging, event-driven architectures
Integrate PostgreSQL with AI capabilities for managing and analyzing EV charging station data. This workshop demonstrates how to combine time-series data with vector search and AI features.
What you'll learn:
Use cases: EV infrastructure management, smart grid analytics, energy optimization, predictive maintenance
Work with cryptocurrency tick data and create candlestick charts. Learn advanced time-series analysis techniques for financial markets.
What you'll learn:
Use cases: Cryptocurrency trading, market analysis, financial data visualization, algorithmic trading
Each example is completely standalone and self-contained. You can use any example as your starting point:
Choose an example that matches your use case or interests
Navigate to the example directory and read the README
Follow the step-by-step guide - each example includes:
Run the queries and see TimescaleDB's columnstore performance in action
Adapt to your needs - use these patterns for your own data
New to TimescaleDB? We recommend this path:
All examples demonstrate these TimescaleDB features:
tsdb.hypertabletsdb.enable_columnstore=trueenable_direct_compress_copyAll examples require:
psql recommended)Each example works with the same Docker setup. You have two options:
Option 1: One-line install (Recommended)
curl -sL https://tsdb.co/start-local | sh
This command:
Option 2: Manual Docker command
docker run -d --name timescaledb \
-p 6543:5432 \
-e POSTGRES_PASSWORD=password \
timescale/timescaledb-ha:pg18
Note: We use port 6543 (mapped to container port 5432) to avoid conflicts if you have other PostgreSQL instances running on the standard port 5432.
Choose your example based on your use case:
| Your Use Case | Recommended Example |
|---|---|
| Location-based services, GPS tracking | NYC Taxi |
| Financial trading, market data | Financial Ticks |
| Application logs, user events | Events with UUIDv7 |
| Cryptocurrency, volatile markets | Time-Series Workshop: Financial Data Analysis |
| AI/ML with time-series data | AI Workshop: EV Charging Station Analysis |
| General time-series analytics | Start with NYC Taxi |
psqlAfter trying these examples:
Found an issue or want to improve an example? Contributions are welcome! Please open an issue or pull request on our GitHub repository.
Ready to start? Pick an example above and dive in!