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

Data provider summary info. More...

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

## Public Attributes

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?
string | desc
| The description of the data provider; supports markdown.
bool | has_record = False
| Does the data provider provide a record?
string | name
| The name of the data provider.
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_children = False
| Does the data provider support children?
bool | supports_create = False
| Does the data provider support record creation?
bool | supports_delete = False
| Does the data provider support record deletion?
string | supports_messages = MSG_None
| 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_search_expressions = False
| Does this data provide support advanced search experssions?
bool | supports_update = False
| Does the data provider support record updates?
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.

## Detailed Description

Data provider summary info.

## Member Data Documentation

## children_can_support_apis

bool DataProvider::DataProviderSummaryInfo::children_can_support_apis = False

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

Since
  DataProvider 2.7

## children_can_support_messages

bool DataProvider::DataProviderSummaryInfo::children_can_support_messages = False

Can any child data providers support messages?

Since
  DataProvider 2.7

## children_can_support_observers

bool DataProvider::DataProviderSummaryInfo::children_can_support_observers = False

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

Since
  DataProvider 2.7

## children_can_support_records

bool DataProvider::DataProviderSummaryInfo::children_can_support_records = False

Can any child data providers offer record-based providers?

Since
  DataProvider 2.7

## children_can_support_transactions

bool DataProvider::DataProviderSummaryInfo::children_can_support_transactions = False

Can any child data providers support transaction management?

Since
  DataProvider 2.8

## supports_bulk_create

bool DataProvider::DataProviderSummaryInfo::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)

## supports_bulk_read

bool DataProvider::DataProviderSummaryInfo::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)

## supports_bulk_upsert

bool DataProvider::DataProviderSummaryInfo::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)

## supports_messages

string DataProvider::DataProviderSummaryInfo::supports_messages = MSG_None

Message support.

This describes the data provider's support for output messages, if any, and the relationship to observed events, if any.

See also
  Output Message Support

Since
  DataProvider 2.5

## supports_observable

bool DataProvider::DataProviderSummaryInfo::supports_observable = False

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

Since
  DataProvider 2.5