Qorus Integration Engine® Enterprise Edition 6.0.25_prod
|
Back to the System Reference Manual Table of Contents
This section will outline Qorus system properties, which serve as a configuration store.
System properties are a domain-based key-value store that can be used to store persistent configuration information for Qorus interfaces. In the context of Qorus system properties, a "domain" is simply a name that groups together key-value pairs. Keys are strings, and values are any Qore value that can be serialized to YAML.
System Properties Overview
Component | Description |
domain | a string of up to 240 bytes used to group key-value pairs; domain names are unique and case-sensitive |
key | a string of up to 240 bytes that uniquely identifies a value within a domain; key names are case-sensitive |
value | Any Qore value that can be serialized to YAML in less or equal to than 4000 bytes |
SYSTEM_PROPERTIES
table in the Qorus system schema; the data size limitations listed in the table above are due to column constraints in this table.PROP-ERROR
exception to be thrown"omq"
domain is protected; it contains system reference information and cannot be updated.System properties can be created, updated, read, and deleted using REST APIs, internal function calls, and from the command line.
System Properties REST APIs
System Properties Functions
Method | Availability |
MapperApi::propGet() | Mappers |
UserApi::propGet() | All user server code (workflows, services, jobs) and the Qorus client library |
UserApi::propUpdate() | workflows, services, jobs and the Qorus client library |
System Properties Command-Line Programs
Program | Description |
oprop | The primary command-line interface to system properties; uses the REST API |
qrest | The raw REST client; can be used to query and set system properties directly with the REST API |
ocmd | The RPC command-line API interface; can be used to query and set system properties using the deprecated system.prop service |
qrest get system/props qrest get system/props/omq qrest get system/props/omq/value
string ds = UserApi::propGet("mydomain", "myds") ?? "default_value";
oprop get mydomain myds oprop set mydomain hash key1=value,key2=value