Reference manuals

A full copy of each of the Polyhedra reference manuals is available in PDF format, by following the links on this page. For your convenience, some are also provided in web format for easier on-line viewing: these pages were generated by cutting and pasting from the same Microsoft Word document that was used to generate the PDF file, so there may be some missing text and diagrams, and there may be other artefacts generated by the conversion process. In case of conflict, the PDF version should be considered authoritative!

Alphabetical listing of the available manuals

Manuals grouped by purpose

The documentation supplied with Polyhedra is aimed chiefly at the configurer and the application writer. The documents assume that the readers have an understanding of computer languages and operating systems. Application users are referred to documents specific to the application.

General documents

These documents should be read by anyone new to the Polyhedra system.

  • Evaluation Guide
  • Start here!

    The Polyhedra Evaluation guide is the real starting point for using Polyhedra. It describes how to install and run the Polyhedra components, and then walks you through some demo material that illustrate some of the chief features of Polyhedra: you are strongly advised to follow through these steps for yourself. (Some of the demonstrations discussed are only applicable to certain editions of Polyhedra, but the guide points out where this is the case, and the comparison table indicates whether your edition of Polyhedra has the right features.)

    As well as being available for download from this web site, the evaluation guide is included in each Polyhedra release kit, along with a text file summarising the features that vary (in their availability) between different editions of Polyhedra.

  • Installation Guide
  • A quick guide on unpacking the Polyhedra kits and making them ready for use. As well as being available for download from this web site, the installation guide is included in each Polyhedra release kit.

  • Polyhedra Overview
  • The Polyhedra Overview manual gives a very brief summary of the features of Polyhedra, and its client-server nature.

  • Polyhedra User's Guide
  • Polyhedra user guide - general information on how to run the main Polyhedra executables: a description of 'resources' and of the configuration file format.

Component documents

Component documents describe the standard Polyhedra executables, plus their subcomponents. They contain some  introductory information, but they are mainly aimed at configurers and application writers.

  • Control Language Client (CLC)
  •  How to run the CLC executable, a stand-alone implementation of the CL engine.

  • Debugger Reference
  • How to use the Polyhedra debugger component of the RTRDB (and CLC). Note: the debugger is not available in all editions of Polyhedra.

  • Historic Data Logging
  • How to use the historian component of the RTRDB, that can be configured to generate time-stamped samples on a periodic basis or as data changes, and record them in files used in a circular fashion, for later retrieval. Note: the historian is not available in all editions of Polyhedra.

  • Real-Time Relational Database (RTRDB)
  • How to run the RTRDB executable, the Polyhedra database server, including information on using it in fault-tolerant configurations and with read-only replicas.

  • SQL Client (SQLC)
  • How to run the SQLC executable, a command-line SQL client application.

Polyhedra language guides

Polyhedra language guides contain the main source of information for application writers.

Class library definitions

These documents contain detailed information on Control Language classes provided by Polyhedra. They are of use to application writers designing trigger code to run as part of the database, or writing client applications that will be run using CLC (the stand-alone CL engine).

  • Schema Classes
  • CL classes in the CLC used to hold information about the classes known to the CLC. certain of the classes (such as object) are also available to those writing CL code to be directly attached to a database. 

  • Utility Classes
  • description of various built-in classes – timer, file, program, etc.

  • CL Communication Classes
  • Details of the TCP/IP and UDP communications classes available to the CL programmer.

Client interface definitions

These documents contain detailed information on the client interfaces provided by Polyhedra. They are of use to application writers. Apart from the proprietary callback API, the manuals listed below assume the reader is familiar with the API in question; they are reference manuals, not tutorials!

  • ADO.NET Data Provider

    A description of the Polyhedra ADO.NET data provider, including notes on Polyhedra-specific capabilities such as fault-tolerance, active queries and safe-commit. The data provider is only available for use on Windows. The manual assumes the reader is familiar with Microsoft .NET Framework

  • Callback API
  • Details of the C/C++ Callback Client API, with example code and a full description of each function provided. There is also a complementary Socket API which allows you to register extra socket with the client-side scheduler at the core of the Callback API support library.

  • Details of the JDBC API, with example Java code and a full description of each function provided. It is assumed that the reader has some familiarity with JDBC.

  • Details of the ODBC API with a full description of each function provided. It is assumed that the reader is familiar with ODBC.

  • OLE DB and ADO
  • How to run the Polyhedra OLE DB provider. It is assumed the reader is familiar with OLE DB.

  • Python DB-API

    Details of the Polyhedra Python DB-API module with a full description of the interface. It is assumed that the reader is familiar with Python.

Platform-specific Guides and the Embedded API

Most of Polyhedra is platform-independent. However, there are some minor features that are only available on a specific platform - for example, the ability to use a special transport mechanism for client-server communications, and these are documented in separate manuals each concentrating on a specific platform. These manuals can be found here. In addition, for expert users there is also:
  • The Embedded API
  • In certain editions of Polyhedra, the release kits come with sufficient components to allow you to tune the behaviour of the system, by providing alternate definitions of certain functions. By using this 'embedded API', you can, for example, intercept file system calls, redirect the log message output and decide on the volume of such messages, define your own watchdog function and configure the memory management code in the RTRDB. In some editions targeted at embedded systems, you even set up a warm restart capability.

Each of the reference manuals contain notices re copyright, disclaimers and trademarks, which also apply to the whole of this site and the Polyhedra Developer site - see the legal page on the developer site for more information.