# Redis

Kubemq redis target connector allows services using kubemq server to access redis server functions such `set`, `get` and `delete`.

## Prerequisites

The following are required to run the redis target connector:

* kubemq cluster
* redis v5.0.0 (or later)
* kubemq-targets deployment

## Configuration

Redis target connector configuration properties:

| Properties Key | Required | Description             | Example                   |
| -------------- | -------- | ----------------------- | ------------------------- |
| url            | yes      | redis connection string | "redis\://localhost:6379" |

Example:

```yaml
bindings:
  - name: kubemq-query-redis
    source:
      kind: kubemq.query
      name: kubemq-query
      properties:
        address: "kubemq-cluster:50000"
        client_id: "kubemq-query-redis-connector"
        auth_token: ""
        channel: "query.redis"
        group:   ""
        auto_reconnect: "true"
        reconnect_interval_seconds: "1"
        max_reconnects: "0"
    target:
      kind: cache.redis
      name: target-redis
      properties:
        url: "redis://localhost:6379"
```

## Usage

### Get Request

Get request metadata setting:

| Metadata Key | Required | Description      | Possible values |
| ------------ | -------- | ---------------- | --------------- |
| key          | yes      | redis key string | any string      |
| method       | yes      | get              | "get"           |

Example:

```javascript
{
  "metadata": {
    "key": "your-redis-key",
    "method": "get"
  },
  "data": null
}
```

### Set Request

Set request metadata setting:

| Metadata Key | Required | Description      | Possible values |
| ------------ | -------- | ---------------- | --------------- |
| key          | yes      | redis key string | any string      |
| method       | yes      | set              | "set"           |
| etag         | no       | set etag version | "0"             |
| concurrency  | no       | set concurrency  | ""              |
|              |          |                  | "first-write"   |
|              |          |                  | "last-write"    |
|              |          |                  |                 |
| consistency  | no       | set consistency  | ""              |
|              |          |                  | "strong"        |
|              |          |                  | "eventual"      |

Set request data setting:

| Data Key | Required | Description                   | Possible values    |
| -------- | -------- | ----------------------------- | ------------------ |
| data     | yes      | data to set for the redis key | base64 bytes array |

Example:

```javascript
{
  "metadata": {
    "key": "your-redis-key",
    "method": "set",
    "etag": "0",
    "concurrency": "",
    "consistency": ""
  },
  "data": "c29tZS1kYXRh" 
}
```

### Delete Request

Delete request metadata setting:

| Metadata Key | Required | Description      | Possible values |
| ------------ | -------- | ---------------- | --------------- |
| key          | yes      | redis key string | any string      |
| method       | yes      | delete           | "delete"        |

Example:

```javascript
{
  "metadata": {
    "key": "your-redis-key",
    "method": "delete"
  },
  "data": null
}
```