DSIPropertyUtilities Class Reference

DSIPropertyUtilities is a utility class to set properties that enable/disable common functionality such as stored procedure, catalog, and schema support. More...

List of all members.

Static Public Member Functions

static bool HasCatalogSupport (IConnection *in_connection)
 Check the properties to see if there is catalog support on the specified connection.
static bool HasSchemaSupport (IConnection *in_connection)
 Check the properties to see if there is schema support on the specified connection.
static bool HasStoredProcedureSupport (IConnection *in_connection)
 Check the properties to see if there is stored procedure support on the specified connection.
static bool HasTransactionSupport (IConnection *in_connection)
 Check the properties to see if there is transaction support on the specified connection.
static bool IsReadOnly (IConnection *in_connection)
 Check the properties to see if the DSII is read-only.
static void SetCatalogSupport (IConnection *in_connection, bool in_isEnabled)
 Set the properties to enable or disable catalog support on the specified connection.
static void SetReadOnly (IConnection *in_connection, bool in_isReadOnly)
 Set the properties to enable or disable read/write support.
static void SetSchemaSupport (IConnection *in_connection, bool in_isEnabled)
 Set the properties to enable or disable schema support on the specified connection.
static void SetStoredProcedureSupport (IConnection *in_connection, bool in_isEnabled)
 Set the properties to enable or disable stored procedure support on the specified connection.
static void SetTransactionSupport (IConnection *in_connection, simba_uint32 in_txnLevel)
 Set the properties for transaction support on the specified connection.

Detailed Description

DSIPropertyUtilities is a utility class to set properties that enable/disable common functionality such as stored procedure, catalog, and schema support.


Member Function Documentation

static bool HasCatalogSupport ( IConnection in_connection  )  [static]

Check the properties to see if there is catalog support on the specified connection.

The properties involved are: DSI_CONN_CATALOG_NAME DSI_CONN_CATALOG_TERM DSI_CONN_CATALOG_USAGE

Parameters:
in_connection The connection to check catalog support for. (NOT OWN)
Returns:
True if catalogs are supported; false otherwise.
static bool HasSchemaSupport ( IConnection in_connection  )  [static]

Check the properties to see if there is schema support on the specified connection.

The properties involved are: DSI_CONN_SCHEMA_TERM DSI_CONN_SCHEMA_USAGE

Parameters:
in_connection The connection to check schema support for. (NOT OWN)
Returns:
True if schemas are supported; false otherwise.
static bool HasStoredProcedureSupport ( IConnection in_connection  )  [static]

Check the properties to see if there is stored procedure support on the specified connection.

The properties involved are: DSI_CONN_PROCEDURE_TERM DSI_CONN_PROCEDURES

Parameters:
in_connection The connection to check stored procedure support for. (NOT OWN)
Returns:
True if stored procedures are supported; false otherwise.
static bool HasTransactionSupport ( IConnection in_connection  )  [static]

Check the properties to see if there is transaction support on the specified connection.

The properties involved are: DSI_CONN_TXN_CAPABLE

Parameters:
in_connection The connection to check transaction support for. (NOT OWN)
Returns:
True if transactions are supported; false otherwise.
static bool IsReadOnly ( IConnection in_connection  )  [static]

Check the properties to see if the DSII is read-only.

The properties involved are: DSI_CONN_ACCESS_MODE

Parameters:
in_connection The connection to check for read-only. (NOT OWN)
Returns:
True if no DDL/DML is supported; false otherwise.
static void SetCatalogSupport ( IConnection in_connection,
bool  in_isEnabled 
) [static]

Set the properties to enable or disable catalog support on the specified connection.

The default for connections is catalogs are supported.

The properties involved are: DSI_CONN_CATALOG_NAME DSI_CONN_CATALOG_TERM DSI_CONN_CATALOG_USAGE

Parameters:
in_connection The connection to enable/disable catalog support for. (NOT OWN)
in_isEnabled True to enable catalog support; false otherwise.
static void SetReadOnly ( IConnection in_connection,
bool  in_isReadOnly 
) [static]

Set the properties to enable or disable read/write support.

The default for connections is read-write. The default for data sources is read-only.

The properties involved are: DSI_CONN_ACCESS_MODE DSI_CONN_DATA_SOURCE_READ_ONLY

Note that DSI_CONN_ACCESS_MODE will always be set to read-write, but write support may still be disabled.

Parameters:
in_connection The connection to enable/disable read/write support for. (NOT OWN)
in_isReadOnly True to disable write support; false otherwise.
static void SetSchemaSupport ( IConnection in_connection,
bool  in_isEnabled 
) [static]

Set the properties to enable or disable schema support on the specified connection.

The default for connections is schemas are supported.

The properties involved are: DSI_CONN_SCHEMA_TERM DSI_CONN_SCHEMA_USAGE

Parameters:
in_connection The connection to enable/disable schema support for. (NOT OWN)
in_isEnabled True to enable schema support; false otherwise.
static void SetStoredProcedureSupport ( IConnection in_connection,
bool  in_isEnabled 
) [static]

Set the properties to enable or disable stored procedure support on the specified connection.

The default for connections is stored procedures are not supported.

The properties involved are: DSI_CONN_PROCEDURE_TERM DSI_CONN_PROCEDURES

Parameters:
in_connection The connection to enable/disable stored procedure support for. (NOT OWN)
in_isEnabled True to enable stored procedure support; false otherwise.
static void SetTransactionSupport ( IConnection in_connection,
simba_uint32  in_txnLevel 
) [static]

Set the properties for transaction support on the specified connection.

The properties involved are: DSI_CONN_TXN_CAPABLE

Parameters:
in_connection The connection to set transaction support for. (NOT OWN)
in_txnLevel The level of transaction support to set: DSI_TC_NONE DSI_TC_DML DSI_TC_DDL_COMMIT DSI_TC_DDL_IGNORE DSI_TC_ALL

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

Generated on Wed May 17 14:21:15 2017 for SimbaEngine 10.1.3.1011 by simba