# Redis

This article outlines the integration with the Redis connector, enabling streamlined metadata management through features such as crawling, querying, and data preview. It also ensures secure authentication via Credential Manager.

<figure><img src="/files/hmrWB3s0RJMAIVr83FlO" alt=""><figcaption></figcaption></figure>

## Overview

### Connector Details

| Connector Category                                                        | NoSQL                                  |
| ------------------------------------------------------------------------- | -------------------------------------- |
| OvalEdge Release Supported                                                | Release8.1                             |
| <p>Connectivity</p><p>\[How the connection is established with Redis]</p> | Redis Protocol over TCP (TLS Optional) |

### Connector Features

| Feature                                      | Availability |
| -------------------------------------------- | :----------: |
| Crawling                                     |       ✅      |
| Delta Crawling                               |       ❌      |
| Profiling                                    |       ❌      |
| Query Sheet                                  |       ✅      |
| Data Preview                                 |       ✅      |
| Auto Lineage                                 |       ❌      |
| Manual Lineage                               |       ❌      |
| Secure Authentication via Credential Manager |       ✅      |
| Data Quality                                 |       ❌      |
| DAM (Data Access Management)                 |       ❌      |
| Bridge                                       |       ✅      |

### Metadata Mapping

The following objects are crawled from Redis and mapped to the corresponding UI assets.

<table><thead><tr><th width="163.20001220703125">Redis Object</th><th width="169.60003662109375">Redis Attribute</th><th width="183.39990234375">OvalEdge Attribute</th><th width="174.7999267578125">OvalEdge Category</th><th width="147.39990234375">OvalEdge Type</th></tr></thead><tbody><tr><td>All Keys</td><td>Key name </td><td>Key identifier</td><td>Table / entity</td><td>Entity </td></tr><tr><td>String Keys</td><td>Key name </td><td>Key identifier</td><td>Table / entity</td><td>Entity </td></tr><tr><td>Hash Keys</td><td>Key name </td><td>Key identifier</td><td>Table / entity</td><td>Entity </td></tr><tr><td>List Keys </td><td>Key name </td><td>Key identifier</td><td>Table / entity</td><td>Entity </td></tr><tr><td>Set Keys</td><td>Key name </td><td>Key identifier</td><td>Table / entity</td><td>Entity </td></tr><tr><td>Sorted Set Keys</td><td>Key name </td><td>Key identifier</td><td>Table / entity</td><td>Entity </td></tr><tr><td>JSON Keys</td><td>Key name </td><td>Key identifier</td><td>Table / entity</td><td>Entity </td></tr><tr><td>Key Fields</td><td>Key attributes (Key name, Type, TTL &#x26; Value preview) </td><td>Column list for key preview </td><td>Column </td><td>Column</td></tr></tbody></table>

## Set up a Connection

### Prerequisites

The following are the prerequisites to establish a connection:

#### **Whitelisting Ports**

Ensure outbound connectivity from the OvalEdge application environment is allowed to the Redis server over the required TCP port:

• Default without TLS: \`6379\`

• Common with TLS: \`6380\`

The exact port depends on how your Redis endpoint is configured.

#### **Service Account User Permissions**

{% hint style="warning" %}
It is recommended to use a separate service account to establish the connection to the data source, configured with the following minimum set of permissions.
{% endhint %}

{% hint style="info" %}
👨‍💻 Who can provide these permissions? These permissions are typically granted by the Redis administrator, as users may not have the required access to assign them independently.
{% endhint %}

| Operation                   | Objects                       | Access Permission                                                                                                                                        |
| --------------------------- | ----------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Connection Validation       | Redis Server                  | Ability to authenticate (if configured) and execute \`PING\`                                                                                             |
| Crawling Database Keys      | Redis database keys           | Ability to scan keys with \`SCAN\` and read metadata such as \`TYPE\` and TTL                                                                            |
| Crawling Key Preview Fields | Redis keys of supported types | Ability to read key contents required for preview (e.g. \`GET\`, \`HGETALL\`, \`LRANGE\`, \`SMEMBERS\`, \`ZRANGE\`, JSON commands depending on key type) |
| Query Sheet / Data Preview  | Selected keys                 | Ability to read the selected key values for rendering a preview                                                                                          |

### Connection Configuration Steps

{% hint style="warning" %}
Users are required to have the Connector Creator role in order to configure a new connection.
{% endhint %}

1. Log into OvalEdge, go to **Administration > Connectors**, click **+ (New Connector)**, search for **Redis**, and complete the required parameters.

{% hint style="info" %}
Fields marked with an asterisk (\*) are mandatory for establishing a connection.
{% endhint %}

<table><thead><tr><th width="219.60003662109375">Field Name</th><th>Description</th></tr></thead><tbody><tr><td>Connector Type</td><td>By default, "<strong>Redis</strong>" is displayed as the selected connector type.</td></tr><tr><td>Credential Manager*</td><td><p>Select the desired credentials manager from the drop-down list. Relevant parameters will be displayed based on your selection.</p><p>Supported Credential Managers:</p><ul><li>OE Credential Manager</li><li>AWS Secrets Manager</li><li>HashiCorp Vault</li><li>Azure Key Vault</li></ul></td></tr><tr><td>Connector Name*</td><td><p>Enter a unique name for the Redis connection              </p><p>(<strong>Example</strong>: "Redis_Prod").</p></td></tr><tr><td>Connector Description</td><td>Enter a brief description of the connector.</td></tr><tr><td>Host* </td><td>Enter the Redis host name or IP address. For Redis Cloud, use the endpoint host.</td></tr><tr><td>Port</td><td>By default, the port number for the Redis, "6379" is auto-populated or 6380 for TLS. </td></tr><tr><td>Username</td><td>Enter the Redis username if required. Leave blank to use the default user.</td></tr><tr><td>Database Password*</td><td>Enter the password for the Redis user.</td></tr><tr><td>Database</td><td>Enter the Redis database index. The default value is 0.</td></tr><tr><td>Timeout (ms) </td><td><p>Enter the connection timeout in milliseconds for validation. </p><p><strong>Example</strong>: 5000.</p></td></tr><tr><td>TLS Enabled</td><td>Enable TLS or SSL when connecting to Redis. Use true for Redis Cloud endpoints.</td></tr></tbody></table>

2. After entering all connection details, the following actions can be performed:
   1. Click **Validate** to verify the connection.&#x20;
   2. Click **Save** to store the connection for future use.
   3. Click **Save & Configure** to apply additional settings before saving.
3. The saved connection will appear on the Connectors home page.

### Manage Connector Operations

#### Crawl/Profile

{% hint style="info" %}
To perform crawl operations, users must be assigned the Integration Admin role.

For Redis, containers represent logical Redis database indexes (for example \`0\` by default).
{% endhint %}

The **Crawl/Profile** button allows users to select one or more schemas for **crawling**.&#x20;

1. Navigate to the **Connectors** page and click **Crawl/Profile**.
2. Select the **schemas** to crawl.
3. The **Crawl** option is selected by default.&#x20;
4. Click **Run** to collect metadata from the connected source and load it into the OvalEdge **Data Catalog**.
5. After a **successful crawl**, the information appears in the OvalEdge **Data Catalog**.

The **Schedule** checkbox allows automated **crawling** at defined intervals, from a minute to a year.

1. Click the **Schedule** checkbox to enable the Select **Period drop-down**.
2. Select a **time period** for the operation from the drop-down menu.
3. Click **Schedule** to initiate metadata collection from the connected source.
4. The system will automatically execute the crawl operation at the scheduled time.

#### Other Operations

The **Connectors** page in OvalEdge provides a centralized view of all configured connectors, including their health status.

**Managing connectors includes:**

* **Connectors Health:** Displays the current status of each connector using a green icon for active connections and a red icon for inactive connections, helping to monitor the connectivity with data sources.
* **Viewing:** Click the Eye icon next to the connector name to view connector details, including databases, tables, columns, and codes.

**Nine Dots Menu Options:**

To view, edit, validate, configure, or delete connectors, click on the Nine Dots menu.

* **Edit Connector:** Update and revalidate the data source.
* **Validate Connector:** Check the connection's integrity.
* **Settings:** Modify connector settings.
  * **Crawler:** Configure data extraction.
  * **Query Policies:** Define query execution rules based on roles.
  * **Access Instructions:** Add notes on how data can be accessed.
  * **Business Glossary Settings:** Manage term associations at the connector level.
  * **Others:** Configure notification recipients for metadata changes
* **Delete Connector:** Remove a connector with confirmation.

### Connectivity Troubleshooting

If incorrect parameters are entered, error messages may appear. Ensure all inputs are accurate to resolve these issues. If issues persist, contact the assigned support team.

<table><thead><tr><th width="88.20001220703125">S.No.</th><th width="303.4000244140625">Error Message (s)</th><th>Error Description &#x26; Resolution</th></tr></thead><tbody><tr><td>1</td><td>Invalid connection config.</td><td><p><strong>Error Description:</strong> </p><ul><li>Required connection settings were missing when validation ran.</li></ul><p><strong>Resolution:</strong></p><ul><li>Open the connector settings.</li><li>Enter all required fields such as Host and Database Password.</li><li>Validate the connection again.</li></ul></td></tr><tr><td>2</td><td>Redis host is required.</td><td><p><strong>Error Description:</strong> </p><ul><li>No Redis host was provided.</li></ul><p><strong>Resolution:</strong></p><ul><li>Enter the Host value.</li><li>Use the endpoint host for Redis Cloud.</li><li>Run validation again.</li></ul></td></tr><tr><td>3 </td><td>Redis API account key is required.</td><td><p><strong>Error Description:</strong> </p><ul><li>No API account key/credentials were provided.</li></ul><p><strong>Resolution:</strong></p><ul><li>Enter the Database Password.</li><li>Verify the credentials are correct.</li><li>Validate the connection again.</li></ul></td></tr><tr><td>4</td><td>Connection failed: (message from driver/server)</td><td><p><strong>Error Description:</strong> </p><ul><li>Redis authentication or network connectivity failed during validation.</li></ul><p><strong>Resolution:</strong></p><ul><li>Verify host, port, and TLS settings.</li><li>Check credentials and firewall rules.</li><li>Retry the connection.</li></ul></td></tr><tr><td>5</td><td>entityId (Redis key) is required.</td><td><p><strong>Error Description:</strong> </p><ul><li>A data preview/query request was submitted without a selected Redis key.</li></ul><p><strong>Resolution:</strong></p><ul><li>Select a Redis key from the data catalog.</li><li>Use a key pattern filter if needed.</li><li>Run query or preview again.</li></ul></td></tr><tr><td>6</td><td>Key not found or could not be fetched</td><td><p><strong>Error Description:</strong> </p><ul><li>The selected key cannot be accessed or was deleted/expired since crawling.</li></ul><p><strong>Resolution:</strong></p><ul><li>Run crawl again to refresh keys.</li><li>Select a valid key.</li><li>Verify read access for the key.</li></ul></td></tr></tbody></table>

***

Copyright © 2026, OvalEdge LLC, Peachtree Corners GA USA


---

# 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.ovaledge.com/release8.1/connectors/connector-repositories/nosql/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.