Parameters

This appendix describes the parameters used to execute ProSort. Modified parameter values apply to a system statically or dynamically.

1. Performance-related Parameters

The following parameters are related to ProSort performance.

It is recommend to use the default values of the following parameters. However, to find optimal parameter values, modify them multiple times while executing ProSort for better performance.
Parameter Description

SORT_THREAD_COUNT

Number of threads used to sort data. (Default value: 2)

SORT_READ_BLK_SIZE

Block size to be read from a file at a time during sorting. (Default value: 4 MB)

SORT_WRITE_BLK_SIZE

Block size to be written to a sorting result file at a time. (Default value: 4 MB)

USE_SYSTEM_QUICK_SORT

Option to use qsort, a C standard library function. (Default value: N)

USE_AIO_READ

Option to use asynchronous I/O when reading files. (Default value: Y)

USE_AIO_WRITE

Option to use asynchronous I/O when writing results to files. (Default value: Y)

MERGE_READ_BLK_SIZE

Block size to be read from a file at a time during merge. (Default value: 2 MB)

MAXIMIZE_MEM_RUN_SIZE

Option to maximize the input file size to be processed in memory. (Default value: Y)

USE_SYSTEM_MALLOC

Option to use malloc, a C standard library function. (Default value: N)

MEMORY

Memory size used for sorting. (Default value: 0)

USE_STRICT_MEMORY

How to use the MEMORY parameter value. (Default value: N)

USE_ALTERNATIVE_TP_TYPE

How to express the TP data format of positive numbers.

SUM_OVERFLOW_OPTION

Action to take when a summary field overflow occurs.

USE_BI_KEY_CONV

Option to use a conversion function for BI data sorting.

USE_CH_EBCDIC

Option to use either EBCDIC or ASCII character set for CH data sorting.

USE_BI_EBCDIC

Option to use either EBCDIC or ASCII character set for BI data sorting.

USE_AQ_EBCDIC

Option to use either EBCDIC or ASCII as a base sequence for AQ data sorting.

EBCDIC_CODEPAGE

Code page used when sorting EBCDIC.

USE_OF_CONVERSION_RULE

Option to use OpenFrame EBCDIC conversion rules. (Default value: N)

OF_CPM

CPM to use when OpenFrame EBCDIC conversion rules are enabled.

1.1. SORT_THREAD_COUNT

Number of threads used to sort data. A greater value improves performance, but it is recommended to set a value less than the number of CPU processors.

  • Properties

    Property Description

    Data type

    Integer

    Default value

    2

    Range

    0 ~ 255

  • Example

    If set to 0, threads are not used.

    SORT_THREAD_COUNT=0

1.2. SORT_READ_BLK_SIZE

Block size to be read from a file at a time during sorting. The value must be a multiple of the OS block size. It is recommended to use the default value because a value too small or too large decreases performance.

  • Properties

    Property Description

    Data type

    Integer

    Default value

    4194304

    Range

    64K ~ 512M

1.3. SORT_WRITE_BLK_SIZE

Block size to be written to a sorting result file at a time. The value must be a multiple of the OS block size. It is recommended to use the default value because a value too small or too large decreases performance.

  • Properties

    Property Description

    Data type

    Integer

    Default value

    4194304

    Range

    64K ~ 512M

1.4. USE_SYSTEM_QUICK_SORT

Option to use qsort, a C standard library function. If set to N, the ProSort-provided sorting function is used. It is recommended to use the default value for better performance.

  • Properties

    Property Description

    Data type

    String

    Default value

    N

    Range

    Y | N

  • Example

    The following uses qsort instead of the ProSort-provided sorting function.

    USE_SYSTEM_QUICK_SORT=Y

1.5. USE_AIO_READ

Option to use asynchronous I/O when reading files. In OSs that support asynchronous I/O, setting this parameter to Y improves performance, but in OSs that do not support asynchronous I/O, this parameter must be set to N.

  • Properties

    Property Description

    Data type

    String

    Default value

    Y

    Range

    Y | N

1.6. USE_AIO_WRITE

Option to use asynchronous I/O when writing results to files. In OSs that support asynchronous I/O, setting this parameter to Y improves performance, but in OSs that do not support asynchronous I/O, this parameter must be set to N.

  • Properties

    Property Description

    Data type

    String

    Default value

    Y

    Range

    Y | N

1.7. MERGE_READ_BLK_SIZE

Block size to be read from a file at a time during merge. Since external sorting entails internal merge, the value influences sorting performance. The value must be a multiple of the OS block size. A greater value improves performance, but it is recommended to set to a value less than the memory size / the number of input files.

  • Properties

    Property Description

    Data type

    Integer

    Default value

    2097152

    Range

    64K ~ 512M

1.8. MAXIMIZE_MEM_RUN_SIZE

Option to maximize the input file size to be processed in memory. It is recommended to use the default value for better performance.

  • Properties

    Property Description

    Data type

    String

    Default value

    Y

    Range

    Y | N

  • Example

    The following maximizes the input file size to be processed in memory.

    MAXIMIZE_MEM_RUN_SIZE=Y

1.9. USE_SYSTEM_MALLOC

Option to use malloc, a C standard library function. If set to the default value N, the ProSort-provided memory allocation function is used. It is recommended to use the default value for better performance.

  • Properties

    Property Description

    Data type

    String

    Default value

    N

    Range

    Y | N

  • Example

    The following uses malloc instead of the ProSort-provided memory allocation function.

    USE_SYSTEM_MALLOC=Y

1.10. MEMORY

Memory size used for sorting. If a MEMORY value is set in a script, a value set in this parameter is ignored.

If an input file size is less than the parameter value, 1-pass sorting is performed. If not, 2-pass sorting is performed.

  • Properties

    Property Description

    Data type

    Integer

    Default value

    0 (0 means the total memory size * 0.1.)

    Range

    0 ~ 1125899906842624

1.11. USE_STRICT_MEMORY

How to use the MEMORY parameter value.

  • Properties

    Property Description

    Data type

    String

    Default value

    N

    Range

    Y | N

  • Setting Values

    The parameter value does not influence performance.

    Value Description

    Y

    Limits memory usage according to the MEMORY parameter value.

    N

    Selects a sorting method according to the MEMORY parameter value. (Default value)

  • Example

    The following limits memory usage according to the MEMORY parameter value.

    USE_STRICT_MEMORY=Y

    The following selects a sorting method according to the MEMORY parameter value.

    USE_STRICT_MEMORY=N

1.12. USE_ALTERNATIVE_TP_TYPE

How to express the TP data format of positive numbers.

  • Properties

    Property Description

    Data type

    String

    Default value

    N

    Range

    Y | N

  • Setting Values

    • If set to N,

      the last digit of a positive number is converted as follows:

      '0'->'{', '1'->'A', '2'->'B', '3'->'C', '4'->'D', '5'->'E', '6'->'F', '7'->'G', '8'->'H', '9'->'I'

    • If set to Y,

      the last digit of a positive number is converted as follows. The last digit of a positive number in the ZD data format is also converted as follows:

      '0'->'0', '1'->'1', '2'->'2', '3'->'3', '4'->'4', '5'->'5', '6'->'6', '7'->'7', '8'->'8', '9'->'9'

1.13. SUM_OVERFLOW_OPTION

Action to take when a summary field overflow occurs.

  • Properties

    Property Description

    Data type

    String

    Default value

    RC4

    Range

    RC0 | RC4 | RC16

  • Example

    The following sets the return value to 0 and continuously performs the summary operation. The record with the overflow is excluded from the operation.

    SUM_OVERFLOW_OPTION=RC0

    The following sets the return value to 4 and continuously performs the summary operation. The record with the overflow is excluded from the operation.

    SUM_OVERFLOW_OPTION=RC4

    The following stops the summary operation and returns 16.

    SUM_OVERFLOW_OPTION=RC16

1.14. USE_BI_KEY_CONV

Option to use a conversion function for BI data sorting. It is recommended to use the function only when BI data error occurs.

  • Properties

    Property Description

    Data type

    String

    Default value

    N

    Range

    Y | N

1.15. USE_CH_EBCDIC

Option to use either EBCDIC or ASCII character set for CH data sorting.

  • Properties

    Property Description

    Data type

    String

    Default value

    N

    Range

    Y | N

  • Example

    The following uses EBCDIC.

    USE_CH_EBCDIC=Y

    The following uses ASCII.

    USE_CH_EBCDIC=N

1.16. USE_BI_EBCDIC

Option to use either EBCDIC or ASCII character set for BI data sorting.

  • Properties

    Property Description

    Data type

    String

    Default value

    N

    Range

    Y | N

  • Example

    The following uses EBCDIC.

    USE_BI_EBCDIC=Y

    The following uses ASCII.

    USE_BI_EBCDIC=N

1.17. USE_AQ_EBCDIC

Option to use either EBCDIC or ASCII character set as a base sequence for AQ data sorting.

  • Properties

    Property Description

    Data type

    String

    Default value

    N

    Range

    Y | N

  • Example

    The following uses EBCDIC.

    USE_AQ_EBCDIC=Y

    The following uses ASCII.

    USE_AQ_EBCDIC=N

1.18. EBCDIC_CODEPAGE

Code page used when sorting EBCDIC.

  • Properties

    Property Description

    Data type

    String

    Default value

    CP500

    Range

    EBCDIC | CP500 | CP298

  • Example

    The following uses the code page 298 when sorting EBCDIC.

    EBCDIC_CODEPAGE=CP298

1.19. USE_OF_CONVERSION_RULE

Option to use OpenFrame EBCDIC conversion rules.

  • Properties

    Property Description

    Data type

    String

    Default value

    N

    Range

    Y | N

  • Example

    The following uses OpenFrame EBCDIC conversion rules.

    USE_OF_CONVERSION_RULE=Y

1.20. OF_CPM

CPM to use when OpenFrame EBCDIC conversion rules are enabled.

  • Properties

    Property Description

    Data type

    String

    Default value

    ASCEBCUS

    Range

    OpenFrame CPM

  • Example

    The following specifies OpenFrame CPM.

    OF_CPM=ASCEBCUS

2. Other Parameters

The following parameters are not related to ProSort performance.

Parameter Description

USE_DEFAULT_EQUALS

Option to perform a stable sort even when the EQUALS option is not specified in a script. (Default value: N)

CHECK_DATA_VALIDATION

Option to perform data validity checks based on the data type. (Default value: N)

USE_DEFAULT_LASTDUP_IN_SUM

Option to make the SUM operation behave as if the LASTDUP option were specified, even when it is not explicitly specified in the script. (Default value: N)

SPARM_DATE

Date to be used instead of the system date when DATE-related options are used.

2.1. USE_DEFAULT_EQUALS

Option to perform a stable sort even when the EQUALS option is not specified in a script.

  • Properties

    Property Description

    Data type

    String

    Default value

    N

    Range

    Y | N

  • Values

    Value Description

    Y

    Performs a stable sort.

    N

    Does not performs a stable sort. (Default)

2.2. CHECK_DATA_VALIDATION

Option to perform data validity checks based on the data type.

  • Properties

    Property Description

    Data type

    String

    Default value

    N

    Range

    Y | N

  • Values

    Value Description

    Y

    Performs validity checks based on the data type. If the data is invalid an error occurs.

    N

    Does not perform validity checks based on the data type. (Default)

2.3. USE_DEFAULT_LASTDUP_IN_SUM

Option to make the SUM operation behave as if the LASTDUP option were specified, even when it is not explicitly specified in the script.

  • Properties

    Property Description

    Data type

    String

    Default value

    N

    Range

    Y | N

  • Values

    Value Description

    Y

    Implicitly applies LASTDUP when performing a SUM operation.

    N

    Does not implicitly apply LASTDUP when performing a SUM operation. (Default)

2.4. SPARM_DATE

Date to be used instead of the system date when DATE-related options are used.

  • Properties

    Property Description

    Data type

    Integer

    Default value

    0

    Range

    0 ~ 99991231

    Remarks

    The format is YYYYMMDD.

    If the SPARM_DATE parameter is not specified, or is set to 0 or 00000000, the system date is used.