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
 integermessageId

Unique id for this query.
 stringserviceId

The service id, Adapter channel name.
 integerdatabaseId

Database connection id.
 stringquery

Query to run (either query string or name).
 booleannamedQuery

True if this is a named query.
 dictionary<stringstring>namedQueryParameters

Parameters for a named query.
 stringreturnType

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

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

Indicates Query is being used for backtest.
 floatstatusFrequency

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

Max events to send before waiting for GetNextBatch.
 booleanbatchSizeIncludesTimeEvents

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

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

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

Stop the query and send a BatchDone if the event time > runUntilTime.
 integerpreparedQueryId

PreparedQuery to run.
 sequence<string>inputParameters

Input parameters for preparedQuery.
 dictionary<stringstring>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<stringstringextraParams
This is currently a container to allow additional information in the future.

inputParameters

sequence<stringinputParameters
Input parameters for preparedQuery.

messageId

integer messageId
Unique id for this query.

namedQuery

boolean namedQuery
True if this is a named query.

namedQueryParameters

dictionary<stringstringnamedQueryParameters
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".