C++ API Reference for Intel® Data Analytics Acceleration Library 2020 Update 1

Public Types | List of all members
KDBDataSource< _featureManager, summaryStatisticsType > Class Template Reference

Connects to data sources with the KDB API. More...

Public Types

enum  NumericTableAllocationFlag
 Specifies whether a Numeric Table is allocated inside of the Data Source object. More...
 
enum  DictionaryCreationFlag
 Specifies whether a Data Dictionary is created from the context of a Data Source. More...
 
enum  DataSourceStatus
 Specifies the status of the Data Source. More...
 
- Public Types inherited from DataSourceIface
enum  DataSourceStatus { readyForLoad = 1, waitingForRows = 2, endOfData = 3, notReady = 4 }
 Specifies the status of the Data Source. More...
 
enum  DictionaryCreationFlag { notDictionaryFromContext = 1, doDictionaryFromContext = 2 }
 Specifies whether a Data Dictionary is created from the context of a Data Source. More...
 
enum  NumericTableAllocationFlag { notAllocateNumericTable = 1, doAllocateNumericTable = 2 }
 Specifies whether a Numeric Table is allocated inside of the Data Source object. More...
 

Class Declaration

template<typename _featureManager, typename summaryStatisticsType = DAAL_SUMMARY_STATISTICS_TYPE>
class daal::data_management::interface1::KDBDataSource< _featureManager, summaryStatisticsType >

Template Parameters
_featureManagerType of a data source, supports only KDBFeatureManager

Member Enumeration Documentation

Constructor & Destructor Documentation

KDBDataSource ( const std::string &  dbname,
size_t  port,
const std::string &  tablename,
const std::string &  username = "",
const std::string &  password = "",
DataSourceIface::NumericTableAllocationFlag  doAllocateNumericTable = DataSource::notAllocateNumericTable,
DataSourceIface::DictionaryCreationFlag  doCreateDictionaryFromContext = DataSource::notDictionaryFromContext,
size_t  initialMaxRows = 10 
)
inline

Constructor for the KDBDataSource class

Parameters
[in]dbnameData Source Name as configured in settings of the KDB driver
[in]portConnection port number
[in]tablenameName of a table to export from a data source
[in]username(optional) Username for the data source
[in]password(optional) Password for the Username in the data source
[in]doAllocateNumericTable(optional) Flag that specifies whether a Numeric Table associated with an KDB Data Source is allocated inside the Data Source
[in]doCreateDictionaryFromContext(optional) Flag that specifies whether a Data Dictionary is created from the context of the KDB Data Source
[in]initialMaxRowsInitial value of maximum number of rows in Numeric Table allocated in loadDataBlock() method

Member Function Documentation

services::Status createDictionaryFromContext ( )
inlinevirtual

Creates a Data Dictionary by extracting information from a Data Source

Reimplemented from DataSource.

size_t getNumberOfAvailableRows ( )
inlinevirtual

Returns the number of rows available in a Data Source

Returns
Number of rows

Implements DataSourceIface.

DataSourceIface::DataSourceStatus getStatus ( )
inlinevirtual

Returns the status of a Data Source

Returns
Status of the Data Source

Implements DataSourceIface.

size_t loadDataBlock ( )
inlinevirtual

Loads a data block into an internally allocated Numeric Table

Reimplemented from DataSource.

size_t loadDataBlock ( NumericTable nt)
inlinevirtual

Loads a data block into a provided Numeric Table

Parameters
[in]ntPointer to the Numeric Table

Reimplemented from DataSource.

virtual size_t loadDataBlock ( size_t  maxRows)
inlinevirtual

Loads a data block of a specified size into an internally allocated Numeric Table

Parameters
[in]maxRowsMaximum number of rows to load from a Data Source into the Numeric Table

Reimplemented from DataSource.

virtual size_t loadDataBlock ( size_t  maxRows,
NumericTable nt 
)
inlinevirtual

Loads a data block of a specified size into an externally allocated Numeric Table

Parameters
[in]maxRowsMaximum number of rows to load from a Data Source into the Numeric Table
ntExternally allocated Numeric Table
Returns
Actual number of rows loaded from the Data Source

Reimplemented from DataSource.


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

For more complete information about compiler optimizations, see our Optimization Notice.