Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zigad/quarkus-timescale-example
Example application that will post random values into TimescaleDB
https://github.com/zigad/quarkus-timescale-example
docker-compose java quarkus quarkus-example quarkus-hibernate-orm quarkus-maven quarkus-resteasy quarkusio timescale timescaledb timeseries
Last synced: 2 months ago
JSON representation
Example application that will post random values into TimescaleDB
- Host: GitHub
- URL: https://github.com/zigad/quarkus-timescale-example
- Owner: zigad
- Created: 2024-06-13T19:37:06.000Z (6 months ago)
- Default Branch: develop
- Last Pushed: 2024-09-16T13:15:27.000Z (3 months ago)
- Last Synced: 2024-09-30T05:22:17.694Z (3 months ago)
- Topics: docker-compose, java, quarkus, quarkus-example, quarkus-hibernate-orm, quarkus-maven, quarkus-resteasy, quarkusio, timescale, timescaledb, timeseries
- Language: Java
- Homepage:
- Size: 43 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Quarkus TimescaleDB Example
This project demonstrates a simple Quarkus application that writes random values into TimescaleDB. This is
more of a playground for my personal use but feel free to optimise or use to code used here, The application will automatically drop all the tables at startup and recreate random values and populate them into DB so you will already have some example data. We can use REST GET call to get values, we can use POST request call to create a sensor in database and another POST call to populate DB with more random data. This project was done based on Java Quick Start Guide from official [Timescale Code Quick Start - Java](https://docs.timescale.com/quick-start/latest/java/) but instead of using pure Java I used Quarkus.
## Table of Contents
- [Features](#features)
- [Prerequisites](#prerequisites)
- [Getting Started](#getting-started)
- [Clone the Repository](#clone-the-repository)
- [Configure Database](#configure-database)
- [Run the Application](#run-the-application)
- [Endpoints](#endpoints)
- [Project Structure](#project-structure)
- [Technologies Used](#technologies-used)
## Features
- RESTful API for managing sensor data
- TimescaleDB hypertable for efficient time-series data handling
- Automatic database schema creation and data initialization
- Demonstrates use of Quarkus with a PostgreSQL-based TimescaleDB
## Prerequisites
- Java 17 or higher
- Maven 3.6.3 or higher
- Docker (for running TimescaleDB)
- Quarkus CLI (optional, for easier project management)
## Getting Started
### Clone the Repository
```bash
git clone https://github.com/zigad/Quarkus-Timescale-Example.git
cd Quarkus-Timescale-Example
```
### Configure Database
1. **Start TimescaleDB**:
You can use Docker to quickly start a TimescaleDB instance:
```bash
docker run -d --name timescaledb -p 5432:5432 -e POSTGRES_PASSWORD=p433w0rd timescale/timescaledb:latest-pg14
```
Alternatively, you can use the provided [docker-compose.yaml](docker-compose.yaml) file to start a TimescaleDB
instance provided in the
root folder.
To start the TimescaleDB instance using Docker Compose, run:
```bash
docker-compose up -d
```
2. **Update Database Configuration**:
Modify [application.properties](src%2Fmain%2Fresources%2Fapplication.properties) to match your TimescaleDB
configuration.
### Run the Application
Use Maven to build and run the application:
```bash
./mvnw compile quarkus:dev
```
Make sure that TimescaleDB is running in docker.
Quarkus will start in development mode, enabling hot reload for faster development.
## Endpoints
The application exposes the following RESTful endpoints:
- **Get All Sensors**:
- **GET** `/sensorEntities`
- Response: `[{ "id": 1, "type": "Temperature", "location": "Living Room", "sensorDataList": [...] }]`
- **Add a Sensor**:
- **POST** `/sensorEntities`
- Request Body: `{ "type": "Temperature", "location": "Living Room" }`
- **Add Sensor Data**:
- **POST** `/generateData/{count}`
- Replace `{count}` with the number of random data points to generate.
## Project Structure
```
src
├── main
│ ├── docker
│ ├── java
│ │ └── si
│ │ └── deisinger
│ │ ├── dto
│ │ │ └── SensorDTO.java
│ │ ├── entity
│ │ │ ├── Sensor.java
│ │ │ └── SensorData.java
│ │ ├── repository
│ │ │ ├── SensorDataRepository.java
│ │ │ └── SensorRepository.java
│ │ └── service
│ │ ├── SensorDataService.java
│ │ ├── SensorService.java
│ │ └── TimescaleResource.java
│ └── resources
│ ├── application.properties
│ └── import.sql
└── target
```
- **src/main/java/si/deisinger/dto**: Data Transfer Objects
- **src/main/java/si/deisinger/entity**: JPA entities for Sensor and SensorData
- **src/main/java/si/deisinger/repository**: Repositories for accessing the database
- **src/main/java/si/deisinger/service**: Service layer for business logic
- **src/main/resources**: Configuration files
- **application.properties**: Quarkus application configuration
- **import.sql**: SQL script for initializing database schema and data
## Technologies Used
- **Quarkus**: Supersonic Subatomic Java framework
- **TimescaleDB**: Time-series database based on PostgreSQL
- **Hibernate ORM**: Object-relational mapping framework
- **RESTEasy Reactive**: Reactive extensions for JAX-RS