StartQuery

com.apama.database
Event StartQuery

Sent to adapter to start a database query.

See also: QueryStatus(), ResultSchema(), ResultEvent()

Response: QueryStatus(), ResultSchema(), ResultEvent()

Dataplayer:
- Direction: Client to correlator.

Field summary
`integer`	`messageId` Unique id for this query.
`string`	`serviceId` The service id, Adapter channel name.
`integer`	`databaseId` Database connection id.
`string`	`query` Query to run (either query string or name).
`boolean`	`namedQuery` True if this is a named query.
`dictionary<string, string>`	`namedQueryParameters` Parameters for a named query.
`string`	`returnType` Return Event Type should be one of: Native, Historical, ResultEvent, ResultEventHetero.
`string`	`eventType` Event type (name) for use in mapping rules, needed when using Native returnType.
`boolean`	`backtest` Indicates Query is being used for backtest.
`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.
`string`	`timeColumn` Column to use for backtest time attribute, not needed if column name is "time".
`float`	`runUntilTime` Stop the query and send a BatchDone if the event time > runUntilTime.
`integer`	`preparedQueryId` PreparedQuery to run.
`sequence<string>`	`inputParameters` Input parameters for preparedQuery.
`dictionary<string, string>`	`extraParams` This is currently a container to allow additional information in the future.

Field detail

backtest

boolean backtest

Indicates Query is being used for backtest.

 This requires:
 1. Only one can be running per database per adapter. 
 2. All queries must be time sorted. 
 3. The IAF must be able to identify the time attribute 
 for all types and possible tie breaker attribute.

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.

databaseId

integer databaseId

Database connection id.

eventType

string eventType

Event type (name) for use in mapping rules, needed when using Native returnType.

extraParams

dictionary<string, string> extraParams

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

inputParameters

sequence<string> inputParameters

Input parameters for preparedQuery.

messageId

integer messageId

Unique id for this query.

namedQuery

boolean namedQuery

True if this is a named query.

namedQueryParameters

dictionary<string, string> namedQueryParameters

Parameters for a named query.

preparedQueryId

integer preparedQueryId

PreparedQuery to run.

query

string query

Query to run (either query string or name).

returnType

string returnType

Return Event Type should be one of: Native, Historical, ResultEvent, ResultEventHetero.

runUntilTime

float runUntilTime

Stop the query and send a BatchDone if 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.

timeColumn

string timeColumn

Column to use for backtest time attribute, not needed if column name is "time".

com.apama.databaseEvent StartQuery