Redis connector

The Redis connector supports Redis 2.0 and above, and anything that supports the Redis RESP protocol.

To connect to a Redis cluster, you will need to use the RedisCluster connector, which takes different parameters, but otherwise behaves essentially the same as this connector.

Related pages

Parameters

This connector takes the following parameters:

Connection name

Can be any name you want.


Active

If checked, then this connection will be active any time Gallium Data is running, meaning that the local port will be open and listening for requests. If you uncheck this (and then click Publish), then the connection is "commented out" -- it's as if it didn't exist, but you can still keep it around and re-activate it later.


Type

The type of database for this connection. This is set to "Redis" when you create the connection and cannot be changed afterwards.


Server host

Required. The name or address of the Redis server. This can be a partial name (like dbserver), a full name (like dbserver.it.acme.com), an IP4 address (like 181.77.230.42) or an IP6 address if your network supports IP6 (like 266a:1790:2920:1234:35c:8765:9876:4321).

If you are running Gallium Data as a Docker container, and Redis is on the host machine, you can use host.docker.internal to specify the host machine (on Windows or Mac, but see here for Linux).


Server port

Required. The port on the database server. For Redis, it's usually 6379 but it can also be something else.


Use TLS with server

If selected, the connection to the server will use TLS.


Trust server certificate

Whether to accept the SSL certificate from the Redis server at face value, or not.

If this is false, and Use TLS with server is selected, then the server's certificate will be verified, either by being signed by a well-known certificate authority, or by verifying it with the chain of certificates provided in the project's Trust entry.

If this is true, then the Redis server's certificate will be accepted without verification. This is useful for debugging and casual usage, but is discouraged in production because it is not secure.


Local address

The address on which to listen for requests. This is typically only relevant if your server has more than one address. By default, Gallium Data will listen on all addresses (which is equivalent to 0.0.0.0).


Local port

Required. The port number on which Gallium Data will be listening to requests from database clients. If you set this to a port other than 6379, your Redis clients will need to specify that port.


Use TLS with clients

If selected, clients will be required to connect using TLS.


Require TLS client authentication

If selected, clients will be required to provide a valid certificate.

Gallium Data commands

When connected to a Redis database through Gallium Data, you can execute a few special commands that will be intercepted by Gallium Data and will never reach the Redis server.


galliumdata ping

Response:

OK Gallium Data says Hello


galliumdata status

Response:

Gallium Data status as of 2022-04-30T00:59:16.122015Z

Version 1.2.1 build 997

Start time: 2022-04-29T23:40:00.826291Z

# requests: 1846554

# responses: 1846511

Request bytes: 27334908

Response bytes: 3974126312

Note: if you have multiple Gallium Data servers, this only shows the status of the Gallium Data server to which you are connected.