Redis v2 (Beta) connection

Introduction

A Redis v2 (Beta) connection, created using the Redis v2 (Beta) connector, establishes access to Redis. Once a connection is configured, you can create instances of Redis v2 (Beta) activities associated with that connection to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).

Create or edit a Redis v2 (Beta) connection

A new Redis v2 (Beta) connection is created using the Redis v2 (Beta) connector from one of these locations:

• The design component palette's Project endpoints and connectors tab (see Design component palette).
• The Global Endpoints page (see Create a global endpoint in Global Endpoints).

An existing Redis v2 (Beta) connection can be edited from these locations:

• The design component palette's Project endpoints and connectors tab (see Design Component Palette).
• The project pane's Components tab (see Component actions menu in Project pane Components tab).
• The Global Endpoints page (see Edit a global endpoint in Global Endpoints).

Configure a Redis v2 (Beta) connection

Each user interface element of the Redis v2 (Beta) connection configuration screen is described below.

• Connection name: Enter a name to use to identify the connection. The name must be unique for each Redis v2 (Beta) connection and must not contain forward slashes / or colons :. This name is also used to identify the Redis v2 (Beta) endpoint, which refers to both a specific connection and its activities.

• Provider: Select the Redis instance provider, one of REDIS (CLOUD/ON-PREMISE) (default), AZURE CACHE FOR REDIS, or AMAZON ELASTICACHE.

• Connect using: Choose how you want to enter your connection information:

  • Connection string: For this option, the connection is authenticated using a combined credential string in Redis protocol format.
  • Form: For this option, the connection is authenticated using distinct credential fields.

  For both options, the same additional settings appear after their specific UI fields.

Connection string settings

When Connection string is selected for the Connect using setting, these fields are shown:

• Connection URL: Enter the full connection string in Redis protocol format, including the credentials necessary to log in. For example redis://username:password@host:port or rediss://username:password@host:port if SSL is enabled.

• Deployment type: Select the deployment type, one of NON CLUSTERED (default), CLUSTERED, and SENTINEL.

  • NON CLUSTERED: Select when connecting to a non-clustered, non-high availability Redis instance.

  • CLUSTERED: Select when connecting to a Redis Cluster instance. When selected, an additional table is shown:

    • Enter connection string of Cluster nodes: Click the add icon to add a row to the table below and enter a Connection String in Redis protocol format.

      To save the row, click the submit icon in the rightmost column.

      To edit or delete a single row, hover over the rightmost column and use the edit icon or delete icon .

      To delete all rows, click Clear All.

  • SENTINEL: Select when connecting to a Redis Sentinel instance. When selected, an additional table is shown:

    • Enter connection string of Sentinel nodes: Click the add icon to add a row to the table below and enter a Sentinel Node URL in Redis protocol format and Master ID.

      To save the row, click the submit icon in the rightmost column.

      To edit or delete a single row, hover over the rightmost column and use the edit icon or delete icon .

      To delete all rows, click Clear All.

Form settings

When Form is selected for the Connect using setting, these fields are shown:

• Username: Enter the username to connect to the Redis instance. Ensure that the associated user has sufficient permissions to connect to and interact with the Redis instance.

• Password: Enter the password associated with the supplied Username.

• Deployment type: Select the deployment type, one of NON CLUSTERED, CLUSTERED, and SENTINEL.

  • NON CLUSTERED: Select when connecting to a non-clustered, non-high availability Redis instance. When selected, the following fields are shown:

    • Host: Enter the hostname of the Redis instance.

    • Port: Enter the port of the Redis instance. The default Redis port is 6379.

  • CLUSTERED: Select when connecting to a Redis Cluster instance. When selected, an additional table is shown:

    • Enter hosts and ports of Cluster nodes: Click the add icon to add a row to the table below and enter a Host and Port.

      To save the row, click the submit icon in the rightmost column.

      To edit or delete a single row, hover over the rightmost column and use the edit icon or delete icon .

      To delete all rows, click Clear All.

  • SENTINEL: Select when connecting to a Redis Sentinel instance. When selected, an additional table is shown:

    • Enter hosts and ports of Sentinel nodes: Click the add icon to add a row to the table below and enter a SentinelHost, SentinelPort, and Master ID.

      To save the row, click the submit icon in the rightmost column.

      To edit or delete a single row, hover over the rightmost column and use the edit icon or delete icon .

      To delete all rows, click Clear All.

Additional settings

Regardless of the option selected for the Connect using setting, these fields are shown:

• Optional settings: Click to expand additional optional settings:

  • Enable Client Configuration: Select to show Redis client configuration settings:

    

    • Time Out (Seconds): Enter the time-out value for the client connection.
    • Database: Enter the index of the default database to use for the client connection. The Redis default is 0.
    • ClientName: Enter a client name to identify the client connection within Redis.
    • SSL: Select to enable SSL encryption for the client connection.

  • Enable Pool Configuration: Select to show Redis connection pool configuration settings:

    

    • Max Total: Enter the maximum total connections in the pool. Enter -1 for unlimited connections.
    • Max Active: Enter the maximum active connections in the pool.
    • Max Idle: Enter the maximum idle connections in the pool.
    • Min Idle: Enter the minimum idle connections in the pool.
    • Enable LIFO: Select to enable last-in first-out (LIFO) mode for connection borrowing. By default, first-in first-out (FIFO) mode is used.
    • Max Wait (Milliseconds): Enter the maximum wait time before a connection is made available.
    • Min Evictable Idle Time (Milliseconds): Enter the minimum idle time before connections are flagged for eviction.
    • Num Tests Per Eviction Run: Enter the number of connections to test for each eviction attempt.
    • Time Between Eviction Run (Milliseconds): Enter the time between eviction runs.
    • Test On Borrow: Select to test connections before they are borrowed from the pool. Enabling this setting may negatively impact performance.
    • Test While Idle: Select to test connections while they are idle. Time Between Eviction Run (Milliseconds) must be greater than 0 for this setting to function as expected.

• Test: Click to verify the connection using the specified configuration. When the connection is tested, the latest version of the connector is downloaded by the agent(s) in the agent group associated with the current environment. This connector supports suspending the download of the latest connector version by using the Disable Auto Connector Update organization policy.

• Save Changes: Click to save and close the connection configuration.

• Discard Changes: After making changes to a new or existing configuration, click to close the configuration without saving. A message asks you to confirm that you want to discard changes.

• Delete: After opening an existing connection configuration, click to permanently delete the connection from the project and close the configuration (see Component dependencies, deletion, and removal). A message asks you to confirm that you want to delete the connection.

Next steps

After a Redis v2 (Beta) connection has been created, you place an activity type on the design canvas to create activity instances to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).

Menu actions for a connection and its activity types are accessible from the project pane and design component palette. For details, see Actions menus in Connector Basics.

These activity types are available:

• Set: Sets keys in Redis and is intended to be used as a target in an operation.

• Get: Gets keys from Redis and is intended to be used as a source in an operation.

• Exists: Checks if keys exist in Redis and is intended to be used as a target in an operation.