Software and Services, Portable Libraries  2019.Mar.01
A library for managing digital certificates
SoftwareAndServices::Library::Database::SqlColumnAttributes Class Reference

The column attributes. More...

#include <SaS/Sql/Types.hpp>

+ Collaboration diagram for SoftwareAndServices::Library::Database::SqlColumnAttributes:

Public Types

enum  AttributeDefault_e {
  DefaultNone, DefaultIsString, DefaultIsInt, DefaultIsDouble,
  DefaultIsBool, DefaultIsNow
}
 The type of default data. More...
 

Public Member Functions

 SqlColumnAttributes ()
 SqlColumnAttributes - Default Constructor. More...
 
 SqlColumnAttributes (const SqlColumnAttributes &CopyFrom)
 SqlColumnAttributes - Copy Constructor. More...
 
virtual ~SqlColumnAttributes ()
 SqlColumnAttributes - Destructor. More...
 
void ClearDefaults ()
 Clear the Default Values. More...
 
bool operator!= (const SqlColumnAttributes &Other)
 Compare Operator. More...
 
bool operator== (const SqlColumnAttributes &Other)
 Compare Operator. More...
 

Public Attributes

bool DefaultBool
 When non-NULL, the default value is a string. More...
 
long double DefaultDouble
 When non-NULL, the default value is a string. More...
 
long long DefaultInt
 When non-NULL, the default value is a string. More...
 
const char * DefaultSequenceName
 When non-NULL, the column is auto increment and is the name of the sequence. More...
 
const char * DefaultString
 When non-NULL, the default value is a string. More...
 
SqlColumnForeignKeyForeignKey
 When non-NULL, this column has a foreign key. More...
 
bool IsDefaultNow
 When TRUE, the default is 'now()'. More...
 
bool IsPrimaryKey
 When TRUE, the column value is unique and the primary key. More...
 
bool IsUnique
 When TRUE, the column value is unique on its own. More...
 
bool NullAllowed
 When TRUE, NULL values are allowed. More...
 
SqlColumnPrimaryKeyPrimaryKeyConstraint
 Pointer to SqlColumnPrimaryKey object when this column is part of a multi-column PRIVATE KEY constraint. More...
 
AttributeDefault_e Type
 The type for the default. More...
 
SqlColumnUniqueUniqueConstraint
 Pointer to SqlColumnUnique object when this column is part of a multi-column UNIQUE constraint. More...
 

Detailed Description

The column attributes.

Definition at line 729 of file Types.hpp.

Member Enumeration Documentation

◆ AttributeDefault_e

The type of default data.

Definition at line 754 of file Types.hpp.

Constructor & Destructor Documentation

◆ SqlColumnAttributes() [1/2]

SoftwareAndServices::Library::Database::SqlColumnAttributes::SqlColumnAttributes ( )

SqlColumnAttributes - Default Constructor.

◆ SqlColumnAttributes() [2/2]

SoftwareAndServices::Library::Database::SqlColumnAttributes::SqlColumnAttributes ( const SqlColumnAttributes CopyFrom)

SqlColumnAttributes - Copy Constructor.

Parameters
CopyFromThe other SqlColumnAttributes to copy from.

◆ ~SqlColumnAttributes()

virtual SoftwareAndServices::Library::Database::SqlColumnAttributes::~SqlColumnAttributes ( )
virtual

SqlColumnAttributes - Destructor.

Member Function Documentation

◆ ClearDefaults()

void SoftwareAndServices::Library::Database::SqlColumnAttributes::ClearDefaults ( )

Clear the Default Values.

◆ operator!=()

bool SoftwareAndServices::Library::Database::SqlColumnAttributes::operator!= ( const SqlColumnAttributes Other)

Compare Operator.

Parameters
OtherThe other object to compare to.
Returns
true when they do not have the same values.

◆ operator==()

bool SoftwareAndServices::Library::Database::SqlColumnAttributes::operator== ( const SqlColumnAttributes Other)

Compare Operator.

Parameters
OtherThe other object to compare to.
Returns
true when they have the same values.

Member Data Documentation

◆ DefaultBool

bool SoftwareAndServices::Library::Database::SqlColumnAttributes::DefaultBool

When non-NULL, the default value is a string.

Definition at line 792 of file Types.hpp.

◆ DefaultDouble

long double SoftwareAndServices::Library::Database::SqlColumnAttributes::DefaultDouble

When non-NULL, the default value is a string.

Definition at line 787 of file Types.hpp.

◆ DefaultInt

long long SoftwareAndServices::Library::Database::SqlColumnAttributes::DefaultInt

When non-NULL, the default value is a string.

Definition at line 782 of file Types.hpp.

◆ DefaultSequenceName

const char* SoftwareAndServices::Library::Database::SqlColumnAttributes::DefaultSequenceName

When non-NULL, the column is auto increment and is the name of the sequence.

Definition at line 777 of file Types.hpp.

◆ DefaultString

const char* SoftwareAndServices::Library::Database::SqlColumnAttributes::DefaultString

When non-NULL, the default value is a string.

Definition at line 771 of file Types.hpp.

◆ ForeignKey

SqlColumnForeignKey* SoftwareAndServices::Library::Database::SqlColumnAttributes::ForeignKey

When non-NULL, this column has a foreign key.

Definition at line 821 of file Types.hpp.

◆ IsDefaultNow

bool SoftwareAndServices::Library::Database::SqlColumnAttributes::IsDefaultNow

When TRUE, the default is 'now()'.

Definition at line 802 of file Types.hpp.

◆ IsPrimaryKey

bool SoftwareAndServices::Library::Database::SqlColumnAttributes::IsPrimaryKey

When TRUE, the column value is unique and the primary key.

Definition at line 816 of file Types.hpp.

◆ IsUnique

bool SoftwareAndServices::Library::Database::SqlColumnAttributes::IsUnique

When TRUE, the column value is unique on its own.

See also
UniqueConstraint

Definition at line 810 of file Types.hpp.

◆ NullAllowed

bool SoftwareAndServices::Library::Database::SqlColumnAttributes::NullAllowed

When TRUE, NULL values are allowed.

Definition at line 797 of file Types.hpp.

◆ PrimaryKeyConstraint

SqlColumnPrimaryKey* SoftwareAndServices::Library::Database::SqlColumnAttributes::PrimaryKeyConstraint

Pointer to SqlColumnPrimaryKey object when this column is part of a multi-column PRIVATE KEY constraint.

NULL when not.

See also
IsUnique

Definition at line 863 of file Types.hpp.

◆ Type

AttributeDefault_e SoftwareAndServices::Library::Database::SqlColumnAttributes::Type

The type for the default.

Definition at line 766 of file Types.hpp.

◆ UniqueConstraint

SqlColumnUnique* SoftwareAndServices::Library::Database::SqlColumnAttributes::UniqueConstraint

Pointer to SqlColumnUnique object when this column is part of a multi-column UNIQUE constraint.

NULL when not.

See also
IsUnique

Definition at line 854 of file Types.hpp.


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