Discovery

FRAMES NO FRAMES

Overview

Package

Deprecated

Help

API Reference for EPL (ApamaDoc) 10.3.1.5

SUMMARY: IMPORT | CONSTANT | MEMBER | ACTION

DETAIL: IMPORT | CONSTANT | MEMBER | ACTION

com.apama.database
Event Discovery

Event containing the actions to perform discovery of ADBC adapter resources. This is used to find the available data sources (JDBC, Sim, etc.) and the default databases and query templates (named queries) configured for those data sources.

See findAvailableDataSources(), getDatabases() and getQueryTemplates()

Also see findAvailableDataSourcesFull(), getDatabasesFull() and getQueryTemplatesFull() for versions of the calls that accept the complete set of parameters.

Routes:: com.apama.database.RequestDataSources -; com.apama.database.RequestDatabases -; com.apama.database.RequestNamedQueries -

Listens:: com.apama.database.DataSources -; com.apama.database.Databases -; com.apama.database.NamedQueries -

Action summary
`void`	`findAvailableDataSources(float timeout, action<string, sequence<com.apama.database.DataSource>> callback)` Search for available DataSources.
`void`	`findAvailableDataSourcesFull(float timeout, dictionary<string, string> extraParams, action<string, sequence<com.apama.database.DataSource>> callback)` Search for available DataSources, This action allows you to pass in any extra parameters.
`void`	`findAvailableServers(float timeout, action<string, sequence<com.apama.database.DataSource>> callback)` Find the availale DataSources. Deprecated: [This action has been deprecated due to the misleading name. Please use findAvailableDataSources instead as it is identical in functionality and a more acurately named action.]
`void`	`findAvailableServersFull(float timeout, dictionary<string, string> extraParams, action<string, sequence<com.apama.database.DataSource>> callback)` Find the available data sources. Deprecated: [This action has been deprecated due to the misleading name. Please use findAvailableDataSourcesFull instead as it is identical in functionality and a more acurately named action.]
`void`	`getDatabases(string serviceId, string user, string password, action<string, sequence<com.apama.database.Database>> callback)` Get the available Databases on a serviceId, using the service Id(s) returned from findAvailableDataSources.
`void`	`getDatabasesFull(string serviceId, string locationURL, string user, string password, dictionary<string, string> extraParams, action<string, sequence<com.apama.database.Database>> callback)` Get the available Databases on a serviceId, using the service Id(s) returned from findAvailableDataSources.
`void`	`getNamedQueries(string serviceId, action<string, sequence<com.apama.database.NamedQuery>> callback)` Provides details of all the loaded named queries.
`void`	`getNamedQueriesFull(string serviceId, dictionary<string, string> extraParams, action<string, sequence<com.apama.database.NamedQuery>> callback)` Provides details of all the loaded named queries. This action allows you to pass in any extra parameters.
`void`	`initPreSpawnContext(context preSpawnContext)` Set context that is current prior to spawning.
`void`	`onBeginRecovery()` OnBeginRecovery is called after all objects and listeners of persistent monitors have been recovered and before queued events are processed.

Action detail

findAvailableDataSources

void findAvailableDataSources(float timeout, action<string, sequence<com.apama.database.DataSource>> callback)

Search for available DataSources.

Parameters:: timeout - The find Datasources timesout.; callback - User defined action called when the current action completes.

See findAvailableDataSourcesFull()

findAvailableDataSourcesFull

void findAvailableDataSourcesFull(float timeout, dictionary<string, string> extraParams, action<string, sequence<com.apama.database.DataSource>> callback)

Search for available DataSources, This action allows you to pass in any extra parameters.

Parameters:: timeout - The find Datasources timesout.; extraParams - This is currently a container to allow additional information in the future.; callback - User defined action called when the current action completes.

Routes:: com.apama.database.RequestDataSources -

Listens:: com.apama.database.DataSources -

findAvailableServers

void findAvailableServers(float timeout, action<string, sequence<com.apama.database.DataSource>> callback)

Deprecated:: [This action has been deprecated due to the misleading name. Please use findAvailableDataSources instead as it is identical in functionality and a more acurately named action.]

Find the availale DataSources.

Parameters:: timeout; callback

findAvailableServersFull

void findAvailableServersFull(float timeout, dictionary<string, string> extraParams, action<string, sequence<com.apama.database.DataSource>> callback)

Deprecated:: [This action has been deprecated due to the misleading name. Please use findAvailableDataSourcesFull instead as it is identical in functionality and a more acurately named action.]

Find the available data sources.

Parameters:: timeout; extraParams; callback

getDatabases

void getDatabases(string serviceId, string user, string password, action<string, sequence<com.apama.database.Database>> callback)

Get the available Databases on a serviceId, using the service Id(s) returned from findAvailableDataSources.

Parameters:: serviceId - The serviceId to search on.; user - The user Id for the database (if required).; password - The password to the database (if required).; callback - User defined action called when the current action completes.

See getDatabasesFull()

getDatabasesFull

void getDatabasesFull(string serviceId, string locationURL, string user, string password, dictionary<string, string> extraParams, action<string, sequence<com.apama.database.Database>> callback)

Get the available Databases on a serviceId, using the service Id(s) returned from findAvailableDataSources.

Parameters:: serviceId - The serviceId to search on.; locationURL - The location of the database.; user - The user Id for the database (if required).; password - The password to the database (if required).; extraParams - This is currently a container to allow additional information in the future.; callback - User defined action called when the current action completes.

Routes:: com.apama.database.RequestDatabases -

Listens:: com.apama.database.Databases -

getNamedQueries

void getNamedQueries(string serviceId, action<string, sequence<com.apama.database.NamedQuery>> callback)

Provides details of all the loaded named queries.

Parameters:: serviceId - The serviceId to search on.; callback - User defined action called when the current action completes.

see getNamedQueriesFull()

getNamedQueriesFull

void getNamedQueriesFull(string serviceId, dictionary<string, string> extraParams, action<string, sequence<com.apama.database.NamedQuery>> callback)

Provides details of all the loaded named queries. This action allows you to pass in any extra parameters.

Parameters:: serviceId - The serviceId to search on.; extraParams - This is currently a container to allow additional information in the future.; callback - User defined action called when the current action completes.

Routes:: com.apama.database.RequestNamedQueries -

Listens:: com.apama.database.NamedQueries -

initPreSpawnContext

void initPreSpawnContext(context preSpawnContext)

Set context that is current prior to spawning.

Optional: Only needed when using parallel processing.

Parameters:: preSpawnContext - Current context prior to spawning.

onBeginRecovery

void onBeginRecovery()

OnBeginRecovery is called after all objects and listeners of persistent monitors have been recovered and before queued events are processed.