Kinetica C# API
Version 7.1.10.0
|
Optional parameter to pass in specifications for the randomness of the values. 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... | |
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. Below follows a more detailed description of the map:
The default value is an empty Dictionary. A set of string constants for the parameter options.
Definition at line 269 of file InsertRecordsRandom.cs.
const string kinetica.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.
Definition at line 378 of file InsertRecordsRandom.cs.
const string kinetica.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.
This overrides any parameter set by all.
Definition at line 506 of file InsertRecordsRandom.cs.
const string kinetica.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 419 of file InsertRecordsRandom.cs.
const string kinetica.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 linerally 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 (eg char4) the prefix is dropped. No nulls will be generated for nullable columns.
Definition at line 405 of file InsertRecordsRandom.cs.
const string kinetica.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 390 of file InsertRecordsRandom.cs.
const string kinetica.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 384 of file InsertRecordsRandom.cs.
const string kinetica.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 412 of file InsertRecordsRandom.cs.
const string kinetica.InsertRecordsRandomRequest.Options.SEED = "seed" |
If provided, the internal random number generator will be initialized with the given value.
The minimum is 0. This allows for the same set of random numbers to be generated across invocation of this endpoint in case the user wants to repeat the test. Since options, is a map of maps, we need an internal map to provide the seed value. For example, to pass 100 as the seed value through this parameter, you need something equivalent to: 'options' = {'seed': { 'value': 100 } }
Definition at line 289 of file InsertRecordsRandom.cs.
const string kinetica.InsertRecordsRandomRequest.Options.TRACK_LENGTH = "track_length" |
This key-map pair is only valid for track data sets (an error is thrown otherwise).
No nulls would be generated for nullable columns.
Definition at line 531 of file InsertRecordsRandom.cs.
const string kinetica.InsertRecordsRandomRequest.Options.VALUE = "value" |
The seed value to use
Definition at line 292 of file InsertRecordsRandom.cs.