Qore DataProvider Module Reference  2.3
DataProvider::DataProviderInfo hashdecl Reference

Data provider info. More...

Public Attributes

*hash< string, hash< DataProviderOptionInfo > > add_field_options
 Add field options supported by the data provider. More...
 
*hash< string, hash< DataProviderOptionInfo > > child_create_options
 Child creation options supported by the data provider. More...
 
*hash< string, hash< DataProviderOptionInfo > > child_delete_options
 Child deletion options supported by the data provider. More...
 
*list< stringchildren
 A list of child data providers in this data provider. More...
 
*hash< string, hash< DataProviderOptionInfo > > constructor_options
 Constructor options supported by the data provider for the constructor variant taking a hash. More...
 
*hash< string, hash< DataProviderOptionInfo > > create_options
 Create options supported by the data provider. More...
 
*hash< string, hash< DataProviderOptionInfo > > delete_field_options
 Delete field options supported by the data provider. More...
 
*string desc
 A markdown description of the data provider. More...
 
*hash< string, hash< DataProviderExpressionInfo > > expressions
 Expressions (operators and functions) supported by the data provider. More...
 
bool has_record = False
 Does the data provider provide a record? More...
 
hash< string, hash< MapperRuntimeKeyInfo > > mapper_keys = Mapper::MapperKeyInfo
 A hash of mapper key information. More...
 
string name
 Data provider name. More...
 
bool record_requires_search_options = False
 Do we require search options to retrieve the record type? More...
 
*hash< string, hash< DataProviderOptionInfo > > request_options
 Request options supported by the data provider. More...
 
*string schema_type
 Returns the schema type supported by this data provider. More...
 
int search_logic_capabilities = LC_All
 Supported search logic capabilities. More...
 
*hash< string, hash< DataProviderOptionInfo > > search_options
 Search options supported by the data provider. More...
 
bool supports_add_field = False
 Does the data provider support adding new fields? More...
 
bool supports_bulk_create = False
 Does the data provider support native / optimized bulk creation? More...
 
bool supports_bulk_read = False
 Does the data provider support native / optimized bulk reads? More...
 
bool supports_bulk_upsert = False
 Does the data provider support native / optimized bulk upserts? More...
 
bool supports_child_create = False
 Does the data provider support creating new child providers? More...
 
bool supports_child_delete = False
 Does the data provider support deleting new child providers? More...
 
bool supports_children = False
 Does the data provider support children? More...
 
bool supports_create = False
 Does the data provider support record creation? More...
 
bool supports_delete = False
 Does the data provider support record deletion? More...
 
bool supports_delete_field = False
 Does the data provider support deleting fields? More...
 
bool supports_native_search = False
 Does the data provider support native record searching? More...
 
bool supports_read = False
 Does the data provider support reading. More...
 
bool supports_request = False
 Does the data provider support the request API? More...
 
bool supports_schema = False
 Does the data provider support a schema? More...
 
bool supports_search_expressions = False
 Does this data provide support advanced search experssions? More...
 
bool supports_update = False
 Does the data provider support record updates? More...
 
bool supports_update_field = False
 Does the data provider support updating existing fields? More...
 
bool supports_upsert = False
 Does the data provider support record upserts (create or update)? More...
 
bool transaction_management = False
 Does the data provider require transaction management? More...
 
string type
 The name of the provider type. More...
 
*hash< string, hash< DataProviderOptionInfo > > update_field_options
 Update field options supported by the data provider. More...
 
*hash< string, hash< DataProviderOptionInfo > > upsert_options
 Upsert options supported by the data provider. More...
 

Detailed Description

Data provider info.

Member Data Documentation

◆ add_field_options

*hash<string, hash<DataProviderOptionInfo> > DataProvider::DataProviderInfo::add_field_options

Add field options supported by the data provider.

Note
this is a static attribute; it is the same for all data providers of the same type
Since
DataProvider 2.0

◆ child_create_options

*hash<string, hash<DataProviderOptionInfo> > DataProvider::DataProviderInfo::child_create_options

Child creation options supported by the data provider.

Note
this is a static attribute; it is the same for all data providers of the same type
Since
DataProvider 2.0

◆ child_delete_options

*hash<string, hash<DataProviderOptionInfo> > DataProvider::DataProviderInfo::child_delete_options

Child deletion options supported by the data provider.

Note
this is a static attribute; it is the same for all data providers of the same type
Since
DataProvider 2.0

◆ children

*list<string> DataProvider::DataProviderInfo::children

A list of child data providers in this data provider.

Note
this is a dynamic attribute; it differs for different data providers of the same type

◆ constructor_options

*hash<string, hash<DataProviderOptionInfo> > DataProvider::DataProviderInfo::constructor_options

Constructor options supported by the data provider for the constructor variant taking a hash.

Note
this is a static attribute; it is the same for all data providers of the same type

◆ create_options

*hash<string, hash<DataProviderOptionInfo> > DataProvider::DataProviderInfo::create_options

Create options supported by the data provider.

Note
this is a static attribute; it is the same for all data providers of the same type

◆ delete_field_options

*hash<string, hash<DataProviderOptionInfo> > DataProvider::DataProviderInfo::delete_field_options

Delete field options supported by the data provider.

Note
this is a static attribute; it is the same for all data providers of the same type
Since
DataProvider 2.0

◆ desc

*string DataProvider::DataProviderInfo::desc

A markdown description of the data provider.

Note
this is a dynamic attribute; it differs for different data providers of the same type

◆ expressions

*hash<string, hash<DataProviderExpressionInfo> > DataProvider::DataProviderInfo::expressions

Expressions (operators and functions) supported by the data provider.

Note
this is a static attribute; it is the same for all data providers of the same type
Since
DataProvider 2.3

◆ has_record

bool DataProvider::DataProviderInfo::has_record = False

Does the data provider provide a record?

Note
this is a static attribute; it is the same for all data providers of the same type

◆ mapper_keys

hash<string, hash<MapperRuntimeKeyInfo> > DataProvider::DataProviderInfo::mapper_keys = Mapper::MapperKeyInfo

A hash of mapper key information.

Note
  • this is a static attribute; it is the same for all data providers of the same type
  • the handler keys are not returned as they are only valid at runtime

◆ name

string DataProvider::DataProviderInfo::name

Data provider name.

Note
this is a dynamic attribute; it differs for different data providers of the same type

◆ record_requires_search_options

bool DataProvider::DataProviderInfo::record_requires_search_options = False

Do we require search options to retrieve the record type?

Note
this is a static attribute; it is the same for all data providers of the same type

◆ request_options

*hash<string, hash<DataProviderOptionInfo> > DataProvider::DataProviderInfo::request_options

Request options supported by the data provider.

Note
this is a static attribute; it is the same for all data providers of the same type

◆ schema_type

*string DataProvider::DataProviderInfo::schema_type

Returns the schema type supported by this data provider.

Since
DataProvider 2.2

◆ search_logic_capabilities

int DataProvider::DataProviderInfo::search_logic_capabilities = LC_All

Supported search logic capabilities.

This is a bitfield of capabilities; see Logic Capability Codes for more info

◆ search_options

*hash<string, hash<DataProviderOptionInfo> > DataProvider::DataProviderInfo::search_options

Search options supported by the data provider.

Note
this is a static attribute; it is the same for all data providers of the same type

◆ supports_add_field

bool DataProvider::DataProviderInfo::supports_add_field = False

Does the data provider support adding new fields?

Note
this is a static attribute; it is the same for all data providers of the same type
Since
DataProvider 2.0

◆ supports_bulk_create

bool DataProvider::DataProviderInfo::supports_bulk_create = False

Does the data provider support native / optimized bulk creation?

if this is False and supports_creation is True, the data provider will still support bulk write APIs but without any performance improvements for bulk data (simulated bulk creates)

Note
this is a static attribute; it is the same for all data providers of the same type

◆ supports_bulk_read

bool DataProvider::DataProviderInfo::supports_bulk_read = False

Does the data provider support native / optimized bulk reads?

if this is False and supports_read is True, the data provider will still support bulk read APIs but without any performance improvements for bulk data (simulated bulk reads)

Note
this is a static attribute; it is the same for all data providers of the same type

◆ supports_bulk_upsert

bool DataProvider::DataProviderInfo::supports_bulk_upsert = False

Does the data provider support native / optimized bulk upserts?

if this is False and supports_upsert is True, the data provider will still support bulk upsert APIs but without any performance improvements for bulk data (simulated bulk upserts)

Note
this is a static attribute; it is the same for all data providers of the same type

◆ supports_child_create

bool DataProvider::DataProviderInfo::supports_child_create = False

Does the data provider support creating new child providers?

Note
this is a static attribute; it is the same for all data providers of the same type
Since
DataProvider 2.0

◆ supports_child_delete

bool DataProvider::DataProviderInfo::supports_child_delete = False

Does the data provider support deleting new child providers?

Note
this is a static attribute; it is the same for all data providers of the same type
Since
DataProvider 2.0

◆ supports_children

bool DataProvider::DataProviderInfo::supports_children = False

Does the data provider support children?

Note
this is a static attribute; it is the same for all data providers of the same type

◆ supports_create

bool DataProvider::DataProviderInfo::supports_create = False

Does the data provider support record creation?

Note
this is a static attribute; it is the same for all data providers of the same type

◆ supports_delete

bool DataProvider::DataProviderInfo::supports_delete = False

Does the data provider support record deletion?

Note
this is a static attribute; it is the same for all data providers of the same type

◆ supports_delete_field

bool DataProvider::DataProviderInfo::supports_delete_field = False

Does the data provider support deleting fields?

Note
this is a static attribute; it is the same for all data providers of the same type
Since
DataProvider 2.0

◆ supports_native_search

bool DataProvider::DataProviderInfo::supports_native_search = False

Does the data provider support native record searching?

Note
this is a static attribute; it is the same for all data providers of the same type

◆ supports_read

bool DataProvider::DataProviderInfo::supports_read = False

Does the data provider support reading.

Note
this is a static attribute; it is the same for all data providers of the same type

◆ supports_request

bool DataProvider::DataProviderInfo::supports_request = False

Does the data provider support the request API?

Note
this is a static attribute; it is the same for all data providers of the same type

◆ supports_schema

bool DataProvider::DataProviderInfo::supports_schema = False

Does the data provider support a schema?

Note
this is a static attribute; it is the same for all data providers of the same type
Since
DataProvider 2.2

◆ supports_search_expressions

bool DataProvider::DataProviderInfo::supports_search_expressions = False

Does this data provide support advanced search experssions?

Note
this is a static attribute; it is the same for all data providers of the same type
Since
DataProvider 2.2

◆ supports_update

bool DataProvider::DataProviderInfo::supports_update = False

Does the data provider support record updates?

Note
this is a static attribute; it is the same for all data providers of the same type

◆ supports_update_field

bool DataProvider::DataProviderInfo::supports_update_field = False

Does the data provider support updating existing fields?

Note
this is a static attribute; it is the same for all data providers of the same type
Since
DataProvider 2.0

◆ supports_upsert

bool DataProvider::DataProviderInfo::supports_upsert = False

Does the data provider support record upserts (create or update)?

Note
this is a static attribute; it is the same for all data providers of the same type

◆ transaction_management

bool DataProvider::DataProviderInfo::transaction_management = False

Does the data provider require transaction management?

Note
this is a static attribute; it is the same for all data providers of the same type

◆ type

string DataProvider::DataProviderInfo::type

The name of the provider type.

Note
this is a static attribute; it is the same for all data providers of the same type

◆ update_field_options

*hash<string, hash<DataProviderOptionInfo> > DataProvider::DataProviderInfo::update_field_options

Update field options supported by the data provider.

Note
this is a static attribute; it is the same for all data providers of the same type
Since
DataProvider 2.0

◆ upsert_options

*hash<string, hash<DataProviderOptionInfo> > DataProvider::DataProviderInfo::upsert_options

Upsert options supported by the data provider.

Note
this is a static attribute; it is the same for all data providers of the same type