![]() |
Qore DataProvider Module Reference 3.1
|
DataProvider action and application catalog class. More...
#include <DataProviderActionCatalog.qc.dox.h>
Static Public Member Functions | |
| static hash< DataProviderActionInfo > | checkAppActionOptions (string app, string action) |
| Check that the action has had its options initialized if necessary and return the possibly updated action info. | |
| static *int | checkName (string name) |
| Checks for a valid name. | |
| static int | compareActions (hash< DataProviderActionInfo > act0, hash< DataProviderActionInfo > act1) |
| Compares two actions for equality. | |
| static int | compareBaseTypes (*Type t0, *Type t1) |
| Compares two types for equality. | |
| static int | compareOptions (*hash< string, hash< ActionOptionInfo > > opt0, *hash< string, hash< ActionOptionInfo > > opt1) |
| Compares two option hashes for equality. | |
| static *hash< DataProviderAppInfo > | deregisterDynamicApp (string name) |
| Removes a dynamic data provider application. | |
| static *hash< string, hash< DataProviderActionInfo > > | getActionHash (string app) |
| Returns a hash of all actions for the given application. | |
| static *hash< string, hash< DataProviderActionInfo > > | getActionHashEx (string app) |
| Returns a hash of all actions for the given application. | |
| static hash< string, hash< ActionOptionInfo > > | getActionOptionFromFields (hash< auto > fields, *hash< auto > additional_fields) |
| Converts field definitions into option descriptions. | |
| static *list< hash< DataProviderActionInfo > > | getActions (string app) |
| Returns all actions for the given application. | |
| static list< hash< DataProviderActionInfo > > | getActionsEx (string app) |
| Returns all actions for the given application; throws an exception if the app is not registered. | |
| static *list< hash< DataProviderActionInfo > > | getActionsForScheme (string scheme) |
| Returns all actions for a particular connection scheme. | |
| static *list< hash< DataProviderActionInfo > > | getAllActions () |
| Returns all actions in the cache. | |
| static *list< hash< DataProviderAppInfo > > | getAllApps () |
| Returns all applications in the cache. | |
| static *list< hash< DataProviderAppInfo > > | getAllAppsNoInit () |
| Returns all applications in the cache without initializing actions. | |
| static *hash< DataProviderAppInfo > | getApp (string app) |
| Returns the application definition for the given application name. | |
| static *hash< DataProviderActionInfo > | getAppAction (string app, string action) |
| Returns the action definition for the given application and action. | |
| static hash< DataProviderActionInfo > | getAppActionEx (string app, string action) |
| Returns the application definition for the given application name. | |
| static hash< DataProviderAppInfo > | getAppEx (string app) |
| Returns the application definition for the given application name. | |
| static AbstractDataProvider | getDataProviderForAction (hash< DataProviderActionInfo > action, *reference< hash< auto > > options) |
| Returns a data provider option for the given action and options. | |
| static | registerAction (hash< DataProviderActionInfo > action) |
| Registers a data provider action. | |
| static | registerApp (hash< DataProviderAppInfo > app) |
| Registers a data provider application. | |
| static | registerPendingApp (string app, code init) |
| Registers an app for deferred initialization / initialization on demand. | |
| static | registerPendingAppAction (string app, string action, code init) |
| Registers an app action for deferred initialization / initialization on demand. | |
| static *list< hash< DataProviderActionInfo > > | searchActionRegex (string regex_pattern, int regex_options=RE_Caseless) |
| Searches for actions whose descriptions match a regular expression pattern. | |
| static *list< hash< DataProviderActionInfo > > | searchActionSubstr (string substr, bool ignore_case=True) |
| Searches for actions whose descriptions match a substring. | |
| static *list< hash< DataProviderActionInfo > > | searchAppActionRegex (string app, string regex_pattern, int regex_options=RE_Caseless) |
| Searches for application actions whose descriptions match a regular expression pattern. | |
| static *list< hash< DataProviderActionInfo > > | searchAppActionRegexEx (string app, string regex_pattern, int regex_options=RE_Caseless) |
| Searches for application actions whose descriptions match a regular expression pattern. | |
| static *list< hash< DataProviderActionInfo > > | searchAppActionSubstr (string app, string substr, bool ignore_case=True) |
| Searches for application actions whose descriptions match a substring. | |
| static *list< hash< DataProviderActionInfo > > | searchAppActionSubstrEx (string app, string substr, bool ignore_case=True) |
| Searches for application actions whose descriptions match a substring. | |
| static *list< hash< DataProviderAppInfo > > | searchAppRegex (string regex_pattern, int regex_options=RE_Caseless) |
| Searches for applications whose names or descriptions match a regular expression pattern. | |
| static *list< hash< DataProviderAppInfo > > | searchAppSubstr (string substr, bool ignore_case=True) |
| Searches for applications whose names or descriptions match a substring. | |
Public Attributes | |
| const | RequiredActionKeys = ... |
| Required action key set (without action_code and path_vars, which are checked separately) | |
| const | RequiredAppKeys = ... |
| Required application key set. | |
Protected Attributes | |
| const | DefaultDescription = "" |
| Default description. | |
Static Protected Attributes | |
| static hash< string, hash< string, hash< DataProviderActionInfo > > > | app_actionmap |
| Action cache, the key is the application key, the second key is the action string. | |
| static hash< string, hash< DataProviderAppInfo > > | appcache |
| Top-level master application cache keyed by application name. | |
| static hash< string, hash< string, code > > | initactionmap |
| Pending application action init handler map: app -> action -> init handler. | |
| static hash< string, code > | initmap |
| Pending application init handler map: app -> init handler. | |
| static hash< string, hash< string, bool > > | resolve_output_types |
| Set of actions requiring output type resolution; app -> action -> True. | |
| static hash< string, list< hash< DataProviderActionInfo > > > | smap |
| Scheme map; keys are connection schemes. | |
| static hash< string, hash< DataProviderActionInfo > > | top_actionmap |
| Master action cache, the key <app>/<action> | |
DataProvider action and application catalog class.
|
static |
Checks for a valid name.
|
static |
Compares two actions for equality.
|
static |
Compares two option hashes for equality.
|
static |
Removes a dynamic data provider application.
| name | the name of the dynamic application to remove |
The caller must not be restricted with Qore::PO_NO_PROCESS_CONTROL
| APP-ERROR | app not dynamic |
| PERMISSION-DENIED | Caller is restricted with Qore::PO_NO_PROCESS_CONTROL |
|
static |
Returns a hash of all actions for the given application.
| app | the data provider application |
|
static |
Returns a hash of all actions for the given application.
| app | the data provider application |
| APP-ERROR | the given application is not registered |
|
static |
Returns all actions for the given application.
| app | the data provider application |
|
static |
Returns all actions for the given application; throws an exception if the app is not registered.
| app | the data provider application |
| APP-ERROR | the given application is not registered |
|
static |
Returns all actions for a particular connection scheme.
| scheme | the connection scheme |
|
static |
Returns all actions in the cache.
|
static |
Returns all applications in the cache.
|
static |
Returns all applications in the cache without initializing actions.
|
static |
Returns the application definition for the given application name.
| app | the app name |
|
static |
Returns the action definition for the given application and action.
| app | the app name |
| action | the action name |
|
static |
Returns the application definition for the given application name.
| app | the app name |
| action | the action name |
| APP-ERROR | the given application is not registered |
| ACTION-ERROR | the given action is not registered |
|
static |
Returns the application definition for the given application name.
| app | the app name |
| APP-ERROR | the given application is not registered |
|
static |
Returns a data provider option for the given action and options.
| action | the action to use to return the data provider |
| options | a reference to options where constructor options will be taken from |
|
static |
Registers a data provider action.
| action | the action to register |
| ACTION-ERROR | missing or invalid attributes, action already registered |
The app and action attributes must be unique for every action registered
|
static |
Registers a data provider application.
| app | the application to register |
| APP-ERROR | missing or invalid attributes, app already registered |
|
static |
Registers an app for deferred initialization / initialization on demand.
| app | the application to register |
| init | the initialization code that will register the app |
|
static |
Registers an app action for deferred initialization / initialization on demand.
| app | the application to register |
| action | the action to register |
| init | the initialization code that will register the app |
|
static |
Searches for actions whose descriptions match a regular expression pattern.
| regex_pattern | A regular expression pattern to match in the short_desc and desc fields |
| regex_options | Regular expression options; a case-insensitive match is performed by default |
short_desc or desc fields
|
static |
Searches for actions whose descriptions match a substring.
| substr | A substring to match in the short_desc and desc fields |
| ignore_case | Ignore case when searching |
short_desc or desc fields
|
static |
Searches for application actions whose descriptions match a regular expression pattern.
| app | The application to search for actions in |
| regex_pattern | A regular expression pattern to match in the short_desc and desc fields |
| regex_options | Regular expression options; a case-insensitive match is performed by default |
short_desc or desc fields
|
static |
Searches for application actions whose descriptions match a regular expression pattern.
| app | The application to search for actions in |
| regex_pattern | A regular expression pattern to match in the short_desc and desc fields |
| regex_options | Regular expression options; a case-insensitive match is performed by default |
short_desc or desc fields| APP-ERROR | the given application is not registered |
|
static |
Searches for application actions whose descriptions match a substring.
| app | The application to search for actions in |
| substr | A substring to match in the short_desc and desc fields |
| ignore_case | Ignore case when searching |
short_desc or desc fields
|
static |
Searches for application actions whose descriptions match a substring.
| app | The application to search for actions in |
| substr | A substring to match in the short_desc and desc fields |
| ignore_case | Ignore case when searching |
short_desc or desc fields| APP-ERROR | the given application is not registered |
|
static |
Searches for applications whose names or descriptions match a regular expression pattern.
| regex_pattern | A regular expression pattern to match in the name and desc fields |
| regex_options | Regular expression options; a case-insensitive match is performed by default |
name or desc fields
|
static |
Searches for applications whose names or descriptions match a substring.
| substr | A substring to match in the name and desc fields; pending apps only are matched with the name |
| ignore_case | Ignore case when searching |
name or desc fields