DataProvider.qc.dox.h
// -*- mode: c++; indent-tabs-mode: nil -*-
// minimum required Qore version
// assume local scope for variables, do not use "$" signs
// require type definitions everywhere
// enable all warnings
namespace DataProvider {
class DataProvider {
public:
const FactoryMap = {
"db": "DbDataProvider",
"swagger": "SwaggerDataProvider",
"csvread": "CsvUtil",
"csvwrite": "CsvUtil",
"fixedlengthread": "FixedLengthUtil",
"fixedlengthwrite": "FixedLengthUtil",
"salesforcerest": "SalesforceRestDataProvider",
// provided by the xml module
"soap": "SoapDataProvider",
};
const TypeMap = {
"qore/ftp": "FtpPollerUtil",
"qore/sftp": "SftpPollerUtil",
"qore/fsevents": "FsEventPollerUtil",
};
const FactoryModuleList = keys (map {$1: True}, FactoryMap.iterator());
// "map" is used above to ensure that the values only appear once in the final list
protected:
static hash<string, AbstractDataProviderFactory> factory_cache;
static hash<string, string> factory_module_map;
static Mutex factory_cache_lock();
static DataProviderTypeCache type_cache();
static hash<string, string> type_module_map;
static bool allow_env_config = False;
static bool env_config_locked = False;
public:
static registerFactory(AbstractDataProviderFactory factory);
static *AbstractDataProviderFactory getFactory(string name);
static AbstractDataProviderFactory getFactoryEx(string name);
static AbstractDataProvider getFactoryObject(string path, *hash<auto> options);
static AbstractDataProvider getFactoryObjectFromString(string name);
static *list<string> listFactories();
static DataProviderTypeCache getTypeCache();
static registerType(string path, AbstractDataProviderType type);
static *AbstractDataProviderType getType(string path);
static AbstractDataProviderType getTypeEx(string path);
static DataProviderTypeEntry getTypeRoot();
static lockAllTypes();
static *list<string> listTypes();
static registerKnownFactories();
static loadProvidersFromEnvironment();
static registerKnownTypes();
static loadTypesFromEnvironment();
static hash<auto> getInfoAsData(hash<auto> info0);
static setAutoConfig();
static bool getAutoConfig();
static list<string> getPathList(string path);
protected:
static checkRequest();
public:
protected:
static *string tryGetFactoryModuleName(string name);
public:
protected:
static *string tryGetTypeModuleName(string name);
public:
protected:
static *string tryGetModuleName(string name, string func, string type);
public:
protected:
static *DataProviderTypeEntry tryLoadTypeFromPath(list<string> type_path);
public:
protected:
static bool tryLoad(string module_str, *bool verbose);
public:
protected:
static loadFromEnvironment(string func, string type);
public:
protected:
static bool checkInjection(object obj, hash<string, string> module_map);
public:
};
};
DataProvider::DataProvider::getTypeRoot
static DataProviderTypeEntry getTypeRoot()
Returns the root type entry.
DataProvider::AbstractDataProviderFactory
Data provider factory class.
Definition: AbstractDataProviderFactory.qc.dox.h:34
DataProvider::DataProvider::loadProvidersFromEnvironment
static loadProvidersFromEnvironment()
Loads data providers from the environment.
DataProvider::AbstractDataProviderType
describes a data type
Definition: AbstractDataProviderType.qc.dox.h:161
DataProvider::DataProvider::getTypeEx
static AbstractDataProviderType getTypeEx(string path)
Returns the given data provider type or throws an exception if not present.
type
string type(auto arg)
DataProvider::DataProvider::registerFactory
static registerFactory(AbstractDataProviderFactory factory)
Register a new data provider factory.
DataProvider::DataProvider::tryLoad
static bool tryLoad(string module_str, *bool verbose)
Try to load the given module.
DataProvider::DataProvider::type_module_map
static hash< string, string > type_module_map
data provider type module map
Definition: DataProvider.qc.dox.h:76
DataProvider::DataProvider::setAutoConfig
static setAutoConfig()
Sets the flag that allows for automatic configuration from environment variables.
DataProvider::DataProvider::checkRequest
static checkRequest()
Sets the env_config_locked variable if not already set.
DataProvider::DataProvider::getTypeCache
static DataProviderTypeCache getTypeCache()
Returns the data provider cache.
DataProvider::DataProvider::getPathList
static list< string > getPathList(string path)
Returns a list of strings in a path separated by "/" characters.
DataProvider::DataProvider::factory_cache
static hash< string, AbstractDataProviderFactory > factory_cache
data provider factory cache
Definition: DataProvider.qc.dox.h:64
True
const True
DataProvider
Qore AbstractDataField class definition.
Definition: AbstractDataField.qc.dox.h:32
DataProvider::DataProvider::registerKnownTypes
static registerKnownTypes()
Registers all known data provider types.
DataProvider::DataProvider::getInfoAsData
static hash< auto > getInfoAsData(hash< auto > info0)
Converts an info hash with objects to a hash with string descriptions instead of the objects.
DataProvider::DataProvider::loadTypesFromEnvironment
static loadTypesFromEnvironment()
Loads data types from the environment.
DataProvider::DataProvider::getFactoryObjectFromString
static AbstractDataProvider getFactoryObjectFromString(string name)
Returns a data provider object from the given factory with options given as string-formatted hash in ...
DataProvider::DataProvider::registerKnownFactories
static registerKnownFactories()
Registers all known data provider factories.
DataProvider::DataProvider::loadFromEnvironment
static loadFromEnvironment(string func, string type)
Loads modules from the QORE_DATA_PROVIDERS environment variable.
DataProvider::DataProvider::getFactoryObject
static AbstractDataProvider getFactoryObject(string path, *hash< auto > options)
Returns a data provider object from the given factory, created with the given constructor options.
DataProvider::DataProvider::tryLoadTypeFromPath
static *DataProviderTypeEntry tryLoadTypeFromPath(list< string > type_path)
Tries to load the given type.
DataProvider::DataProvider::getFactoryEx
static AbstractDataProviderFactory getFactoryEx(string name)
Returns the given data provider factory or throws an exception if not present.
DataProvider::DataProvider::tryGetModuleName
static *string tryGetModuleName(string name, string func, string type)
Tries to load a module corresponding to the given factory.
DataProvider::DataProvider::getFactory
static *AbstractDataProviderFactory getFactory(string name)
Returns the given data provider factory or NOTHING if not present.
DataProvider::DataProvider::getAutoConfig
static bool getAutoConfig()
Returns the auto config flag.
DataProvider::DataProvider::lockAllTypes
static lockAllTypes()
Locks all types.
DataProvider::AbstractDataProvider
The AbstractDataProvider class.
Definition: AbstractDataProvider.qc.dox.h:194
DataProvider::DataProviderTypeEntry
the DataProviderTypeEntry class
Definition: DataProviderTypeEntry.qc.dox.h:55
DataProvider::DataProvider::tryGetTypeModuleName
static *string tryGetTypeModuleName(string name)
Tries to load a module corresponding to the given factory.
DataProvider::DataProviderTypeCache
Data provider type cache class.
Definition: DataProviderTypeCache.qc.dox.h:35
False
const False
DataProvider::DataProvider::listTypes
static *list< string > listTypes()
Returns a list of registered data provider type paths.
DataProvider::DataProvider::getType
static *AbstractDataProviderType getType(string path)
Returns the given data provider type or NOTHING if not present.
DataProvider::DataProvider::registerType
static registerType(string path, AbstractDataProviderType type)
Register a new data provider type.
DataProvider::DataProvider::checkInjection
static bool checkInjection(object obj, hash< string, string > module_map)
Check if the object is from a module that has been subject to dependency injections.
DataProvider::DataProvider::factory_cache_lock
static Mutex factory_cache_lock()
data provider factory cache lock
DataProvider::DataProvider::listFactories
static *list< string > listFactories()
Returns a list of registered data provider factories.
DataProvider::DataProvider::tryGetFactoryModuleName
static *string tryGetFactoryModuleName(string name)
Tries to load a module corresponding to the given factory.
DataProvider::DataProvider::type_cache
static DataProviderTypeCache type_cache()
data provider data type cache
DataProvider::DataProvider::factory_module_map
static hash< string, string > factory_module_map
data provider factory module map
Definition: DataProvider.qc.dox.h:67