CloseDatabase

FRAMES NO FRAMES

Overview

Package

Deprecated

Help

API Reference for EPL (ApamaDoc) 10.5.4.1

SUMMARY: IMPORT | CONSTANT | MEMBER | ACTION

DETAIL: IMPORT | CONSTANT | MEMBER | ACTION

com.apama.database
Event CloseDatabase

Request an open Database be closed, freeing up resources. CloseDatabase will succeed if the database is not currently open.

See also: DatabaseOperationAck()

Response event: DatabaseOperationAck(); errorMessage is blank on success.

Dataplayer:
- Direction: From client to the correlator.

Member summary
`integer`	`messageId` Unique request-response matching number.
`string`	`serviceId` The service Id this database is on.
`integer`	`databaseId` Database connection to close.
`boolean`	`force` Force the adapter to close even if the reference count is not zero.
`dictionary<string, string>`	`extraParams` Any additional parameters.

Member detail

databaseId

integer databaseId

Database connection to close.

extraParams

dictionary<string, string> extraParams

Any additional parameters.

force

boolean force

Force the adapter to close even if the reference count is not zero.

messageId

integer messageId

Unique request-response matching number.

serviceId

string serviceId

The service Id this database is on.