Package com.gpudb.protocol

Class InsertRecordsRandomRequest.Options

  • Enclosing class:
    InsertRecordsRandomRequest
    public static final class InsertRecordsRandomRequest.Options
extends Object
    A set of string constants for the InsertRecordsRandomRequest 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. Below follows a more detailed description of the map:

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String ALL
      This key indicates that the specifications relayed in the internal map are to be applied to all columns of the records.
      static String ATTR_NAME
      Use the desired column name in place of ATTR_NAME, and set the following parameters for the column specified.
      static String CARDINALITY
      If specified, limit the randomly generated values to a fixed set.
      static String INTERVAL
      If specified, generate values for all columns evenly spaced with the given interval value.
      static String MAX
      Maximum possible length for generated series; default is 500 records per series.
      static String MIN
      Minimum possible length for generated series; default is 100 records per series.
      static String NULL_PERCENTAGE
      If specified and if this column is nullable, then generate the given percentage of the count as nulls.
      static String SEED
      If provided, the internal random number generator will be initialized with the given value.
      static String TRACK_LENGTH
      This key-map pair is only valid for track data sets (an error is thrown otherwise).
      static String VALUE
      The seed value to use

    • Field Detail

      • SEED

        public static final String 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 } }.
        • VALUE: The seed value to use
        See Also:
        Constant Field Values

      • ALL

        public static final String 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.
        See Also:
        Constant Field Values

      • MIN

        public static final String 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.
        See Also:
        Constant Field Values

      • MAX

        public static final String 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.
        See Also:
        Constant Field Values

      • INTERVAL

        public static final String 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.
        See Also:
        Constant Field Values

      • NULL_PERCENTAGE

        public static final String 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).
        See Also:
        Constant Field Values

      • CARDINALITY

        public static final String 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.
        See Also:
        Constant Field Values

      • ATTR_NAME

        public static final String 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.
        • 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.
        See Also:
        Constant Field Values

      • TRACK_LENGTH

        public static final String 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.
        • 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.
        See Also:
        Constant Field Values