Loading...
Searching...
No Matches
DataProvider::DataProviderInfo Struct Reference

Data provider info. More...

`#include <AbstractDataProvider.qc.dox.h>`

## Public Attributes

*hash< string, hash< DataProviderOptionInfo > > | add_field_options
| Add field options supported by the data provider.
*hash< string, hash< DataProviderOptionInfo > > | child_create_options
| Child creation options supported by the data provider.
*hash< string, hash< DataProviderOptionInfo > > | child_delete_options
| Child deletion options supported by the data provider.
*list< string > | children
| A list of child data providers in this data provider.
bool | children_can_support_apis = False
| Can any child data providers offer API services (request - response data providers)?
bool | children_can_support_messages = False
| Can any child data providers support messages?
bool | children_can_support_observers = False
| Can any child data providers support the observer pattern / event API?
bool | children_can_support_records = False
| Can any child data providers offer record-based providers?
bool | children_can_support_transactions = False
| Can any child data providers support transaction management?
bool | children_identical = False
| Are all children always of the same data provider class that support the same options?
*string | connection_event
| Connection event for event-based connection-capable data providers.
*hash< string, hash< DataProviderOptionInfo > > | constructor_options
| Constructor options supported by the data provider for the constructor variant taking a hash.
*hash< string, hash< DataProviderOptionInfo > > | create_options
| Create options supported by the data provider.
*hash< string, hash< DataProviderOptionInfo > > | delete_field_options
| Delete field options supported by the data provider.
*string | desc
| A markdown description of the data provider.
*string | disconnection_event
| Disconnection event for event-based connection-capable data providers.
string | display_name
| Data provider display name.
*hash< string, hash< DataProviderMessageInfo > > | events
| hash of observable events and event types
*hash< string, hash< DataProviderExpressionInfo > > | expressions
| Expressions (operators and functions) supported by the data provider.
bool | has_record = False
| Does the data provider provide a record?
*hash< auto > | info
| Any optional provider-specific information.
hash< string, hash< MapperRuntimeKeyInfo > > | mapper_keys = Mapper::MapperKeyInfo
| A hash of mapper key information.
*hash< string, hash< DataProviderMessageInfo > > | messages
| List of output message IDs and message types.
string | name
| Data provider name.
bool | record_requires_search_options = False
| Do we require search options to retrieve the record type?
*hash< string, hash< DataProviderOptionInfo > > | request_options
| Request options supported by the data provider.
*string | required_constructor_options
| Required constructor option combinations.
*string | schema_type
| Returns the schema type supported by this data provider.
int | search_logic_capabilities = LC_All
| Supported search logic capabilities.
*hash< string, hash< DataProviderOptionInfo > > | search_options
| Search options supported by the data provider.
*hash< string, hash< DataProviderOptionInfo > > | send_message_options
| Send message options supported by the data provider.
*string | short_desc
| Data provider short description in plain text.
bool | supports_add_field = False
| Does the data provider support adding new fields?
bool | supports_auto_reconnect = False
| Does the data provider support automatic reconnection?
bool | supports_bulk_create = False
| Does the data provider support native / optimized bulk creation?
bool | supports_bulk_read = False
| Does the data provider support native / optimized bulk reads?
bool | supports_bulk_upsert = False
| Does the data provider support native / optimized bulk upserts?
bool | supports_child_create = False
| Does the data provider support creating new child providers?
bool | supports_child_delete = False
| Does the data provider support deleting new child providers?
bool | supports_children = False
| Does the data provider support children?
bool | supports_connections = False
| Does the data provider support connections and connection status reporting?
bool | supports_create = False
| Does the data provider support record creation?
bool | supports_delete = False
| Does the data provider support record deletion?
bool | supports_delete_field = False
| Does the data provider support deleting fields?
string | supports_messages = MSG_None
| Output message support.
bool | supports_native_search = False
| Does the data provider support native record searching?
bool | supports_observable = False
| Does this data provider support the event API / observer pattern?
bool | supports_read = False
| Does the data provider support reading.
bool | supports_request = False
| Does the data provider support the request API?
bool | supports_schema = False
| Does the data provider support a schema?
bool | supports_search_expressions = False
| Does this data provide support advanced search experssions?
bool | supports_update = False
| Does the data provider support record updates?
bool | supports_update_field = False
| Does the data provider support updating existing fields?
bool | supports_upsert = False
| Does the data provider support record upserts (create or update)?
bool | transaction_management = False
| Does the data provider require transaction management?
string | type
| The name of the provider type.
*hash< string, hash< DataProviderOptionInfo > > | update_field_options
| Update field options supported by the data provider.
*hash< string, hash< DataProviderOptionInfo > > | upsert_options
| Upsert options supported by the data provider.

## 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

## children_can_support_apis

bool DataProvider::DataProviderInfo::children_can_support_apis = False

Can any child data providers offer API services (request - response data providers)?

Since
  DataProvider 2.6

## children_can_support_messages

bool DataProvider::DataProviderInfo::children_can_support_messages = False

Can any child data providers support messages?

Since
  DataProvider 2.7

## children_can_support_observers

bool DataProvider::DataProviderInfo::children_can_support_observers = False

Can any child data providers support the observer pattern / event API?

Since
  DataProvider 2.6

## children_can_support_records

bool DataProvider::DataProviderInfo::children_can_support_records = False

Can any child data providers offer record-based providers?

Since
  DataProvider 2.6

## children_can_support_transactions

bool DataProvider::DataProviderInfo::children_can_support_transactions = False

Can any child data providers support transaction management?

Since
  DataProvider 2.8

## children_identical

bool DataProvider::DataProviderInfo::children_identical = False

Are all children always of the same data provider class that support the same options?

Since
  DataProvider 3.0

## connection_event

*string DataProvider::DataProviderInfo::connection_event

Connection event for event-based connection-capable data providers.

Since
  DataProvider 3.0

## 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

## disconnection_event

*string DataProvider::DataProviderInfo::disconnection_event

Disconnection event for event-based connection-capable data providers.

Since
  DataProvider 3.0

## events

*hash<string, hash<DataProviderMessageInfo> > DataProvider::DataProviderInfo::events

hash of observable events and event types

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

Since
  DataProvider 2.5

## 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

## messages

*hash<string, hash<DataProviderMessageInfo> > DataProvider::DataProviderInfo::messages

List of output message IDs and message types.

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

Since
  DataProvider 2.5

## 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

## required_constructor_options

*string DataProvider::DataProviderInfo::required_constructor_options

Required constructor option combinations.

If set it indicates that there are multiple possibilities for the set of required options for the data provider's hash constructor (if any); the format of this string is the required option names separated by commas (`","`); multiple possibilities must be separated by pipe chars (`"|""); ex: \c "client_id`,client_secret,tenant|token";if this option is set, then the `required` attribute of options is ignored

## 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

## send_message_options

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

Send message 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.5

## 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_auto_reconnect

bool DataProvider::DataProviderInfo::supports_auto_reconnect = False

Does the data provider support automatic reconnection?

Since
  DataProvider 3.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_connections

bool DataProvider::DataProviderInfo::supports_connections = False

Does the data provider support connections and connection status reporting?

Since
  DataProvider 3.0

## 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_messages

string DataProvider::DataProviderInfo::supports_messages = MSG_None

Output message support.

See also
  Output Message Support

This attribute defines if the message API is supported by the data provider as well as the relationship to observable events, if any

Since
  DataProvider 2.5

## 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_observable

bool DataProvider::DataProviderInfo::supports_observable = False

Does this data provider support the event API / observer pattern?

If this is True, then the data provider will inherit Observable and can be observed

Since
  DataProvider 2.5

## 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