Introduction to Data Type Definitions in Qorus

Data types in Qorus are based on the AbstractDataProviderType class in the DataProvider module.

This class supports type-safe data exchanges in Qorus.

The following Qorus objects support data type definitions:

Classes support connectors that have defined input and output types
Config items have a defined data type for the config item value
Data pipelines support input and output types for each pipeline element
Finite state machines / flows support the definition of input and output types for the finite state machine itself, for each state, and for internal blocks
Mappers provide a data transformation object from an input type to an output type, and each field in mapper input or output also has a defined type
Services support defined API handlers that define and enforce request and response types on each service method or ech service finite state machine used to serve API endpoints
Workflows allow for the static data type to be defined

Data Type Paths

Qorus manages type definitions (with DataProviderTypeCache) with a unique path name to the type.

Example Builtin Qorus Data Types

Type Path	Description
`qore/bool`	base boolean type; based on QoreBoolDataType
`qore/binary`	base binary type; based on QoreBinaryDataType
`qore/date`	base date/time type (can be absolute or relative); based on QoreDateDataType
`qore/float`	base floating-point number type; based on QoreFloatDataType
`qore/hash`	base hash type (set key-value pairs); based on HashDataType
`qore/int`	base integer type; based on QoreIntDataType
`qore/number`	base arbitrary-precision number type; based on QoreNumberDataType
`qore/string`	base string type; based on QoreStringDataType
`qoretechnologies/qorus-api/workflows/create-order/request`	the data type required for a create-order call
`qoretechnologies/qorus-api/workflows/create-order/response`	the data type returned from a create-order call

The type hierarchy is quite large; the above table provides only a representative sample of a subset of the types provided by Qorus.

Types can be queried with the REST API with GET /api/latest/dataprovider/types, created with POST /api/latest/dataprovider/types, and compared with GET /api/latest/dataprovider/types/.../{type}/type?action=compare, for example.

Additionally, types can be browsed with the UI as in the following image.

Data Type List in the UI

Data type defails can be viewed with the UI as well as in the following image.

Data Type Details in the UI

Data Type Definitions in the IDE

In the IDE, custom, user-defined hash types can be defined, which can define the record type for record sets or the type of a simple hash, for example to defined input or output data for a class connectors or finite state machine state, block, or the FSM itself, or as the input or output of a mapper, etc.

Data Type Definitions in the IDE

The path of the data type will uniquely identify the type, and the user can then add the fields to the type to define a record or a simple hash for use elsewhere in other Qorus objects.

Data Type Field Details in the IDE

Table of Contents

Introduction to Data Type Definitions in Qorus

Data Type Paths

Data Type Definitions in the IDE