How-to Guides‎ > ‎Some crib sheets‎ > ‎

Resource names

Polyhedra is a flexible DBMS. This means there are a lot of configuration parameters. While in general there are only two that are critical (where is the file holding the database snapshot plus any appended journal log records, and what is the access point or points - normally a TCP/IP port - through which clients access the database server managing a particular database) there are lots of others that can be specified. For convenience, these are usually gathered together in a file called poly.cfg in the directory in which the database server will operate, so that when something launches a command such as...

rtrdb db

...the Polyhedra server executable (called rtrdb or rtrdb.exe, depending on the platform) will 'look up' the entry point db in poly.cfg, and discover how it is to operate. It is also possible to add or override the resource definitions in poly.cfg from the command line by supplying one or more -r parameters, viz:

rtrdb -r data_service=8002 -r verbosity=4 db

A full description of this is given in the Polyhedra User Guide, which also contains a description of the main resource names understood by all the standard Polyhedra executables - but the description of the other resource names understood by the various Polyhedra components is scattered over the various reference manuals. For your convenience, then, this crib sheet gathers together all the resource names and presents them in alphabetical order, alone with an indication of the manual in which they can be found, the component to which they relate, and a copy of the description of the resource name (taken from the Polyhedra 8.6 reference manuals). While we have tried to make this list complete and accurate, there may well be errors and omissions; in the case of any conflict with the manuals, the manuals are to be taken as definitive! Before that, though, we shall list the executables that make use of this resource mechanism (and the resources they use), and then list the manuals that contain resource definitions (and the resources they define).

Contents

  1. 1 The executables that use the Polyhedra resource mechanism
    1. 1.1 CLC
    2. 1.2 fileutil
    3. 1.3 ODBC DBI
    4. 1.4 RTRDB
    5. 1.5 SQLC
  2. 2 Reference manuals that define resources
    1. 2.1 CL reference manual
    2. 2.2 CLC
    3. 2.3 Debugger
    4. 2.4 DVI subsystem
    5. 2.5 Polyhedra Embedded API
    6. 2.6 fileutil
    7. 2.7 Historian subsystem
    8. 2.8 ODBC DBI
    9. 2.9 RTRDB
    10. 2.10 SQLC
    11. 2.11 User Guide
  3. 3 Alphabetical list of resources
    1. 3.1 arbitrator_protocol
      1. 3.1.1 arbitrator _service
      2. 3.1.2 char _character _set
      3. 3.1.3 char _character _set
      4. 3.1.4 cl _disable
      5. 3.1.5 cl _disable _new _keywords
      6. 3.1.6 cl _exception _handler
      7. 3.1.7 cl _global _class
      8. 3.1.8 cl _ignore _local _constraint
      9. 3.1.9 cl _integer32 _compatibility
      10. 3.1.10 cl _library
      11. 3.1.11 cl _library _path
      12. 3.1.12 cl _memory _limit
      13. 3.1.13 cl _savefile
      14. 3.1.14 cl _stack _limit
      15. 3.1.15 data _service
      16. 3.1.16 data _service (clc)
      17. 3.1.17 data _service (odbc dbi)
      18. 3.1.18 data _service (rtrdb)
      19. 3.1.19 database
      20. 3.1.20 dataconnection _class
      21. 3.1.21 dataport _class
      22. 3.1.22 dataquery _class
      23. 3.1.23 dataquerymonitor _class
      24. 3.1.24 debug _level
      25. 3.1.25 debug _service
      26. 3.1.26 debug startup _file
      27. 3.1.27 default _poll _period
      28. 3.1.28 default _table _max
      29. 3.1.29 default _table _min
      30. 3.1.30 dvi _no _initial _poll
      31. 3.1.31 dvi _nulls _allowed
      32. 3.1.32 dvi _register _datum _with _values
      33. 3.1.33 dvi _suppress _initial _values
      34. 3.1.34 dvi _suppress _update _comparison
      35. 3.1.35 dvi _triggers _on
      36. 3.1.36 editor
      37. 3.1.37 enable _journalling
      38. 3.1.38 enable _parallel _allocator
      39. 3.1.39 enable _parallel _transactions
      40. 3.1.40 environment
      41. 3.1.41 environment (clc)
      42. 3.1.42 environment (sqlc)
      43. 3.1.43 error _text _detail
      44. 3.1.44 fileconvert
      45. 3.1.45 Filename
      46. 3.1.46 flash _cache _size
      47. 3.1.47 flash _convert _file
      48. 3.1.48 flash _file _extent
      49. 3.1.49 flash _file _max
      50. 3.1.50 flash _file _size
      51. 3.1.51 flash _page _size
      52. 3.1.52 flash _shrink _file
      53. 3.1.53 flash _swap _file
      54. 3.1.54 ft _enable
      55. 3.1.55 ft _heartbeat _interval
      56. 3.1.56 ft _heartbeat _timeout
      57. 3.1.57 ft _reconnect _count
      58. 3.1.58 ft _reconnect _interval
      59. 3.1.59 ftp _host
      60. 3.1.60 ftp _user
      61. 3.1.61 ftp _userpassword
      62. 3.1.62 include _file
      63. 3.1.63 journal _compression
      64. 3.1.64 journal _connect _count
      65. 3.1.65 journal _connect _interval
      66. 3.1.66 journal _connect _timeout
      67. 3.1.67 journal _failover _timeout
      68. 3.1.68 journal _heartbeat _check _interval
      69. 3.1.69 journal _heartbeat _interval
      70. 3.1.70 journal _heartbeat _timeout
      71. 3.1.71 journal _load _timeout
      72. 3.1.72 journal _queue _size
      73. 3.1.73 journal _replication _depth
      74. 3.1.74 journal _service
      75. 3.1.75 journal _session _queue _size
      76. 3.1.76 load _file (clc)
      77. 3.1.77 load _file (rtrdb)
      78. 3.1.78 load _file _directory
      79. 3.1.79 log _data _recovery
      80. 3.1.80 log _directory
      81. 3.1.81 log _dst _adjusted
      82. 3.1.82 log _long _timestamp
      83. 3.1.83 log _startup _info _level
      84. 3.1.84 log _streaming _thread _pool _size
      85. 3.1.85 memory _limit
      86. 3.1.86 memory _usage _limit
      87. 3.1.87 msg _queue _size
      88. 3.1.88 newfilename
      89. 3.1.89 other _journal _service
      90. 3.1.90 password
      91. 3.1.91 password
      92. 3.1.92 password
      93. 3.1.93 password _security _level
      94. 3.1.94 password (sqlc)
      95. 3.1.95 poll _periods
      96. 3.1.96 query _delta _all
      97. 3.1.97 query _delta _pk
      98. 3.1.98 query _disable _integer64
      99. 3.1.99 query _disable _integer64
      100. 3.1.100 query _processor
      101. 3.1.101 query _processor _connection _delay
      102. 3.1.102 query _processor _count
      103. 3.1.103 query _processor _port
      104. 3.1.104 quiet
      105. 3.1.105 quit _on _finish
      106. 3.1.106 ready _port
      107. 3.1.107 replica _queue _size
      108. 3.1.108 replication _service
      109. 3.1.109 root _class
      110. 3.1.110 safe _commit (clc)
      111. 3.1.111 safe _commit (rtrdb)
      112. 3.1.112 safe _commit (sqlc)
      113. 3.1.113 session _memory _limit
      114. 3.1.114 snapshot _on _shutdown
      115. 3.1.115 sql _default _transient _tables
      116. 3.1.116 sql _disable _v8 _3 _reserved _words
      117. 3.1.117 sql _function _file
      118. 3.1.118 suppress _building _dvi _tables
      119. 3.1.119 suppress _cl
      120. 3.1.120 suppress _dvi
      121. 3.1.121 suppress _local _dvi _drivers
      122. 3.1.122 suppress _log
      123. 3.1.123 suppress _standby _startup _snapshot
      124. 3.1.124 tcp _keepalive
      125. 3.1.125 thread _pool _initial
      126. 3.1.126 thread _pool _limit
      127. 3.1.127 thread _pool _size
      128. 3.1.128 transaction _processor _count
      129. 3.1.129 type (clc)
      130. 3.1.130 type (fileutil)
      131. 3.1.131 type (odbc dbi)
      132. 3.1.132 type (rtrdb)
      133. 3.1.133 type (sqlc)
      134. 3.1.134 unicode _convert
      135. 3.1.135 use _unique _indexes
      136. 3.1.136 username (clc)
      137. 3.1.137 username (odbc dbi)
      138. 3.1.138 username (sqlc)

The executables that use the Polyhedra resource mechanism

CLC

The CL bytecode interpreter, running as a client application (connected to 0 or more Polyhedra servers).
 
resources used by CLC:

fileutil

A utility program for operation on log files produced by the Polyhedra Historian. Note: this is a separately-licensed product, and the manual is distributed only to those who have purchased a license. It is only mentioned here for completeness.
 
resources used by fileutil:

ODBC DBI

A Polyhedra server that stores the data in a foreign database, access via its ODBC driver. Note: this is a separately-licensed product, and the manual is distributed only to those who have purchased a license. It is only mentioned here for completeness.

resources used by the ODBC DBI:

RTRDB

The main Polyhedra database server. Note: the executable (and the resources it understands) differs between different editions of the Polyhedra product - for example the Polyhedra Lite and Polyhedra Flash DBMS do not support the historian or the DVI modules, and Flash DBMS does not support fault-tolerant configurations or replica servers.

resources used by RTRDB:

SQLC

The Polyhedra SQL command-line client.

resources used by SQLC:

Reference manuals that define resources

CL reference manual

The resources defined in this manual:

CLC

The resources defined in this manual:

Debugger

The resources defined in this manual:

DVI subsystem

The resources defined in this manual:

Polyhedra Embedded API

The resources defined in this manual:

fileutil

The resources defined in this manual (which is not available online at present):

Historian subsystem

The resources defined in this manual:

ODBC DBI

The resources defined in this manual (which is not available online at present):

RTRDB

The resources defined in this manual:

SQLC

The resources defined in this manual:

User Guide

The resources defined in this manual:

Alphabetical list of resources

resource name manual in which it is documented executable in which it has meaning description

arbitrator_protocol

RTRDB RTRDB Specifies the protocol to be used between the RTRDB and arbitrator. If arbitrator_protocol is supplied, then so must arbitrator_service. The permitted values are: poly - the standard Polyhedra client-server protocol (the arbitrator will be implemented as a Polyhedra database, with one record for each server in a special table); ose - a simple OSE signal based protocol that does not require the arbitrator to be a Polyhedra database or require a TCP/IP stack to be available; tcp - a simple TCP/IP based protocol that does not require the arbitrator to be a Polyhedra database; and, linx - a simple LINX based protocol that does not require the arbitrator to be a Polyhedra database. poly and tcp are supported on all platforms; the other options are platform-specific.

arbitrator _service

RTRDB RTRDB Specifies the service by which the RTRDB connects to the arbitrator. If arbitrator_service is supplied, then the value of arbitrator_protocol determines how arbitrator_service is interpreted: poly - arbitrator_service contains either a standard Polyhedra data service name or a comma-separated list of data service names (this is the default: this protocol will be used if no value is supplied for the arbitrator_protocol resource); ose - arbitrator_service contains the name of the arbitrator process; tcp - arbitrator_service contains a TCP/IP port number; and, linx - arbitrator_service contains a LINX endpoint name. This resource is only required if the RTRDB is running as part of a fault tolerant configuration.

char _character _set

ODBC DBI ODBC DBI Specifies the character set used for translating Unicode columns in the host database. The only acceptable values are ASCII and UTF-8. The default value is ASCII.

char _character _set

RTRDB RTRDB Specifies the character set used by the SQL CHAR and VARCHAR and CL STRING data types. The allowable values are ASCII and UTF-8. The default value is ASCII.

cl _disable

CL reference RTRDB A Boolean resource used to disable the execution of CL. If set to true, no CL will be executed. For CL running in the RTRDB, the SQL SEND command will not have any effect. The default value is false.

cl _disable _new _keywords

CL reference CLC RTRDB A Boolean resource that disables the use of the CL reserved words added in version 2.3. If set to true, the words catch, locate, throw and try will not be reserved. The default value is false, enabling the use of the new keywords.

cl _exception _handler

CL reference CLC RTRDB The name of a CL class to instantiate as the run-time exception handler. The class specified must be derived from the predefined class ExceptionHandler. This is used to override the default behaviour of CL when it encounters a run-time error. See Utility Classes for more information.

cl _global _class

CL reference CLC The name of a CL class to be instantiated for the purpose of holding globally accessible attributes. If present, a single instance of the class is created before any other object. This object can be accessed from any CL handler using the special variable global.

cl _ignore _local _constraint

CL reference RTRDB A boolean resource used to suppress the execution of CL on a standby or replica database. The default is false.

cl _integer32 _compatibility

CL reference CLC RTRDB A Boolean resource provided for backwards compatibility. If set to true, the CL bit functions operate on 32-bits rather than 64-bits, truncating their arguments to 32-bits and sign extending their result to 64-bits. The default is false.

cl _library

CL reference CLC RTRDB A comma-separated list of CL source files to be loaded by CL on start up. The names can be specified with or without a path. If no path is given, the library is searched for in the list of CL library directories set up by the cl_library_path resource and the current directory.

cl _library _path

CL reference CLC RTRDB A comma-separated list of directory paths. Whenever CL loads a library file it looks for it in each of the directories specified in this list. If it cannot find it in any of those directories, it then looks in the current directory.

cl _memory _limit

RTRDB RTRDB The maximum amount of memory in bytes that may be allocated by the CL sub-system. If this limit is exceeded then the RTRDB will attempt to recover by resetting the CL sub-system. This memory will be included in the memory_limit resource if that is set. A zero value indicates the default behaviour of no CL memory limit.

cl _savefile

CLC CLC This resource specifies a .bcl file into which compiled CL is to be saved. Note that bcl files produced in this way are not portable to different platforms or different versions of Polyhedra.

cl _stack _limit

CL reference CLC RTRDB An integer resource specifying a stack size limit in bytes. If any CL thread uses more stack than the specified limit, a stack-overflow run-time exception is raised. The default value is 0, which specifies no limit. The limit is only checked each time a handler is called.

data _service

User Guide CLC ODBC DBI RTRDB SQLC A string resource containing the address(es) of a Polyhedra server or service. This specifies the access point(s) by which clients connect to the database service. This must be defined for a server. A client requires this resource if it is to connect to a server.

data _service (clc)

CLC CLC A string resource containing the address of a Polyhedra server. See Section 4 of the Polyhedra User's Guide for detailed explanation of this resource.

data _service (odbc dbi)

ODBC DBI ODBC DBI A string resource containing the address of the Polyhedra server. This specifies the name by which the server is known to the clients. See section 4 of the Polyhedra User's Guide for detailed explanation of this resource.

data _service (rtrdb)

RTRDB RTRDB A string resource containing the address of the Polyhedra server. This specifies the name by which the server is known to the clients. See section 4 of the Polyhedra User's Guide for detailed explanation of this resource.

database

ODBC DBI ODBC DBI Specifies the ODBC data source name (DSN) used to establish connection to the host database.

dataconnection _class

RTRDB RTRDB A string resource which conveys the name of an alternative table to be used for storing client connection details (see dataconnection class in the utility classes manual).

dataport _class

RTRDB RTRDB A string resource which conveys the name of an alternative table to be used for storing data service listening port details (see dataport class in the utility classes manual)

dataquery _class

RTRDB RTRDB A string resource which conveys the name of an alternative table to be used to show current active queries (see the dataquery class in the utility classes manual)

dataquerymonitor _class

RTRDB RTRDB A string resource which conveys the name of an alternative table to be used for defining criteria for monitoring active queries (see the dataquerymonitor class in the utility classes manual)

debug _level

ODBC DBI ODBC DBI An integer resource specifying the level of output generated for debugging purposes. The default value is 0, indicating that no debug output is generated. A value of 1 causes catalogue information and query trace debug to be generated.

debug _service

Debugger CLC RTRDB This is specified by the RTRDB (or CLC) to which the telnet session is to connect. There is no default value.

debug startup _file

Debugger CLC RTRDB The name of a file containing a sequence of commands that are automatically executed when a debugging session is initiated.

default _poll _period

ODBC DBI ODBC DBI An integer resource that specifies the default polling interval in seconds for active queries. The default value is 600. This can be overridden on a per table basis using the poll_periods resource.

default _table _max

RTRDB RTRDB (Flash DBMS only) The default maximum number of pages that may be allocated for a table. A value of 0 specifies that the number of pages is unlimited. The default value is 0. The value may be overridden using the WITH MAX table constraint.

default _table _min

RTRDB RTRDB (Flash DBMS only) The default number of pages allocated for a table when it is created. The default value is 10. The value may be overridden using the WITH MIN table constraint.

dvi _no _initial _poll

DVI RTRDB By default, a datum associated with a schedule is polled on database startup or when the datum is created. If the resource is set to true, the datum is first polled at the next time determined by the schedule record.

dvi _nulls _allowed

DVI RTRDB A boolean resource which, if set to true, allows force write of a datum to be sent to driver even though a writeable column is null.

dvi _register _datum _with _values

DVI RTRDB If this resource is set to true then the initial write of a datum's values is sent with the registration message for the datum instead of being sent separately. This can reduce the time taken to initialise an RTRDB with many datums. Not all drivers support this protocol; setting it for drivers that do not support this functionality may cause the driver to crash.

dvi _suppress _initial _values

DVI RTRDB If this resource is set to true then the initial write of a datum's values when it is created in the RTRDB is suppressed. Setting this value to true can improve performance when many datums are created at once.

dvi _suppress _update _comparison

DVI RTRDB Suppresses the comparison of datum updates sent from the driver to the RTRDB. This means that CL handlers in the RTRDB will be able to see all updates that the driver has sent rather than just seeing the changed values.

dvi _triggers _on

DVI RTRDB Monitors all system and driver specific columns in order to prevent the user from updating read-only columns. Allows writes to be sent to the driver as soon as column is updated (rather than waiting for forcewrite to be set to true).

editor

SQLC SQLC This is used in conjunction with the edit command. It holds the name of the editor to be invoked. The default is vi.

enable _journalling

RTRDB RTRDB (Polyhedra IMDB only) A boolean resource which if set activates the journalling capability of the RTRDB. The default value is false unless journal_service is specified in which case the default it true.

enable _parallel _allocator

RTRDB RTRDB A Boolean resource that when set (the default is true) activates the parallel memory allocation scheme. This scheme improves performance by efficiently providing memory to client sessions within the RTRDB. Setting this resource to false may reduce memory usage at the expense of performance. The parallel memory allocation scheme requires the allocator library (liballoc.a on Linux) to be linked into the RTRDB. The default RTRDB executable includes this library.

enable _parallel _transactions

RTRDB RTRDB (Polyhedra IMDB only) A Boolean resource which if set activates the parallel transaction mode.

environment

User Guide CLC RTRDB SQLC A string resource which can be set to indicate the "local" environment for a component. When data connection monitoring is enabled, this value appears in the env attribute of the DataConnection class (see Utility Classes manual).

environment (clc)

CLC CLC An environment string applied when connecting to a database. See section 4 of the Polyhedra users manual for further details.

environment (sqlc)

SQLC SQLC An environment string applied when connecting to a database. See section 4 of the Polyhedra users manual for further details.

error _text _detail

RTRDB RTRDB Specifies the levels of detail in the error text supplied with a transaction or query failure. The default value is 1.

fileconvert

fileutil fileutil A boolean resource indicating whether the utility should attempt to convert the file into one with the current format. The default for this resource is false. This resource takes precedence over that of the newfilename resource if there a conflict over whether or not the utility should attempt to convert a file. If this resource is set to true when the resource newfilename is not specified then a warning message will be generated and an output filename will be used which is unique within the local directory.If this resource is set to true when a file written in the current format is being read then a warning message will be generated.

Filename

fileutil fileutil A string resource giving the name of the file which contains Historic data. This resource is compulsory.

flash _cache _size

RTRDB RTRDB (Flash DBMS only) The amount of RAM reserved for the database cache and other necessary runtime information in bytes. The default value is 20480. The RTRDB will not start-up if the cache size specified is too small.

flash _convert _file

RTRDB RTRDB (Flash DBMS only) This resource optionally specifies a Polyhedra IMDB load file. The Flash DBMS database file (as specified normally with load_file) is initialised with the contents of this file. There are a number of unsupported configurations that will cause the RTRDB to terminate: the RTRDB is in FT mode; the load file contains any functionality not supported by Flash DBMS (e.g. domains, arrays); the load file contains journalled records (i.e. the load file must be created by a “SAVE INTO”); and, the load file contains CL and CL is enabled in the RTRDB (if CL is disabled, the CL in the load file is ignored). This conversion functionality requires the optional Fault Tolerance module. Please see the linking instructions for the relevant platform for how to link in this module.

flash _file _extent

RTRDB RTRDB (Flash DBMS only) The number of pages by which the size of the database file is increased when it is required to grow. A value of 0 specifies that the file cannot grow in size. The default value is 100. The resource is used when a database file is created or an existing database file is loaded.

flash _file _max

RTRDB RTRDB (Flash DBMS only) The maximum size of the database file in pages. A value of 0 specifies that the size of the file is unlimited. The default value is 0.

flash _file _size

RTRDB RTRDB (Flash DBMS only) The size of the database file in pages. The default value is 100. The resource is used when a database file is created and when the flash_shrink_file resource is set. This resource is ignored when an existing database file is used.

flash _page _size

RTRDB RTRDB (Flash DBMS only) The page size of the created database file in bytes. Acceptable values are 512, 1024, 2048, 4096 and 8192. The default value is 1024. The RTRDB will not start-up if an invalid page size is specified. For optimal performance, the page size must be a multiple of the block size used by the Flash memory. This resource is ignored when an existing database file is used.

flash _shrink _file

RTRDB RTRDB (Flash DBMS only) A Boolean resource specifying whether to shrink the database file. A value of “true” specifies that an attempt is made to reduce the size of the database file when it is loaded. The default value is ‘false’. The resource can be used in conjunction with the flash_file_size resource to shrink a database file to a given size. Note that this functionality depends on a file system's ability to truncate files and may not work correctly on all file systems (for example some OSE file systems).

flash _swap _file

RTRDB RTRDB (Flash DBMS only) A string resource that defines a file to receive database changes in swap file mode. The setting of this resource enables swap file mode. The value is affected by the load_file_directory resource. When set the load file is not written to, changes are written to the swap file in a non durable fashion and the number of writes to the file are minimised.

ft _enable

User Guide CLC RTRDB SQLC A boolean resource which if set to true causes fault tolerance to be enabled when connecting as a client. The default is false.

ft _heartbeat _interval

User Guide CLC RTRDB SQLC Specifies an interval in milliseconds between heartbeat messages. When connected, the client sends heartbeat messages to the server at this interval. The default value is 5000.

ft _heartbeat _timeout

User Guide CLC RTRDB SQLC Specifies a period in milliseconds within which the client expects a reply to a heartbeat message. If no reply is received in this period, the service is considered to have failed. The default value is 5000.

ft _reconnect _count

User Guide CLC RTRDB SQLC Specifies the number of times an attempt is made to connect to a service before the service is considered to be unavailable. The default value is 0.

ft _reconnect _interval

User Guide CLC RTRDB SQLC Specifies the interval in milliseconds between connection attempts. The default value is 0.

ftp _host

Embedded RTRDB Where to read files from. Requires additional code to be attached to the database server.

ftp _user

Embedded RTRDB for use with ftp_host resource

ftp _userpassword

Embedded RTRDB for use with ftp_host resource

include _file

SQLC SQLC Specifies the name of a file containing SQLC and SQL commands that will be read and submitted when the client has connected. The client will terminate once the SQL has been included.

journal _compression

historian RTRDB A boolean resource with a default value of false. If set, the Historian in a fault tolerant standby or a replica will request that it should be sent historical log file and archive file data in a compressed form during initial start-up.

journal _connect _count

RTRDB RTRDB Specifies the number of times an attempt is made by a replica RTRDB to connect to the journal service of a master or replica RTRDB. A value of 0 specifies an unlimited number of attempts. The default value is 10. Once a replica RTRDB has established its first connection, it will make an unlimited number of attempts to connect and reconnect to a standby or second replica RTRDB, irrespective of the setting of this resource.

journal _connect _interval

RTRDB RTRDB Specify in milliseconds the interval between connection attempts to a master or standby RTRDB made by a replica RTRDB. The default value is 5000.

journal _connect _timeout

RTRDB RTRDB Specifies in milliseconds the timeout for each connection attempt made by a standby or replica RTRDB. The default is 10000.

journal _failover _timeout

RTRDB RTRDB Specifies in seconds the timeout that a replica RTRDB uses when waiting for a standby RTRDB to be promoted to master. The default value is 60. A replica RTRDB terminates if it loses connection to the replication service whilst obtaining its initial snapshot.

journal _heartbeat _check _interval

RTRDB RTRDB Specifies in milliseconds the interval a journal server uses between checking its journal connections for heartbeat failure. A value of 0 disables checking. The default value is 1000. A journal server is aware of the heartbeat settings used by a journal client and if no heartbeat or other message is received within twice the specified interval, the server assumes the connection has failed and disconnects the client.

journal _heartbeat _interval

RTRDB RTRDB Specifies in milliseconds the interval between journal heartbeat messages. When a journal client is connected, it sends heartbeat messages to the server at this interval. A value of 0 disables heartbeats. The default value is 1000.

journal _heartbeat _timeout

RTRDB RTRDB Specifies in milliseconds a period within which a journal client expects a server to reply to a heartbeat message. If no reply or other message is received within this period, the client assumes the connection has failed and disconnects from the server. A value of 0 disables heartbeats. The default value is 5000.

journal _load _timeout

RTRDB RTRDB Specifies a timeout in milliseconds. A standby or replica database will wait for twice this period for new data before terminating when loading the initial snapshot from the master RTRDB. It will also wait for twice this period for the connection to master to be broken before terminating. The default value is 60000.

journal _queue _size

RTRDB RTRDB Specifies the number of transaction data buffers (each of size 4K bytes) that can be queued for journaling. If the queue fills up (due to not being emptied quickly enough), the next transaction will be blocked until there is room in the queue. The default value is 1000. When increasing the queue size you must be aware of the extra memory requirements. Each slot in the queue takes up 8 bytes on 32-bit platforms and 16 bytes on 64-bit platforms. An extra 4K bytes is used for each occupied slot.

journal _replication _depth

RTRDB RTRDB Specifies the maximum replication depth permitted for a particular configuration. The resource is only read by a standalone or master RTRDB and is communicated to and acted upon in any connected replica RTRDB. The default value is 2. A replica RTRDB will error and terminate if it reports a replication depth equal to the maximum replication depth and it is providing a journal service.

journal _service

RTRDB RTRDB Specifies the name of the data service on which the RTRDB listens for journal connections. Note that setting journal_service also enables the journalling capabilities of the RTRDB (see enable_journalling).

journal _session _queue _size

RTRDB RTRDB Specifies the number of transaction data buffers (each of size 4K bytes) that can be queued for sending to each standby and replica database. By default if the queue fills up (due to not being emptied quickly enough), the connection to the standby or replica will be disconnected. The default value is 1000. A value of 0 specifies that the queue blocks until the data has been sent. When increasing the queue size you must be aware of the extra memory requirements. Each slot in the queue takes up 8 bytes on 32-bit platforms and 16 bytes on 64-bit platforms. An extra 4K bytes is used for each occupied slot.

load _file (clc)

CLC CLC This resource specifies a .bcl file to load on startup. The file contains compiled CL. If the cl_library resource is set, then that resource takes precedence.

load _file (rtrdb)

RTRDB RTRDB This resource specifies a .dat file to load on start up. In Polyhedra IMDB, this file is overwritten whenever the contents of the database is saved to disk.
In the Flash DBMS product, If the file does not exist when the RTRDB starts-up, it is created. If it already exists, and is a valid database file, it is used. If no value is supplied for this resource, a default name of ‘poly.fdb’ is used, but any existing file named ‘poly.fdb’ is ignored and overwritten. This behaviour emulates that of the IMDB product as much as possible.

load _file _directory

RTRDB RTRDB Specifies the directory containing the journal files (and the Flash DBMS swap file if applicable). Defaults to the current directory.

log _data _recovery

historian RTRDB A boolean resource with a default value of true. When set to false, the Historian in a fault tolerant standby will not attempt to recover data from local log files which may not be stored elsewhere.

log _directory

historian RTRDB A string resource giving the default Historian directory. The Historian uses this directory to load and save all history data and archive files unless specifically directed otherwise. If omitted, the default directory is the current directory.

log _dst _adjusted

historian RTRDB A boolean resource with a default value of false. If set, the Historian will automatically adjust the compression period which is an exact multiple of one day when that period straddles a transition between standard and daylight saving time so that the compression period starts at the same local time of day.

log _long _timestamp

historian RTRDB A boolean resource with a default value of false. If set, the Historian will store the timestamp of each logged raw event with the maximum available granularity rather than recording an increment of centiseconds from the last full timestamp. Note when used with a fault tolerant configuration the resource should be set the same on every RTRDB (master, standby and replicas).

log _startup _info _level

historian RTRDB An integer resource with a default value of 0. This controls the production of statistics relating to Historian start-up, output by either a fault tolerant standby or a replica. The value of the resource specifies the level of detail included in the statistics as follows: 0 (the default value) - no statistics are output; 1 - summary statistics are output when start-up has completed that includes the time taken to start-up, the number of bytes transferred and the number of files synchronised, with subtotals for log and archive files; and, 2 - in addition to the summary statistics, progress statistics are output during the start-up. When the initial database snapshot has been transferred a message is output that includes the number of bytes transferred. Each time a file is transferred a message is output that includes the name of the file, the number of bytes synchronised so far, with percentages against total bytes, and number of files synchronised so far, with subtotals for log and archive files and a comparison against total number of files.

log _streaming _thread _pool _size

historian RTRDB An integer resource that sizes the pool of threads available to service requests from streaming API clients.

memory _limit

RTRDB RTRDB The memory usage limit (in bytes) above which the RTRDB will attempt to reduce memory usage as defined in the section on Memory Exhaustion Recovery in the RTRDB reference manual. A zero value indicates the default behaviour of no memory limit. This resource differs from the (deprecated) memory_usage_limit resource in that it will attempt to recover from the low-memory situation.

memory _usage _limit

RTRDB RTRDB This is deprecated and will be removed from a future release. If non-zero, this specifies in bytes a level of memory usage that if exceeded will cause the RTRDB to automatically terminate. When non-persistent memory usage exceeds the specified limit, the RTRDB generates a warning and performs an automatic termination at its earliest opportunity. Before doing so and also during the process of terminating its non-persistent memory usage may further exceed the limit. This feature is only available if fast memory allocation is used. The pre-built RTRDB executables do not use fast memory allocation and so the RTRDB must be re-linked to use this resource. On 64-bit systems a value greater than 2^32 is interpreted correctly.

msg _queue _size

RTRDB RTRDB An integer resource specifying the number of entries allocated in each internal message queue used by the RTRDB. Changing this value will affect the memory allocated by the RTRDB for client sessions. Note that setting the value too low may degrade the performance of the RTRDB. The default value is 1000. It is an error to set msg_queue_size to less than 2.

newfilename

fileutil fileutil A string resource giving the name of any output file. If this resource is specified then the utility will attempt to convert the file being read into one with the name given unless the fileconvert resource is set to false. In this case a warning message will be generated and no conversion will be attempted. If there is an existing file with the given name then a different filename will be used and a warning message will be generated.

other _journal _service

RTRDB RTRDB Specifies the name of the journal service on which the other RTRDB listens for connections. This resource is only required when configuring a fault tolerant system. Note that other_journal_service is ignored when using the OSE signal based arbitrator protocol. Instead, the journal service of the master database is supplied in the message from the arbitrator.

password

User Guide CLC ODBC DBI RTRDB SQLC A password used to authenticate the user specified by the username resource and establish a session on the client connection defined by the data_service resource. This is only required if security is enabled on the database.

password

CLC CLC A password used for authentication when connecting to a database with security enabled. See Section 4 of the Polyhedra users guide for further details.

password

ODBC DBI ODBC DBI The password used to connect to the host database. Although connection to some host databases may not require a username and password, a value for this resource must be supplied.

password _security _level

RTRDB RTRDB Specifies the method by which passwords are protected. If security is not enabled then the resource has no discernible effect. The default value is 0.

password (sqlc)

SQLC SQLC A password used for authentication when connecting to a database with security enabled. See Section 4 of the Polyhedra users guide for further details.

poll _periods

ODBC DBI ODBC DBI Specifies polling periods for individual tables. The value is a semicolon separated list of table poll period settings. For tables not included in the list, the value specified by the default_poll_period resource is used.

query _delta _all

RTRDB RTRDB A Boolean resource that changes the way active queries are handled by the database. Normally, when updates are reported to a client, the server only sends the changed attributes. When this resource is set to true, the all the attributes are also transmitted, regardless of whether they are changed. This affects the behaviour observed by all clients, and so should be used with caution, and only when use is being made of the callback API. The default is false.

query _delta _pk

RTRDB RTRDB A Boolean resource that changes the way active queries are handled by the database. Normally, when updates are reported to a client, the server only sends the changed attributes. When this resource is set to true, the primary key attributes are also transmitted, regardless of whether they are changed. This affects the behaviour observed by all clients, and so should be used with caution, and only when use is being made of the callback API. The default is false.

query _disable _integer64

ODBC DBI ODBC DBI A Boolean resource provided for backwards compatibility. If set to true, all queries return integer expressions as 32-bit. The default is false.

query _disable _integer64

RTRDB RTRDB A Boolean resource provided for backwards compatibility. If set to true, all queries return integer expressions as 32-bit. The default is false.

query _processor

ODBC DBI ODBC DBI Specifies either the full path name of the query processor executable or just the name of the executable. In the latter case, the PATH system environment variable is used to locate the executable. The default is qp.

query _processor _connection _delay

ODBC DBI ODBC DBI Specifies the number of milliseconds the ODBC DBI waits before attempting to connect to the query processor. The default value is 5000.

query _processor _count

ODBC DBI ODBC DBI An integer resource specifying the number of query processors used by the ODBC DBI for processing queries. The default is 1

query _processor _port

ODBC DBI ODBC DBI An integer resource specifying the first port number of the range of sequential port numbers allocated to each query processor by the ODBC DBI. The default is 10000.

quiet

fileutil fileutil A boolean resource indicating whether the file conversion utility will perform its action with only minimal output. The default for this resource is false. If this resource is set to false then the utility will display the file contents.

quit _on _finish

fileutil fileutil A boolean resource indicating whether the file conversion utility will quit immediately once it has completed its actions. The default for this resource is false. This resource only has any material effect on Windows platforms.

ready _port

RTRDB RTRDB Specifies a UDP port to which a single four-byte message (“POLY”) is sent when the database is ready to accept client connections. This resource is optional.

replica _queue _size

RTRDB RTRDB Specifies the number of transaction data buffers (each of size 4K bytes) that can be queued in the replica. If the queue fills up (due to it not being emptied quick enough), data from the server will be blocked until there is room in the queue, which can cause data to queue up at the server and eventually the replica connection to be closed. The default value is 1000. Values less than 1000 are ignored. When increasing the queue size you must be aware of the extra memory requirements. Each slot in the queue takes up 4 bytes which when occupied also uses an extra 4K per slot.

replication _service

RTRDB RTRDB (Polyhedra IMDB only) Specifies the name of the journal service(s) to which an RTRDB running in replica mode connects to obtain its journal stream. Use of the resource implies the RTRDB is running in replica mode.

root _class

CLC CLC CLC starts the application by creating a single instance of this class. This resource is compulsory.

safe _commit (clc)

CLC CLC A Boolean resource (default false) indicating whether transactions should be submitted in safe-commit mode.

safe _commit (rtrdb)

RTRDB RTRDB A boolean resource (with default false) indicating whether transactions performed through the internal connection or using a dataservice object should be submitted in safe-commit mode.

safe _commit (sqlc)

SQLC SQLC A boolean resource (default false) indicating whether transactions should be submitted in safe-commit mode. The resource is ignored when executing a CALL command.

session _memory _limit

RTRDB RTRDB The number of bytes that an individual client session may use before the RTRDB takes steps to reduce the memory consumption of the session – as defined in the section on Memory Exhaustion Recovery in the RTRDB reference manual. The memory accounted for by a client session is included in the total limited by the memory_limit resource. A zero value indicates the default behaviour of no session memory limit.

snapshot _on _shutdown

RTRDB RTRDB A boolean resource which if true forces the journal file to be saved on shutdown. Applies even if journaling is disabled. The default is false.

sql _default _transient _tables

RTRDB RTRDB A boolean resource which if true sets the default table column persistence to transient rather than persistent. The default is false.

sql _disable _v8 _3 _reserved _words

RTRDB RTRDB A boolean resource which if true disables the SQL reserved words LIMIT and OFFSET that were introduced in Polyhedra 8.3. Note that the functionality associated with these reserved words is also disabled. This resource is provided as a migration aid and may be withdrawn in later versions of Polyhedra.

sql _function _file

ODBC DBI ODBC DBI The name of a textual file containing the prototypes of the SQL functions supported by the host database.

suppress _building _dvi _tables

DVI RTRDB A boolean resource which, if set to true, prevents the DVI from creating DVI tables at start up.

suppress _cl

RTRDB RTRDB A boolean resource which if true prevents CL source being loaded and executed. The default is false.

suppress _dvi

DVI RTRDB A boolean resource which, if set to true, prevents the DVI from running.

suppress _local _dvi _drivers

DVI RTRDB A boolean resource which, if set to true, prevents automatic initialisation of built in DVI drivers.

suppress _log

RTRDB RTRDB (Polyhedra IMDB only) A boolean resource which if true disables the Historian subsystem. The default value is false.

suppress _standby _startup _snapshot

RTRDB RTRDB (Polyhedra IMDB only) A boolean resource which if true prevents a standby RTRDB from writing a snapshot when it connects to the master RTRDB. The resource only has any effect if journalling is disabled. The default value is false.

tcp _keepalive

RTRDB RTRDB A boolean resource which if true enables the setting of the SO_KEEPALIVE socket option on client TCP socket connections accepted by the RTRDB. The default value is false.

thread _pool _initial

RTRDB RTRDB An integer resource specifying the initial number of database threads. The default value is 1. It is an error to set thread_pool_initial to less than 1 or greater than thread_pool_limit.

thread _pool _limit

RTRDB RTRDB An integer resource specifying the maximum number of database threads. The default value is 1024. It is an error to set thread_pool_limit to less than thread_pool_initial.

thread _pool _size

RTRDB RTRDB An integer resource specifying the number of database threads. This specifies a fixed size thread pool and is an alternative to setting both thread_pool_initial and thread_pool_limit to the same value. It is an error to set thread_pool_size and either thread_pool_initial or thread_pool_limit.

transaction _processor _count

ODBC DBI ODBC DBI An integer resource specifying the number of query processors used by the ODBC DBI for processing transactions. The default is 1.

type (clc)

CLC CLC Specifies the type of Polyhedra component to be executed. It must be set to clc to run the CLC. This resource is compulsory.

type (fileutil)

fileutil fileutil This is used to specify the type of Polyhedra component to be executed. If it is supplied then it must be set to fileutil.

type (odbc dbi)

ODBC DBI ODBC DBI Specifies the type of Polyhedra component to be executed. It must be set to dbi. This resource is compulsory.

type (rtrdb)

RTRDB RTRDB This is used to specify the type of Polyhedra component to be executed. It must be set to rtrdb. This resource is compulsory.

type (sqlc)

SQLC SQLC This is used to specify the type of Polyhedra component to be executed. It must be set to sqlc. This resource is compulsory.

unicode _convert

fileutil fileutil A boolean resource indicating whether the utility should attempt to convert the file from an ASCII to Unicode. That is, from one using the ASCII character set to one using the UTF-8 character set. If this resource is set to true, the file specified by the filename resource is converted to use the UTF-8 character set. The file is converted without writing a new file. If the file contains any 8-bit ASCII (top-bit set) character data, an error is generated and the file is not converted.

use _unique _indexes

ODBC DBI ODBC DBI A boolean resource specifying whether to use unique indexes as pseudo primary keys.

username (clc)

CLC CLC A username used for authentication when connecting to a database with security enabled. See Section 4 of the Polyhedra users guide for further details.

username (odbc dbi)

ODBC DBI ODBC DBI The username used to connect to the host database. Although connection to some host databases may not require a username and password, a value for this resource must be supplied.

username (sqlc)

SQLC SQLC A username used for authentication when connecting to a database with security enabled. See Section 4 of the Polyhedra users guide for further details.