Main Page | Class Hierarchy | Class List | File List | Class Members | File Members

IDSSDBRole Interface Reference

Inherited by IDSSDBRole2.

List of all members.

Detailed Description

A DBRole object represents a logical database abstraction.

A logical database can be mapped to physical databases base on security setting or load balancing algorithm. For example, base on security setting, a logical database SalesWarehouse (DBRole is SalesWareHouse) can be mapped to an enterprise central sales database for the CEO or a regional sales database for that region's AE. In addition, if a DSS system have duplicate warehouse databases to store sales data, the DBRole to SalesWareHouse can be mapped to either one of the warehouses based on their load.

The mapping of a logical database to physical database is stored in DBConnectionMap objects, which are second class objects included in objects such as IDSSProject.


Public Member Functions

HRESULT DatabaseName ([in] BSTR DatabaseName)
 Reserved for future use.
HRESULT DatabaseName ([out, retval] BSTR *pDatabaseName)
 Reserved for future use.
HRESULT DatabaseType ([in] EnumDSSDatabaseType DatabaseType)
 Set the vendor/type of the database.
HRESULT DatabaseType ([out, retval] EnumDSSDatabaseType *pDatabaseType)
 Vendor/type of the database.
HRESULT DatabaseVersion ([in] EnumDSSDatabaseVersion DatabaseVersion)
 Version of the database.
HRESULT DatabaseVersion ([out, retval] EnumDSSDatabaseVersion *pDatabaseVersion)
 Version of the database.
HRESULT DBMS ([in] IDSSDBMS *pDBMS)
 DBMS object associated with this version of the database.
HRESULT DBMS ([out, retval] IDSSDBMS ppDBMS)
 DBMS object associated with this version of the database.
HRESULT DefaultDBConnection ([in] IDSSDBConnection *pDefaultDBConnection)
 Default physical DB Connection associated with this DBRole.
HRESULT DefaultDBConnection ([out, retval] IDSSDBConnection ppDefaultDBConnection)
 Default physical DB Connection associated with this DBRole.
HRESULT DefaultDBConnections ([out, retval] IDSSDBConnections ppDefaultDBConnections)
 Default DB Connections associated with this DBRole A collection of DBConnection objects that can be used as default for this DBRole.
HRESULT DefaultMaxDBConnection ([in] Int32 DefaultMaxDBConnection)
 Maximum number of physical connection allowed.
HRESULT DefaultMaxDBConnection ([out, retval] Int32 *pDefaultMaxDBConnection)
 Maximum number of physical connection allowed.
HRESULT DefaultMaxDBCost ([in] Int32 DefaultMaxDBCost)
 Maximum query load allowed.
HRESULT DefaultMaxDBCost ([out, retval] Int32 *pDefaultMaxDBCost)
 Maximum query load allowed.
HRESULT Info ([out, retval] IDSSObjectInfo ppInfo)
 Generic information about this first class object.
HRESULT Populate ([in] IDSSDBRole *pOriginal)
 Populates the definition of this DBRole from another one.
HRESULT PrimaryDBRole ([in] IDSSDBRole *pPrimaryDBRole)
 This property holds a reference to the primary DBRole for a given DBRole.
HRESULT PrimaryDBRole ([out, retval] IDSSDBRole ppPrimaryDBRole)
 This property holds a reference to the primary DBRole for a given DBRole.
HRESULT Queue ([out, retval] IDSSQueue ppQueue)
 Server job queue associated with this DBRole.
HRESULT Tables ([in] IDSSTables *pTables)
 Reserved for future use.
HRESULT Tables ([out, retval] IDSSTables ppTables)
 Reserved for future use.
HRESULT TableSource ([in] IDSSTableSource *pTableSource)
 TableSource object associated with this DBRole.
HRESULT TableSource ([out, retval] IDSSTableSource ppTableSource)
 TableSource object associated with this DBRole.
HRESULT TableSpaceName ([in] BSTR TableSpaceName)
 Reserved for future use.
HRESULT TableSpaceName ([out, retval] BSTR *pTableSpaceName)
 Reserved for future use.

Member Function Documentation

HRESULT IDSSDBRole::DatabaseName (  [in] BSTR  DatabaseName  ) 
 

Reserved for future use.

Reserved property. Do not use.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSDBRole::DatabaseName (  [out, retval] BSTR *  pDatabaseName  ) 
 

Reserved for future use.

Reserved property. Do not use.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSDBRole::DatabaseType (  [in] EnumDSSDatabaseType  DatabaseType  ) 
 

Set the vendor/type of the database.

See the get method of this property for a list of some database types.
Parameters:
DatabaseType Vendor/type of database
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSDBRole::DatabaseType (  [out, retval] EnumDSSDatabaseType *  pDatabaseType  ) 
 

Vendor/type of the database.

The vendor and type of database that this DBRole represents.

EnumDSSDatabaseType has the following enumeration values:
Symbolic Name Database vendor/type represented
DssDBAccess Microsoft Access
DssDBOracle Oracle
DssDBSQLServer Microsoft SQL Server
DssDBInformix Informix
DssDBSybase Sybase
DssDBRedBrick RedBrick
DssDBDB2 IBM DB2
DssDBTandem Tandem
DssDBTeradata NCR Teradata
DssDBUnknown Unknown or unspecified database vendor / type
Parameters:
pDatabaseType Vendor/type of database. Must be a valid enumeration value or it will be rejected.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSDBRole::DatabaseVersion (  [in] EnumDSSDatabaseVersion  DatabaseVersion  ) 
 

Version of the database.

The detail database version this DBRole represents. See the get method of this property for a list of some database versions.

Parameters:
DatabaseVersion Version of database. Must be a valid enumeration value or it will be rejected
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSDBRole::DatabaseVersion (  [out, retval] EnumDSSDatabaseVersion *  pDatabaseVersion  ) 
 

Version of the database.

The detail database version this DBRole represents. See for database versions currently supported.

Enumeration EnumDSSDatabaseVersion has the following possible values:
Symbolic Name Database Version
DssDatabaseVersionDefault Default version for the specified DB type
DssDBAccess20 Microsoft Access 2.0
DssDBAccess2000 Microsoft Access 2000
DssDBAccess70 Microsoft Access 97
DssDBAdabaseD6112 Software AG Adabase-D6.1.1.2
DssDBIBMDB2400V3R1 IBM DB2/400 V3R1
DssDBIBMDB2400V3R2 IBM DB2/400 V3R2
DssDBIBMDB2400V3R7 IBM DB2/400 V3R7
DssDBIBMDB2400V4R3 IBM DB2/400 V4R3
DssDBIBMDB2400V4R4 IBM DB2/400 V4R4
DssDBIBMDB2400V4R5 IBM DB2/400 V4R5
DssDBIBMDB2CS 212 IBM DB2/CS 2.1.2
DssDBIBMDB2OS39041 IBM DB2/OS390 4.1
DssDBIBMDB2OS39050 IBM DB2/OS390 5
DssDBIBMDB2OS39062 IBM DB2/OS390 6.2
DssDBIBMDB2OS3907 IBM DB2/OS390 7
DssDBIBMDB2PE12 IBM DB2/PE 1.2
DssDBIBMUDB52 IBM UDB 5.2
DssDBIBMUDB61 IBM UDB 6.1
DssDBIBMUDB7 IBM UDB 7
DssDBIBMUDBEEE50 IBM UDB/EEE 5.0
DssDBIBMUDBSMP50 IBM UDB/SMP5.0
DssDBInformixODS724UC1 Informix ODS 7.24UC1
DssDBInformixODS731 Informix ODS 7.31
DssDBInformixUDO92 Informix UDO 9.2
DssDBInformixXPS82 Informix XPS 8.2
DssDBInformixXPS83 Informix XPS 8.3
DssDBOracle733 Oracle 7.3.3
DssDBOracle8003 Oracle 8.0.03
DssDBOracle805 Oracle 8.0.5
DssDBOracle8i Oracle 8i (e.g. 8.1.5)
DssDBOracle8iR2 Oracle 8i R2
DssDBRedBrick5007 Red Brick 5.0.7
DssDBRedBrick5012 Red Brick 5.0.12
DssDBRedBrick5105 Red Brick 5.1.5
DssDBRedBrick6 Red Brick 6
DssDBSQLServer2000 Microsoft SQL Server 2000
DssDBSQLServer65 Microsoft SQL Server 6.5 SP4
DssDBSQLServer70 Microsoft SQL Server 7.0
DssDBSybaseAdaptive115 Sybase adaptive server 11.5
DssDBSybaseAdaptive12 Sybase Adaptive Server 12
DssDBSybaseIQ112 Sybase IQ 11.2
DssDBSybaseIQ12 Sybase IQ 12
DssDBSybaseSQL112 Sybase SQL server 11.2
DssDBTandemMPD42 Tandem NonStop SQL/MPD42
DssDBTandemMPD45 Tandem NonStop SQL/MP D45
DssDBTandemMX1 Tandem NonStop SQL/MX 1
DssDBTeradataNTV2R2 NCR Teradata NT V2R2
DssDBTeradataNTV2R3 NCR Teradata NT V2R3
DssDBTeradataV2R1 NCR Teradata V2R1
DssDBTeradataV2R20002 NCR Teradata V2R2.00.02
DssDBTeradataV2R21 NCR Teradata V2R21
DssDBTeradatav2R3 NCR teradata V2R3
DssDBTeradataV2R4 NCR Teradata V2R4
Parameters:
pDatabaseVersion Version of the database
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSDBRole::DBMS (  [in] IDSSDBMS *  pDBMS  ) 
 

DBMS object associated with this version of the database.

A DBMS object holds a rich set of properties that characterizes a specific version of a DBMS platform.

Parameters:
pDBMS Pointer to DBMS object to be associated with this DBRole. If pointer is NULL, this DBRole object will not be associated with any DBMS object.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSDBRole::DBMS (  [out, retval] IDSSDBMS   ppDBMS  ) 
 

DBMS object associated with this version of the database.

A DBMS object holds a rich set of properties that characterizes a specific version of a DBMS platform.

Parameters:
ppDBMS Returns a pointer to a DBMS object associated with this DBRole.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSDBRole::DefaultDBConnection (  [in] IDSSDBConnection *  pDefaultDBConnection  ) 
 

Default physical DB Connection associated with this DBRole.

A default DBConnection object is used as the physical DB connection for this DBRole unless a DBConnectionMap overwrites such association.

Parameters:
pDefaultDBConnection Pointer to the default DBConnection object to be associated with this DBRole. If pointer is NULL, this DBRole object will not be associated with a default DBConnection
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSDBRole::DefaultDBConnection (  [out, retval] IDSSDBConnection   ppDefaultDBConnection  ) 
 

Default physical DB Connection associated with this DBRole.

A default DBConnection object is used as the physical DB connection for this DBRole unless a DBConnectionMap overwrites such association.

Parameters:
ppDefaultDBConnection Returns a pointer to the default DBConnection object associated with this DBRole.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSDBRole::DefaultDBConnections (  [out, retval] IDSSDBConnections   ppDefaultDBConnections  ) 
 

Default DB Connections associated with this DBRole A collection of DBConnection objects that can be used as default for this DBRole.

Please note that this collection is used only if DefaultDBConnection property is empty.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSDBRole::DefaultMaxDBConnection (  [in] Int32  DefaultMaxDBConnection  ) 
 

Maximum number of physical connection allowed.

The default maximum number of database connection can be made in DSS Server for this DBRole. A DSS Server can set its own MaxDBConnection by specifying it in its DBConnectionMap for this DBRole.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSDBRole::DefaultMaxDBConnection (  [out, retval] Int32 *  pDefaultMaxDBConnection  ) 
 

Maximum number of physical connection allowed.

The default maximum number of database connection can be made in DSS Server for this DBRole. A DSS Server can set its own MaxDBConnection by specifying it in its DBConnectionMap for this DBRole.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSDBRole::DefaultMaxDBCost (  [in] Int32  DefaultMaxDBCost  ) 
 

Maximum query load allowed.

The default maximum estimate cost a server can put on this Database (DBRole). A DSS Server can set its own MaxDBCost by specifying it in its DBConnectionMap for this DBRole. A DSS Server can set its own MaxDBCost by specifying it in its DBConnectionMap for this DBRole.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSDBRole::DefaultMaxDBCost (  [out, retval] Int32 *  pDefaultMaxDBCost  ) 
 

Maximum query load allowed.

The default maximum estimate cost a server can put on this Database (DBRole). A DSS Server can set its own MaxDBCost by specifying it in its DBConnectionMap for this DBRole.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSDBRole::Info (  [out, retval] IDSSObjectInfo   ppInfo  ) 
 

Generic information about this first class object.

Shortcut to the IDSSObjectInfo interface to this object, which contains generic information about this object, including name, type, description etc.

Parameters:
ppInfo Browsing info of the DB Role
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSDBRole::Populate (  [in] IDSSDBRole *  pOriginal  ) 
 

Populates the definition of this DBRole from another one.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSDBRole::PrimaryDBRole (  [in] IDSSDBRole *  pPrimaryDBRole  ) 
 

This property holds a reference to the primary DBRole for a given DBRole.

A DBRole maybe a primary DbRole in which case it is used by the server connection management module to map database connections. A secondary DbRole is not used for connection management, it holds a reference to its primary role. A secondary role is compatible with its primary role and in turn with all the other secondary roles that have the same primary roles. By compatibility, we mean two tables coming from different but compatible DbRole can be used in the same SQL statement.

A primary role is identified as one with a NULL PrimaryDBRole property.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSDBRole::PrimaryDBRole (  [out, retval] IDSSDBRole   ppPrimaryDBRole  ) 
 

This property holds a reference to the primary DBRole for a given DBRole.

A DBRole maybe a primary DBRole in which case it is used by the server connection management module to map database connections. A secondary DbRole is not used for connection management, it holds a reference to its primary role. A secondary role is compatible with its primary role and in turn with all the other secondary roles that have the same primary roles. By compatibility, we mean two tables coming from different but compatible DbRole can be used in the same SQL statement.

A primary role is identified as one with a NULL PrimaryDBRole property.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSDBRole::Queue (  [out, retval] IDSSQueue   ppQueue  ) 
 

Server job queue associated with this DBRole.

See IDSSQueue documentation for information about queues.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSDBRole::Tables (  [in] IDSSTables *  pTables  ) 
 

Reserved for future use.

This property is reserved and should not be used.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSDBRole::Tables (  [out, retval] IDSSTables   ppTables  ) 
 

Reserved for future use.

This property is reserved and should not be used.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSDBRole::TableSource (  [in] IDSSTableSource *  pTableSource  ) 
 

TableSource object associated with this DBRole.

A table source object defines prefix and suffix information for tables in the warehouse. If a table source is associated with a DBRole, tables from this warehouse will have the defined prefix/suffix unless the table source is overridden at the table level (see IDSSDBTable::TableSource).

Parameters:
pTableSource TableSource object to be associated with the DBRole. If null, this DBRole will not have a table source.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSDBRole::TableSource (  [out, retval] IDSSTableSource   ppTableSource  ) 
 

TableSource object associated with this DBRole.

A table source object defines prefix and suffix information for tables in the warehouse. If a table source is associated with a DBRole, tables from this warehouse will have the defined prefix/suffix unless the table source is overridden at the table level (see IDSSDBTable::TableSource).

Parameters:
ppTableSource TableSource object associated with the DBRole. If null, this DBRole does not have a table source.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSDBRole::TableSpaceName (  [in] BSTR  TableSpaceName  ) 
 

Reserved for future use.

Reserved property. Do not use.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSDBRole::TableSpaceName (  [out, retval] BSTR *  pTableSpaceName  ) 
 

Reserved for future use.

Reserved property. Do not use.

Returns:
Usual COM result code:
  • S_OK

Copyright © 1996-2018 MicroStrategy Inc. All Rights Reserved.