8.7.2 Details of the parameters in the query group property file

This subsection provides the details of the parameters in the query group property file shown in 8.7.1(5) Specifiable parameters.

Organization of this subsection
(1) querygroup.cqlFilePath=query-group-definition-file-path
(2) querygroup.sleepOnOverStore=query-group-execution-sleep-time
(3) querygroup.sleepOnOverStoreRetryCount=number-of-times-to-check-output-stream-queue-for-available-space
(4) stream.filterCondition=conditional-expression
(5) stream.filterMode={unuse|condition}
(6) stream.freeInputQueueSizeThreshold=threshold-value-for-available-size-to-maximum-size-of-input-stream-queue
(7) stream.freeInputQueueSizeThresholdOutputMessage={true|false}
(8) stream.maxKeepTupleCount=maximum-number-of-tuples-retained-by-timestamp-adjustment-function
(9) stream.propertyFiles=stream-property-file-names
(10) stream.timestampAccuracy={{sec|msec|usec},time-adjustment-range|unuse}
(11) stream.timestampMode={Server|DataSource}
(12) stream.timestampPosition=time-data-column-name
(13) stream.tupleLogMode={true|false}
(14) tpl.backupFileCount=maximum-number-of-backup-generations-retained-for-tuple-log-file
(15) tpl.bufferCount=tupple-log-buffers-count
(16) tpl.bufferSize=maximum-tuple-log-buffer-size
(17) tpl.fileCount=maximum-tuple-log-files-count
(18) tpl.fileSize=maximum-tuple-log-file-size
(19) tpl.outputLevel=tuple-log-output-level
(20) tpl.outputTrigger={BUFFER|NONE}
(21) tpl.useOverwrite={true|false}

(1) querygroup.cqlFilePath=query-group-definition-file-path

This parameter specifies the path of the query definition file that defines the query group, expressed as an absolute path or a path relative to the working directory. If this parameter is omitted, the query group will not be registered.

(2) querygroup.sleepOnOverStore=query-group-execution-sleep-time

This parameter specifies as an integer from 1 to 2147483647 the period of time (in milliseconds) that execution of the query group is to be placed in the sleep mode when the SDP server's checking determines that there is no available space in the output stream queue.

This parameter takes effect if 1 or a greater value is specified in the querygroup.sleepOnOverStoreRetryCount parameter.

You can perform the following operations on the query group while it is in the sleep mode:

You can specify this parameter in the system configuration property file and the query group property file. If the parameter is duplicated or omitted, the specified value takes effect in the following order (1 > 2):

  1. Query group property file
  2. System configuration property file

(3) querygroup.sleepOnOverStoreRetryCount=number-of-times-to-check-output-stream-queue-for-available-space

This parameter specifies as an integer from 0 to 2147483647 the number of times the SDP server is to check the output stream queue for available space before it loads the tuples obtained from query execution to the output stream queue.

If the value 0 is specified, the SDP server loads the tuples obtained from query execution to the output stream queue without checking the output stream queue for available space.

If 1 or a greater value is specified, the SDP server performs the following processing as many times as specified:

  1. The SDP server checks whether there is room in the output stream queue.
  2. If there is no room in the output stream queue, the SDP server places execution of the query group that uses the output stream queue in the sleep mode. The length of the sleep time is specified in the querygroup.sleepOnOverStore parameter.
    When the sleep period expires, if this processing has not been performed as many times as specified in this parameter, the SDP server returns to step 1.
  3. If there is room in the output stream queue, the SDP server loads the tuples obtained from query execution into the output stream queue.

You can specify this parameter in the system configuration property file and the query group property file. If the parameter is duplicated or omitted, the specified value takes effect in the following order (1 > 2):

  1. Query group property file
  2. System configuration property file

(4) stream.filterCondition=conditional-expression

This parameter specifies a conditional expression for filtering in order to use the timestamp adjustment function to filter tuples. A specified conditional operation is performed on the contents of the column whose name is specified in the conditional expression and on a specified constant. As a result of the conditional operation, the timestamp adjustment function retains tuples satisfying the condition and discards tuples that do not satisfy the condition.

For details about how to specify the conditional expression, see 8.7.3 Coding rules for conditional expressions.

You must specify this parameter when you specify condition in the stream.filterMode parameter. If you specify unuse in the stream.filterMode parameter, this parameter is ignored, but its format is checked.

You can specify this parameter in the query group property file and the stream property file. If the parameter is duplicated or omitted, the specified value takes effect in the following order (1 > 2):

  1. Stream property file
  2. Query group property file

(5) stream.filterMode={unuse|condition}

This parameter specifies, as unuse or condition, whether the timestamp adjustment function is to be used to filter tuples. This value is not case sensitive. The default value is unuse.

unuse
Does not filter tuples.
condition
Filters tuples.
When you specify condition, you must also specify the stream.filterCondition parameter.

If you specify unuse in the stream.timestampAccuracy parameter, this parameter is ignored, but its format is checked.

You can specify this parameter in the query group property file and the stream property file. If the parameter is duplicated or omitted, the specified value takes effect in the following order (1 > 2):

  1. Stream property file
  2. Query group property file

(6) stream.freeInputQueueSizeThreshold=threshold-value-for-available-size-to-maximum-size-of-input-stream-queue

This parameter specifies a threshold value (%) for the available size with respect to the maximum number of elements used in the input stream queue as an integer from 1 to 99 (the engine.maxQueueSize parameter value specified in the system configuration property file).

When the condition shown below is satisfied, a SDPClientFreeInputQueueSizeThresholdOverException exception is thrown from the put(StreamTuple tuple) method or the put(ArrayList<StreamTuple> tuple_list) method. In such a case, loading of tuples into the input stream queue has been successful.

This parameter's value[Figure] ((available size of input stream queue[Figure] maximum size of the input stream queue) x 100)

If this parameter is omitted, an exception by threshold value checking will not occur.

When the sdptplput command is used to load tuples to the input stream queue, this parameter is ignored.

You can specify this parameter in the system configuration property file, the query group property file, and the stream property file. If the parameter is duplicated or omitted, the specified value takes effect in the following order (1 > 2 > 3):

  1. Stream property file
  2. Query group property file
  3. System configuration property file

(7) stream.freeInputQueueSizeThresholdOutputMessage={true|false}

This parameter specifies, as true or false, whether a warning messages (the KFSP42032-W message) is to be output to the SDP server's message log. This value is not case sensitive.

true
Outputs the warning message.
false
Does not output the warning message.

This parameter takes effect only when the stream.freeInputQueueSizeThreshold parameter is specified.

Note that the warning message is output only when true is specified in this parameter and the following condition is satisfied:

stream.freeInputQueueSizeThreshold parameter value[Figure] ((available size of input stream queue[Figure] maximum size of input stream queue) x 100)

You can specify this parameter in the system configuration property file, the query group property file, and the stream property file. If the parameter is duplicated or omitted, the specified value takes effect in the following order (1 > 2 > 3):

  1. Stream property file
  2. Query group property file
  3. System configuration property file

(8) stream.maxKeepTupleCount=maximum-number-of-tuples-retained-by-timestamp-adjustment-function

This parameter specifies as an integer from 1 to 1048576 the maximum number of tuples that can be retained by the timestamp adjustment function.

The number of tuples specified in this parameter is used as the maximum value for the timestamp adjustment function for each input stream.

When the number of tuples exceeds the value specified in this parameter, the query group is shut down.

You can specify this parameter in the system configuration property file, the query group property file, and the stream property file. If the parameter is duplicated or omitted, the specified value takes effect in the following order (1 > 2 > 3):

  1. Stream property file
  2. Query group property file
  3. System configuration property file

(9) stream.propertyFiles=stream-property-file-names

This parameter specifies the names of the stream property files when you specify properties for individual streams.

In specifying a file name in this parameter, do not include the path name. If you specify a path name, it will be handled as part of the file name.

To specify multiple file names, delimit them with the single-byte comma (,). An error results in the following cases:

If a stream property file is specified for a stream that does not exist in the query group, the specified file is still analyzed, but the definitions contained in it are ignored.

(10) stream.timestampAccuracy={{sec|msec|usec},time-adjustment-range|unuse}

This parameter specifies the time units and time adjustment range for the timestamp adjustment function. This value is not case sensitive.

You must specify this parameter when you specify DataSource in the stream.timestampMode parameter. If you specify Server in the stream.timestampMode parameter, this parameter is ignored, but its format is checked.

{sec|msec|usec},time-adjustment-range
Specifies the time units and time adjustment range. There must be no spaces or tabs preceding or following the single-byte comma (,) between the time units (sec, msec, or usec) and the time adjustment range. If you violate this rule, an error results. If you specify sec, msec, or usec as the time units and 0 as the time adjustment range, the time adjustment range is applied only to the reference time.
The meaning of each value is as follows:
sec
Specifies that seconds are to be used as the time units.
msec
Specifies that milliseconds are to be used as the time units.
usec
Specifies that microseconds are to be used as the time units.
time-adjustment-range
Specifies as an integer the range of times to be adjusted for timestamp adjustment. The permitted value range depends on the time units, as shown in the table below.
Time unitsPermitted value range
sec (seconds)Integer from 0 to 59
msec (milliseconds)Integer from 0 to 999
usec (microseconds)Integer from 0 to 999
unuse
Specifies that time adjustment is not to be performed.

You can specify this parameter in the system configuration property file, the query group property file, and the stream property file. If the parameter is duplicated or omitted, the specified value takes effect in the following order (1 > 2 > 3):

  1. Stream property file
  2. Query group property file
  3. System configuration property file

(11) stream.timestampMode={Server|DataSource}

This parameter specifies Server or DataSource as the timestamp mode to be used in timestamping tuples. This value is not case sensitive.

Server
Uses the server mode.
DataSource
Uses the data source mode.
If you specify DataSource, you must specify the stream.timestampAccuracy and stream.timestampPosition parameters.

You can specify this parameter in the system configuration property file and the query group property file. If the parameter is duplicated or omitted, the specified value takes effect in the following order (1 > 2):

  1. Query group property file
  2. System configuration property file

(12) stream.timestampPosition=time-data-column-name

This parameter specifies the name of the time-data column in tuples. This value is not case sensitive.

If you specify DataSource in the stream.timestampMode parameter, you must also specify this parameter. If you specify Server in the stream.timestampMode parameter, this parameter is ignored, but its format is checked.

The only data type that can be specified as time data is the TIMESTAMP type.

The permitted range of time data is from 1970/01/01 00:00:00.000000000 to 2261/12/31 23:59:59.999999999 in GMT (Greenwich Mean Time). If a specified time is outside this range, an exception occurs when the stream data is sent.

You can specify this parameter in the system configuration property file, the query group property file, and the stream property file. If the parameter is duplicated or omitted, the specified value takes effect in the following order (1 > 2 > 3):

  1. Stream property file
  2. Query group property file
  3. System configuration property file

(13) stream.tupleLogMode={true|false}

This parameter specifies, as true or false, whether the sdptplput command is to be enabled. This value is not case sensitive.

true
sdptplput command is to be executed.
false
Execution of the sdptplput command is to be disabled.

If you specify Server in the stream.timestampMode parameter and true in this parameter, an SDPClientException exception will occur if you then send stream data using the put method of the StreamInput interface.

You can specify this parameter in the system configuration property file and the query group property file. If the parameter is duplicated or omitted, the specified value takes effect in the following order (1 > 2):

  1. Query group property file
  2. System configuration property file

(14) tpl.backupFileCount=maximum-number-of-backup-generations-retained-for-tuple-log-file

This parameter specifies as an integer from 0 to 10 the maximum number of backup generations to be retained for the tuple log file.

You can specify this parameter in the system configuration property file, the query group property file, and the stream property file. If the parameter is duplicated or omitted, the specified value takes effect in the following order (1 > 2 > 3):

  1. Stream property file
  2. Query group property file
  3. System configuration property file

(15) tpl.bufferCount=tupple-log-buffers-count

This parameter specifies the number of tuple log buffers, as an integer from 3 to 512.

You can specify this parameter in the system configuration property file, the query group property file, and the stream property file. If the parameter is duplicated or omitted, the specified value takes effect in the following order (1 > 2 > 3):

  1. Stream property file
  2. Query group property file
  3. System configuration property file

(16) tpl.bufferSize=maximum-tuple-log-buffer-size

This parameter specifies as an integer from 1 to 2048000 the maximum size of a tuple log buffer (in kilobytes).

You can specify this parameter in the system configuration property file, the query group property file, and the stream property file. If the parameter is duplicated or omitted, the specified value takes effect in the following order (1 > 2 > 3):

  1. Stream property file
  2. Query group property file
  3. System configuration property file

(17) tpl.fileCount=maximum-tuple-log-files-count

This parameter specifies the maximum number of tuple log files, as an integer from 3 to 512.

You can specify this parameter in the system configuration property file, the query group property file, and the stream property file. If the parameter is duplicated or omitted, the specified value takes effect in the following order (1 > 2 > 3):

  1. Stream property file
  2. Query group property file
  3. System configuration property file

(18) tpl.fileSize=maximum-tuple-log-file-size

This parameter specifies the maximum size of a tuple log file (in megabytes), as an integer from 1 to 2048.

You can specify this parameter in the system configuration property file, the query group property file, and the stream property file. If the parameter is duplicated or omitted, the specified value takes effect in the following order (1 > 2 > 3):

  1. Stream property file
  2. Query group property file
  3. System configuration property file

(19) tpl.outputLevel=tuple-log-output-level

This parameter specifies the tuple log output level, as an integer from 1 to 3.

1
Outputs tuple logs for the tuples that are stored in the stream queue.
2
Outputs tuple logs for the tuples that are discarded due to an out-of-sequence time.
3
Outputs tuple logs for tuples with levels 1 and 2.

You can specify this parameter in the system configuration property file, the query group property file, and the stream property file. If the parameter is duplicated or omitted, the specified value takes effect in the following order (1 > 2 > 3):

  1. Stream property file
  2. Query group property file
  3. System configuration property file

(20) tpl.outputTrigger={BUFFER|NONE}

This parameter specifies BUFFER or NONE as the tuple log file output timing. This value is not case sensitive.

BUFFER
Outputs tuple logs to a file when the buffer being used to collect the current tuple logs in the target stream becomes full.
NONE
Does not output tuple logs to a file or perform buffering of tuple logs.

You can specify this parameter in the system configuration property file, the query group property file, and the stream property file. If the parameter is duplicated or omitted, the specified value takes effect in the following order (1 > 2 > 3):

  1. Stream property file
  2. Query group property file
  3. System configuration property file

(21) tpl.useOverwrite={true|false}

This parameter specifies, as true or false, whether a tuple log buffer is to be overwritten in the event it becomes full. This value is not case sensitive.

true
Overwrites the tuple log buffer.
false
Does not overwrite the tuple log buffer.

You can specify this parameter in the system configuration property file, the query group property file, and the stream property file. If the parameter is duplicated or omitted, the specified value takes effect in the following order (1 > 2 > 3):

  1. Stream property file
  2. Query group property file
  3. System configuration property file