Menu
Grafana k6 JavaScript API k6/experimental redis Client Client.set(key, value, expiration)
Open source

Client.set(key, value, expiration)

Set the value of a key, with a time to live equal to the expiration time parameter (in seconds). If the key already holds a value, it is overwritten.

Parameters

ParameterTypeDescription
keystringthe key to set
valuestring, number, or booleanthe value to set
expirationintegerthe time to live in seconds. the 0 value indicates no expiration.

Returns

TypeResolves withRejected when
Promise<string>On success, the promise resolves with ‘OK’.If the provided value is not of a supported type, the promise is rejected with an error.

Example

JavaScript 
import redis from 'k6/experimental/redis';

// Get the redis instance(s) address and password from the environment
const redis_addrs = __ENV.REDIS_ADDRS || '';
const redis_password = __ENV.REDIS_PASSWORD || '';

// Instantiate a new redis client
const redisClient = new redis.Client({
  addrs: redis_addrs.split(',') || new Array('localhost:6379'), // in the form of 'host:port', separated by commas
  password: redis_password,
});

export default async function () {
  await redisClient.set('mykey', 'myvalue', 0);

  const exists = await redisClient.exists('mykey');
  if (exists === false) {
    throw new Error('mykey should exist');
  }

  const value = await redisClient.get('mykey');
  console.log(`set key 'mykey' to value: ${value}`);

  await redisClient.del('mykey');
}