ResultSchema

FRAMES NO FRAMES

Overview

Package

Deprecated

Help

API Reference for EPL (ApamaDoc) 10.15.1.2

SUMMARY: IMPORT | CONSTANT | MEMBER | ACTION

DETAIL: IMPORT | CONSTANT | MEMBER | ACTION

com.apama.database
Event ResultSchema

Event in response to the StartQuery event to indicate the result's schema.

Note: This event will be sent before the first ResultEvent and only if ReturnType is set to ResultEvent.

See also: StartQuery()

Dataplayer:
- Direction: Correlator to client

Channel: <serviceId>.Control

Member summary
`integer`	`messageId` Unique id for this query.
`string`	`serviceId` The service id, Adapter channel name.
`integer`	`schemaId` The id of the schema.
`sequence<string>`	`fieldOrder` The order of the fields in the schema.
`dictionary<string, string>`	`fieldTypes` The types of the fields in the schema.
`sequence<string>`	`indexFields` The index field(s) of this schema.
`dictionary<string, string>`	`extraParams` This is currently a container to allow additional information in the future.

Member detail

extraParams

dictionary<string, string> extraParams

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

fieldOrder

sequence<string> fieldOrder

The order of the fields in the schema.

fieldTypes

dictionary<string, string> fieldTypes

The types of the fields in the schema.

indexFields

sequence<string> indexFields

The index field(s) of this schema.

messageId

integer messageId

Unique id for this query.

schemaId

integer schemaId

The id of the schema.

serviceId

string serviceId

The service id, Adapter channel name.