dt_hold

Daylight v4.9
Release Date: 1 February 2008

Name

dt_hold - mark an object as held

Generic Prototype

dt_hold(dt_Handle, dt_String) => dt_Boolean

C Prototype

#include "dt_thor.h"

dt_Boolean dt_hold(dt_Handle object, dt_Integer alen, dt_String auth_pw)

FORTRAN Prototype

include 'dt_f_thor.inc'

logical dt_f_hold(object, auth_pw)

integer*4 object
character*() auth_pw

Description

Marks the specified object as "held", so that it will be kept even if no client is using it. The 'object' may be a THOR or Merlin database or a Merlin column.

For a Merlin database (pool), this means the database will be retained in memory. For a Merlin column, it means the column will be retained (columns are normally shared among clients) for faster startup.

For a THOR database, it means the database's files will remain open, and if the database is partially or fully cached (see dt_cache(3) and dt_cachecontrol(3)), the cached data will remain in memory.

The password 'auth_pw' is that of user "thor", and must be supplied even if the client is connected as user "thor".

Note that this is an operation to manage the Merlin servers use of memory, as opposed to an object operation. Because of this, the authorization password for user "thor" rather than the database's executive password.

Return Value