# 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)
* access to gcp redis server
* 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.kubemq.query
      name: kubemq-query
      properties:
        host: "localhost"
        port: "50000"
        client_id: "kubemq-query-redis-connector"
        auth_token: ""
        channel: "query.redis"
        group:   ""
        concurrency: "1"
        auto_reconnect: "true"
        reconnect_interval_seconds: "1"
        max_reconnects: "0"
    target:
      kind: gcp.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
}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.kubemq.io/configuration/connectors/kubemq-targets/gcp/redis.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.