60 softlist<AbstractDataProviderType>
type;
390 softlist<hash<DataProviderSignatureTypeInfo>>
args;
674 *hash<string, hash<DataProviderMessageInfo>>
events;
681 *hash<string, hash<DataProviderMessageInfo>>
messages;
693 hash<string, hash<MapperRuntimeKeyInfo>>
mapper_keys = Mapper::MapperKeyInfo;
717 "desc":
"logical AND operation supporting logic short-circuiting",
723 "impl":
auto sub (hash<auto> rec, hash<DataProviderExpression>
exp) {
724 foreach auto arg in (
exp.args) {
737 "desc":
"logical OR operation supporting logic short-circuiting",
743 "impl":
auto sub (hash<auto> rec, hash<DataProviderExpression>
exp) {
744 foreach auto arg in (
exp.args) {
756 "name":
"equals (=)",
757 "desc":
"a value for equality comparisons; the type of the value should correspond to the field "
763 "impl":
auto sub (hash<auto> rec, hash<DataProviderExpression>
exp) {
776 "name":
"not equals (!=)",
777 "desc":
"a value for not-equals comparisons; the type of the value should correspond to the "
783 "impl":
auto sub (hash<auto> rec, hash<DataProviderExpression>
exp) {
792 "name":
"less than (<)",
793 "desc":
"a value for less than comparisons; if the field value is less than the argument, then "
794 "the operation returns true; the type of the value should correspond to the field type",
799 "impl":
auto sub (hash<auto> rec, hash<DataProviderExpression>
exp) {
808 "name":
"less than or equals (<=)",
809 "desc":
"a value for less than or equals comparisons; if the field value is less than or equal "
810 "to the argument, then the operation returns true; the type of the value should correspond "
816 "impl":
auto sub (hash<auto> rec, hash<DataProviderExpression>
exp) {
825 "name":
"greater than (>)",
826 "desc":
"a value for less than comparisons; if the field value is less than the argument, then "
827 "the operation returns true; the type of the value should correspond to the field type",
832 "impl":
auto sub (hash<auto> rec, hash<DataProviderExpression>
exp) {
841 "name":
"greater than or equals (>=)",
842 "desc":
"a value for greater than or equals comparisons; if the field value is greater than or "
843 "equal to the argument, then the operation returns true; the type of the value should "
844 "correspond to the field type",
849 "impl":
auto sub (hash<auto> rec, hash<DataProviderExpression>
exp) {
859 "desc":
"A list with two elements giving the lower and upper bounds of the field value; the list "
860 "element value types must be equal to the field's type",
869 "impl":
auto sub (hash<auto> rec, hash<DataProviderExpression>
exp) {
880 "desc":
"A list giving possible values of the field; if the field's value matches any of the "
881 "values in the list, then the operation returns true; element value types must be equal to "
888 "impl":
auto sub (hash<auto> rec, hash<DataProviderExpression>
exp) {
897 "name":
"logical not (!)",
898 "desc":
"This operator reverses the logcal value of the operator expression given as an argument",
903 "impl":
auto sub (hash<auto> rec, hash<DataProviderExpression>
exp) {
911 "name":
"regular expression match",
912 "desc":
"regular expression operator; the first argument will be processed with the second as a "
913 "regular expression pattern",
927 "impl":
auto sub (hash<auto> rec, hash<DataProviderExpression>
exp) {
930 arg1.pattern, arg1.options);
945 TypedHash::forName(
"DataProviderSummaryInfo").getMembers();
969 "desc":
"allows a subset of fields to be output in searches",
973 "desc":
"the maximum number of records to return",
977 "desc":
"the offset number in records to return",
1100 *hash<auto> search_options) {
1118 *hash<DataProviderExpression> where_cond, *hash<auto> search_options) {
1120 if (block_size <= 0);
1122 search_options = validateSearchOptions(search_options);
1123 return searchRecordsBulkImpl(block_size, processSearchParameters(where_cond, search_options),
1138 *hash<auto> search_options) {
1140 if (block_size <= 0);
1142 search_options = validateSearchOptions(search_options);
1143 return searchRecordsBulkImpl(block_size,
getSearchExpression(where_cond, search_options), search_options);
1155 *hash<auto> search_options) {
1157 search_options = validateSearchOptions(search_options);
1158 return searchRecordsImpl(processSearchParameters(where_cond, search_options), search_options);
1182 *hash<auto> search_options) {
1185 return requestSearchRecordsImpl(req, processSearchParameters(where_cond, search_options), search_options);
1198 *hash<auto> search_options) {
1201 return requestSearchRecordsImpl(req,
getSearchExpression(where_cond, search_options), search_options);
1216 bool updateSingleRecord(hash<auto> set, hash<DataProviderExpression> where_cond, *hash<auto> search_options);
1245 int updateRecords(hash<auto> set, *hash<DataProviderExpression> where_cond, *hash<auto> search_options);
1259 int updateRecords(hash<auto> set, *hash<auto> where_cond, *hash<auto> search_options);
1275 int deleteRecords(*hash<DataProviderExpression> where_cond, *hash<auto> search_options);
1317 *hash<auto> child_create_options) {
1319 child_create_options = validateChildCreateOptions(child_create_options);
1322 on_error
if (1.err !=
'CREATE-CHILD-PROVIDER-ERROR');
1324 return createChildProviderImpl(name, fields, child_create_options);
1389 sendMessage(
string message_id,
auto msg, *hash<auto> send_message_options);
1731 hash<DataProviderExpressionInfo> expinfo,
string key,
auto value) {
1734 hash<DataProviderExpression> rv;
1735 if (value.typeCode() ==
NT_HASH && value.op && value.hasKey(
'arg'));
1739 int caps = role ==
ER_Search ? info.search_logic_capabilities : 0;
1751 string key,
auto value) {
1752 if (!info.expressions.
'=');
1754 return <DataProviderExpression>{
1765 *
hash<
string, hash<DataProviderExpressionInfo>> expmap) {
1766 *hash<DataProviderExpressionInfo> expinfo = expmap{
exp};
1769 if (!(expinfo.role & role));
1788 if (val instanceof hash<DataProviderExpression>);
1797 static auto evalGenericExpression(hash<auto> rec, hash<DataProviderExpression>
exp);
1810 static bool setDynamicValueCallbacks(code value_needs_resolution, code resolve_value);
1821 static verifyExpression(
int role, *
hash<
string, hash<DataProviderExpressionInfo>> expmap,
int caps,
1822 AbstractDataProviderType expected_type, hash<DataProviderExpression>
exp) {
1823 hash<DataProviderExpressionInfo> expinfo = AbstractDataProvider::getExpression(role,
exp.exp, expmap);
1824 return AbstractDataProvider::verifyExpression(role, expinfo, caps, expected_type,
exp);
1836 static verifyExpression(
int role, hash<DataProviderExpressionInfo> expinfo,
int caps,
1837 AbstractDataProviderType expected_type, hash<DataProviderExpression>
exp) {
1839 if (
exp.args.lsize() > expinfo.args.size() && !expinfo.varargs);
1841 map AbstractDataProvider::verifyExpressionArgValue(role, caps, expinfo,
exp.args,
1842 if (
exp.args.lsize() > expinfo.args.size());
1844 if (!expected_type.isAssignableFrom(expinfo.return_type));
1855 static verifyExpressionArgValue(
int role,
int caps, hash<DataProviderExpressionInfo> expinfo,
1856 softlist<auto> values,
int pos) {
1857 hash<DataProviderSignatureTypeInfo> arginfo = expinfo.args[pos] ?? expinfo.args.last();
1858 if (arginfo.type_code == ST_Any);
1860 auto val = values[pos];
1861 bool is_exp = val instanceof hash<DataProviderExpression>;
1862 bool is_ref = is_exp ?
False : val instanceof hash<DataProviderFieldReference>;
1864 switch (arginfo.type_code);
1870 static bool checkCallbacks();
1878 *hash<auto> validateCreateOptions(*hash<auto> create_options);
1886 *hash<auto> validateUpsertOptions(*hash<auto> upsert_options);
1894 *hash<auto> validateSearchOptions(*hash<auto> search_options);
1902 *hash<auto> validateRequestOptions(*hash<auto> request_options);
1912 *hash<auto> validateChildCreateOptions(*hash<auto> child_create_options);
1922 *hash<auto> validateChildDeleteOptions(*hash<auto> child_delete_options);
1932 *hash<auto> validateFieldAddOptions(*hash<auto> field_add_options);
1942 *hash<auto> validateFieldUpdateOptions(*hash<auto> field_update_options);
1952 *hash<auto> validateFieldDeleteOptions(*hash<auto> field_delete_options);
1962 *hash<auto> validateSendMessageOptions(*hash<auto> send_message_options);
1968 processConstructorOptions(*
hash<
string, hash<DataProviderOptionInfo>> option_desc, *hash<auto> options);
1973 private *hash<auto> checkOptions(
string err, *
hash<
string, hash<DataProviderOptionInfo>> option_desc,
1974 *hash<auto> options) {
1975 if (!option_desc && options);
1977 if (*list<string> invalid_keys = keys (options - (keys option_desc)));
1981 foreach hash<auto> i in (option_desc.pairIterator());
1992 private *hash<DataProviderExpression> processSearchParameters(*hash<DataProviderExpression>
exp,
1993 *hash<auto> search_options) {
1996 checkSearchExpressions();
1997 hash<DataProviderInfo> info = getInfo();
1998 verifyExpression(ER_Search, info.expressions, info.search_logic_capabilities,
2012 *hash<auto> processFieldValues(*hash<auto> h, *hash<auto> search_options);
2018 error(
string err,
string fmt);
2028 private *hash<auto> searchFirstRecordImpl(hash<auto> where_cond,
2029 *hash<auto> search_options) {
2031 AbstractDataProviderRecordIterator i = searchRecordsImpl(where_cond, search_options);
2044 private *hash<auto> searchSingleRecordImpl(hash<auto> where_cond,
2045 *hash<auto> search_options) {
2047 *list<*hash<auto>> records = map $1, searchRecordsImpl(where_cond, search_options);
2048 if (records.lsize() > 1);
2059 *list<string> getChildProviderNamesImpl();
2067 *AbstractDataProvider getChildProviderImpl(
string name);
2078 *hash<string, AbstractDataField> getRecordType(*hash<auto> search_options);
2082 *hash<string, AbstractDataField> getSoftRecordType(*hash<auto> search_options);
2086 *hash<string, AbstractDataField> getOrNothingRecordType(*hash<auto> search_options);
2093 *hash<string, hash<DataProviderOptionInfo>> getSearchOptions();
2100 *hash<string, hash<DataProviderOptionInfo>> getCreateOptions();
2107 *hash<string, hash<DataProviderOptionInfo>> getUpsertOptions();
2114 *hash<string, hash<DataProviderOptionInfo>> getRequestOptions();
2124 *hash<string, hash<DataProviderOptionInfo>> getChildCreateOptions();
2134 *hash<string, hash<DataProviderOptionInfo>> getChildDeleteOptions();
2144 *hash<string, hash<DataProviderOptionInfo>> getFieldAddOptions();
2154 *hash<string, hash<DataProviderOptionInfo>> getFieldUpdateOptions();
2164 *hash<string, hash<DataProviderOptionInfo>> getFieldDeleteOptions();
2174 *hash<string, hash<DataProviderOptionInfo>> getSendMessageOptions();
2180 string getMessageSupport();
2186 bool supportsRead();
2192 bool supportsBulkRead();
2198 bool supportsCreate();
2204 bool supportsUpdate();
2210 bool supportsUpsert();
2216 bool supportsDelete();
2222 bool supportsNativeSearch();
2228 bool supportsBulkCreate();
2234 bool supportsBulkUpsert();
2240 bool supportsRequest();
2246 bool recordRequiresSearchOptions();
2258 bool supportsCreateChild();
2264 bool supportsDeleteChild();
2270 bool supportsAddField();
2276 bool supportsUpdateField();
2282 bool supportsDeleteField();
2288 bool supportsSchema();
2294 bool supportsSearchExpressions();
2300 bool supportsObservable();
2306 bool supportsMessages();
2312 *
object getSchemaType();
2321 *hash<string, AbstractDataField> getRecordTypeImpl(*hash<auto> search_options);
2333 private AbstractDataProviderBulkRecordInterface searchRecordsBulkImpl(
int block_size = 1000,
2334 *hash<auto> where_cond, *hash<auto> search_options) {
2335 return new DefaultBulkRecordIterface(block_size, searchRecordsImpl(where_cond, search_options));
2344 private AbstractDataProviderRecordIterator searchRecordsImpl(hash<auto> where_cond,
2345 *hash<auto> search_options) {
2346 throwUnimplementedException();
2358 private AbstractDataProviderRecordIterator requestSearchRecordsImpl(
auto req,
2359 *hash<auto> where_cond, *hash<auto> search_options) {
2360 throwUnimplementedException();
2373 *hash<auto> createRecordImpl(hash<auto> rec, *hash<auto> create_options);
2384 string upsertRecordImpl(hash<auto> rec, *hash<auto> upsert_options);
2393 private bool updateSingleRecordImpl(hash<auto> set, hash<auto> where_cond,
2394 *hash<auto> search_options) {
2395 throwUnimplementedException();
2405 private int updateRecordsImpl(hash<auto> set, *hash<auto> where_cond,
2406 *hash<auto> search_options) {
2407 throwUnimplementedException();
2418 int deleteRecordsImpl(*hash<auto> where_cond, *hash<auto> search_options);
2429 auto doRequestImpl(
auto req, *hash<auto> request_options);
2442 private AbstractDataProvider createChildProviderImpl(
string name, hash<string, AbstractDataField> fields,
2443 *hash<auto> child_create_options) {
2444 throwUnimplementedException();
2454 deleteChildProviderImpl(
string name, *hash<auto> child_delete_options);
2466 addFieldImpl(AbstractDataField field, *hash<auto> field_add_options);
2478 updateFieldImpl(
string name, AbstractDataField field, *hash<auto> field_update_options);
2489 deleteFieldImpl(
string name, *hash<auto> field_delete_options);
2502 sendMessageImpl(
string message_id,
auto msg, *hash<auto> send_message_options);
2512 object getSchemaObjectImpl();
2522 *AbstractDataProviderType getRequestTypeImpl();
2532 *AbstractDataProviderType getResponseTypeImpl();
2542 *hash<string, AbstractDataProviderType> getErrorResponseTypesImpl();
2554 AbstractDataProviderType getErrorResponseTypeImpl(
string error_code);
2570 hash<DataProviderMessageInfo> getEventInfoImpl(
string event_id);
2582 hash<string, hash<DataProviderMessageInfo>> getEventTypesImpl();
2596 hash<DataProviderMessageInfo> getMessageInfoImpl(
string message_id);
2608 hash<string, hash<DataProviderMessageInfo>> getMessageTypesImpl();
2616 throwUnimplementedException();
2621 abstract string getName();
2625 abstract hash<DataProviderInfo> getStaticInfoImpl();
describes a data type based on a hashdecl
Definition: AbstractDataField.qc.dox.h:47
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:707
static code cb_resolve_value
static callback for dynamic value resolution
Definition: AbstractDataProvider.qc.dox.h:958
const GenericExpressions
Generic search operator expressions.
Definition: AbstractDataProvider.qc.dox.h:941
*hash< string, hash< MapperRuntimeKeyInfo > > getMapperRuntimeKeys()
Returns custom data mapper runtime keys.
checkDeleteChild()
Ensures that the data provider supports deleting children.
deleteChildProvider(string name, *hash< auto > child_delete_options)
Deletes a child data provider.
*list< hash< DataProviderSummaryInfo > > getChildProviderSummaryInfo()
Return data provider summary info.
beginTransaction()
Begins a transaction with a data provider.
const DataProviderSummaryInfoKeys
A list of members names of the DataProviderSummaryInfoKeys hashdecl.
Definition: AbstractDataProvider.qc.dox.h:944
*hash< string, AbstractDataProviderType > getErrorResponseTypes()
Returns a hash of error responses, if any.
*AbstractDataProviderType getRequestType()
Returns the description of a successful request message, if any.
checkUpdate()
Ensures that the data provider supports record upserts.
AbstractDataProviderBulkOperation getBulkUpserter()
Returns a bulk upsert operation object for the data provider.
hash< auto > getInfoAsData(*bool with_type_info)
Returns static provider information as data; no objects are returned.
const GenericExpressionImplementations
Generic expression implementations for data providers without native search functionality.
Definition: AbstractDataProvider.qc.dox.h:711
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.
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.
hash< DataProviderInfo > getInfo()
Returns data provider info.
const GenericRecordSearchOptions
Generic record search options; see details below.
Definition: AbstractDataProvider.qc.dox.h:966
commit()
Commits data written to the data provider.
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 supports transaction management.
AbstractDataProviderRecordIterator getRecordIterator(*hash< auto > search_options)
Returns an iterator iterating all records.
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.
Definition: AbstractDataProvider.qc.dox.h:1137
constructor()
Creates the data provider.
*hash< auto > createRecord(hash< auto > rec, *hash< auto > create_options)
Creates the given record in the data provider.
hash< DataProviderMessageInfo > getEventInfo(string event_id)
Returns the description of an observable event, if any.
setLogger(Logger logger)
Sets or replaces the logger.
hash< DataProviderMessageInfo > getMessageInfo(string message_id)
Returns the description of an outbound message, if any.
deleteField(string name, *hash< auto > field_delete_options)
Deletes an existing field.
int deleteRecords(*hash< DataProviderExpression > where_cond, *hash< auto > search_options)
Deletes zero or more records.
static private hash< DataProviderExpressionInfo > getExpression(int role, string exp, *hash< string, hash< DataProviderExpressionInfo >> expmap)
Returns an expression definition for an expression code or throws an exception.
Definition: AbstractDataProvider.qc.dox.h:1764
*Logger logger
Logger for logging.
Definition: AbstractDataProvider.qc.dox.h:949
rollback()
Rolls back data written to the data provider.
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.
*hash< auto > searchFirstRecord(hash< DataProviderExpression > where_cond, *hash< auto > search_options)
Returns the first record matching the search options.
*AbstractDataProviderType getResponseType()
Returns the description of a response message, if this object represents a response message.
static bool callbacks_locked
flag if callbacks are locked
Definition: AbstractDataProvider.qc.dox.h:952
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.
Definition: AbstractDataProvider.qc.dox.h:1197
AbstractDataProviderBulkOperation getBulkInserter()
Returns a bulk insert operation object for 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.
static code cb_value_needs_resolution
static callback the returns a bool if the value needs dynamic resolution
Definition: AbstractDataProvider.qc.dox.h:955
object getSchemaObject()
Returns the schema supporting this data provider.
checkCreate()
Ensures that the data provider supports record creation.
checkSchema()
Ensures that the data provider supports a schema.
checkRead()
Ensures that the data provider supports read operations.
private hash< DataProviderExpression > getSimpleArgumentIntern(int role, hash< DataProviderInfo > info, hash< DataProviderExpressionInfo > expinfo, string key, auto value)
Returns an argument for an expression.
Definition: AbstractDataProvider.qc.dox.h:1730
*string getDesc()
Returns the data provider description.
*hash< auto > searchFirstRecord(hash< auto > where_cond, *hash< auto > search_options)
Returns the first record matching the search options.
AbstractDataProviderBulkRecordInterface getBulkRecordInterface(int block_size=1000, *hash< auto > search_options)
Returns an iterator iterating all records with the bulk read API.
Definition: AbstractDataProvider.qc.dox.h:1099
int updateRecords(hash< auto > set, *hash< auto > where_cond, *hash< auto > search_options)
Updates zero or more records matching the search options.
*hash< auto > searchSingleRecord(hash< auto > where_cond, *hash< auto > search_options)
Returns a single record matching the search options.
hash< DataProviderSummaryInfo > getSummaryInfo()
Return data provider summary info.
*hash< auto > getSearchExpression(*hash< auto > where_cond, *hash< auto > search_options)
Returns a search expression for a standard search hash.
*hash< auto > searchSingleRecord(hash< DataProviderExpression > where_cond, *hash< auto > search_options)
Returns a single record matching the search options.
hash< string, hash< DataProviderMessageInfo > > getMessageTypes()
Returns a hash of all supported outbound messages.
AbstractDataProviderRecordIterator searchRecords(*hash< auto > where_cond, *hash< auto > search_options)
Returns an iterator for zero or more records matching the search options.
checkDelete()
Ensures that the data provider supports record deletion.
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.
Definition: AbstractDataProvider.qc.dox.h:1154
checkDeleteField()
Ensures that the data provider supports deleting fields.
AbstractDataProvider getChildProviderPath(string path)
Returns the given child provider from a "/" separated path string.
constructor(Logger logger)
Creates the data provider with the given Logger.
*list< string > getChildProviderNames()
Returns a list of child data provider names, if any.
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.
Definition: AbstractDataProvider.qc.dox.h:1316
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.
private hash< DataProviderExpression > getEqualityComparisonExpression(int role, hash< DataProviderInfo > info, string key, auto value)
Returns an equality comparison expression.
Definition: AbstractDataProvider.qc.dox.h:1750
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.
Definition: AbstractDataProvider.qc.dox.h:1181
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.
Definition: AbstractDataProvider.qc.dox.h:1117
int deleteRecords(*hash< auto > where_cond, *hash< auto > search_options)
Deletes zero or more records.
checkUpsert()
Ensures that the data provider supports record upserts.
hash< string, hash< DataProviderMessageInfo > > getEventTypes()
Returns a hash of all supported event types.
Defines the abstract class for data provider iterators; the destructor releases the iterator.
Definition: AbstractDataProviderRecordIterator.qc.dox.h:339
describes a data type
Definition: AbstractDataProviderType.qc.dox.h:187
static AbstractDataProviderType get(Type type, *hash< auto > options, *hash< auto > tags)
Returns an appropriate object for the given type.
describes a data type based on a hash
Definition: HashDataType.qc.dox.h:36
describes a data type based on a hashdecl
Definition: QoreDataField.qc.dox.h:34
bool regex(string str, string regex, int options=0)
hash< auto > hash(object obj)
Qore AbstractDataField class definition.
Definition: AbstractDataField.qc.dox.h:27
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 DP_SEARCH_OP_EQ
Identifies the generic data provider equals operator (=) for use in generic search criteria.
Definition: AbstractDataProviderRecordIterator.qc.dox.h:81
const ER_All
Indicates an expression that can be used in all contexts.
Definition: AbstractDataProvider.qc.dox.h:234
const UpsertResultInserted
Indicates that the record was inserted.
Definition: AbstractDataProvider.qc.dox.h:33
const DP_OP_OR
OR logic.
Definition: AbstractDataProviderRecordIterator.qc.dox.h:41
const DP_SEARCH_OP_REGEX
Identifies the regex operator for use in generic search criteria.
Definition: AbstractDataProviderRecordIterator.qc.dox.h:51
const MSG_None
No output type.
Definition: AbstractDataProvider.qc.dox.h:179
const ST_Value
Indicates any literal value of the given type; i.e. not an operator or other expression.
Definition: AbstractDataProvider.qc.dox.h:203
const DP_SEARCH_OP_GT
Identifies the generic data provider greater than operator (>) for use in generic search criteria.
Definition: AbstractDataProviderRecordIterator.qc.dox.h:66
const DataProviderSignatureOptionalIntValueType
Data provider signature *int value type.
Definition: AbstractDataProvider.qc.dox.h:309
const DataProviderSignatureStringType
Data provider signature string type.
Definition: AbstractDataProvider.qc.dox.h:333
const DataProviderSignatureDateType
Data provider signature date type.
Definition: AbstractDataProvider.qc.dox.h:339
const LC_Or
Indicates that boolean expressions can be combined with OR logic.
Definition: AbstractDataProvider.qc.dox.h:254
const DataProviderSignatureHashValueType
Data provider signature hash value type.
Definition: AbstractDataProvider.qc.dox.h:321
const ER_Search
Indicates an expression that can be used in a search operation.
Definition: AbstractDataProvider.qc.dox.h:228
const DP_SEARCH_OP_IN
Identifies the generic data provider "in" operator for use in generic search criteria.
Definition: AbstractDataProviderRecordIterator.qc.dox.h:91
const SignatureTypeDescMap
Maps signature description values to integer codes.
Definition: AbstractDataProvider.qc.dox.h:220
const SignatureTypeCodeMap
Maps signature type codes to descriptions.
Definition: AbstractDataProvider.qc.dox.h:213
const DET_Operator
Indicates an operator expression.
Definition: AbstractDataProvider.qc.dox.h:350
const DataProviderSignatureOptionalStringValueType
Data provider signature optional string value type.
Definition: AbstractDataProvider.qc.dox.h:297
const LogicDescMap
Logic map from descriptions to integer codes.
Definition: AbstractDataProvider.qc.dox.h:267
const DP_SEARCH_OP_GE
Identifies the generic data provider greater than or equals operator (>=) for use in generic search c...
Definition: AbstractDataProviderRecordIterator.qc.dox.h:71
const LC_And
Indicates that boolean expressions can be combined with AND logic.
Definition: AbstractDataProvider.qc.dox.h:251
const DET_Function
Indicates a function expression.
Definition: AbstractDataProvider.qc.dox.h:353
const DP_SEARCH_OP_BETWEEN
Identifies the generic data provider "between" operator for use in generic search criteria.
Definition: AbstractDataProviderRecordIterator.qc.dox.h:86
const DP_OP_AND
AND logic.
Definition: AbstractDataProviderRecordIterator.qc.dox.h:38
const DataProviderSignatureFieldType
Data provider signature field type.
Definition: AbstractDataProvider.qc.dox.h:279
const DP_SEARCH_OP_NE
Identifies the generic data provider not equals operator (!= or <>) for use in generic search criteri...
Definition: AbstractDataProviderRecordIterator.qc.dox.h:76
const DP_SEARCH_OP_NOT
Identifies the generic data provider "not" operator for use in generic search criteria.
Definition: AbstractDataProviderRecordIterator.qc.dox.h:96
const ExpressionTypeDescMap
Maps DataProvider expression type descriptions to integer codes.
Definition: AbstractDataProvider.qc.dox.h:363
const DataProviderSignatureBoolType
Data provider signature bool type.
Definition: AbstractDataProvider.qc.dox.h:327
const AbstractDataProviderTypeMap
Maps Qore type name constant values to AbstractDataProviderType values.
Definition: AbstractDataProviderType.qc.dox.h:121
const DataProviderSignatureListValueType
Data provider signature list value type.
Definition: AbstractDataProvider.qc.dox.h:315
const DataProviderSignatureStringValueType
Data provider signature string value type.
Definition: AbstractDataProvider.qc.dox.h:291
const DataProviderSignatureAnyType
Data provider signature any type.
Definition: AbstractDataProvider.qc.dox.h:285
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:209
const UpsertResultVerified
Indicates that the record was verified as already in the target state.
Definition: AbstractDataProvider.qc.dox.h:39
const DP_SEARCH_OP_LT
Identifies the generic data provider less than (<) operator for use in generic search criteria.
Definition: AbstractDataProviderRecordIterator.qc.dox.h:56
const RoleCodeMap
Role map from codes to descriptions.
Definition: AbstractDataProvider.qc.dox.h:238
const UpsertResultUpdated
Indicates that the record was updated.
Definition: AbstractDataProvider.qc.dox.h:36
const MSG_Async
Asynchronous output type, output can happen any time.
Definition: AbstractDataProvider.qc.dox.h:191
const LC_All
Indicates that all logic capabilities are supported.
Definition: AbstractDataProvider.qc.dox.h:257
const ST_Any
Indicates any valid expression that returns the given type (default)
Definition: AbstractDataProvider.qc.dox.h:200
const LogicCodeMap
Logic map from codes to descriptions.
Definition: AbstractDataProvider.qc.dox.h:261
const DP_SEARCH_OP_LE
Identifies the generic data provider less than or equals (<=) operator for use in generic search crit...
Definition: AbstractDataProviderRecordIterator.qc.dox.h:61
const RoleDescMap
Role map from descriptions to codes.
Definition: AbstractDataProvider.qc.dox.h:243
const ER_Field
Indicates an expression that can be used in a field.
Definition: AbstractDataProvider.qc.dox.h:231
const ExpressionTypeCodeMap
Maps DataProvider expression type codes to descriptions.
Definition: AbstractDataProvider.qc.dox.h:357
const MSG_Sync
Synchronous output type, an output message is expected after each observed event.
Definition: AbstractDataProvider.qc.dox.h:186
const DataProviderSignatureIntValueType
Data provider signature int value type.
Definition: AbstractDataProvider.qc.dox.h:303
Allowed value hash.
Definition: AbstractDataProvider.qc.dox.h:49
auto value
The value.
Definition: AbstractDataProvider.qc.dox.h:51
string desc
Description for the value.
Definition: AbstractDataProvider.qc.dox.h:54
Data provider expression.
Definition: AbstractDataProvider.qc.dox.h:406
string exp
Expression name.
Definition: AbstractDataProvider.qc.dox.h:408
softlist< auto > args
Expression arguments.
Definition: AbstractDataProvider.qc.dox.h:414
Data provider signature info.
Definition: AbstractDataProvider.qc.dox.h:366
string symbol
The symbol to use when rendering expressions.
Definition: AbstractDataProvider.qc.dox.h:382
string name
The display name.
Definition: AbstractDataProvider.qc.dox.h:376
string label
The label used for the expression.
Definition: AbstractDataProvider.qc.dox.h:373
bool varargs
The last argument can be repeated indefinitely.
Definition: AbstractDataProvider.qc.dox.h:396
int role
The expression role code / bitfield.
Definition: AbstractDataProvider.qc.dox.h:387
int type
The type of expression; see DataProvider Expression Type Codes.
Definition: AbstractDataProvider.qc.dox.h:368
softlist< hash< DataProviderSignatureTypeInfo > > args
Argument types.
Definition: AbstractDataProvider.qc.dox.h:390
string desc
The description of the operation.
Definition: AbstractDataProvider.qc.dox.h:379
AbstractDataProviderType return_type
The return type.
Definition: AbstractDataProvider.qc.dox.h:393
Data provider field reference.
Definition: AbstractDataProvider.qc.dox.h:400
string field
The name of the field being referenced.
Definition: AbstractDataProvider.qc.dox.h:402
Data provider info.
Definition: AbstractDataProvider.qc.dox.h:418
string supports_messages
Output message support.
Definition: AbstractDataProvider.qc.dox.h:572
bool supports_delete
Does the data provider support record deletion?
Definition: AbstractDataProvider.qc.dox.h:452
*hash< string, hash< DataProviderMessageInfo > > events
hash of observable events and event types
Definition: AbstractDataProvider.qc.dox.h:674
bool supports_bulk_read
Does the data provider support native / optimized bulk reads?
Definition: AbstractDataProvider.qc.dox.h:465
*hash< string, hash< DataProviderOptionInfo > > add_field_options
Add field options supported by the data provider.
Definition: AbstractDataProvider.qc.dox.h:639
*hash< string, hash< DataProviderMessageInfo > > messages
List of output message IDs and message types.
Definition: AbstractDataProvider.qc.dox.h:681
bool transaction_management
Does the data provider require transaction management?
Definition: AbstractDataProvider.qc.dox.h:496
*hash< string, hash< DataProviderExpressionInfo > > expressions
Expressions (operators and functions) supported by the data provider.
Definition: AbstractDataProvider.qc.dox.h:667
bool children_can_support_observers
Can any child data providers support the observer pattern / event API?
Definition: AbstractDataProvider.qc.dox.h:587
bool supports_child_delete
Does the data provider support deleting new child providers?
Definition: AbstractDataProvider.qc.dox.h:520
string type
The name of the provider type.
Definition: AbstractDataProvider.qc.dox.h:427
bool supports_delete_field
Does the data provider support deleting fields?
Definition: AbstractDataProvider.qc.dox.h:541
bool supports_child_create
Does the data provider support creating new child providers?
Definition: AbstractDataProvider.qc.dox.h:513
*hash< string, hash< DataProviderOptionInfo > > child_delete_options
Child deletion options supported by the data provider.
Definition: AbstractDataProvider.qc.dox.h:632
bool supports_native_search
Does the data provider support native record searching?
Definition: AbstractDataProvider.qc.dox.h:457
*hash< string, hash< DataProviderOptionInfo > > request_options
Request options supported by the data provider.
Definition: AbstractDataProvider.qc.dox.h:618
*hash< string, hash< DataProviderOptionInfo > > search_options
Search options supported by the data provider.
Definition: AbstractDataProvider.qc.dox.h:613
string name
Data provider name.
Definition: AbstractDataProvider.qc.dox.h:422
bool supports_add_field
Does the data provider support adding new fields?
Definition: AbstractDataProvider.qc.dox.h:527
bool supports_bulk_upsert
Does the data provider support native / optimized bulk upserts?
Definition: AbstractDataProvider.qc.dox.h:481
*hash< string, hash< DataProviderOptionInfo > > child_create_options
Child creation options supported by the data provider.
Definition: AbstractDataProvider.qc.dox.h:625
hash< string, hash< MapperRuntimeKeyInfo > > mapper_keys
A hash of mapper key information.
Definition: AbstractDataProvider.qc.dox.h:693
bool supports_read
Does the data provider support reading.
Definition: AbstractDataProvider.qc.dox.h:432
bool record_requires_search_options
Do we require search options to retrieve the record type?
Definition: AbstractDataProvider.qc.dox.h:506
bool supports_update
Does the data provider support record updates?
Definition: AbstractDataProvider.qc.dox.h:442
bool supports_search_expressions
Does this data provide support advanced search experssions?
Definition: AbstractDataProvider.qc.dox.h:555
*hash< string, hash< DataProviderOptionInfo > > upsert_options
Upsert options supported by the data provider.
Definition: AbstractDataProvider.qc.dox.h:608
bool supports_update_field
Does the data provider support updating existing fields?
Definition: AbstractDataProvider.qc.dox.h:534
bool supports_request
Does the data provider support the request API?
Definition: AbstractDataProvider.qc.dox.h:486
*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:598
*hash< string, hash< DataProviderOptionInfo > > create_options
Create options supported by the data provider.
Definition: AbstractDataProvider.qc.dox.h:603
bool supports_create
Does the data provider support record creation?
Definition: AbstractDataProvider.qc.dox.h:437
*list< string > children
A list of child data providers in this data provider.
Definition: AbstractDataProvider.qc.dox.h:703
bool supports_observable
Does this data provider support the event API / observer pattern?
Definition: AbstractDataProvider.qc.dox.h:562
bool supports_upsert
Does the data provider support record upserts (create or update)?
Definition: AbstractDataProvider.qc.dox.h:447
bool supports_bulk_create
Does the data provider support native / optimized bulk creation?
Definition: AbstractDataProvider.qc.dox.h:473
*hash< string, hash< DataProviderOptionInfo > > delete_field_options
Delete field options supported by the data provider.
Definition: AbstractDataProvider.qc.dox.h:653
*hash< string, hash< DataProviderOptionInfo > > send_message_options
Send message options supported by the data provider.
Definition: AbstractDataProvider.qc.dox.h:660
bool supports_children
Does the data provider support children?
Definition: AbstractDataProvider.qc.dox.h:491
bool children_can_support_apis
Can any child data providers offer API services (request - response data providers)?
Definition: AbstractDataProvider.qc.dox.h:577
bool children_can_support_records
Can any child data providers offer record-based providers?
Definition: AbstractDataProvider.qc.dox.h:582
*hash< string, hash< DataProviderOptionInfo > > update_field_options
Update field options supported by the data provider.
Definition: AbstractDataProvider.qc.dox.h:646
*string desc
A markdown description of the data provider.
Definition: AbstractDataProvider.qc.dox.h:698
bool supports_schema
Does the data provider support a schema?
Definition: AbstractDataProvider.qc.dox.h:548
int search_logic_capabilities
Supported search logic capabilities.
Definition: AbstractDataProvider.qc.dox.h:686
*string schema_type
Returns the schema type supported by this data provider.
Definition: AbstractDataProvider.qc.dox.h:593
bool has_record
Does the data provider provide a record?
Definition: AbstractDataProvider.qc.dox.h:501
Data provider message and event info.
Definition: AbstractDataProvider.qc.dox.h:158
string desc
The description of the message or event.
Definition: AbstractDataProvider.qc.dox.h:162
AbstractDataProviderType type
The data type of the message or event.
Definition: AbstractDataProvider.qc.dox.h:165
Data provider option info.
Definition: AbstractDataProvider.qc.dox.h:58
softlist< AbstractDataProviderType > type
The option value type or types.
Definition: AbstractDataProvider.qc.dox.h:60
bool sensitive
Is the option value sensitive?
Definition: AbstractDataProvider.qc.dox.h:72
auto default_value
Any default value.
Definition: AbstractDataProvider.qc.dox.h:69
string desc
The option description.
Definition: AbstractDataProvider.qc.dox.h:66
*softlist< hash< AllowedValueInfo > > allowed_values
List of allowed values (enum)
Definition: AbstractDataProvider.qc.dox.h:75
bool required
Required flag.
Definition: AbstractDataProvider.qc.dox.h:63
Data provider signature argument info.
Definition: AbstractDataProvider.qc.dox.h:270
int type_code
The signature type code.
Definition: AbstractDataProvider.qc.dox.h:275
AbstractDataProviderType type
Argument types.
Definition: AbstractDataProvider.qc.dox.h:272
Data provider summary info.
Definition: AbstractDataProvider.qc.dox.h:79
bool supports_observable
Does this data provider support the event API / observer pattern?
Definition: AbstractDataProvider.qc.dox.h:144
bool supports_bulk_upsert
Does the data provider support native / optimized bulk upserts?
Definition: AbstractDataProvider.qc.dox.h:123
bool transaction_management
Does the data provider require transaction management?
Definition: AbstractDataProvider.qc.dox.h:132
bool supports_create
Does the data provider support record creation?
Definition: AbstractDataProvider.qc.dox.h:93
string name
The name of the data provider.
Definition: AbstractDataProvider.qc.dox.h:81
bool supports_read
Does the data provider support reading.
Definition: AbstractDataProvider.qc.dox.h:90
string desc
The description of the data provider; supports markdown.
Definition: AbstractDataProvider.qc.dox.h:84
bool has_record
Does the data provider provide a record?
Definition: AbstractDataProvider.qc.dox.h:135
bool supports_upsert
Does the data provider support record upserts (create or update)?
Definition: AbstractDataProvider.qc.dox.h:99
bool supports_children
Does the data provider support children?
Definition: AbstractDataProvider.qc.dox.h:129
bool supports_bulk_create
Does the data provider support native / optimized bulk creation?
Definition: AbstractDataProvider.qc.dox.h:117
bool supports_delete
Does the data provider support record deletion?
Definition: AbstractDataProvider.qc.dox.h:102
bool supports_request
Does the data provider support the request API?
Definition: AbstractDataProvider.qc.dox.h:126
bool supports_search_expressions
Does this data provide support advanced search experssions?
Definition: AbstractDataProvider.qc.dox.h:138
bool supports_native_search
Does the data provider support native record searching?
Definition: AbstractDataProvider.qc.dox.h:105
string supports_messages
Message support.
Definition: AbstractDataProvider.qc.dox.h:154
string type
The name of the provider type.
Definition: AbstractDataProvider.qc.dox.h:87
bool supports_update
Does the data provider support record updates?
Definition: AbstractDataProvider.qc.dox.h:96
bool supports_bulk_read
Does the data provider support native / optimized bulk reads?
Definition: AbstractDataProvider.qc.dox.h:111