Go to the first, previous, next, last section, table of contents.

An active module based dbserver with interface to SQL remote DBs

Version: 0.5#15 (2003/1/8, 13:32:17 CET)

Usage and interface (`dbserver`)

Library usage: This module is typically compiled as an active module (i.e., a server). Clients can access this server by using the active modules usage convention:
```
:- use_active_module(dbserver).
```
Exports:
- Predicates: db_handler/3, db_maintenance/3, dying/2, die/1.
- Multifiles: $is_persistent/2, persistent_dir/2, $is_sql_persistent/3, sql_persistent_location/2, relation/3, attribute/4.
Other modules used:
- System library modules: operators, pillow/http, pillow/html, persdb/persdbrt, persdb_mysql/persdbrt_mysql, det_hook/det_hook_rt, file_utils, lists, system, aggregates, dynamic, streams, read, write, terms, patterns, errhandle.
- Internal (engine) modules: internals, arithmetic, atomic_basic, attributes, basic_props, basiccontrol, data_facts, exceptions, io_aux, io_basic, prolog_flags, streams_basic, system_info, term_basic, term_compare, term_typing.

Documentation on exports (`dbserver`)

PREDICATE: db_handler/3:

Usage: db_handler(+Input,+Passwd,-Response)

Description: Used to provide an interface to the service requested by the generic client. Once this predicate identifies the required service, it calls the particular predicate that implements it.
Call and exit should be compatible with: +Input is a Pillow dictionary. (dic/1) +Passwd is an identifier for the client type. (passwd/1) -Response is an HTML page. (output_page/1)

PREDICATE: db_maintenance/3:

Usage: db_maintenance(+Input,+Passwd,-Response)

Description: According to the kind of user that calls this predicate, the system generates an interface which provides access to the whole of its services (in the administrator case) or to a restricted set of them (in the case of a common user). Typically used in installation time to automatically generate both common user and administrator front pages.
Call and exit should be compatible with: +Input is a Pillow dictionary. (dic/1) +Passwd is an identifier for the client type. (passwd/1) -Response is an HTML page. (output_page/1)

PREDICATE: dying/2:

Usage: dying(+ClientType,-Response)

Description: Implements with die the stop the system service. Before having halted the database server through die/1, this predicate is used to produce a message, pointing out that the system is about to be halted. Only authorised clients can use this service.
Call and exit should be compatible with: +ClientType is an identifier for the client type. (passwd/1) -Response is an HTML page. (output_page/1)

PREDICATE: die/1:

Once the database has been updated in order to keep all the information in a consistant state, it halts the database server. Only authorised clients can use this service.

Usage: die(ClientType)

Description: Used to kill the server (active module) after updating the database.
The following properties should hold at call time: ClientType is an identifier for the client type. (passwd/1)