CompleteDB Embedded: Direct C++ API  2.4.2
CreateTable Class Reference

CreateTable is a statement class that provides services to create new tables in a database. More...

#include <CreateTable.hpp>

+ Inheritance diagram for CreateTable:

Public Member Functions

bool cast (const Object &from)
bool isConnected () const
bool isDisconnected () const
Type::Enum getClassType () const
Type::Enum getObjectType () const
Error::Enum getLastErrorId () const
const char * getLastError () const
const char * getDescription () const
void setDescription (const char *description)
const char * getName () const
void setName (const char *name)
bool prepare ()
bool execute ()
bool containsColumn (const char *name)
bool containsColumn (const IdentityInfo &name)
bool exists ()
ColumnIterator getColumns ()
ColumnMetadata addColumn (const char *name, const ColumnType::Enum columnType=ColumnType::Int64)
ColumnMetadata addColumn (const IdentityInfo &name, const ColumnType::Enum columnType=ColumnType::Int64)
void clearColumns ()
CreateTableoperator= (const CreateTable &src)
 CreateTable (const CreateTable &src)
virtual ~CreateTable ()
 CreateTable ()
- Public Member Functions inherited from Object
void * get () const
Objectoperator= (const Object &src)
 Object (const Object &src)
virtual ~Object ()
 Object ()
- Public Member Functions inherited from Statement
Statementoperator= (const Statement &src)
 Statement (const Statement &src)
virtual ~Statement ()
 Statement ()

Friends

class Database
class TableDdl

Additional Inherited Members

- Protected Member Functions inherited from Object
 Object (void *src)
- Protected Attributes inherited from Object
void * m

Detailed Description

CreateTable is a statement class that provides services to create new tables in a database.

Definition at line 17 of file CreateTable.hpp.

Constructor & Destructor Documentation

CreateTable ( const CreateTable src)
inline

Definition at line 139 of file CreateTable.hpp.

virtual ~CreateTable ( )
inlinevirtual

Definition at line 143 of file CreateTable.hpp.

CreateTable ( )
inline

Definition at line 144 of file CreateTable.hpp.

Member Function Documentation

ColumnMetadata addColumn ( const char *  name,
const ColumnType::Enum  columnType = ColumnType::Int64 
)
inlinevirtual

Adds a column to the table column collection.

Reimplemented from TableMetadata.

Definition at line 126 of file CreateTable.hpp.

ColumnMetadata addColumn ( const IdentityInfo name,
const ColumnType::Enum  columnType = ColumnType::Int64 
)
inlinevirtual

Adds a column to the table column collection.

Reimplemented from TableMetadata.

Definition at line 130 of file CreateTable.hpp.

bool cast ( const Object from)
inlinevirtual

Performs safe typecast.

Reimplemented from Object.

Definition at line 31 of file CreateTable.hpp.

void clearColumns ( )
inlinevirtual

Clears the table column collection.

Reimplemented from TableMetadata.

Definition at line 134 of file CreateTable.hpp.

bool containsColumn ( const char *  name)
inlinevirtual

Determines wether the database table contains a column with the specified name.

Reimplemented from TableMetadata.

Definition at line 107 of file CreateTable.hpp.

bool containsColumn ( const IdentityInfo name)
inlinevirtual

Determines wether the database table contains a column with the specified name.

Reimplemented from TableMetadata.

Definition at line 111 of file CreateTable.hpp.

bool execute ( )
inlinevirtual

Executes the statement.

Reimplemented from Statement.

Definition at line 100 of file CreateTable.hpp.

bool exists ( )
inlinevirtual

Determines wether the table exists in the database.

Reimplemented from TableMetadata.

Definition at line 115 of file CreateTable.hpp.

Type::Enum getClassType ( ) const
inlinevirtual

class type of the object.

Reimplemented from Object.

Definition at line 43 of file CreateTable.hpp.

ColumnIterator getColumns ( )
inlinevirtual

Gets Column iterator used to iterate columns information in the database table.

Reimplemented from TableMetadata.

Definition at line 119 of file CreateTable.hpp.

const char* getDescription ( ) const
inlinevirtual

Returns the description of the entity.

Reimplemented from TableMetadata.

Definition at line 65 of file CreateTable.hpp.

const char* getLastError ( ) const
inlinevirtual

Retrieves the calling object last-error text message.

Reimplemented from Statement.

Definition at line 58 of file CreateTable.hpp.

Error::Enum getLastErrorId ( ) const
inlinevirtual

Retrieves the calling object last-error id value.

Reimplemented from Statement.

Definition at line 54 of file CreateTable.hpp.

const char* getName ( ) const
inlinevirtual

Returns the name of the entity.

Reimplemented from TableMetadata.

Definition at line 79 of file CreateTable.hpp.

Type::Enum getObjectType ( ) const
inlinevirtual

object type of the underlying derived object.

Reimplemented from Object.

Definition at line 47 of file CreateTable.hpp.

bool isConnected ( ) const
inlinevirtual

if underlying database is connected.

Reimplemented from Object.

Definition at line 35 of file CreateTable.hpp.

bool isDisconnected ( ) const
inlinevirtual

if underlying database is not connected.

Reimplemented from Object.

Definition at line 39 of file CreateTable.hpp.

CreateTable& operator= ( const CreateTable src)
inline

Definition at line 138 of file CreateTable.hpp.

bool prepare ( )
inlinevirtual

Validates and prepares statement for execution.

Reimplemented from Statement.

Definition at line 93 of file CreateTable.hpp.

void setDescription ( const char *  description)
inlinevirtual

Sets the description of the entity.

Reimplemented from TableMetadata.

Definition at line 72 of file CreateTable.hpp.

void setName ( const char *  name)
inlinevirtual

Sets the name of the entity.

Reimplemented from TableMetadata.

Definition at line 86 of file CreateTable.hpp.

Friends And Related Function Documentation

friend class Database
friend

Definition at line 23 of file CreateTable.hpp.

friend class TableDdl
friend

Definition at line 24 of file CreateTable.hpp.


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