Kill

Purpose Terminates a repository session or flushes an object from the DMCL cache.

Syntax

dmAPIExec(“kill,session,session_to_kill[,immediacy_level]

[,message]“)

dmAPIExec(“kill,session,object_id”)

Arguments

Table Kill method arguments

Argument Description

session Identifies the current repository session.

session_to_kill Identifies the repository session you want to terminate. Use

the session’s identifier. (You can obtain the identifier using the LIST_SESSIONS function.)

immediacy_level Defines the immediacy or impact to the end user of the

terminated session. This is a character string argument. Valid values are:

nice, which terminates the session when there are no more open transactions and collections after current request,

which terminates the session when it is finished executing the current request

unsafe, which terminates the session immediately

message A user-defined message that the server will place in the session log. The message can be up to 255 characters.

object_id Specifies an object to flush from the dmcl cache.

Return value

The Kill method returns TRUE if successful or FALSE if unsuccessful.

Usage notes

You must have Superuser user privileges to the use the Kill method.

Terminating sessions

Terminating a session nicely, after all transactions and collections are closed is the least

disruptive. Users and client are functionally unaffected, although users may notice

temporary performance degradation.

Terminating a session after the current request completes is safe and faster than waiting

for all transactions and collections to close. However, some transactions may not

complete and connections may be lost.

Terminating a session immediately, without regard for the status of transactions is

unsafe. If you stop a session the immediacy_level set to unsafe, you should monitor the

server for stability. For example, try to connect, look at some documents, or check the

server log. If the server appears compromised, shut down the server.

Flushing the DMCL cache

You can use the Kill method to flush an object from the DMCL cache. The client then

re-fetches the object. Use this to refresh an object’s attributes in a client application

display.

Related methods

Shutdown