Skip to content

Commit f487b3e

Browse files
committed
update readme
1 parent 4304d5c commit f487b3e

1 file changed

Lines changed: 11 additions & 11 deletions

File tree

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,15 @@ Focus is the usage with spring boot and JPA.
1111
Secondary goal is to support [Poor mans Workflow](https://github.com/sterlp/pmw)
1212

1313
# Key Features ✨
14+
1415
1. **JPA-Powered Persistence** - Automatically persists tasks to your database
1516
1. **Spring Boot Auto-Configuration** - Simple setup with @EnableSpringPersistentTasks
1617
1. **Clustering Support** - Built-in lock management for distributed environments
1718
1. **Type-Safe Tasks** - Generic task definitions with state objects
1819
1. **Retry Mechanisms** - Automatic retry policies for failed executions
1920
1. **Transactional Integration** - Works with Spring's transaction management
2021
1. **Queue Management** - Intelligent task queuing and prioritization
21-
1. **Different DB Supports** --
22+
1. **Different DB Supports** - MySQL, azure-sql-edge, PostgreSQL, and H2
2223

2324
# Documentation
2425

@@ -27,25 +28,25 @@ The README contains a shorter how to use.
2728

2829
# Known issues
2930

30-
- spring-boot-devtools: cause java.lang.ClassCastException exceptions during the state serialization - this is a java/spring issue
31+
- spring-boot-devtools: cause java.lang.ClassCastException exceptions during the state serialization - this is a java/spring issue
3132

3233
# Known limitations
3334

3435
## DBMS have missing bad row lock implementation
3536

3637
The framework briefly locks a row or trigger to ensure that each trigger is started only on a single node when a cluster is in use. However, some databases still do not support proper row locking and instead lock the entire table. This is not a critical issue but can slow down task selection in very large clusters.
3738

38-
- mySQL
39-
- Azure SQL Edge (maybe also MSSQL)
39+
- mySQL
40+
- Azure SQL Edge (maybe also MSSQL)
4041

4142
# DBs for storage
4243

4344
## Tested in the pipeline
4445

45-
- [![H2](https://img.shields.io/badge/H2-Database-green.svg)](https://www.h2database.com)
46-
- [![Azure SQL Edge](https://img.shields.io/badge/Azure_SQL_Edge-2022-0078D4?logo=microsoftsqlserver)](https://azure.microsoft.com/en-us/products/azure-sql/edge/)
47-
- [![PostgreSQL](https://img.shields.io/badge/PostgreSQL-16-336791?logo=postgresql)](https://www.postgresql.org)
48-
- [![MariaDB](https://img.shields.io/badge/MariaDB-11.1-003545?logo=mariadb)](https://mariadb.org)
46+
- [![H2](https://img.shields.io/badge/H2-Database-green.svg)](https://www.h2database.com)
47+
- [![Azure SQL Edge](https://img.shields.io/badge/Azure_SQL_Edge-2022-0078D4?logo=microsoftsqlserver)](https://azure.microsoft.com/en-us/products/azure-sql/edge/)
48+
- [![PostgreSQL](https://img.shields.io/badge/PostgreSQL-16-336791?logo=postgresql)](https://www.postgresql.org)
49+
- [![MariaDB](https://img.shields.io/badge/MariaDB-11.1-003545?logo=mariadb)](https://mariadb.org)
4950

5051
![History](screenshots/supported-dbs.png)
5152

@@ -67,12 +68,11 @@ The framework briefly locks a row or trigger to ensure that each trigger is star
6768

6869
## Setup with Maven
6970

70-
7171
```xml
7272
<dependency>
7373
<groupId>org.sterl.spring</groupId>
7474
<artifactId>spring-persistent-tasks-core</artifactId>
75-
<version>1.x.x</version>
75+
<version>2.x.x</version>
7676
</dependency>
7777
```
7878

@@ -107,7 +107,7 @@ public void triggerTask1(Vehicle vehicle) {
107107

108108
### JUnit Tests
109109

110-
- [Persistent Task and Testing](https://github.com/sterlp/spring-persistent-tasks/wiki/Triggers-and-Tasks-in-JUnit-Tests)
110+
- [Persistent Task and Testing](https://github.com/sterlp/spring-persistent-tasks/wiki/Triggers-and-Tasks-in-JUnit-Tests)
111111

112112
# Setup DB with Liquibase
113113

0 commit comments

Comments
 (0)