60 softlist<AbstractDataProviderType>
type;
526 softlist<hash<DataProviderSignatureTypeInfo>>
args;
858 *hash<string, hash<DataProviderMessageInfo>>
events;
865 *hash<string, hash<DataProviderMessageInfo>>
messages;
1175 bool updateSingleRecord(hash<auto> set, hash<DataProviderExpression> where_cond, *hash<auto> search_options);
1204 int updateRecords(hash<auto> set, *hash<DataProviderExpression> where_cond, *hash<auto> search_options);
1218 int updateRecords(hash<auto> set, *hash<auto> where_cond, *hash<auto> search_options);
1234 int deleteRecords(*hash<DataProviderExpression> where_cond, *hash<auto> search_options);
1340 sendMessage(
string message_id,
auto msg, *hash<auto> send_message_options);
2036 hash<DataProviderExpression>
getSimpleArgumentIntern(
int role, hash<DataProviderInfo> info, hash<DataProviderExpressionInfo> expinfo,
string key,
auto value);
2056 static hash<DataProviderExpressionInfo>
getExpression(
int role,
string exp, *hash<
string, hash<DataProviderExpressionInfo>> expmap);
2074 if (val instanceof hash<DataProviderExpression>);
2083 static auto evalGenericExpression(hash<auto> rec, hash<DataProviderExpression> exp);
2096 static bool setDynamicValueCallbacks(code value_needs_resolution, code resolve_value);
2107 static verifyExpression(
int role, *hash<
string, hash<DataProviderExpressionInfo>> expmap,
int caps, AbstractDataProviderType expected_type, hash<DataProviderExpression> exp);
2118 static verifyExpression(
int role, hash<DataProviderExpressionInfo> expinfo,
int caps, AbstractDataProviderType expected_type, hash<DataProviderExpression> exp);
2127 static verifyExpressionArgValue(
int role,
int caps, hash<DataProviderExpressionInfo> expinfo, softlist<auto> values,
int pos);
2131 static bool checkCallbacks();
2139 *hash<auto> validateCreateOptions(*hash<auto> create_options);
2147 *hash<auto> validateUpsertOptions(*hash<auto> upsert_options);
2155 *hash<auto> validateSearchOptions(*hash<auto> search_options);
2163 *hash<auto> validateRequestOptions(*hash<auto> request_options);
2173 *hash<auto> validateChildCreateOptions(*hash<auto> child_create_options);
2183 *hash<auto> validateChildDeleteOptions(*hash<auto> child_delete_options);
2193 *hash<auto> validateFieldAddOptions(*hash<auto> field_add_options);
2203 *hash<auto> validateFieldUpdateOptions(*hash<auto> field_update_options);
2213 *hash<auto> validateFieldDeleteOptions(*hash<auto> field_delete_options);
2223 *hash<auto> validateSendMessageOptions(*hash<auto> send_message_options);
2229 processConstructorOptions(*hash<
string, hash<DataProviderOptionInfo>> option_desc, *hash<auto> options, *
string required_options);
2248 *hash<auto> checkOptions(
string err, *hash<
string, hash<DataProviderOptionInfo>> option_desc, *hash<auto> uoptions, *
string required_options);
2262 verifyRequiredOptions(
string err, *hash<auto> options,
string required_options);
2273 *hash<DataProviderExpression> processSearchParameters(*hash<DataProviderExpression> exp, *hash<auto> search_options);
2286 *hash<auto> processFieldValues(*hash<auto> h, *hash<auto> search_options);
2291 bool searchAcceptsForeignField(
string field);
2301 *hash<string, AbstractDataField> getRecordType(*hash<auto> search_options);
2312 *hash<string, AbstractDataField> getCreateRecordType(*hash<auto> create_options);
2325 *hash<string, AbstractDataField> getUpdateRecordType(*hash<auto> search_options);
2329 *hash<string, AbstractDataField> getSoftRecordType(*hash<auto> search_options);
2333 *hash<string, AbstractDataField> getOrNothingRecordType(*hash<auto> search_options);
2340 *hash<string, hash<DataProviderOptionInfo>> getSearchOptions();
2347 *hash<string, hash<DataProviderOptionInfo>> getCreateOptions();
2354 *hash<string, hash<DataProviderOptionInfo>> getUpsertOptions();
2361 *hash<string, hash<DataProviderOptionInfo>> getRequestOptions();
2371 *hash<string, hash<DataProviderOptionInfo>> getChildCreateOptions();
2381 *hash<string, hash<DataProviderOptionInfo>> getChildDeleteOptions();
2391 *hash<string, hash<DataProviderOptionInfo>> getFieldAddOptions();
2401 *hash<string, hash<DataProviderOptionInfo>> getFieldUpdateOptions();
2411 *hash<string, hash<DataProviderOptionInfo>> getFieldDeleteOptions();
2421 *hash<string, hash<DataProviderOptionInfo>> getSendMessageOptions();
2427 string getMessageSupport();
2433 bool supportsRead();
2439 bool supportsBulkRead();
2445 bool supportsCreate();
2451 bool supportsUpdate();
2457 bool supportsUpsert();
2463 bool supportsDelete();
2469 bool supportsNativeSearch();
2475 bool supportsBulkCreate();
2481 bool supportsBulkUpsert();
2487 bool supportsRequest();
2493 bool recordRequiresSearchOptions();
2505 bool supportsCreateChild();
2511 bool supportsDeleteChild();
2517 bool supportsAddField();
2523 bool supportsUpdateField();
2529 bool supportsDeleteField();
2535 bool supportsSchema();
2541 bool supportsSearchExpressions();
2547 bool supportsObservable();
2553 bool supportsMessages();
2559 *
object getSchemaType();
2565 bool supportsChildren();
2571 bool childrenIdentical();
2582 static registerChild(
string name, code generator);
2586 error(
string err,
string fmt, ...);
2597 *hash<auto> searchFirstRecordImpl(hash<auto> where_cond, *hash<auto> search_options);
2610 *hash<auto> searchSingleRecordImpl(hash<auto> where_cond, *hash<auto> search_options);
2620 *list<string> getChildProviderNamesImpl();
2628 *AbstractDataProvider getChildProviderImpl(
string name);
2638 *hash<DataProviderConnectionInfo> getConnectionInfoImpl();
2650 hash<auto> generateExampleData(hash<string, AbstractDataField> fields);
2658 *hash<string, AbstractDataField> getRecordTypeImpl(*hash<auto> search_options);
2666 *hash<string, AbstractDataField> getUpdateRecordTypeImpl(*hash<auto> search_options);
2674 *hash<string, AbstractDataField> getCreateRecordTypeImpl(*hash<auto> create_options);
2687 AbstractDataProviderBulkRecordInterface searchRecordsBulkImpl(
int block_size = 1000, *hash<auto> where_cond, *hash<auto> search_options);
2698 AbstractDataProviderRecordIterator searchRecordsImpl(*hash<auto> where_cond, *hash<auto> search_options);
2712 AbstractDataProviderRecordIterator requestSearchRecordsImpl(
auto req, *hash<auto> where_cond, *hash<auto> search_options);
2726 *hash<auto> createRecordImpl(hash<auto> rec, *hash<auto> create_options);
2737 string upsertRecordImpl(hash<auto> rec, *hash<auto> upsert_options);
2747 bool updateSingleRecordImpl(hash<auto> set, hash<auto> where_cond, *hash<auto> search_options);
2759 int updateRecordsImpl(hash<auto> set, *hash<auto> where_cond, *hash<auto> search_options);
2771 int deleteRecordsImpl(*hash<auto> where_cond, *hash<auto> search_options);
2782 auto doRequestImpl(
auto req, *hash<auto> request_options);
2796 AbstractDataProvider createChildProviderImpl(
string name, hash<string, AbstractDataField> fields, *hash<auto> child_create_options);
2807 deleteChildProviderImpl(
string name, *hash<auto> child_delete_options);
2819 addFieldImpl(AbstractDataField field, *hash<auto> field_add_options);
2831 updateFieldImpl(
string name, AbstractDataField field, *hash<auto> field_update_options);
2842 deleteFieldImpl(
string name, *hash<auto> field_delete_options);
2855 sendMessageImpl(
string message_id,
auto msg, *hash<auto> send_message_options);
2865 object getSchemaObjectImpl();
2875 *AbstractDataProviderType getRequestTypeImpl();
2891 *AbstractDataProviderType getRequestTypeWithDataImpl(
auto req);
2901 *AbstractDataProviderType getResponseTypeImpl();
2917 *AbstractDataProviderType getResponseTypeWithDataImpl(
auto req);
2927 *hash<string, AbstractDataProviderType> getErrorResponseTypesImpl();
2939 AbstractDataProviderType getErrorResponseTypeImpl(
string error_code);
2955 hash<DataProviderMessageInfo> getEventInfoImpl(
string event_id);
2972 hash<DataProviderMessageInfo> getEventInfoWithDataImpl(
string event_id,
auto req);
2984 hash<string, hash<DataProviderMessageInfo>> getEventTypesImpl();
2998 hash<DataProviderMessageInfo> getMessageInfoImpl(
string message_id);
3010 hash<string, hash<DataProviderMessageInfo>> getMessageTypesImpl();
3018 throwUnimplementedException();
3028 auto getExampleRequestDataImpl();
3040 auto getExampleResponseDataImpl();
3055 auto getExampleErrorResponseDataImpl(
string error_code);
3070 auto getExampleEventDataImpl(
string event_id);
3080 hash<auto> getExampleRecordDataImpl();
3093 *list<hash<AllowedValueInfo>> getReferenceDataImpl(
string type, *hash<auto> action_opts);
3106 *list<hash<AllowedValueInfo>> getElementReferenceDataImpl(
string type, *hash<auto> action_opts);
3119 auto getReferenceDataValueImpl(
string type, *hash<auto> action_opts);
3124 abstract
string getName();
3128 abstract hash<DataProviderInfo> getStaticInfoImpl();
describes a data type based on a hashdecl
Definition AbstractDataField.qc.dox.h:74
Abstract bulk data operation class.
Definition AbstractDataProviderBulkOperation.qc.dox.h:33
Defines the abstract class for data provider iterators; the destructor releases the iterator.
Definition AbstractDataProviderBulkRecordInterface.qc.dox.h:33
The AbstractDataProvider class.
Definition AbstractDataProvider.qc.dox.h:917
*hash< auto > searchFirstRecord(hash< DataProviderExpression > where_cond, *hash< auto > search_options)
Returns the first record matching the search options.
static code cb_resolve_value
static callback for dynamic value resolution
Definition AbstractDataProvider.qc.dox.h:952
const GenericExpressions
Generic search operator expressions.
Definition AbstractDataProvider.qc.dox.h:930
hash< DataProviderSummaryInfo > getSummaryInfo()
Return data provider summary info.
*hash< string, hash< ActionOptionInfo > > tryGetActionOptionsWithData(hash< DataProviderActionInfo > action, auto req)
Returns action options corresponding to the given option data.
hash< DataProviderMessageInfo > getEventInfo(string event_id)
Returns the description of an observable event, if any.
*list< hash< AllowedValueInfo > > getElementReferenceDataSafe(string type, *hash< auto > action_opts)
Returns element reference data of the given kind if available; logs but ignores exceptions retrieving...
checkDeleteChild()
Ensures that the data provider supports deleting children.
*hash< string, hash< MapperRuntimeKeyInfo > > getMapperRuntimeKeys()
Returns custom data mapper runtime keys.
deleteChildProvider(string name, *hash< auto > child_delete_options)
Deletes a child data provider.
*hash< auto > searchSingleRecord(hash< auto > where_cond, *hash< auto > search_options)
Returns a single record matching the search options.
beginTransaction()
Begins a transaction with a data provider.
const DataProviderSummaryInfoKeys
A list of members names of the DataProviderSummaryInfoKeys hashdecl.
Definition AbstractDataProvider.qc.dox.h:933
*AbstractDataProviderType getRequestType()
Returns the description of a successful request message, if any.
hash< auto > getInfoAsData(*bool with_type_info)
Returns static provider information as data; no objects are returned.
auto getReferenceDataValue(string type, *hash< auto > action_opts)
Returns a reference data value of the given kind if available.
checkUpdate()
Ensures that the data provider supports record upserts.
auto getExampleResponseData()
Returns example data for a successful request message.
AbstractDataProviderBulkOperation getBulkUpserter()
Returns a bulk upsert operation object for the data provider.
hash< DataProviderMessageInfo > getMessageInfo(string message_id)
Returns the description of an outbound message, if any.
const GenericExpressionImplementations
Generic expression implementations for data providers without native search functionality.
Definition AbstractDataProvider.qc.dox.h:921
*string getShortDesc()
Returns the data provider short description.
*hash< auto > searchSingleRecord(hash< DataProviderExpression > where_cond, *hash< auto > search_options)
Returns a single record matching the search options.
hash< string, hash< DataProviderMessageInfo > > getEventTypes()
Returns a hash of all supported event types.
checkUpdateField()
Ensures that the data provider supports updating fields.
sendMessage(string message_id, auto msg, *hash< auto > send_message_options)
Sends a message from message-capable data providers.
*list< hash< AllowedValueInfo > > getReferenceDataEx(string type, *hash< auto > action_opts)
Returns reference data of the given kind if available.
auto getExampleEventData(string event_id)
Returns example data for the given observable event.
checkObservable()
Ensures that the data provider supports observer pattern / event API.
*AbstractDataProvider getChildProvider(string name)
Returns the given child provider or NOTHING if the given child is unknown.
const GenericRecordSearchOptions
Generic record search options; see details below.
Definition AbstractDataProvider.qc.dox.h:941
auto getReferenceDataValueEx(string type, *hash< auto > action_opts)
Returns a reference data value of the given kind if available.
commit()
Commits data written to the data provider.
string getDisplayName()
Returns the data provider display name.
bool updateSingleRecord(hash< auto > set, hash< DataProviderExpression > where_cond, *hash< auto > search_options)
Updates a single record matching the search options.
bool requiresTransactionManagement()
Returns True if the data provider requires transaction management.
auto getExampleErrorResponseData(string error_code)
Returns example data for the error message with the given error code.
AbstractDataProviderRecordIterator getRecordIterator(*hash< auto > search_options)
Returns an iterator iterating all records.
auto getExampleRequestData()
Returns example data for a request message.
AbstractDataProviderBulkRecordInterface searchRecordsBulk(int block_size=1000, *hash< auto > where_cond, *hash< auto > search_options)
Returns an iterator for zero or more records matching the search options.
constructor()
Creates the data provider.
deleteField(string name, *hash< auto > field_delete_options)
Deletes an existing field.
*hash< auto > searchFirstRecord(hash< auto > where_cond, *hash< auto > search_options)
Returns the first record matching the search options.
hash< DataProviderInfo > getInfo()
Returns data provider info.
int deleteRecords(*hash< DataProviderExpression > where_cond, *hash< auto > search_options)
Deletes zero or more records.
hash< auto > getExampleRecordData()
Returns example data for the record type.
hash< DataProviderExpression > getEqualityComparisonExpression(int role, hash< DataProviderInfo > info, string key, auto value)
Returns an equality comparison expression.
*list< hash< AllowedValueInfo > > getElementReferenceData(string type, *hash< auto > action_opts)
Returns element reference data of the given kind if available.
hash< DataProviderExpression > getSimpleArgumentIntern(int role, hash< DataProviderInfo > info, hash< DataProviderExpressionInfo > expinfo, string key, auto value)
Returns an argument for an expression.
rollback()
Rolls back data written to the data provider.
*list< hash< AllowedValueInfo > > getReferenceData(string type, *hash< auto > action_opts)
Returns reference data of the given kind if available.
int updateRecords(hash< auto > set, *hash< DataProviderExpression > where_cond, *hash< auto > search_options)
Updates zero or more records matching the search options.
static auto evalGenericExpressionValue(hash< auto > rec, auto val)
Evaluates the given expression with the generic internal implementation and returns the result.
*AbstractDataProviderType getRequestTypeWithData(auto req)
Returns the description of a successful request message with call data, if any.
*list< hash< AllowedValueInfo > > getReferenceDataSafe(string type, *hash< auto > action_opts)
Returns reference data of the given kind if available; logs but ignores exceptions retrieving the dat...
*AbstractDataProviderType getResponseType()
Returns the description of a response message, if this object represents a response message.
*hash< string, hash< ActionOptionInfo > > tryGetActionOptionsWithDataImpl(hash< DataProviderActionInfo > action, auto req)
Returns action options corresponding to the given option data.
*hash< auto > getAdditionalInfo()
Returns additional provider-specific information.
hash< DataProviderMessageInfo > getEventInfoWithData(string event_id, auto req)
Returns the description of an observable event, if any with option data, if any.
static bool callbacks_locked
flag if callbacks are locked
Definition AbstractDataProvider.qc.dox.h:946
AbstractDataProviderRecordIterator requestSearchRecords(auto req, *hash< auto > where_cond, *hash< auto > search_options)
Returns an iterator for zero or more records matching the search options according to an API request.
AbstractDataProviderBulkOperation getBulkInserter()
Returns a bulk insert operation object for the data provider.
*hash< auto > createRecord(hash< auto > rec, *hash< auto > create_options)
Creates the given record in the data provider.
static bool setDynamicValueCallbacks()
Ensures that no callbacks can be set for dynamic URI resolution.
bool updateSingleRecord(hash< auto > set, hash< auto > where_cond, *hash< auto > search_options)
Updates a single record matching the search options.
auto doRequest(auto req, *hash< auto > request_options)
Makes a request and returns the response.
*hash< string, bool > getSupportedReferenceDataValues()
Returns information on supported reference data values.
*list< hash< DataProviderSummaryInfo > > getChildProviderSummaryInfo()
Return data provider summary info.
static code cb_value_needs_resolution
static callback the returns a bool if the value needs dynamic resolution
Definition AbstractDataProvider.qc.dox.h:949
object getSchemaObject()
Returns the schema supporting this data provider.
checkCreate()
Ensures that the data provider supports record creation.
auto getReferenceDataValueSafeEx(string type, *hash< auto > action_opts)
Returns reference data of the given kind if available.
*list< hash< AllowedValueInfo > > getReferenceDataSafeEx(string type, *hash< auto > action_opts)
Returns reference data of the given kind if available.
checkSchema()
Ensures that the data provider supports a schema.
checkRead()
Ensures that the data provider supports read operations.
*string getDesc()
Returns the data provider description.
*list< hash< AllowedValueInfo > > getElementReferenceDataEx(string type, *hash< auto > action_opts)
Returns element reference data of the given kind if available.
AbstractDataProviderBulkRecordInterface getBulkRecordInterface(int block_size=1000, *hash< auto > search_options)
Returns an iterator iterating all records with the bulk read API.
int updateRecords(hash< auto > set, *hash< auto > where_cond, *hash< auto > search_options)
Updates zero or more records matching the search options.
updateConnectionObjects(object conn, object connobj)
Update any connection used by the data provider.
*hash< DataProviderConnectionInfo > getConnectionInfo()
Returns connection info if the data provider supports connections, otherwise returns NOTHING.
*hash< string, bool > getSupportedReferenceData()
Returns information on supported reference data.
AbstractDataProviderRecordIterator searchRecords(*hash< auto > where_cond, *hash< auto > search_options)
Returns an iterator for zero or more records matching the search options.
constructor(LoggerInterface logger)
Creates the data provider with the given Logger.
checkDelete()
Ensures that the data provider supports record deletion.
hash< string, hash< DataProviderMessageInfo > > getMessageTypes()
Returns a hash of all supported outbound messages.
static hash< DataProviderExpressionInfo > getExpression(int role, string exp, *hash< string, hash< DataProviderExpressionInfo > > expmap)
Returns an expression definition for an expression code or throws an exception.
AbstractDataProviderType getErrorResponseType(string error_code)
Returns the type for the given error code.
checkMessages()
Ensures that the data provider supports sending messages.
AbstractDataProviderRecordIterator searchRecords(*hash< DataProviderExpression > where_cond, *hash< auto > search_options)
Returns an iterator for zero or more records matching the search options.
*hash< string, AbstractDataProviderType > getErrorResponseTypes()
Returns a hash of error responses, if any.
checkDeleteField()
Ensures that the data provider supports deleting fields.
AbstractDataProvider getChildProviderPath(string path)
Returns the given child provider from a "/" separated path string.
*hash< string, bool > getSupportedElementReferenceData()
Returns information on supported element reference data.
addField(AbstractDataField field, *hash< auto > field_add_options)
Creates a new field.
AbstractDataProvider createChildProvider(string name, hash< string, AbstractDataField > fields, *hash< auto > child_create_options)
Creates a new child data provider and returns it after adding as a child.
auto getReferenceDataValueSafe(string type, *hash< auto > action_opts)
Returns a reference data value of the given kind if available; logs but ignores exceptions retrieving...
string upsertRecord(hash< auto > rec, *hash< auto > upsert_options)
Upserts the given record in the data provider.
updateField(string name, AbstractDataField field, *hash< auto > field_update_options)
Updates an existing field.
*hash< auto > getSearchExpression(*hash< auto > where_cond, *hash< auto > search_options)
Returns a search expression for a standard search hash.
checkRequest()
Ensures that the data provider supports the request API.
AbstractDataProvider getChildProviderEx(string name)
Returns the given child provider or throws an exception if the given child is unknown.
checkSearchExpressions()
Ensures that the data provider supports advanced search expressions.
AbstractDataProviderRecordIterator requestSearchRecords(auto req, *hash< DataProviderExpression > where_cond, *hash< auto > search_options)
Returns an iterator for zero or more records matching the search options according to an API request.
checkAddField()
Ensures that the data provider supports adding fields.
checkCreateChild()
Ensures that the data provider supports creating children.
AbstractDataProviderBulkRecordInterface searchRecordsBulk(int block_size=1000, *hash< DataProviderExpression > where_cond, *hash< auto > search_options)
Returns an iterator for zero or more records matching the search options.
int deleteRecords(*hash< auto > where_cond, *hash< auto > search_options)
Deletes zero or more records.
checkUpsert()
Ensures that the data provider supports record upserts.
*list< string > getChildProviderNames()
Returns a list of child data provider names, if any.
*list< hash< AllowedValueInfo > > getElementReferenceDataSafeEx(string type, *hash< auto > action_opts)
Returns element reference data of the given kind if available.
*AbstractDataProviderType getResponseTypeWithData(auto req)
Returns the description of a successful response message with call data, if any.
*hash< string, hash< ActionOptionInfo > > tryGetActionOptionsFromRequestTypeWithData(auto req)
Returns action options corresponding to the request type with the given request data,...
Defines the abstract class for data provider iterators; the destructor releases the iterator.
Definition AbstractDataProviderRecordIterator.qc.dox.h:288
describes a data type
Definition AbstractDataProviderType.qc.dox.h:139
const DES_LogicOperator
Indicates a logical operator type.
Definition AbstractDataProvider.qc.dox.h:439
const DES_Generic
Definition AbstractDataProvider.qc.dox.h:436
const DET_Operator
Definition AbstractDataProvider.qc.dox.h:417
const DET_Function
Indicates a function expression.
Definition AbstractDataProvider.qc.dox.h:420
const MSG_None
Definition AbstractDataProvider.qc.dox.h:270
const MSG_Async
Asynchronous output type, output can happen any time.
Definition AbstractDataProvider.qc.dox.h:282
const MSG_Sync
Synchronous output type, an output message is expected after each observed event.
Definition AbstractDataProvider.qc.dox.h:277
const UpsertResultUnchanged
Indicates that the record was left unchanged.
Definition AbstractDataProvider.qc.dox.h:42
const UpsertResultDeleted
Indicates that the record was deleted.
Definition AbstractDataProvider.qc.dox.h:45
const UpsertResultInserted
Definition AbstractDataProvider.qc.dox.h:33
const UpsertResultVerified
Indicates that the record was verified as already in the target state.
Definition AbstractDataProvider.qc.dox.h:39
const UpsertResultUpdated
Indicates that the record was updated.
Definition AbstractDataProvider.qc.dox.h:36
const ER_All
Indicates an expression that can be used in all contexts.
Definition AbstractDataProvider.qc.dox.h:322
const ER_Search
Definition AbstractDataProvider.qc.dox.h:316
const ER_Field
Indicates an expression that can be used in a field.
Definition AbstractDataProvider.qc.dox.h:319
const LC_Or
Indicates that boolean expressions can be combined with OR logic.
Definition AbstractDataProvider.qc.dox.h:341
const LC_And
Definition AbstractDataProvider.qc.dox.h:338
const LC_All
Indicates that all logic capabilities are supported.
Definition AbstractDataProvider.qc.dox.h:344
const ST_Value
Indicates any literal value of the given type; i.e. not an operator or other expression.
Definition AbstractDataProvider.qc.dox.h:294
const ST_Field
The signature type indicates a string field name when used as an argument, and the type is the field ...
Definition AbstractDataProvider.qc.dox.h:300
const ST_Any
Definition AbstractDataProvider.qc.dox.h:291
Qore AbstractDataField class definition.
Definition AbstractDataField.qc.dox.h:27
const DataProviderSignatureOptionalIntValueType
Data provider signature *int value type.
Definition AbstractDataProvider.qc.dox.h:388
const DataProviderSignatureStringType
Data provider signature string type.
Definition AbstractDataProvider.qc.dox.h:404
const DataProviderSignatureDateType
Data provider signature date type.
Definition AbstractDataProvider.qc.dox.h:408
const DataProviderSignatureHashValueType
Data provider signature hash value type.
Definition AbstractDataProvider.qc.dox.h:396
const ExpressionSubtypeCodeMap
Maps DataProvider expression subtype codes to descriptions.
Definition AbstractDataProvider.qc.dox.h:443
const SignatureTypeDescMap
Maps signature description values to integer codes.
Definition AbstractDataProvider.qc.dox.h:308
const SignatureTypeCodeMap
Maps signature type codes to descriptions.
Definition AbstractDataProvider.qc.dox.h:304
const DataProviderSignatureOptionalStringValueType
Data provider signature optional string value type.
Definition AbstractDataProvider.qc.dox.h:380
const LogicDescMap
Logic map from descriptions to integer codes.
Definition AbstractDataProvider.qc.dox.h:352
const DataProviderSignatureFieldType
Data provider signature field type.
Definition AbstractDataProvider.qc.dox.h:364
const ExpressionTypeDescMap
Maps DataProvider expression type descriptions to integer codes.
Definition AbstractDataProvider.qc.dox.h:428
const DataProviderSignatureBoolType
Data provider signature bool type.
Definition AbstractDataProvider.qc.dox.h:400
const DataProviderSignatureListValueType
Data provider signature list value type.
Definition AbstractDataProvider.qc.dox.h:392
const DataProviderSignatureStringValueType
Data provider signature string value type.
Definition AbstractDataProvider.qc.dox.h:376
const DataProviderSignatureAnyType
Data provider signature any type.
Definition AbstractDataProvider.qc.dox.h:368
const ExpressionSubtypeDescMap
Maps DataProvider expression subtype descriptions to integer codes.
Definition AbstractDataProvider.qc.dox.h:447
const RoleCodeMap
Role map from codes to descriptions.
Definition AbstractDataProvider.qc.dox.h:326
const LogicCodeMap
Logic map from codes to descriptions.
Definition AbstractDataProvider.qc.dox.h:348
const RoleDescMap
Role map from descriptions to codes.
Definition AbstractDataProvider.qc.dox.h:330
const DataProviderSignatureListType
Data provider signature list type.
Definition AbstractDataProvider.qc.dox.h:372
const ExpressionTypeCodeMap
Maps DataProvider expression type codes to descriptions.
Definition AbstractDataProvider.qc.dox.h:424
const DataProviderSignatureIntValueType
Data provider signature int value type.
Definition AbstractDataProvider.qc.dox.h:384
Data provider expression arg info.
Definition AbstractDataProvider.qc.dox.h:450
*softlist< hash< Util::AllowedValueInfo > > allowed_values
List of allowed values (enum)
Definition AbstractDataProvider.qc.dox.h:472
*softlist< hash< Util::AllowedValueInfo > > element_allowed_values
List of allowed values for elements of list types (enum)
Definition AbstractDataProvider.qc.dox.h:480
string desc
The argument description.
Definition AbstractDataProvider.qc.dox.h:458
auto default_value
Any default value.
Definition AbstractDataProvider.qc.dox.h:461
bool sensitive
Is the argument value sensitive?
Definition AbstractDataProvider.qc.dox.h:464
bool multiselect
Are allowed values elements of the list's element type that indicate what values the list can have?
Definition AbstractDataProvider.qc.dox.h:467
*string short_desc
Argument short description in plain text.
Definition AbstractDataProvider.qc.dox.h:455
bool element_allowed_values_creatable
Does the option accept values for elements not defined in element_allowed_values too?
Definition AbstractDataProvider.qc.dox.h:483
*bool allowed_values_creatable
Does the option accept values not defined in allowed_values too?
Definition AbstractDataProvider.qc.dox.h:475
auto example_value
Any optional example value for the argument.
Definition AbstractDataProvider.qc.dox.h:488
string display_name
Argument display name.
Definition AbstractDataProvider.qc.dox.h:452
Data provider connection info.
Definition AbstractDataProvider.qc.dox.h:899
bool auto_reconnect
Is auto reconnect supported?
Definition AbstractDataProvider.qc.dox.h:907
bool connected
Is the underlying transport connected?
Definition AbstractDataProvider.qc.dox.h:901
*hash< auto > info
Additional data-provider-dependent connection information.
Definition AbstractDataProvider.qc.dox.h:913
bool reconnecting
Is a reconnect in progress?
Definition AbstractDataProvider.qc.dox.h:904
*string url
Any target URL if available.
Definition AbstractDataProvider.qc.dox.h:910
Data provider expression.
Definition AbstractDataProvider.qc.dox.h:545
string exp
Expression name.
Definition AbstractDataProvider.qc.dox.h:547
softlist< auto > args
Expression arguments.
Definition AbstractDataProvider.qc.dox.h:553
Data provider signature info.
Definition AbstractDataProvider.qc.dox.h:492
string symbol
The symbol to use when rendering expressions.
Definition AbstractDataProvider.qc.dox.h:518
string name
The technical name or internal label used for the expression.
Definition AbstractDataProvider.qc.dox.h:504
string display_name
The display name.
Definition AbstractDataProvider.qc.dox.h:507
string short_desc
The short description of the operation.
Definition AbstractDataProvider.qc.dox.h:510
bool varargs
The last argument can be repeated indefinitely.
Definition AbstractDataProvider.qc.dox.h:535
int role
The expression role code / bitfield.
Definition AbstractDataProvider.qc.dox.h:523
int type
The type of expression; see DataProvider Expression Type Codes.
Definition AbstractDataProvider.qc.dox.h:494
softlist< hash< DataProviderSignatureTypeInfo > > args
Argument types.
Definition AbstractDataProvider.qc.dox.h:526
int subtype
The expression subtype.
Definition AbstractDataProvider.qc.dox.h:499
string desc
The description of the operation.
Definition AbstractDataProvider.qc.dox.h:515
*softlist< hash< DataProviderArgInfo > > arg_info
Argument info.
Definition AbstractDataProvider.qc.dox.h:529
AbstractDataProviderType return_type
The return type.
Definition AbstractDataProvider.qc.dox.h:532
Data provider field reference.
Definition AbstractDataProvider.qc.dox.h:539
string field
The name of the field being referenced.
Definition AbstractDataProvider.qc.dox.h:541
Data provider info.
Definition AbstractDataProvider.qc.dox.h:557
string supports_messages
Output message support.
Definition AbstractDataProvider.qc.dox.h:722
bool supports_delete
Does the data provider support record deletion?
Definition AbstractDataProvider.qc.dox.h:602
*hash< string, hash< DataProviderMessageInfo > > events
hash of observable events and event types
Definition AbstractDataProvider.qc.dox.h:858
bool supports_bulk_read
Does the data provider support native / optimized bulk reads?
Definition AbstractDataProvider.qc.dox.h:615
*hash< string, hash< DataProviderOptionInfo > > add_field_options
Add field options supported by the data provider.
Definition AbstractDataProvider.qc.dox.h:823
*hash< string, hash< DataProviderMessageInfo > > messages
List of output message IDs and message types.
Definition AbstractDataProvider.qc.dox.h:865
bool supports_connections
Does the data provider support connections and connection status reporting?
Definition AbstractDataProvider.qc.dox.h:727
bool transaction_management
Does the data provider require transaction management?
Definition AbstractDataProvider.qc.dox.h:646
*hash< string, hash< DataProviderExpressionInfo > > expressions
Expressions (operators and functions) supported by the data provider.
Definition AbstractDataProvider.qc.dox.h:851
string display_name
Data provider display name.
Definition AbstractDataProvider.qc.dox.h:564
bool children_can_support_observers
Can any child data providers support the observer pattern / event API?
Definition AbstractDataProvider.qc.dox.h:747
bool supports_auto_reconnect
Does the data provider support automatic reconnection?
Definition AbstractDataProvider.qc.dox.h:732
bool supports_child_delete
Does the data provider support deleting new child providers?
Definition AbstractDataProvider.qc.dox.h:670
string type
The name of the provider type.
Definition AbstractDataProvider.qc.dox.h:577
bool supports_delete_field
Does the data provider support deleting fields?
Definition AbstractDataProvider.qc.dox.h:691
bool supports_child_create
Does the data provider support creating new child providers?
Definition AbstractDataProvider.qc.dox.h:663
*hash< string, hash< DataProviderOptionInfo > > child_delete_options
Child deletion options supported by the data provider.
Definition AbstractDataProvider.qc.dox.h:816
bool supports_native_search
Does the data provider support native record searching?
Definition AbstractDataProvider.qc.dox.h:607
*string required_constructor_options
Required constructor option combinations.
Definition AbstractDataProvider.qc.dox.h:782
bool children_identical
Are all children always of the same data provider class that support the same options?
Definition AbstractDataProvider.qc.dox.h:762
*hash< string, hash< DataProviderOptionInfo > > request_options
Request options supported by the data provider.
Definition AbstractDataProvider.qc.dox.h:802
*hash< string, hash< DataProviderOptionInfo > > search_options
Search options supported by the data provider.
Definition AbstractDataProvider.qc.dox.h:797
string name
Data provider name.
Definition AbstractDataProvider.qc.dox.h:561
bool supports_add_field
Does the data provider support adding new fields?
Definition AbstractDataProvider.qc.dox.h:677
bool children_can_support_messages
Can any child data providers support messages?
Definition AbstractDataProvider.qc.dox.h:752
*hash< auto > info
Any optional provider-specific information.
Definition AbstractDataProvider.qc.dox.h:895
bool supports_bulk_upsert
Does the data provider support native / optimized bulk upserts?
Definition AbstractDataProvider.qc.dox.h:631
*hash< string, hash< DataProviderOptionInfo > > child_create_options
Child creation options supported by the data provider.
Definition AbstractDataProvider.qc.dox.h:809
hash< string, hash< MapperRuntimeKeyInfo > > mapper_keys
A hash of mapper key information.
Definition AbstractDataProvider.qc.dox.h:877
*string disconnection_event
Disconnection event for event-based connection-capable data providers.
Definition AbstractDataProvider.qc.dox.h:887
bool supports_read
Does the data provider support reading.
Definition AbstractDataProvider.qc.dox.h:582
bool record_requires_search_options
Do we require search options to retrieve the record type?
Definition AbstractDataProvider.qc.dox.h:656
bool supports_update
Does the data provider support record updates?
Definition AbstractDataProvider.qc.dox.h:592
bool supports_search_expressions
Does this data provide support advanced search experssions?
Definition AbstractDataProvider.qc.dox.h:705
*hash< string, hash< DataProviderOptionInfo > > upsert_options
Upsert options supported by the data provider.
Definition AbstractDataProvider.qc.dox.h:792
bool supports_update_field
Does the data provider support updating existing fields?
Definition AbstractDataProvider.qc.dox.h:684
bool supports_request
Does the data provider support the request API?
Definition AbstractDataProvider.qc.dox.h:636
*hash< string, hash< DataProviderOptionInfo > > constructor_options
Constructor options supported by the data provider for the constructor variant taking a hash.
Definition AbstractDataProvider.qc.dox.h:773
*hash< string, hash< DataProviderOptionInfo > > create_options
Create options supported by the data provider.
Definition AbstractDataProvider.qc.dox.h:787
bool supports_create
Does the data provider support record creation?
Definition AbstractDataProvider.qc.dox.h:587
*string short_desc
Data provider short description in plain text.
Definition AbstractDataProvider.qc.dox.h:567
*list< string > children
A list of child data providers in this data provider.
Definition AbstractDataProvider.qc.dox.h:892
bool supports_observable
Does this data provider support the event API / observer pattern?
Definition AbstractDataProvider.qc.dox.h:712
bool supports_upsert
Does the data provider support record upserts (create or update)?
Definition AbstractDataProvider.qc.dox.h:597
bool supports_bulk_create
Does the data provider support native / optimized bulk creation?
Definition AbstractDataProvider.qc.dox.h:623
*hash< string, hash< DataProviderOptionInfo > > delete_field_options
Delete field options supported by the data provider.
Definition AbstractDataProvider.qc.dox.h:837
*hash< string, hash< DataProviderOptionInfo > > send_message_options
Send message options supported by the data provider.
Definition AbstractDataProvider.qc.dox.h:844
bool supports_children
Does the data provider support children?
Definition AbstractDataProvider.qc.dox.h:641
bool children_can_support_apis
Can any child data providers offer API services (request - response data providers)?
Definition AbstractDataProvider.qc.dox.h:737
*string connection_event
Connection event for event-based connection-capable data providers.
Definition AbstractDataProvider.qc.dox.h:882
bool children_can_support_records
Can any child data providers offer record-based providers?
Definition AbstractDataProvider.qc.dox.h:742
*hash< string, hash< DataProviderOptionInfo > > update_field_options
Update field options supported by the data provider.
Definition AbstractDataProvider.qc.dox.h:830
*string desc
A markdown description of the data provider.
Definition AbstractDataProvider.qc.dox.h:572
bool supports_schema
Does the data provider support a schema?
Definition AbstractDataProvider.qc.dox.h:698
bool children_can_support_transactions
Can any child data providers support transaction management?
Definition AbstractDataProvider.qc.dox.h:757
int search_logic_capabilities
Supported search logic capabilities.
Definition AbstractDataProvider.qc.dox.h:870
*string schema_type
Returns the schema type supported by this data provider.
Definition AbstractDataProvider.qc.dox.h:768
bool has_record
Does the data provider provide a record?
Definition AbstractDataProvider.qc.dox.h:651
Data provider message and event info.
Definition AbstractDataProvider.qc.dox.h:249
string desc
The description of the message or event.
Definition AbstractDataProvider.qc.dox.h:253
AbstractDataProviderType type
The data type of the message or event.
Definition AbstractDataProvider.qc.dox.h:256
Data provider option info.
Definition AbstractDataProvider.qc.dox.h:49
string display_name
Option display name.
Definition AbstractDataProvider.qc.dox.h:51
softlist< AbstractDataProviderType > type
The option value type or types.
Definition AbstractDataProvider.qc.dox.h:60
bool multiselect
Are allowed values elements of the list's element type that indicate what values the list can have?
Definition AbstractDataProvider.qc.dox.h:81
auto example_value
Any optional example value for the option.
Definition AbstractDataProvider.qc.dox.h:100
bool sensitive
Is the option value sensitive?
Definition AbstractDataProvider.qc.dox.h:78
auto default_value
Any default value.
Definition AbstractDataProvider.qc.dox.h:75
*softlist< hash< Util::AllowedValueInfo > > allowed_values
List of allowed values (enum)
Definition AbstractDataProvider.qc.dox.h:84
*list< string > required_groups
Is the option part of a required group?
Definition AbstractDataProvider.qc.dox.h:72
*string element_ref_data
A tag allowing element allowed values to be returned dynamically as reference data.
Definition AbstractDataProvider.qc.dox.h:114
bool allowed_values_creatable
Does the option accept values not defined in allowed_values too?
Definition AbstractDataProvider.qc.dox.h:87
*string short_desc
Option short description in plain text.
Definition AbstractDataProvider.qc.dox.h:54
string desc
The option description.
Definition AbstractDataProvider.qc.dox.h:57
*bool preselected
Should this option be preselected?
Definition AbstractDataProvider.qc.dox.h:120
*softlist< hash< Util::AllowedValueInfo > > element_allowed_values
List of allowed values for elements of list types (enum)
Definition AbstractDataProvider.qc.dox.h:92
bool element_allowed_values_creatable
Does the option accept values for elements not defined in element_allowed_values too?
Definition AbstractDataProvider.qc.dox.h:95
*string ref_data
A tag allowing allowed values to be returned dynamically as reference data.
Definition AbstractDataProvider.qc.dox.h:107
bool required
Required flag.
Definition AbstractDataProvider.qc.dox.h:66
*string default_ref_data
A tag allowing the default value for the option to be returned dynamically.
Definition AbstractDataProvider.qc.dox.h:117
Data provider signature argument info.
Definition AbstractDataProvider.qc.dox.h:355
int type_code
The signature type code.
Definition AbstractDataProvider.qc.dox.h:360
AbstractDataProviderType type
Argument types.
Definition AbstractDataProvider.qc.dox.h:357
Data provider summary info.
Definition AbstractDataProvider.qc.dox.h:124
bool supports_observable
Does this data provider support the event API / observer pattern?
Definition AbstractDataProvider.qc.dox.h:195
bool supports_bulk_upsert
Does the data provider support native / optimized bulk upserts?
Definition AbstractDataProvider.qc.dox.h:174
bool transaction_management
Does the data provider require transaction management?
Definition AbstractDataProvider.qc.dox.h:183
bool children_can_support_apis
Can any child data providers offer API services (request - response data providers)?
Definition AbstractDataProvider.qc.dox.h:220
bool supports_create
Does the data provider support record creation?
Definition AbstractDataProvider.qc.dox.h:144
*string short_desc
Data provider short description in plain text.
Definition AbstractDataProvider.qc.dox.h:132
string name
The name of the data provider.
Definition AbstractDataProvider.qc.dox.h:126
bool supports_read
Does the data provider support reading.
Definition AbstractDataProvider.qc.dox.h:141
string desc
The description of the data provider; supports markdown.
Definition AbstractDataProvider.qc.dox.h:135
bool has_record
Does the data provider provide a record?
Definition AbstractDataProvider.qc.dox.h:186
bool children_can_support_transactions
Can any child data providers support transaction management?
Definition AbstractDataProvider.qc.dox.h:240
bool children_can_support_observers
Can any child data providers support the observer pattern / event API?
Definition AbstractDataProvider.qc.dox.h:230
string display_name
Data provider display name.
Definition AbstractDataProvider.qc.dox.h:129
bool supports_upsert
Does the data provider support record upserts (create or update)?
Definition AbstractDataProvider.qc.dox.h:150
bool supports_children
Does the data provider support children?
Definition AbstractDataProvider.qc.dox.h:180
bool supports_bulk_create
Does the data provider support native / optimized bulk creation?
Definition AbstractDataProvider.qc.dox.h:168
bool supports_delete
Does the data provider support record deletion?
Definition AbstractDataProvider.qc.dox.h:153
bool supports_request
Does the data provider support the request API?
Definition AbstractDataProvider.qc.dox.h:177
bool supports_search_expressions
Does this data provide support advanced search expressions?
Definition AbstractDataProvider.qc.dox.h:189
bool children_can_support_messages
Can any child data providers support messages?
Definition AbstractDataProvider.qc.dox.h:235
bool supports_native_search
Does the data provider support native record searching?
Definition AbstractDataProvider.qc.dox.h:156
string supports_messages
Message support.
Definition AbstractDataProvider.qc.dox.h:205
bool children_identical
Are all children always of the same data provider class that support the same options?
Definition AbstractDataProvider.qc.dox.h:245
string type
The name of the provider type.
Definition AbstractDataProvider.qc.dox.h:138
bool supports_update
Does the data provider support record updates?
Definition AbstractDataProvider.qc.dox.h:147
bool supports_connections
Does the data provider support connections and connection status reporting?
Definition AbstractDataProvider.qc.dox.h:210
bool supports_bulk_read
Does the data provider support native / optimized bulk reads?
Definition AbstractDataProvider.qc.dox.h:162
bool children_can_support_records
Can any child data providers offer record-based providers?
Definition AbstractDataProvider.qc.dox.h:225
bool supports_auto_reconnect
Does the data provider support automatic reconnection?
Definition AbstractDataProvider.qc.dox.h:215