Skip to content

Commit

Permalink
Revert readme so we can merge it to master
Browse files Browse the repository at this point in the history
  • Loading branch information
lukas-krecan committed Apr 12, 2020
1 parent c6727f0 commit 08a60e7
Showing 1 changed file with 13 additions and 51 deletions.
64 changes: 13 additions & 51 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ executed repeatedly.
- [JdbcTemplate](#jdbctemplate)
- [Mongo](#mongo)
- [DynamoDB](#dynamodb)
- [DynamoDB 2](#dynamodb2)
- [ZooKeeper (using Curator)](#zookeeper-using-curator)
- [Redis (using Spring RedisConnectionFactory)](#redis-using-spring-redisconnectionfactory)
- [Redis (using Jedis)](#redis-using-jedis)
Expand Down Expand Up @@ -59,7 +58,7 @@ First of all, we have to import the project
<dependency>
<groupId>net.javacrumbs.shedlock</groupId>
<artifactId>shedlock-spring</artifactId>
<version>4.8.0</version>
<version>4.7.1</version>
</dependency>
```

Expand Down Expand Up @@ -148,7 +147,7 @@ Add dependency
<dependency>
<groupId>net.javacrumbs.shedlock</groupId>
<artifactId>shedlock-provider-jdbc-template</artifactId>
<version>4.8.0</version>
<version>4.7.1</version>
</dependency>
```

Expand Down Expand Up @@ -195,7 +194,7 @@ Import the project
<dependency>
<groupId>net.javacrumbs.shedlock</groupId>
<artifactId>shedlock-provider-mongo</artifactId>
<version>4.8.0</version>
<version>4.7.1</version>
</dependency>
```

Expand All @@ -215,15 +214,13 @@ public LockProvider lockProvider(MongoClient mongo) {
Please note that MongoDB integration requires Mongo >= 2.4 and mongo-java-driver >= 3.4.0

#### DynamoDB
This depends on AWS SDK v1.

Import the project

```xml
<dependency>
<groupId>net.javacrumbs.shedlock</groupId>
<artifactId>shedlock-provider-dynamodb</artifactId>
<version>4.8.0</version>
<version>4.7.1</version>
</dependency>
```

Expand All @@ -236,37 +233,7 @@ import net.javacrumbs.shedlock.provider.dynamodb.DynamoDBLockProvider;

@Bean
public LockProvider lockProvider(com.amazonaws.services.dynamodbv2.document.DynamoDB dynamoDB) {
return new DynamoDBLockProvider(dynamoDB.getTable("Shedlock"));
}
```

> Please note that the lock table must be created externally.
> `DynamoDBUtils#createLockTable` may be used for creating it programmatically.
> A table definition is available from `DynamoDBLockProvider`'s Javadoc.
#### DynamoDB 2
This depends on AWS SDK v2.

Import the project

```xml
<dependency>
<groupId>net.javacrumbs.shedlock</groupId>
<artifactId>shedlock-provider-dynamodb2</artifactId>
<version>4.8.0</version>
</dependency>
```

Configure:

```java
import net.javacrumbs.shedlock.provider.dynamodb2.DynamoDBLockProvider;

...

@Bean
public LockProvider lockProvider(software.amazon.awssdk.services.dynamodb.DynamoDbClient dynamoDB) {
return new DynamoDBLockProvider(dynamoDB, "Shedlock");
return new DynamoDBLockProvider(dynamoDB.getTable("existingTableName"));
}
```

Expand All @@ -280,7 +247,7 @@ Import
<dependency>
<groupId>net.javacrumbs.shedlock</groupId>
<artifactId>shedlock-provider-zookeeper-curator</artifactId>
<version>4.8.0</version>
<version>4.7.1</version>
</dependency>
```

Expand All @@ -304,7 +271,7 @@ Import
<dependency>
<groupId>net.javacrumbs.shedlock</groupId>
<artifactId>shedlock-provider-redis-spring</artifactId>
<version>4.8.0</version>
<version>4.7.1</version>
</dependency>
```

Expand Down Expand Up @@ -335,7 +302,7 @@ Import
<dependency>
<groupId>net.javacrumbs.shedlock</groupId>
<artifactId>shedlock-provider-redis-jedis</artifactId>
<version>4.8.0</version>
<version>4.7.1</version>
</dependency>
```

Expand All @@ -362,7 +329,7 @@ Import the project
<artifactId>shedlock-provider-hazelcast</artifactId>
<!-- Hazelcast 4 -->
<!-- <artifactId>shedlock-provider-hazelcast4</artifactId> -->
<version>4.8.0/version>
<version>4.7.1/version>
</dependency>
```

Expand All @@ -388,7 +355,7 @@ Import the project
<dependency>
<groupId>net.javacrumbs.shedlock</groupId>
<artifactId>shedlock-provider-couchbase-javaclient</artifactId>
<version>4.8.0/version>
<version>4.7.1/version>
</dependency>
```

Expand All @@ -412,7 +379,7 @@ I am really not sure that it's a good idea to use Elasticsearch as a lock provid
<dependency>
<groupId>net.javacrumbs.shedlock</groupId>
<artifactId>shedlock-provider-elasticsearch</artifactId>
<version>4.8.0</version>
<version>4.7.1</version>
</dependency>
```

Expand Down Expand Up @@ -440,7 +407,7 @@ Import the project
<dependency>
<groupId>net.javacrumbs.shedlock</groupId>
<artifactId>shedlock-provider-cassandra</artifactId>
<version>4.8.0/version>
<version>4.7.1/version>
</dependency>
```

Expand Down Expand Up @@ -479,7 +446,7 @@ Import the project:
<dependency>
<groupId>net.javacrumbs.shedlock</groupId>
<artifactId>shedlock-micronaut</artifactId>
<version>4.8.0</version>
<version>4.7.1</version>
</dependency>
```

Expand Down Expand Up @@ -601,11 +568,6 @@ after each other, `lockAtLeastFor` can prevent it.
* slf4j-api

# Release notes
## 4.8.0
* DynamoDB 2 module introduced (thanks Mark Egan)
* JDBC template code refactored to not log error on failed insert in Postgres
* INSERT .. ON CONFLICT UPDATE is used for Postgres

## 4.7.1
* Make LockAssert.TestHelper public

Expand Down

0 comments on commit 08a60e7

Please sign in to comment.