GetNextBatch

FRAMES NO FRAMES

Overview

Package

Deprecated

Help

API Reference for EPL (ApamaDoc) 10.11.3.3

SUMMARY: IMPORT | CONSTANT | MEMBER | ACTION

DETAIL: IMPORT | CONSTANT | MEMBER | ACTION

com.apama.database
Event GetNextBatch

Sent to the adapter to request the next rowLimit set of events from a running query.

Must be sent after a BatchDone message to get additional events from the query. If conflicting settings are used (both batchSize and runUntilTime non-zero) a BatchDone with reason invalidGetNextBatch will be returned.

See also: StartQuery(), QueryDone(), BatchDone()

Dataplayer:
- Direction: Client to correlator

Member summary
`integer`	`messageId` Unique id for this query.
`string`	`serviceId` The service id, Adapter channel name.
`float`	`statusFrequency` Generate a status event every n seconds. If n <= 0.0 no status event is generated.
`integer`	`batchSize` Max events to send before waiting for GetNextBatch.
`boolean`	`batchSizeIncludesTimeEvents` If true the batch size will count &Time events, if false it will not.
`float`	`backtestSpeed` Speed for back testing: <= 0.0, as fast as possible, > 0.0 -> some multiple of playback speed.
`float`	`runUntilTime` Stop the query and send a BatchDone in the event time >= runUntilTime.
`dictionary<string, string>`	`extraParams` This is currently a container to allow additional information in the future.

Member detail

backtestSpeed

            float backtestSpeed

Speed for back testing: <= 0.0, as fast as possible, > 0.0 -> some multiple of playback speed.

batchSize

            integer batchSize

Max events to send before waiting for GetNextBatch.

batchSizeIncludesTimeEvents

            boolean batchSizeIncludesTimeEvents

If true the batch size will count &Time events, if false it will not.

extraParams

            dictionary<string, string> extraParams

This is currently a container to allow additional information in the future.

messageId

            integer messageId

Unique id for this query.

runUntilTime

            float runUntilTime

Stop the query and send a BatchDone in the event time >= runUntilTime.

serviceId

            string serviceId

The service id, Adapter channel name.

statusFrequency

            float statusFrequency

Generate a status event every n seconds. If n <= 0.0 no status event is generated.