microservices/redis

By microservices

•Updated almost 7 years ago

Image

2.4K

Overview Tags

microservices/redis repository overview

⁠Redis Open Microservice

Wrapper for the Redis key-value store

⁠Introduction

This project is an example implementation of the Open Microservice Specification⁠, a standard originally created at Storyscript⁠ for building highly-portable "microservices" that expose the events, actions, and APIs inside containerized software.

⁠Getting Started

The oms command-line interface allows you to interact with Open Microservices. If you're interested in creating an Open Microservice the CLI also helps validate, test, and debug your oms.yml implementation!

See the oms-cli⁠ project to learn more!

⁠Installation

npm install -g @microservices/oms

⁠Usage

⁠Open Microservices CLI Usage

Once you have the oms-cli⁠ installed, you can run any of the following commands from within this project's root directory:

⁠Actions

⁠set

Sets 'key' to hold 'value'.

⁠Action Arguments

Argument Name	Type	Required	Default	Description
key	`string`	`true`	None	No description provided.
value	`any`	`true`	None	No description provided.
REDIS_HOST	`string`	`false`	None	No description provided.
REDIS_PORT	`int`	`false`	None	No description provided.
REDIS_DB	`string`	`false`	None	No description provided.
REDIS_PASSWORD	`string`	`false`	None	No description provided.

oms run set \ 
    -a key='*****' \ 
    -a value='*****' \ 
    -e REDIS_HOST=$REDIS_HOST \ 
    -e REDIS_PORT=$REDIS_PORT \ 
    -e REDIS_DB=$REDIS_DB \ 
    -e REDIS_PASSWORD=$REDIS_PASSWORD

⁠rpush

Insert 'value' at the end of list stored at 'key'.

⁠Action Arguments

Argument Name	Type	Required	Default	Description
key	`string`	`true`	None	No description provided.
value	`any`	`true`	None	No description provided.
REDIS_HOST	`string`	`false`	None	No description provided.
REDIS_PORT	`int`	`false`	None	No description provided.
REDIS_DB	`string`	`false`	None	No description provided.
REDIS_PASSWORD	`string`	`false`	None	No description provided.

oms run rpush \ 
    -a key='*****' \ 
    -a value='*****' \ 
    -e REDIS_HOST=$REDIS_HOST \ 
    -e REDIS_PORT=$REDIS_PORT \ 
    -e REDIS_DB=$REDIS_DB \ 
    -e REDIS_PASSWORD=$REDIS_PASSWORD

⁠lpush

Insert 'value' at the head of list stored at 'key'.

⁠Action Arguments

Argument Name	Type	Required	Default	Description
key	`string`	`true`	None	No description provided.
value	`any`	`true`	None	No description provided.
REDIS_HOST	`string`	`false`	None	No description provided.
REDIS_PORT	`int`	`false`	None	No description provided.
REDIS_DB	`string`	`false`	None	No description provided.
REDIS_PASSWORD	`string`	`false`	None	No description provided.

oms run lpush \ 
    -a key='*****' \ 
    -a value='*****' \ 
    -e REDIS_HOST=$REDIS_HOST \ 
    -e REDIS_PORT=$REDIS_PORT \ 
    -e REDIS_DB=$REDIS_DB \ 
    -e REDIS_PASSWORD=$REDIS_PASSWORD

⁠lpop

Removes and returns the first element of the list stored at 'key'.

⁠Action Arguments

Argument Name	Type	Required	Default	Description
key	`string`	`true`	None	No description provided.
REDIS_HOST	`string`	`false`	None	No description provided.
REDIS_PORT	`int`	`false`	None	No description provided.
REDIS_DB	`string`	`false`	None	No description provided.
REDIS_PASSWORD	`string`	`false`	None	No description provided.

oms run lpop \ 
    -a key='*****' \ 
    -e REDIS_HOST=$REDIS_HOST \ 
    -e REDIS_PORT=$REDIS_PORT \ 
    -e REDIS_DB=$REDIS_DB \ 
    -e REDIS_PASSWORD=$REDIS_PASSWORD

⁠rpop

Removes and returns the last element of the list stored at 'key'.

⁠Action Arguments

Argument Name	Type	Required	Default	Description
key	`string`	`true`	None	No description provided.
REDIS_HOST	`string`	`false`	None	No description provided.
REDIS_PORT	`int`	`false`	None	No description provided.
REDIS_DB	`string`	`false`	None	No description provided.
REDIS_PASSWORD	`string`	`false`	None	No description provided.

oms run rpop \ 
    -a key='*****' \ 
    -e REDIS_HOST=$REDIS_HOST \ 
    -e REDIS_PORT=$REDIS_PORT \ 
    -e REDIS_DB=$REDIS_DB \ 
    -e REDIS_PASSWORD=$REDIS_PASSWORD

⁠blpop

Removes and returns the first element of the list stored at 'key'. When there are no element in the list, the command will not return until an element got added.

⁠Action Arguments

Argument Name	Type	Required	Default	Description
key	`string`	`true`	None	No description provided.
REDIS_HOST	`string`	`false`	None	No description provided.
REDIS_PORT	`int`	`false`	None	No description provided.
REDIS_DB	`string`	`false`	None	No description provided.
REDIS_PASSWORD	`string`	`false`	None	No description provided.

oms run blpop \ 
    -a key='*****' \ 
    -e REDIS_HOST=$REDIS_HOST \ 
    -e REDIS_PORT=$REDIS_PORT \ 
    -e REDIS_DB=$REDIS_DB \ 
    -e REDIS_PASSWORD=$REDIS_PASSWORD

⁠brpop

Removes and returns the last element of the list stored at 'key'. When there are no element in the list, the command will not return until an elements got added.

⁠Action Arguments

Argument Name	Type	Required	Default	Description
key	`string`	`true`	None	No description provided.
REDIS_HOST	`string`	`false`	None	No description provided.
REDIS_PORT	`int`	`false`	None	No description provided.
REDIS_DB	`string`	`false`	None	No description provided.
REDIS_PASSWORD	`string`	`false`	None	No description provided.

oms run brpop \ 
    -a key='*****' \ 
    -e REDIS_HOST=$REDIS_HOST \ 
    -e REDIS_PORT=$REDIS_PORT \ 
    -e REDIS_DB=$REDIS_DB \ 
    -e REDIS_PASSWORD=$REDIS_PASSWORD

⁠delete

Removes 'key'.

⁠Action Arguments

Argument Name	Type	Required	Default	Description
key	`string`	`true`	None	No description provided.
REDIS_HOST	`string`	`false`	None	No description provided.
REDIS_PORT	`int`	`false`	None	No description provided.
REDIS_DB	`string`	`false`	None	No description provided.
REDIS_PASSWORD	`string`	`false`	None	No description provided.

oms run delete \ 
    -a key='*****' \ 
    -e REDIS_HOST=$REDIS_HOST \ 
    -e REDIS_PORT=$REDIS_PORT \ 
    -e REDIS_DB=$REDIS_DB \ 
    -e REDIS_PASSWORD=$REDIS_PASSWORD

⁠get

Returns the value of 'key'.

⁠Action Arguments

Argument Name	Type	Required	Default	Description
key	`string`	`true`	None	No description provided.
REDIS_HOST	`string`	`false`	None	No description provided.
REDIS_PORT	`int`	`false`	None	No description provided.
REDIS_DB	`string`	`false`	None	No description provided.
REDIS_PASSWORD	`string`	`false`	None	No description provided.

oms run get \ 
    -a key='*****' \ 
    -e REDIS_HOST=$REDIS_HOST \ 
    -e REDIS_PORT=$REDIS_PORT \ 
    -e REDIS_DB=$REDIS_DB \ 
    -e REDIS_PASSWORD=$REDIS_PASSWORD

⁠mget

Returns the values of multiple 'keys'.

⁠Action Arguments

Argument Name	Type	Required	Default	Description
keys	`list`	`false`	None	No description provided.
REDIS_HOST	`string`	`false`	None	No description provided.
REDIS_PORT	`int`	`false`	None	No description provided.
REDIS_DB	`string`	`false`	None	No description provided.
REDIS_PASSWORD	`string`	`false`	None	No description provided.

oms run mget \ 
    -a keys='*****' \ 
    -e REDIS_HOST=$REDIS_HOST \ 
    -e REDIS_PORT=$REDIS_PORT \ 
    -e REDIS_DB=$REDIS_DB \ 
    -e REDIS_PASSWORD=$REDIS_PASSWORD

⁠increment

Increments a number stored at 'key'.

⁠Action Arguments

Argument Name	Type	Required	Default	Description
key	`string`	`true`	None	No description provided.
by	`int`	`false`	None	No description provided.
REDIS_HOST	`string`	`false`	None	No description provided.
REDIS_PORT	`int`	`false`	None	No description provided.
REDIS_DB	`string`	`false`	None	No description provided.
REDIS_PASSWORD	`string`	`false`	None	No description provided.

oms run increment \ 
    -a key='*****' \ 
    -a by='*****' \ 
    -e REDIS_HOST=$REDIS_HOST \ 
    -e REDIS_PORT=$REDIS_PORT \ 
    -e REDIS_DB=$REDIS_DB \ 
    -e REDIS_PASSWORD=$REDIS_PASSWORD

⁠decrement

Decrements a number stored at 'key'.

⁠Action Arguments

Argument Name	Type	Required	Default	Description
key	`string`	`true`	None	No description provided.
by	`int`	`false`	None	No description provided.
REDIS_HOST	`string`	`false`	None	No description provided.
REDIS_PORT	`int`	`false`	None	No description provided.
REDIS_DB	`string`	`false`	None	No description provided.
REDIS_PASSWORD	`string`	`false`	None	No description provided.

oms run decrement \ 
    -a key='*****' \ 
    -a by='*****' \ 
    -e REDIS_HOST=$REDIS_HOST \ 
    -e REDIS_PORT=$REDIS_PORT \ 
    -e REDIS_DB=$REDIS_DB \ 
    -e REDIS_PASSWORD=$REDIS_PASSWORD

⁠append

Appends 'value' to a 'key'.

⁠Action Arguments

Argument Name	Type	Required	Default	Description
key	`string`	`true`	None	No description provided.
value	`any`	`true`	None	No description provided.
REDIS_HOST	`string`	`false`	None	No description provided.
REDIS_PORT	`int`	`false`	None	No description provided.
REDIS_DB	`string`	`false`	None	No description provided.
REDIS_PASSWORD	`string`	`false`	None	No description provided.

oms run append \ 
    -a key='*****' \ 
    -a value='*****' \ 
    -e REDIS_HOST=$REDIS_HOST \ 
    -e REDIS_PORT=$REDIS_PORT \ 
    -e REDIS_DB=$REDIS_DB \ 
    -e REDIS_PASSWORD=$REDIS_PASSWORD

⁠getSet

Returns the current value of 'key' and overwrites it with 'value'.

⁠Action Arguments

Argument Name	Type	Required	Default	Description
key	`string`	`true`	None	No description provided.
value	`any`	`true`	None	No description provided.
REDIS_HOST	`string`	`false`	None	No description provided.
REDIS_PORT	`int`	`false`	None	No description provided.
REDIS_DB	`string`	`false`	None	No description provided.
REDIS_PASSWORD	`string`	`false`	None	No description provided.

oms run getSet \ 
    -a key='*****' \ 
    -a value='*****' \ 
    -e REDIS_HOST=$REDIS_HOST \ 
    -e REDIS_PORT=$REDIS_PORT \ 
    -e REDIS_DB=$REDIS_DB \ 
    -e REDIS_PASSWORD=$REDIS_PASSWORD

⁠setnx

Set a 'key' to 'value' only if the key does not exist yet.

⁠Action Arguments

Argument Name	Type	Required	Default	Description
key	`string`	`true`	None	No description provided.
value	`any`	`true`	None	No description provided.
REDIS_HOST	`string`	`false`	None	No description provided.
REDIS_PORT	`int`	`false`	None	No description provided.
REDIS_DB	`string`	`false`	None	No description provided.
REDIS_PASSWORD	`string`	`false`	None	No description provided.

oms run setnx \ 
    -a key='*****' \ 
    -a value='*****' \ 
    -e REDIS_HOST=$REDIS_HOST \ 
    -e REDIS_PORT=$REDIS_PORT \ 
    -e REDIS_DB=$REDIS_DB \ 
    -e REDIS_PASSWORD=$REDIS_PASSWORD

⁠mset

Sets multiple 'key'/'value' pairs simultaneously.

⁠Action Arguments

Argument Name	Type	Required	Default	Description
pairs	`map`	`false`	None	No description provided.
REDIS_HOST	`string`	`false`	None	No description provided.
REDIS_PORT	`int`	`false`	None	No description provided.
REDIS_DB	`string`	`false`	None	No description provided.
REDIS_PASSWORD	`string`	`false`	None	No description provided.

oms run mset \ 
    -a pairs='*****' \ 
    -e REDIS_HOST=$REDIS_HOST \ 
    -e REDIS_PORT=$REDIS_PORT \ 
    -e REDIS_DB=$REDIS_DB \ 
    -e REDIS_PASSWORD=$REDIS_PASSWORD

⁠msetnx

Sets multiple 'key'/'value' pairs simultaneously. Only non-existing keys will be set.

⁠Action Arguments

Argument Name	Type	Required	Default	Description
pairs	`map`	`false`	None	No description provided.
REDIS_HOST	`string`	`false`	None	No description provided.
REDIS_PORT	`int`	`false`	None	No description provided.
REDIS_DB	`string`	`false`	None	No description provided.
REDIS_PASSWORD	`string`	`false`	None	No description provided.

oms run msetnx \ 
    -a pairs='*****' \ 
    -e REDIS_HOST=$REDIS_HOST \ 
    -e REDIS_PORT=$REDIS_PORT \ 
    -e REDIS_DB=$REDIS_DB \ 
    -e REDIS_PASSWORD=$REDIS_PASSWORD

⁠expire

Set a timeout on a 'key'.

⁠Action Arguments

Argument Name	Type	Required	Default	Description
key	`string`	`true`	None	No description provided.
seconds	`int`	`true`	None	No description provided.
REDIS_HOST	`string`	`false`	None	No description provided.
REDIS_PORT	`int`	`false`	None	No description provided.
REDIS_DB	`string`	`false`	None	No description provided.
REDIS_PASSWORD	`string`	`false`	None	No description provided.

oms run expire \ 
    -a key='*****' \ 
    -a seconds='*****' \ 
    -e REDIS_HOST=$REDIS_HOST \ 
    -e REDIS_PORT=$REDIS_PORT \ 
    -e REDIS_DB=$REDIS_DB \ 
    -e REDIS_PASSWORD=$REDIS_PASSWORD

⁠rpop

RPOP a key constantly, and emit the values as events

⁠Action Arguments

Argument Name	Type	Required	Default	Description
key	`string`	`true`	None	The key to RPOP
REDIS_HOST	`string`	`false`	None	No description provided.
REDIS_PORT	`int`	`false`	None	No description provided.
REDIS_DB	`string`	`false`	None	No description provided.
REDIS_PASSWORD	`string`	`false`	None	No description provided.

oms subscribe rpop \ 
    -a key='*****' \ 
    -e REDIS_HOST=$REDIS_HOST \ 
    -e REDIS_PORT=$REDIS_PORT \ 
    -e REDIS_DB=$REDIS_DB \ 
    -e REDIS_PASSWORD=$REDIS_PASSWORD

,##### lpop

LPOP a key constantly, and emit the values as events

⁠Action Arguments

Argument Name	Type	Required	Default	Description
key	`string`	`true`	None	The key to LPOP
REDIS_HOST	`string`	`false`	None	No description provided.
REDIS_PORT	`int`	`false`	None	No description provided.
REDIS_DB	`string`	`false`	None	No description provided.
REDIS_PASSWORD	`string`	`false`	None	No description provided.

oms subscribe lpop \ 
    -a key='*****' \ 
    -e REDIS_HOST=$REDIS_HOST \ 
    -e REDIS_PORT=$REDIS_PORT \ 
    -e REDIS_DB=$REDIS_DB \ 
    -e REDIS_PASSWORD=$REDIS_PASSWORD

⁠Contributing

All suggestions in how to improve the specification and this guide are very welcome. Feel free share your thoughts in the Issue tracker, or even better, fork the repository to implement your own ideas and submit a pull request.

This project is guided by Contributor Covenant⁠. Please read out full Contribution Guidelines⁠.

⁠Additional Resources

Install the CLI⁠ - The OMS CLI helps developers create, test, validate, and build microservices.
Example OMS Services⁠ - Examples of OMS-compliant services written in a variety of languages.
Example Language Implementations⁠ - Find tooling & language implementations in Node, Python, Scala, Java, Clojure.
Storyscript Hub⁠ - A public registry of OMS services.
Community Chat⁠ - Have ideas? Questions? Join us on Spectrum.

Tag summary

Recent tags

Content type

Image

Digest

Size

42.8 MB

Last updated

almost 7 years ago

docker pull microservices/redis