RWDBOCIEnvironmentHandle Class Reference
[DB Access Module for Oracle OCI]

Provides methods for setting and retrieving certain connect time and configuration parameters with Oracle OCI. More...

#include <rw/db/ocisrc/ocienvh.h>

Inheritance diagram for RWDBOCIEnvironmentHandle:

List of all members.

Public Member Functions
bool	foreignKeysFromView ()
bool	foreignKeysFromView (bool value)
bool	useTimestamp () const
bool	useTimestamp (bool value)
bool	ociLocatorForDefaultString ()
void	ociLocatorForDefaultString (bool)
bool	ociLocatorForDefaultBlob ()
void	ociLocatorForDefaultBlob (bool)

---

Detailed Description

Class RWDBOCIEnvironmentHandle provides methods for setting and retrieving certain connect time and configuration parameters.

Note:

Use of this class reduces an application's portability.

Synopsis

 #include <rw/db/ocisrc/ocienvh.h>

 RWDBOCIEnvironmentHandle* env =
       (RWDBOCIEnvironmentHandle*)myDatabase.environmentHandle();

---

Member Function Documentation

bool RWDBOCIEnvironmentHandle::foreignKeysFromView

(

bool

value

)

[virtual]

Sets whether the higher-performance version of RWDBTable::foreignKeys() should be used. A value is true enables the higher-performance version. The default is false to enable the standard version.

The higher-performance version is implemented by installing a stored procedure in the database for quicker system table queries. Returns the previous value.

Reimplemented from RWDBEnvironmentHandle.

bool RWDBOCIEnvironmentHandle::foreignKeysFromView

(

)

[virtual]

Returns true if a higher-performance version of RWDBTable::foreignKeys() is used, false otherwise. The default value is false.

Reimplemented from RWDBEnvironmentHandle.

void RWDBOCIEnvironmentHandle::ociLocatorForDefaultBlob

(

bool

)

Deprecated:

This can now be achieved by setting the native types in the table's RWDBSchema. This method exists for backward compatibility only.

When creating tables, sets the flag for controlling whether or not a Locator column is associated with an RWDBColumn that has an RWDBValue::ValueType of Blob.

This method was previously used to distinguish between Oracle server types RAW and BLOB during the creation of tables.

bool RWDBOCIEnvironmentHandle::ociLocatorForDefaultBlob

(

)

Deprecated:

This can now be achieved by setting the native types in the table's RWDBSchema. This method exists for backward compatibility only.

Returns true if, when creating tables, a Locator column is associated with an RWDBColumn that has an RWDBValue::ValueType of Blob. The default value is false.

This method was previously used to distinguish between Oracle server types RAW and BLOB during the creation of tables.

void RWDBOCIEnvironmentHandle::ociLocatorForDefaultString

(

bool

)

Deprecated:

This can now be achieved by setting the native types in the table's RWDBSchema. This method exists for backward compatibility only.

When creating tables, sets the flag for controlling whether or not a Locator column is associated with an RWDBColumn that has an RWDBValue::ValueType of String.

This method was previously used to distinguish between Oracle server types LONG and CLOB during the creation of tables.

bool RWDBOCIEnvironmentHandle::ociLocatorForDefaultString

(

)

Deprecated:

This method exists for backward compatibility only.

Returns true if, when creating tables, a Locator column is associated with an RWDBColumn that has an RWDBValue::ValueType of String. The default value is false.

bool RWDBOCIEnvironmentHandle::useTimestamp

(

bool

value

)

[inline]

Sets the type used for table creation or sending and receiving data. If value is true, the TIMESTAMP type is used, otherwise DATE is used.

Note:

Be careful to maintain the same TIMESTAMP setting on an object between executions; changing the setting while the object is still in scope does not have an effect.

bool RWDBOCIEnvironmentHandle::useTimestamp

(

)

const [inline]

Returns true if TIMESTAMP should be used for both table creation and sending and receiving data, otherwise returns false. The default value is true.