Qore AbstractDataField class definition. More...

Classes
class	AbstractDataField
	describes a data type based on a hashdecl More...

class	AbstractDataProcessor
	Defines an abstract class for accepting data and outputting optionally transformed or filtered data. More...

class	AbstractDataProvider
	The AbstractDataProvider class. More...

class	AbstractDataProviderBulkOperation
	Abstract bulk data operation class. More...

class	AbstractDataProviderBulkRecordInterface
	Defines the abstract class for data provider iterators; the destructor releases the iterator. More...

class	AbstractDataProviderFactory
	Data provider factory class. More...

class	AbstractDataProviderRecordIterator
	Defines the abstract class for data provider iterators; the destructor releases the iterator. More...

class	AbstractDataProviderType
	describes a data type More...

class	AbstractEventFilter
	This abstract class can be used to filter events that are raised on an Observer. More...

hashdecl	ActionOptionInfo
	Data provider action option definition. More...

hashdecl	DataFieldInfo
	describes a data type More...

class	DataProvider
	Data provider class. More...

class	DataProviderActionCatalog
	DataProvider action and application catalog class. More...

hashdecl	DataProviderActionInfo
	DataProvider action definition. More...

hashdecl	DataProviderAppInfo
	Application information hash. More...

hashdecl	DataProviderArgInfo
	Data provider expression arg info. More...

class	DataProviderBulkRecordIterator
	Defines the standard record iterator for bulk record iterators. More...

hashdecl	DataProviderConnectionInfo
	Data provider connection info. More...

hashdecl	DataProviderExpression
	Data provider expression. More...

hashdecl	DataProviderExpressionInfo
	Data provider signature info. More...

hashdecl	DataProviderFactoryInfo
	Data provider factory info. More...

hashdecl	DataProviderFieldReference
	Data provider field reference. More...

hashdecl	DataProviderInfo
	Data provider info. More...

hashdecl	DataProviderMessageInfo
	Data provider message and event info. More...

hashdecl	DataProviderOptionInfo
	Data provider option info. More...

hashdecl	DataProviderPathVarInfo
	DataProvider path var info. More...

class	DataProviderPipeline
	Defines a class for passing data through record processors. More...

class	DataProviderPipelineFactory
	A factory class for creating DataProviderPipeline objects. More...

hashdecl	DataProviderSignatureTypeInfo
	Data provider signature argument info. More...

hashdecl	DataProviderSummaryInfo
	Data provider summary info. More...

class	DataProviderTypeCache
	Data provider type cache class. More...

class	DataProviderTypeEntry
	the DataProviderTypeEntry class More...

hashdecl	DataProviderTypeEntryInfo
	Data provider type entry info. More...

hashdecl	DataProviderTypeOptionInfo
	describes type options More...

hashdecl	DataTypeInfo
	describes a data type More...

class	DefaultBulkInserter
	Default builk inserter class. More...

class	DefaultBulkRecordIterface
	Default bulk record interface class for data providers that do not support bulk read APIs. More...

class	DefaultBulkUpserter
	Default builk inserter class. More...

class	DefaultRecordIterator
	Default record iterator class for data providers that do not support custom read / search APIs. More...

class	DelayedObservable
	This class represents an observable subject that waits for external confirmation before raising events. More...

class	HashDataType
	describes a data type based on a hash More...

class	HashDeclDataType
	describes a data type based on a hashdecl More...

class	ImplicitModuleTransaction
	Implements a mechanism to roll back changes made in external module initialization if an error occurs. More...

class	ImpliedArgumentHelper
	Data provider implied argument helper. More...

class	ListDataType
	describes a data type based on a hash More...

hashdecl	NameDescInfo
	Name and description info. More...

class	NullDataProvider
	A dumrequest data provider that provides an empty hash as the request and response types. More...

class	NullDataProviderFactory
	The null data provider factory. More...

class	Observable
	This class represents an observable subject that will notify all of its registered observers. More...

class	Observer
	This abstract class represents an observer that will get notified by the subject it observes. More...

hashdecl	PipelineFactoryInfo
	Pipeline factory info. More...

hashdecl	PipelineInfo
	Pipeline info. More...

hashdecl	PipelineOptionInfo
	Pipeline option info. More...

class	PipelineQueue
	Pipeline element. More...

class	QoreBase64BinaryDataType
	describes a data type based on binary More...

class	QoreBase64BinaryOrNothingDataType
	describes a data type based on *binary More...

class	QoreBinaryDataType
	describes a data type based on binary More...

class	QoreBinaryDataTypeBase
	describes a data type based on binary types with validation for parsing strings when used with soft types More...

class	QoreBinaryOrNothingDataType
	describes a data type based on *binary More...

class	QoreBoolDataType
	describes a data type based on int More...

class	QoreBoolDataTypeBase
	describes a data type based on softint with validation for parsing strings More...

class	QoreBoolOrNothingDataType
	describes a data type based on *int More...

class	QoreDataField
	describes a data type based on a hashdecl More...

class	QoreDataType
	describes a data type based on a Qore data type More...

class	QoreDateDataType
	describes a data type based on date with output time zone support More...

class	QoreDateDataTypeBase
	describes a data type based on a date type with validation for string parsing and time zone support More...

class	QoreDateOrNothingDataType
	describes a data type based on softdate with validation for string parsing and time zone support More...

class	QoreFloatDataType
	describes a data type based on float More...

class	QoreFloatDataTypeBase
	describes a data type based on softnumber with validation for parsing strings More...

class	QoreFloatOrNothingDataType
	describes a data type based on *float More...

class	QoreHashDataType
	describes a data type More...

class	QoreHexBinaryDataType
	describes a data type based on binary More...

class	QoreHexBinaryOrNothingDataType
	describes a data type based on *binary More...

class	QoreIntDataType
	describes a data type based on int More...

class	QoreIntDataTypeBase
	describes a data type based on int types with validation for parsing strings when used with soft types More...

class	QoreIntOrNothingDataType
	describes a data type based on *int More...

class	QoreListDataType
	describes a data type based on a hash More...

class	QoreNumberDataType
	describes a data type based on number More...

class	QoreNumberDataTypeBase
	describes a data type based on number types with validation for parsing strings when used with soft types More...

class	QoreNumberOrNothingDataType
	describes a data type based on *number More...

class	QoreSignedByteDataType
	Signed byte data type for ints with values from -127 - 128. More...

class	QoreSignedByteOrNothingDataType
	Signed byte data type for ints with values from -127 - 128. More...

class	QoreSoftBinaryDataType
	describes a data type based on softbinary with validation for parsing strings More...

class	QoreSoftBinaryNoNullDataType
	describes a data type based on softbinary with validation for parsing strings More...

class	QoreSoftBinaryOrNothingDataType
	describes a data type based on *softbinary with validation for parsing strings More...

class	QoreSoftBoolDataType
	describes a data type based on softint with validation for parsing strings More...

class	QoreSoftBoolNoNullDataType
	describes a data type based on softint with validation for parsing strings More...

class	QoreSoftBoolOrNothingDataType
	describes a data type based on *softint with validation for parsing strings More...

class	QoreSoftDateDataType
	describes a data type based on softdate with validation for string parsing and time zone support More...

class	QoreSoftDateNoNullDataType
	describes a data type based on softdate with validation for string parsing and time zone support More...

class	QoreSoftDateOrNothingDataType
	describes a data type based on softdate with validation for string parsing and time zone support More...

class	QoreSoftFloatDataType
	describes a data type based on softfloat with validation for parsing strings More...

class	QoreSoftFloatNoNullDataType
	describes a data type based on softfloat with validation for parsing strings More...

class	QoreSoftFloatOrNothingDataType
	describes a data type based on *softfloat with validation for parsing strings More...

class	QoreSoftIntDataType
	describes a data type based on softint with validation for parsing strings More...

class	QoreSoftIntNoNullDataType
	describes a data type based on softint with validation for parsing strings More...

class	QoreSoftIntOrNothingDataType
	describes a data type based on *softint with validation for parsing strings More...

class	QoreSoftNumberDataType
	describes a data type based on softnumber with validation for parsing strings More...

class	QoreSoftNumberNoNullDataType
	describes a data type based on softnumber with validation for parsing strings More...

class	QoreSoftNumberOrNothingDataType
	describes a data type based on *softnumber with validation for parsing strings More...

class	QoreSoftSignedByteDataType
	Signed byte data type for ints with values from -127 - 128. More...

class	QoreSoftSignedByteOrNothingDataType
	Signed byte data type for ints with values from -127 - 128. More...

class	QoreSoftStringDataType
	describes a data type based on softstring with a target encoding More...

class	QoreSoftStringOrNothingDataType
	describes a data type based on *softstring with a target encoding More...

class	QoreSoftUnsignedByteDataType
	Unsigned byte data type for ints with values from 0 - 255. More...

class	QoreSoftUnsignedByteOrNothingDataType
	Unsigned byte data type for ints with values from 0 - 255. More...

class	QoreStringDataType
	describes a data type based on string with a target encoding More...

class	QoreStringDataTypeBase
	describes a data type based on a string tyoe with a target encoding option More...

class	QoreStringOrNothingDataType
	describes a data type based on *string with a target encoding More...

class	QoreUnsignedByteDataType
	Unsigned byte data type for ints with values from 0 - 255. More...

class	QoreUnsignedByteOrNothingDataType
	Unsigned byte data type for ints with values from 0 - 255. More...

class	RgbColorDataType
	RGB color data type. More...

class	RgbColorDataTypeBase
	RGB color data type. More...

class	RgbColorOrNothingDataType
	RGB color "or nothing" data type. More...

hashdecl	SearchOperatorInfo
	Generic operator info hash as returned by all generic search operator functions. More...

class	SoftListDataType
	describes a data type based on a hash More...

Functions
hash< SearchOperatorInfo >	dp_make_op (string op, auto arg)

hash< SearchOperatorInfo >	dp_op_between (auto l, auto r)
	returns an SearchOperatorInfo hash for the `"between"` operator with the given arguments

hash< SearchOperatorInfo >	dp_op_eq (auto arg)
	returns an SearchOperatorInfo hash for the `"="` operator with the given argument

hash< SearchOperatorInfo >	dp_op_ge (auto arg)
	returns an SearchOperatorInfo hash for the `">="` operator with the given argument

hash< SearchOperatorInfo >	dp_op_gt (auto arg)
	returns an SearchOperatorInfo hash for the `">"` operator with the given argument

hash< SearchOperatorInfo >	dp_op_in ()
	returns an SearchOperatorInfo hash for the `"in"` operator with all arguments passed to the function

hash< SearchOperatorInfo >	dp_op_in (list< auto > args)
	returns an SearchOperatorInfo hash for the `"in"` operator with the given argument list as the first argument

hash< SearchOperatorInfo >	dp_op_le (auto arg)
	returns an SearchOperatorInfo hash for the `"<="` operator with the given argument

hash< SearchOperatorInfo >	dp_op_like (string str)
	returns an SearchOperatorInfo hash for the SQL-like `"like"` operator with the given argument

hash< SearchOperatorInfo >	dp_op_lt (auto arg)
	returns an SearchOperatorInfo hash for the `"<"` operator with the given argument

hash< SearchOperatorInfo >	dp_op_ne (auto arg)
	returns an SearchOperatorInfo hash for the `"!="` or `"<>"` operator with the given argument

hash< SearchOperatorInfo >	dp_op_not (hash< auto > arg)
	returns an SearchOperatorInfo hash for the `"not"` operator

hash< SearchOperatorInfo >	dp_op_regex (string str)
	returns an SearchOperatorInfo hash for regular expression matches

list< auto >	elems ()
	Queue elements; either AbstractDataProcessor objects or a list of PipelineQueueInfo hashes.

Variables
const	AbstractDataProviderTypeMap = ...
	Maps Qore type name constant values to AbstractDataProviderType values.

const	ActionAttrMap = ...
	Maps a action type code to a data provider attribute string.

const	ActionNameMap = ...
	Maps a action type code to a user-friendly name.

const	DataProviderSignatureAnyType = ...
	Data provider signature any type.

const	DataProviderSignatureBoolType = ...
	Data provider signature bool type.

const	DataProviderSignatureDateType = ...
	Data provider signature date type.

const	DataProviderSignatureFieldType = ...
	Data provider signature field type.

const	DataProviderSignatureHashValueType = ...
	Data provider signature hash value type.

const	DataProviderSignatureIntValueType = ...
	Data provider signature int value type.

const	DataProviderSignatureListType = ...
	Data provider signature list type.

const	DataProviderSignatureListValueType = ...
	Data provider signature list value type.

const	DataProviderSignatureOptionalIntValueType = ...
	Data provider signature *int value type.

const	DataProviderSignatureOptionalStringValueType = ...
	Data provider signature optional string value type.

const	DataProviderSignatureStringType = ...
	Data provider signature string type.

const	DataProviderSignatureStringValueType = ...
	Data provider signature string value type.

const	DataTypeMap = ...
	Maps Qore type name constant values to data type objects.

const	DefaultGenericSearchOpMap = ...
	a hash of valid operators for use in generic search criteria

const	DES_Generic = 1

const	DES_LogicOperator = 2
	Indicates a logical operator type.

const	DET_Function = 2
	Indicates a function expression.

const	DET_Operator = 1

const	DP_OP_AND = "AND"

const	DP_OP_OR = "OR"
	OR logic.

const	DP_SEARCH_OP_BETWEEN = "between"
	Identifies the generic data provider `"between"` operator for use in generic search criteria.

const	DP_SEARCH_OP_EQ = "="
	Identifies the generic data provider equals operator (=) for use in generic search criteria.

const	DP_SEARCH_OP_GE = ">="
	Identifies the generic data provider greater than or equals operator (>=) for use in generic search criteria.

const	DP_SEARCH_OP_GT = ">"
	Identifies the generic data provider greater than operator (>) for use in generic search criteria.

const	DP_SEARCH_OP_IN = "in"
	Identifies the generic data provider `"in"` operator for use in generic search criteria.

const	DP_SEARCH_OP_LE = "<="
	Identifies the generic data provider less than or equals (<=) operator for use in generic search criteria.

const	DP_SEARCH_OP_LT = "<"
	Identifies the generic data provider less than (<) operator for use in generic search criteria.

const	DP_SEARCH_OP_NE = "!="
	Identifies the generic data provider not equals operator (!= or <>) for use in generic search criteria.

const	DP_SEARCH_OP_NOT = "not"
	Identifies the generic data provider `"not"` operator for use in generic search criteria.

const	DP_SEARCH_OP_REGEX = "regex"

const	DPAT_API = 2
	Data Provider Action Type: make an API call.

const	DPAT_CREATE = 6
	Data Provider Action Type: create a record.

const	DPAT_DELETE = 9
	Data Provider Action Type: delete a record.

const	DPAT_EVENT = 1

const	DPAT_FIND = 4
	Data Provider Action Type: find all matching records.

const	DPAT_FIND_SINGLE = 5
	Data Provider Action Type: find a single record.

const	DPAT_SEND_MESSAGE = 3
	Data Provider Action Type: send a message.

const	DPAT_UPDATE = 8
	Data Provider Action Type: update a record.

const	DPAT_UPSERT = 7
	Data Provider Action Type: upsert a record.

const	DPSP_REST = "rest"

const	DPSP_SOAP = "soap"

const	DTT_ClientOnly = "client_only"
	Tag indicates that the value is only applicable in client contexts.

const	DTT_FromFile = "from_file"

const	DTT_FromLocation = "from_location"
	Tag indicates that a string value can indicate a location.

const	ER_All = ER_Search \| ER_Field
	Indicates an expression that can be used in all contexts.

const	ER_Field = (1 << 1)
	Indicates an expression that can be used in a field.

const	ER_Search = (1 << 0)

const	ExpressionSubtypeCodeMap = ...
	Maps DataProvider expression subtype codes to descriptions.

const	ExpressionSubtypeDescMap = map {$1.value: $1.key.toInt()}
	Maps DataProvider expression subtype descriptions to integer codes.

const	ExpressionTypeCodeMap = ...
	Maps DataProvider expression type codes to descriptions.

const	ExpressionTypeDescMap = map {$1.value: $1.key.toInt()}
	Maps DataProvider expression type descriptions to integer codes.

thread_local *hash< auto >	implied_args
	Implied argument storage.

const	LC_All = (LC_And \| LC_Or)
	Indicates that all logic capabilities are supported.

const	LC_And = (1 << 0)

const	LC_Or = (1 << 1)
	Indicates that boolean expressions can be combined with OR logic.

const	LogicCodeMap = ...
	Logic map from codes to descriptions.

const	LogicDescMap = map {$1.value: $1.key.toInt()}
	Logic map from descriptions to integer codes.

const	MSG_Async = "ASYNC"
	Asynchronous output type, output can happen any time.

const	MSG_None = "NONE"

const	MSG_Sync = "SYNC"
	Synchronous output type, an output message is expected after each observed event.

const	OptimalQoreDataTypeMap = ...
	maps Qore type name constant values from the Type namespace to optimal Qore types names

const	OptimalQoreSoftDataTypeMap = ...
	maps Qore type name constant values from the Type namespace to optimal Qore types names

hashdecl	PipelineQueueInfo
	Internal hashdecl for pipeline queue info.

const	PS_ABORTED = "ABORTED"

const	PS_IDLE = "IDLE"
	Pipeline status: IDLE.

const	PS_RUNNING = "RUNNING"
	Pipeline status: RUNNING.

const	RgbColorDataType = new RgbColorDataType()
	RGB color data type.

const	RgbColorOrNothingDataType = new RgbColorOrNothingDataType()
	RGB color "or nothing" data type constant.

const	RoleCodeMap = ...
	Role map from codes to descriptions.

const	RoleDescMap = map {$1.value: $1.key.toInt()}
	Role map from descriptions to codes.

const	SignatureTypeCodeMap = ...
	Maps signature type codes to descriptions.

const	SignatureTypeDescMap = map {$1.value: $1.key.toInt()}
	Maps signature description values to integer codes.

int	size
	Maximum queue size.

const	ST_Any = 1

const	ST_Field = 3
	The signature type indicates a string field name when used as an argument, and the type is the field type.

const	ST_Value = 2
	Indicates any literal value of the given type; i.e. not an operator or other expression.

const	TypeCodeMap = ...
	maps type codes to type names

const	UpsertResultDeleted = "deleted"
	Indicates that the record was deleted.

const	UpsertResultInserted = "inserted"

const	UpsertResultUnchanged = "unchanged"
	Indicates that the record was left unchanged.

const	UpsertResultUpdated = "updated"
	Indicates that the record was updated.

const	UpsertResultVerified = "verified"
	Indicates that the record was verified as already in the target state.

Detailed Description

Qore AbstractDataField class definition.

Qore SoftListDataType class definition.

Qore RgbColorDataType class definition.

Qore QoreUnsignedByteOrNothingDataType class definition.

Qore QoreUnsignedByteDataType class definition.

Qore QoreStringOrNothingDataType class definition.

Qore QoreStringDataTypeBase class definition.

Qore QoreStringDataType class definition.

Qore QoreSoftUnsignedByteOrNothingDataType class definition.

Qore QoreSoftUnsignedByteDataType class definition.

Qore QoreSoftStringOrNothingDataType class definition.

Qore QoreSoftStringDataType class definition.

Qore QoreSoftSignedByteOrNothingDataType class definition.

Qore QoreSoftSignedByteDataType class definition.

Qore QoreSoftNumberOrNothingDataType class definition.

Qore QoreSoftNumberNoNullDataType class definition.

Qore QoreSoftNumberDataType class definition.

Qore QoreSoftIntOrNothingDataType class definition.

Qore QoreSoftIntNoNullDataType class definition.

Qore QoreSoftIntDataType class definition.

Qore QoreSoftFloatOrNothingDataType class definition.

Qore QoreSoftFloatNoNullDataType class definition.

Qore QoreSoftFloatDataType class definition.

Qore QoreSoftDateOrNothingDataType class definition.

Qore QoreSoftDateNoNullDataType class definition.

Qore QoreSoftDateDataType class definition.

Qore QoreSoftBoolOrNothingDataType class definition.

Qore QoreSoftBoolNoNullDataType class definition.

Qore QoreSoftBoolDataType class definition.

Qore QoreSoftBinaryOrNothingDataType class definition.

Qore QoreSoftBinaryNoNullDataType class definition.

Qore QoreSoftBinaryDataType class definition.

Qore QoreSignedByteOrNothingDataType class definition.

Qore QoreSignedByteDataType class definition.

Qore QoreNumberOrNothingDataType class definition.

Qore QoreNumberDataTypeBase class definition.

Qore QoreNumberDataType class definition.

Qore QoreListDataType class definition.

Qore QoreIntOrNothingDataType class definition.

Qore QoreIntDataTypeBase class definition.

Qore QoreIntDataType class definition.

Qore QoreHexBinaryOrNothingDataType class definition.

Qore QoreHexBinaryDataType class definition.

Qore QoreHashDataType class definition.

Qore QoreFloatOrNothingDataType class definition.

Qore QoreFloatDataTypeBase class definition.

Qore QoreFloatDataType class definition.

Qore QoreDateOrNothingDataType class definition.

Qore QoreDateDataTypeBase class definition.

Qore QoreDateDataType class definition.

Qore QoreDataType class definition.

Qore QoreDataField class definition.

Qore QoreBoolOrNothingDataType class definition.

Qore QoreBoolDataTypeBase class definition.

Qore QoreBoolDataType class definition.

Qore QoreBinaryOrNothingDataType class definition.

Qore QoreBinaryDataTypeBase class definition.

Qore QoreBinaryDataType class definition.

Qore QoreBase64BinaryOrNothingDataType class definition.

Qore QoreBase64BinaryDataType class definition.

Qore Observer class definition.

Qore Observable class definition.

Qore NullDataProviderFactory class definition.

Qore ListDataType class definition.

Qore ImpliedArgumentHelper class definition.

Qore HashDeclDataType class definition.

Qore HashDataType class definition.

Qore DefaultRecordIterator class definition.

Qore DefaultBulkUpserter class definition.

Qore DefaultBulkRecordIterface class definition.

Qore DefaultBulkInserter class definition.

Qore DataProviderPipelineFactory class definition.

Qore DataProviderPipeline class definition.

Qore DataProviderBulkRecordIterator class definition.

contains all public definitions in the DataProvider module

Qore AbstractDataProviderType class definition.

Qore AbstractDataProviderRecordIterator class definition.

Contains all public definitions in the DataProvider module.

Qore AbstractDataProviderBulkRecordInterface class definition.

Qore AbstractDataProviderBulkOperation class definition.

Qore AbstractDataProvider class definition.

Qore AbstractDataProcessor class definition.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: