Skip to content

Commit b9fe2c9

Browse files
committed
adjust readme and unit test example
1 parent d5f2f36 commit b9fe2c9

2 files changed

Lines changed: 9 additions & 12 deletions

File tree

README.md

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Redis Connector
22

3-
The **Redis connector** can be used to seamlessly connect to the No-SQL database Redis (http://redis.io/). Redis is an open source (BSD licensed), in-memory data structure store, used as database, cache and message broker.
3+
The **Redis connector** can be used to seamlessly connect to Redis (http://redis.io/). Redis is an open source (BSD licensed), in-memory data structure store, used as database, cache and message broker.
44
It supports data structures such as strings, hashes, lists, sets, sorted sets with range queries, bitmaps, hyperloglogs and geospatial indexes with radius queries.
55
Redis has built-in replication, Lua scripting, LRU eviction, transactions and different levels of on-disk persistence, and provides high availability via Redis Sentinel and automatic partitioning with Redis Cluster.
66

@@ -13,26 +13,24 @@ Redis has built-in replication, Lua scripting, LRU eviction, transactions and di
1313
* The **authkey** (optional)
1414

1515
## Installation
16-
Import the module **Redis connector** in your project (from the Mendix AppStore or by downloading and exporting the module from this project)
16+
*Import the module **Redis connector** in your project (from the Mendix AppStore or by downloading and exporting the module from this project)
17+
* Add Microflow BeforeShutDownRedisConnector to you Before shutdown setting for cleaning up your Redis pool after shutdown app.
18+
1719

1820
# Getting Started
1921
* You can have 2 options for testing with Redis. Local and in the cloud.
2022
* Download Redis (ported for Windows): https://github.com/MSOpenTech/redis/releases
21-
* Start with a free account at redislabs: https://redislabs.com/pricing?service=redis (note: your performance is limited!)
23+
* Start with a free account at redislabs: https://redislabs.com/pricing?service=redis (note: your performance is limited! better try local installation first)
24+
* check the unit tests for example implementations
2225
Once you have imported the RedisConnector module in your mendix application, you will have *Redis connector* available in the Toolbox.
2326

24-
It supports now 3 actions *LPUSH*, *RPUSH* and *LRANGE*
27+
It supports now 8 actions *LPUSH*, *RPUSH*, *LRANGE*, *DEL*, *HSET*, *HMGETALL*, *HMGET*, *HMSET* and more to come!
2528
In order to use any of these in your Mendix application, you can just drag and drop them to your microflow.
2629
Next step would be to provide all the arguments to the selected action and choose the output result name.
2730

28-
### LPUSH
29-
See http://redis.io/commands/lpush
30-
31-
### RPUSH
32-
See http://redis.io/commands/rpush
31+
### COMMANDS
32+
See http://redis.io/commands/
3333

34-
### LRANGE
35-
See http://redis.io/commands/lrange
3634

3735
# Remarks
3836
* Avoid fetching large amounts of data as it can lead to memory issues because all the ResultRow data is being loaded into memory at once.
@@ -47,7 +45,6 @@ See http://redis.io/commands/lrange
4745
Licensed under the Apache license.
4846

4947
# Developers notes
50-
* `git clone https://github.com/appronto/redis-connector.git`
5148
* Open the RedisConnector.mpr in the Mendix Modeler.
5249
* Use *Deploy for Eclipse* option (F6) and you can then import this module as an Eclipse project to the Eclipse IDE.
5350

RedisConnector.mpr

0 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)