| title | sidebar_label | description |
|---|---|---|
| Random value generator | Random value generator | Random value generator function reference documentation. |
The following functions have been created to help with our test suite. They are also useful for users testing QuestDB on specific workloads in order to quickly generate large test datasets that mimic the structure of their actual data.
Values can be generated either:
- Pseudo randomly
- Deterministically when specifying a
seed
QuestDB supports the following random generation functions:
- rnd_boolean
- rnd_byte
- rnd_short
- rnd_int
- rnd_long
- rnd_long256
- rnd_float
- rnd_double
- rnd_date
- rnd_timestamp
- rnd_char
- rnd_symbol
- rnd_str
- rnd_bin
Usage
Random functions should be used for populating test tables only. They do not hold values in memory and calculations should not be performed at the same time as the random numbers are generated.
For example, running SELECT round(a,2), a FROM (SELECT rnd_double() a FROM long_sequence(10)); is bad practice and will return inconsistent results.
A better approach would be to populate a table and then run the query. So for example
- create -
CREATE TABLE test(val double); - populate -
INSERT INTO test SELECT * FROM (SELECT rnd_double() FROM long_sequence(10)); - query -
SELECT round(val,2) FROM test;
Generating sequences
This page describes the functions to generate values. To generate sequences of values, please refer the page about row generators.
rnd_boolean
rnd_boolean() - generates a random boolean value, either true or false, both having equal probability.
Return value:
Return value type is boolean.
Examples:
1. SELECT
2. value a,
3. count() b
4. FROM (SELECT rnd_boolean() value FROM long_sequence(100));
| a | b |
|---|---|
| true | 47 |
| false | 53 |
rnd_byte
rnd_byte()- returns a random integer which can take any value between0and127.rnd_byte(min, max)- generates byte values in a specific range (for example only positive, or between 1 and 10).
Arguments:
min: is abyterepresenting the lowest possible generated value (inclusive).max: is abyterepresenting the highest possible generated value (inclusive).
Return value:
Return value type is byte.
Examples:
1. SELECT rnd_byte() FROM long_sequence(5);
2. SELECT rnd_byte(-1,1) FROM long_sequence(5);
1. 122,34,17,83,24
2. 0,1,-1,-1,0
rnd_short
rnd_short()- returns a random integer which can take any value between-32768and32767.rnd_short(min, max)- returns short values in a specific range (for example only positive, or between 1 and 10). Supplyingminabovemaxwill result in aninvalid rangeerror.
Arguments:
min: is ashortrepresenting the lowest possible generated value (inclusive).max: is ashortrepresenting the highest possible generated value (inclusive).
Return value:
Return value type is short.
Examples:
1. SELECT rnd_short() FROM long_sequence(5);
2. SELECT rnd_short(-1,1) FROM long_sequence(5);
1. -27434,234,-12977,8843,24
2. 0,1,-1,-1,0
rnd_int
rnd_int()is used to return a random integer which can take any value between-2147483648and2147483647.rnd_int(min, max, nanRate)is used to generate int values in a specific range (for example only positive, or between 1 and 10), or to get occasionalNaNvalues along with int values.
Arguments:
min: is anintrepresenting the lowest possible generated value (inclusive).max: is anintrepresenting the highest possible generated value (inclusive).nanRateis anintdefining the frequency of occurrence ofNaNvalues:0: NoNaNwill be returned.1: Will only returnNaN.N > 1: On average, one in N generated values will be NaN.
Return value:
Return value type is int.
Examples:
1. SELECT rnd_int() FROM long_sequence(5)
2. SELECT rnd_int(1,4,0) FROM long_sequence(5);
3. SELECT rnd_int(1,4,1) FROM long_sequence(5);
4. SELECT rnd_int(1,4,2) FROM long_sequence(5);
1. 1822685476, 1173192835, -2808202361, 78121757821, 44934191
2. 1,4,3,1,2
3. null,null,null,null,null
4. 1,null,4,null,2
rnd_long
rnd_long()is used to return a random signed integer between0x8000000000000000Land0x7fffffffffffffffL.rnd_long(min, max, nanRate)is used to generate long values in a specific range (for example only positive, or between 1 and 10), or to get occasionalNaNvalues along with int values.
Arguments:
min: is alongrepresenting the lowest possible generated value (inclusive).max: is alongrepresenting the highest possible generated value (inclusive).nanRateis anintdefining the frequency of occurrence ofNaNvalues:0: NoNaNwill be returned.1: Will only returnNaN.N > 1: On average, one in N generated values will beNaN.
Return value:
Return value type is long.
Examples:
1. SELECT rnd_long() FROM long_sequence(5);
2. SELECT rnd_long(1,4,0) FROM long_sequence(5);
3. SELECT rnd_long(1,4,1) FROM long_sequence(5);
4. SELECT rnd_long(-10000000,10000000,2) FROM long_sequence(5);
1. 1,4,3,1,2
2. null,null,null,null,null
3. -164567594, -323331140, 26846334, -892982893, -351053301
4. 300291810703592700, 2787990010234796000, 4305203476273459700, -8518907563589124000, 8443756723558216000
rnd_long256
rnd_long256()- generates a randomlong256value between 0 and 2^256.
Arguments:
min: is along256representing the lowest possible generated value (inclusive).max: is along256representing the highest possible generated value (inclusive).nanRateis anintdefining the frequency of occurrence ofNaNvalues:0: NoNaNwill be returned.1: Will only returnNaN.N > 1: On average, one in N generated values will beNaN.
Return value:
Return value type is long256.
Examples:
1. SELECT rnd_long256() FROM long_sequence(5);
1. 0x5dd94b8492b4be20632d0236ddb8f47c91efc2568b4d452847b4a645dbe4871a,
2. 0x55f256188b3474aca83ccc82c597668bb84f36d3f5b25afd9e194c1867625918,
3. 0x630c6f02c1c2e0c2aa4ac80ab684aa36d91dd5233cc185bb7097400fa12e7de0,
4. 0xa9eeaa5268f911f4bcac2e89b621bd28bba90582077fc9fb9f14a53fcf6368b7,
5. 0x7c80546eea2ec093a5244e39efad3f39c5489d2337007fd0b61d8b141058724d
rnd_float
rnd_float()- generates a random positivefloatbetween 0 and 1.rnd_float(nanRate)- generates a random positivefloatbetween 0 and 1 which will beNaNat a frequency defined bynanRate.
Arguments:
nanRateis anintdefining the frequency of occurrence ofNaNvalues:0: NoNaNwill be returned.1: Will only returnNaN.N > 1: On average, one in N generated values will beNaN.
Return value:
Return value type is float.
Examples:
1. SELECT rnd_float() FROM long_sequence(5);
2. SELECT rnd_float(2) FROM long_sequence(6);
1. 0.3821478, 0.5162148, 0.22929084, 0.03736937, 0.39675003
2. 0.08108246, 0.7082644, null, 0.6784522, null, 0.5711276
rnd_double
rnd_double()- generates a random positivedoublebetween 0 and 1.rnd_double(nanRate)- generates a random positivedoublebetween 0 and 1 which will beNaNat a frequency defined bynanRate.
Arguments:
nanRateis anintdefining the frequency of occurrence ofNaNvalues:0: NoNaNwill be returned.1: Will only returnNaN.N > 1: On average, one in N generated values will beNaN.
Return value:
Return value type is double.
Examples:
1. SELECT rnd_double() FROM long_sequence(5);
2. SELECT rnd_double(2) FROM long_sequence(5);
1. 0.99115364871, 0.31011470271, 0.10776479191, 0.53938281731, 0.89820403511
2. 0.99115364871, null, null, 0.53938281731, 0.89820403511
rnd_date()
rnd_date()generates a random date betweenstartandenddates (both inclusive). IT will also generateNaNvalues at a frequency defined bynanRate. Whenstartorendare invalid dates, or whenstartis superior toend, it will returninvalid rangeerror. WhennanRateis inferior to 0, it will returninvalid NAN rateerror.
Arguments:
startis adatedefining the minimum possible generated date (inclusive)endis adatedefining the maximum possible generated date (inclusive)nanRatedefines the frequency of occurrence ofNaNvalues:0: NoNaNwill be returned.1: Will only returnNaN.N > 1: On average, one in N generated values will be NaN.
Return value:
Return value type is date.
Examples:
1. SELECT rnd_date(
2. to_date('2015', 'yyyy'),
3. to_date('2016', 'yyyy'),
4. 0)
5. FROM long_sequence(5);
1. 2015-01-29T18:00:17.402Z, 2015-11-15T20:22:14.112Z,
2. 2015-12-08T09:26:04.483Z, 2015-05-28T02:22:47.022Z,
3. 2015-10-13T19:16:37.034Z
rnd_timestamp()
rnd_timestamp(start, end, nanRate)generates a random timestamp betweenstartandendtimestamps (both inclusive). It will also generateNaNvalues at a frequency defined bynanRate. Whenstartorendare invalid timestamps, or whenstartis superior toend, it will returninvalid rangeerror. WhennanRateis inferior to 0, it will returninvalid NAN rateerror.
Arguments:
startis atimestampdefining the minimum possible generated timestamp (inclusive)endis atimestampdefining the maximum possible generated timestamp (inclusive)nanRatedefines the frequency of occurrence ofNaNvalues:0: NoNaNwill be returned.1: Will only returnNaN.N > 1: On average, one in N generated values will be NaN.
Return value:
Return value type is timestamp.
Examples:
1. SELECT rnd_timestamp(
2. to_timestamp('2015', 'yyyy'),
3. to_timestamp('2016', 'yyyy'),
4. 0)
5. FROM long_sequence(5);
1. 2015-01-29T18:00:17.402762Z, 2015-11-15T20:22:14.112744Z,
2. 2015-12-08T09:26:04.483039Z, 2015-05-28T02:22:47.022680Z,
3. 2015-10-13T19:16:37.034203Z
Sequences
To generate increasing timestamps, please refer the page about row generators.
rnd_char
rnd_char()is used to generate a randomcharwhich will be an uppercase character from the 26-letter A to Z alphabet. Letters from A to Z will be generated with equal probability.
Return value:
Return value type is char.
Examples:
1. SELECT rnd_char() FROM long_sequence(5);
1. G, P, E, W, K
rnd_symbol
rnd_symbol(symbolList)is used to choose a randomsymbolfrom a list defined by the user. It is useful when looking to generate specific symbols from a finite list (e.gBUY, SELLorAUTUMN, WINTER, SPRING, SUMMER. Symbols are randomly chosen from the list with equal probability. When only one symbol is provided in the list, this symbol will be chosen with 100% probability, in which case it is more efficient to usecast('your_symbol' as symbolrnd_symbol(count, minLength, maxLength, null)generated a finite list of distinct random symbols and chooses one symbol from the list at random. The finite list is of sizelist_size. The generated symbols length is betweenminLengthandmaxLength(both inclusive). The function will also generatenullvalues at a a rate defined bynullRate.
Arguments:
symbolListis a variable-length list of possiblesymbolvalues expressed as a comma-separated list of strings. For example,'a', 'bcd', 'efg123', '行'list_sizeis the number of distinctsymbolvalues to generatedminLengthis anintdefining the minimum length for of a generated symbol (inclusive)maxLengthis anintdefining the maximum length for of a generated symbol (inclusive)nullRateis anintdefining the frequency of occurrence ofnullvalues:0: Nonullwill be returned.1: Will only returnnull.N > 1: On average, one in N generated values will benull.
Return value:
Return value type is symbol.
Examples:
1. SELECT rnd_symbol('ABC','def', '123')
2. FROM long_sequence(5);
1. 'ABC', '123', 'def', '123', 'ABC'
1. SELECT rnd_symbol(2, 3, 4, 0)
2. FROM long_sequence(5);
1. 'ABC', 'DEFG', 'ABC', 'DEFG', 'DEFG'
rnd_str
rnd_str(stringList)is used to choose a randomstringfrom a list defined by the user. It is useful when looking to generate specific strings from a finite list (e.gBUY, SELLorAUTUMN, WINTER, SPRING, SUMMER. Strings are randomly chosen from the list with equal probability. When only one string is provided in the list, this string will be chosen with 100% probability.rnd_str(count, minLength, maxLength, null)generated a finite list of distinct random string and chooses one string from the list at random. The finite list is of sizelist_size. The generated strings length is betweenminLengthandmaxLength(both inclusive). The function will also generatenullvalues at a a rate defined bynullRate.
Arguments:
strListis a variable-length list of possiblestringvalues expressed as a comma-separated list of strings. For example,'a', 'bcd', 'efg123', '行'list_sizeis the number of distinctstringvalues to generatedminLengthis anintdefining the minimum length for of a generated string (inclusive)maxLengthis anintdefining the maximum length for of a generated string (inclusive)nullRateis anintdefining the frequency of occurrence ofnullvalues:0: Nonullwill be returned.1: Will only returnnull.N > 1: On average, one in N generated values will benull.
Return value:
Return value type is string.
Examples:
1. SELECT rnd_str('ABC','def', '123')
2. FROM long_sequence(5);
1. 'ABC', '123', 'def', '123', 'ABC'
1. SELECT rnd_str(3, 2, 2, 4)
2. FROM long_sequence(8);
1. 'AB', 'CD', null, 'EF', 'CD', 'EF', null, 'AB'
rnd_bin
rnd_bin()generates random binary data of a size up to32bytes.rnd_bin(minBytes, maxBytes, nullRate)generates random binary data of a size betweenminBytesandmaxBytesand returnsnullat a rate defined bynullRate.
Arguments:
minBytesis alongdefining the minimum size in bytes for of a generated binary (inclusive)maxBytesis alongdefining the maximum size in bytes for of a generated binary (inclusive)nullRateis anintdefining the frequency of occurrence ofnullvalues:0: Nonullwill be returned.1: Will only returnnull.N > 1: On average, one in N generated values will benull.
Return value:
Return value type is binary.
Examples:
1. SELECT rnd_bin() FROM long_sequence(5);
2. SELECT rnd_bin(2, 5, 2) FROM long_sequence(5);
