RemoteDbDataProvider::RemoteDbDataProvider Class Reference

The database data provider class, provides tables as children. More...

Inherits AbstractDataProvider.

Public Member Methods
	constructor (string remote, DbRemoteBase db)
	creates the object
	constructor (string remote, string datasource, *hash< auto > opts)
	creates the object
	constructor (*hash< auto > options)
	Creates the object from constructor options.
string	getName ()
	Returns the datasource name.
*string	getDesc ()
	Returns the data provider description.
	commit ()
	Commits any transaction in progress in the remote datasource.
	rollback ()
	Rolls back any transaction in progress in the remote datasource.

Public Attributes
const	ProviderInfo
	Provider info.
const	ConstructorOptions
	Constructor options.
const	SearchOptions
	Search options.

Private Member Methods
*hash< string, AbstractDataField >	getRecordTypeImpl (*hash< auto > search_options)
	Returns the description of the record type, if any.
AbstractDataProviderBulkRecordInterface	searchRecordsBulkImpl (int block_size=1000, *hash< auto > where_cond, *hash< auto > search_options)
	Returns an iterator for zero or more records matching the search options.
AbstractDataProviderRecordIterator	searchRecordsImpl (*hash< auto > where_cond, *hash< auto > search_options)
	Returns an iterator for zero or more records matching the search options.
*list< string >	getChildProviderNamesImpl ()
	Returns a list of child data provider names, if any.
*AbstractDataProvider	getChildProviderImpl (string name)
	Returns the given child provider or NOTHING if the given child is unknown.
hash< DataProviderInfo >	getStaticInfoImpl ()
	Returns data provider static info.

Private Attributes
string	remote
	The remote connection name.
DbRemoteBase	db
	The remote stream object.

Detailed Description

The database data provider class, provides tables as children.

Member Function Documentation

getChildProviderImpl()

*AbstractDataProvider RemoteDbDataProvider::RemoteDbDataProvider::getChildProviderImpl ( string  name )

private

Returns the given child provider or NOTHING if the given child is unknown.

Returns

the given child provider or NOTHING if the given child is unknown

Exceptions

CHILD-PROVIDER-ERROR

error acquiring child provider

See also

getChildProviderEx()

getChildProviderNamesImpl()

*list< string > RemoteDbDataProvider::RemoteDbDataProvider::getChildProviderNamesImpl ( )

private

Returns a list of child data provider names, if any.

Returns

a list of child data provider names, if any

getRecordTypeImpl()

*hash< string, AbstractDataField > RemoteDbDataProvider::RemoteDbDataProvider::getRecordTypeImpl ( *hash< auto >  search_options )

private

Returns the description of the record type, if any.

Parameters

search_options

to be included and processed by validateSearchOptions() if recordRequiresSearchOptions() is True for this provider, otherwise any value provided in this argument is ignored

searchRecordsBulkImpl()

AbstractDataProviderBulkRecordInterface RemoteDbDataProvider::RemoteDbDataProvider::searchRecordsBulkImpl ( int  block_size = 1000, *hash< auto >  where_cond, *hash< auto >  search_options  )

private

Returns an iterator for zero or more records matching the search options.

Parameters

block_size	the number of records in a read block; must be a positive number
where_cond	the search criteria after processing by processFieldValues()
search_options	the search options after processing by validateSearchOptions()

Exceptions

INVALID-BLOCK-SIZE	the block size must be a positive number
INVALID-OPERATION	the data provider does not support reading

searchRecordsImpl()

AbstractDataProviderRecordIterator RemoteDbDataProvider::RemoteDbDataProvider::searchRecordsImpl ( *hash< auto >  where_cond, *hash< auto >  search_options  )

private

Returns an iterator for zero or more records matching the search options.

Parameters

where_cond	the search criteria
search_options	the search options after processing by validateSearchOptions()

See also

requestSearchRecordsImpl()

---

The documentation for this class was generated from the following file:

• RemoteDbDataProvider.qc