Harlinn.Windows 0.1
Loading...
Searching...
No Matches
Harlinn::OCI::Metadata::Column Class Reference

#include <HOCI.h>

Inheritance diagram for Harlinn::OCI::Metadata::Column:
[legend]
Collaboration diagram for Harlinn::OCI::Metadata::Column:
[legend]

Public Types

using Base = MetadataObject
 

Public Member Functions

HO_EXPORT Column (const OCI::ServiceContext *serviceContext, const TableOrView *owner, const OCI::ColumnDescriptor *descriptor)
 
virtual Metadata::Kind Kind () const noexcept override
 
bool UsesCharacterLength () const
 Returns the type of length semantics of the column. Zero (0) means byte-length semantics and 1 means character-length semantics.
 
UInt16 CharacterLength () const
 Returns the column character length that is the number of characters allowed in the column.
 
UInt16 Length () const
 The maximum size of the column. This length is returned in bytes and not characters for strings and raws. It returns 22 for NUMBERs.
 
ColumnProperties Properties () const
 Returns describe data regarding certain column properties.
 
bool IsInvisible () const
 Returns whether a column is invisible or not.
 
OraType DataType () const
 The datatype of the column. (OCI_ATTR_DATA_TYPE)
 
Int16 Precision () const
 The precision of numeric columns. If the precision is nonzero and scale is -127, then it is a FLOAT, else it is a NUMBER(precision, scale). For the case when precision is 0, NUMBER(precision, scale) can be represented simply as NUMBER.
 
SByte Scale () const
 The scale of numeric columns. If the precision is nonzero and scale is -127, then it is a FLOAT, else it is a NUMBER(precision, scale). For the case when precision is 0, NUMBER(precision, scale) can be represented simply as NUMBER.
 
bool IsNull () const
 Returns false if null values are not permitted for the column. Does not return a correct value for a CUBE or ROLLUP operation.
 
bool Nullable () const
 
WideString TypeName () const
 Returns a string that is the type name. The returned value contains the type name if the data type is SQLT_NTY or SQLT_REF.If the data type is SQLT_NTY, the name of the named data type's type is returned. If the data type is SQLT_REF, the type name of the named data type pointed to by the REF is returned.
 
WideString SchemaName () const
 Returns a string with the schema name under which the type has been created.
 
OCI::CharacterSetForm CharacterSetForm () const
 Character set form of the column.
 

Private Attributes

bool usesCharacterLength_
 
UInt16 characterLength_
 
UInt16 length_
 
ColumnProperties properties_
 
bool isInvisible_
 
OraType dataType_
 
Int16 precision_
 
SByte scale_
 
bool nullable_
 
WideString typeName_
 
WideString schemaName_
 
OCI::CharacterSetForm characterSetForm_
 

Additional Inherited Members

Member Typedef Documentation

◆ Base

Constructor & Destructor Documentation

◆ Column()

Harlinn::OCI::Metadata::Column::Column ( const OCI::ServiceContext * serviceContext,
const TableOrView * owner,
const OCI::ColumnDescriptor * descriptor )

Member Function Documentation

◆ CharacterLength()

UInt16 Harlinn::OCI::Metadata::Column::CharacterLength ( ) const
inline

Returns the column character length that is the number of characters allowed in the column.

◆ CharacterSetForm()

OCI::CharacterSetForm Harlinn::OCI::Metadata::Column::CharacterSetForm ( ) const
inline

Character set form of the column.

◆ DataType()

OraType Harlinn::OCI::Metadata::Column::DataType ( ) const
inline

The datatype of the column. (OCI_ATTR_DATA_TYPE)

◆ IsInvisible()

bool Harlinn::OCI::Metadata::Column::IsInvisible ( ) const
inline

Returns whether a column is invisible or not.

Returns
true if the column is invisible

◆ IsNull()

bool Harlinn::OCI::Metadata::Column::IsNull ( ) const
inline

Returns false if null values are not permitted for the column. Does not return a correct value for a CUBE or ROLLUP operation.

◆ Kind()

virtual Metadata::Kind Harlinn::OCI::Metadata::Column::Kind ( ) const
inlineoverridevirtualnoexcept

◆ Length()

UInt16 Harlinn::OCI::Metadata::Column::Length ( ) const
inline

The maximum size of the column. This length is returned in bytes and not characters for strings and raws. It returns 22 for NUMBERs.

◆ Nullable()

bool Harlinn::OCI::Metadata::Column::Nullable ( ) const
inline

◆ Precision()

Int16 Harlinn::OCI::Metadata::Column::Precision ( ) const
inline

The precision of numeric columns. If the precision is nonzero and scale is -127, then it is a FLOAT, else it is a NUMBER(precision, scale). For the case when precision is 0, NUMBER(precision, scale) can be represented simply as NUMBER.

◆ Properties()

ColumnProperties Harlinn::OCI::Metadata::Column::Properties ( ) const
inline

Returns describe data regarding certain column properties.

Returns
The ColumnProperties for the column

◆ Scale()

SByte Harlinn::OCI::Metadata::Column::Scale ( ) const
inline

The scale of numeric columns. If the precision is nonzero and scale is -127, then it is a FLOAT, else it is a NUMBER(precision, scale). For the case when precision is 0, NUMBER(precision, scale) can be represented simply as NUMBER.

◆ SchemaName()

WideString Harlinn::OCI::Metadata::Column::SchemaName ( ) const
inline

Returns a string with the schema name under which the type has been created.

◆ TypeName()

WideString Harlinn::OCI::Metadata::Column::TypeName ( ) const
inline

Returns a string that is the type name. The returned value contains the type name if the data type is SQLT_NTY or SQLT_REF.If the data type is SQLT_NTY, the name of the named data type's type is returned. If the data type is SQLT_REF, the type name of the named data type pointed to by the REF is returned.

◆ UsesCharacterLength()

bool Harlinn::OCI::Metadata::Column::UsesCharacterLength ( ) const
inline

Returns the type of length semantics of the column. Zero (0) means byte-length semantics and 1 means character-length semantics.

Member Data Documentation

◆ characterLength_

UInt16 Harlinn::OCI::Metadata::Column::characterLength_
private

◆ characterSetForm_

OCI::CharacterSetForm Harlinn::OCI::Metadata::Column::characterSetForm_
private

◆ dataType_

OraType Harlinn::OCI::Metadata::Column::dataType_
private

◆ isInvisible_

bool Harlinn::OCI::Metadata::Column::isInvisible_
private

◆ length_

UInt16 Harlinn::OCI::Metadata::Column::length_
private

◆ nullable_

bool Harlinn::OCI::Metadata::Column::nullable_
private

◆ precision_

Int16 Harlinn::OCI::Metadata::Column::precision_
private

◆ properties_

ColumnProperties Harlinn::OCI::Metadata::Column::properties_
private

◆ scale_

SByte Harlinn::OCI::Metadata::Column::scale_
private

◆ schemaName_

WideString Harlinn::OCI::Metadata::Column::schemaName_
private

◆ typeName_

WideString Harlinn::OCI::Metadata::Column::typeName_
private

◆ usesCharacterLength_

bool Harlinn::OCI::Metadata::Column::usesCharacterLength_
private

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