A set of string constants for the parameter options. More...

Public Attributes
const string	SEED = "seed"
	If provided, the internal random number generator will be initialized with the given value. More...

const string	VALUE = "value"
	The seed value to use. More...

const string	ALL = "all"
	This key indicates that the specifications relayed in the internal map are to be applied to all columns of the records. More...

const string	MIN = "min"
	Minimum possible length for generated series; default is 100 records per series. More...

const string	MAX = "max"
	Maximum possible length for generated series; default is 500 records per series. More...

const string	INTERVAL = "interval"
	If specified, generate values for all columns evenly spaced with the given interval value. More...

const string	NULL_PERCENTAGE = "null_percentage"
	If specified and if this column is nullable, then generate the given percentage of the count as nulls. More...

const string	CARDINALITY = "cardinality"
	If specified, limit the randomly generated values to a fixed set. More...

const string	ATTR_NAME = "attr_name"
	Use the desired column name in place of ATTR_NAME, and set the following parameters for the column specified. More...

const string	TRACK_LENGTH = "track_length"
	This key-map pair is only valid for track data sets (an error is thrown otherwise). More...

Detailed Description

A set of string constants for the parameter options.

Optional parameter to pass in specifications for the randomness of the values. This map is different from the options parameter of most other endpoints in that it is a map of string to map of string to doubles, while most others are maps of string to string. In this map, the top level keys represent which column's parameters are being specified, while the internal keys represents which parameter is being specified. These parameters take on different meanings depending on the type of the column.

Definition at line 34 of file InsertRecordsRandom.cs.

Member Data Documentation

◆ ALL

const string InsertRecordsRandomRequest.Options.ALL = "all"

This key indicates that the specifications relayed in the internal map are to be applied to all columns of the records.

MIN: For numerical columns, the minimum of the generated values is set to this value. Default is -99999. For point, shape, and track columns, min for numeric 'x' and 'y' columns needs to be within [-180, 180] and [-90, 90], respectively. The default minimum possible values for these columns in such cases are -180.0 and -90.0. For the 'TIMESTAMP' column, the default minimum corresponds to Jan 1, 2010. For string columns, the minimum length of the randomly generated strings is set to this value (default is 0). If both minimum and maximum are provided, minimum must be less than or equal to max. If the min is outside the accepted ranges for strings columns and 'x' and 'y' columns for point/shape/track, then those parameters will not be set; however, an error will not be thrown in such a case. It is the responsibility of the user to use the ALL parameter judiciously.
MAX: For numerical columns, the maximum of the generated values is set to this value. Default is 99999. For point, shape, and track columns, max for numeric 'x' and 'y' columns needs to be within [-180, 180] and [-90, 90], respectively. The default minimum possible values for these columns in such cases are 180.0 and 90.0. For string columns, the maximum length of the randomly generated strings. If both minimum and maximum are provided, max must be greater than or equal to min. If the max is outside the accepted ranges for strings columns and 'x' and 'y' columns for point/shape/track, then those parameters will not be set; however, an error will not be thrown in such a case. It is the responsibility of the user to use the ALL parameter judiciously.
INTERVAL: If specified, generate values for all columns evenly spaced with the given interval value. If a max value is specified for a given column the data is randomly generated between min and max and decimated down to the interval. If no max is provided the data is linearly generated starting at the minimum value (instead of generating random data). For non-decimated string-type columns the interval value is ignored. Instead the values are generated following the pattern: 'attrname_creationIndex#', i.e. the column name suffixed with an underscore and a running counter (starting at 0). For string types with limited size (e.g. char4) the prefix is dropped. No nulls will be generated for nullable columns.
NULL_PERCENTAGE: If specified, then generate the given percentage of the count as nulls for all nullable columns. This option will be ignored for non-nullable columns. The value must be within the range [0, 1.0]. The default value is 5% (0.05).
CARDINALITY: If specified, limit the randomly generated values to a fixed set. Not allowed on a column with interval specified, and is not applicable to WKT or Track-specific columns. The value must be greater than 0. This option is disabled by default.

Definition at line 129 of file InsertRecordsRandom.cs.

◆ ATTR_NAME

const string InsertRecordsRandomRequest.Options.ATTR_NAME = "attr_name"

Use the desired column name in place of ATTR_NAME, and set the following parameters for the column specified.

MIN: For numerical columns, the minimum of the generated values is set to this value. Default is -99999. For point, shape, and track columns, min for numeric 'x' and 'y' columns needs to be within [-180, 180] and [-90, 90], respectively. The default minimum possible values for these columns in such cases are -180.0 and -90.0. For the 'TIMESTAMP' column, the default minimum corresponds to Jan 1, 2010. For string columns, the minimum length of the randomly generated strings is set to this value (default is 0). If both minimum and maximum are provided, minimum must be less than or equal to max. If the min is outside the accepted ranges for strings columns and 'x' and 'y' columns for point/shape/track, then those parameters will not be set; however, an error will not be thrown in such a case. It is the responsibility of the user to use the ALL parameter judiciously.
MAX: For numerical columns, the maximum of the generated values is set to this value. Default is 99999. For point, shape, and track columns, max for numeric 'x' and 'y' columns needs to be within [-180, 180] and [-90, 90], respectively. The default minimum possible values for these columns in such cases are 180.0 and 90.0. For string columns, the maximum length of the randomly generated strings. If both minimum and maximum are provided, max must be greater than or equal to min. If the max is outside the accepted ranges for strings columns and 'x' and 'y' columns for point/shape/track, then those parameters will not be set; however, an error will not be thrown in such a case. It is the responsibility of the user to use the ALL parameter judiciously.
INTERVAL: If specified, generate values for all columns evenly spaced with the given interval value. If a max value is specified for a given column the data is randomly generated between min and max and decimated down to the interval. If no max is provided the data is linearly generated starting at the minimum value (instead of generating random data). For non-decimated string-type columns the interval value is ignored. Instead the values are generated following the pattern: 'attrname_creationIndex#', i.e. the column name suffixed with an underscore and a running counter (starting at 0). For string types with limited size (e.g. char4) the prefix is dropped. No nulls will be generated for nullable columns.
NULL_PERCENTAGE: If specified and if this column is nullable, then generate the given percentage of the count as nulls. This option will result in an error if the column is not nullable. The value must be within the range [0, 1.0]. The default value is 5% (0.05).
CARDINALITY: If specified, limit the randomly generated values to a fixed set. Not allowed on a column with interval specified, and is not applicable to WKT or Track-specific columns. The value must be greater than 0. This option is disabled by default.

Definition at line 254 of file InsertRecordsRandom.cs.

◆ CARDINALITY

const string InsertRecordsRandomRequest.Options.CARDINALITY = "cardinality"

If specified, limit the randomly generated values to a fixed set.

Not allowed on a column with interval specified, and is not applicable to WKT or Track-specific columns. The value must be greater than 0. This option is disabled by default.

Definition at line 172 of file InsertRecordsRandom.cs.

◆ INTERVAL

const string InsertRecordsRandomRequest.Options.INTERVAL = "interval"

If specified, generate values for all columns evenly spaced with the given interval value.

If a max value is specified for a given column the data is randomly generated between min and max and decimated down to the interval. If no max is provided the data is linearly generated starting at the minimum value (instead of generating random data). For non-decimated string-type columns the interval value is ignored. Instead the values are generated following the pattern: 'attrname_creationIndex#', i.e. the column name suffixed with an underscore and a running counter (starting at 0). For string types with limited size (e.g. char4) the prefix is dropped. No nulls will be generated for nullable columns.

Definition at line 157 of file InsertRecordsRandom.cs.

◆ MAX

const string InsertRecordsRandomRequest.Options.MAX = "max"

Maximum possible length for generated series; default is 500 records per series.

Must be an integral value within the range [1, 500]. If both min and max are specified, max must be greater than or equal to min.

Definition at line 143 of file InsertRecordsRandom.cs.

◆ MIN

const string InsertRecordsRandomRequest.Options.MIN = "min"

Minimum possible length for generated series; default is 100 records per series.

Must be an integral value within the range [1, 500]. If both min and max are specified, min must be less than or equal to max.

Definition at line 136 of file InsertRecordsRandom.cs.

◆ NULL_PERCENTAGE

const string InsertRecordsRandomRequest.Options.NULL_PERCENTAGE = "null_percentage"

If specified and if this column is nullable, then generate the given percentage of the count as nulls.

This option will result in an error if the column is not nullable. The value must be within the range [0, 1.0]. The default value is 5% (0.05).

Definition at line 164 of file InsertRecordsRandom.cs.

◆ SEED

const string InsertRecordsRandomRequest.Options.SEED = "seed"

If provided, the internal random number generator will be initialized with the given value.

VALUE: The seed value to use.

Definition at line 44 of file InsertRecordsRandom.cs.

◆ TRACK_LENGTH

const string InsertRecordsRandomRequest.Options.TRACK_LENGTH = "track_length"

This key-map pair is only valid for track data sets (an error is thrown otherwise).

MIN: Minimum possible length for generated series; default is 100 records per series. Must be an integral value within the range [1, 500]. If both min and max are specified, min must be less than or equal to max. The minimum allowed value is 1. The maximum allowed value is 500.
MAX: Maximum possible length for generated series; default is 500 records per series. Must be an integral value within the range [1, 500]. If both min and max are specified, max must be greater than or equal to min. The minimum allowed value is 1. The maximum allowed value is 500.

Definition at line 278 of file InsertRecordsRandom.cs.

◆ VALUE

const string InsertRecordsRandomRequest.Options.VALUE = "value"

The seed value to use.

Definition at line 47 of file InsertRecordsRandom.cs.

The documentation for this struct was generated from the following file:

Kinetica/Protocol/InsertRecordsRandom.cs

Public Attributes