Public Member Functions

db_Table Class Reference

an object that stores information about a database schema table More...

#include <structs.db.h>

Inheritance diagram for db_Table:
db_DatabaseObject GrtNamedObject GrtObject db_mysql_Table

List of all members.

Public Member Functions

grt::ListRef< db_Columncolumns () const
 Getter for attribute columns (read-only).
grt::ListRef< db_ForeignKeyforeignKeys () const
 Getter for attribute foreignKeys (read-only).
grt::ListRef< db_Indexindices () const
 Getter for attribute indices (read-only).
grt::IntegerRef isStub () const
 Getter for attribute isStub.
virtual void isStub (const grt::IntegerRef &value)
 Setter for attribute isStub.
grt::IntegerRef isSystem () const
 Getter for attribute isSystem.
virtual void isSystem (const grt::IntegerRef &value)
 Setter for attribute isSystem.
grt::IntegerRef isTemporary () const
 Getter for attribute isTemporary.
virtual void isTemporary (const grt::IntegerRef &value)
 Setter for attribute isTemporary.
db_IndexRef primaryKey () const
 Getter for attribute primaryKey.
virtual void primaryKey (const db_IndexRef &value)
 Setter for attribute primaryKey.
grt::StringRef temporaryScope () const
 Getter for attribute temporaryScope.
virtual void temporaryScope (const grt::StringRef &value)
 Setter for attribute temporaryScope.
grt::ListRef< db_Triggertriggers () const
 Getter for attribute triggers (read-only).
virtual void addColumn (const db_ColumnRef &column)
 

virtual void addIndex (const db_IndexRef &index)
 

virtual void addPrimaryKeyColumn (const db_ColumnRef &column)
 

virtual db_ForeignKeyRef createForeignKey (const std::string &name)
 

virtual grt::StringRef inserts ()
 

virtual grt::IntegerRef isDependantTable ()
 

virtual grt::IntegerRef isForeignKeyColumn (const db_ColumnRef &column)
 

virtual grt::IntegerRef isPrimaryKeyColumn (const db_ColumnRef &column)
 

virtual void removeColumn (const db_ColumnRef &column)
 

virtual void removeForeignKey (const db_ForeignKeyRef &fk, long removeColumns)
 

virtual void removeIndex (const db_IndexRef &index)
 

virtual void removePrimaryKeyColumn (const db_ColumnRef &column)
 


Detailed Description

an object that stores information about a database schema table


Member Function Documentation

virtual void addColumn ( const db_ColumnRef &  column  )  [virtual]

Parameters:
column 
Returns:
virtual void addIndex ( const db_IndexRef &  index  )  [virtual]

Parameters:
index 
Returns:
virtual void addPrimaryKeyColumn ( const db_ColumnRef &  column  )  [virtual]

Parameters:
column 
Returns:
grt::ListRef<db_Column> columns (  )  const

Getter for attribute columns (read-only).

In Python:
value = obj.columns

Reimplemented in db_mysql_Table.

virtual db_ForeignKeyRef createForeignKey ( const std::string &  name  )  [virtual]

Parameters:
name 
Returns:
grt::ListRef<db_ForeignKey> foreignKeys (  )  const

Getter for attribute foreignKeys (read-only).

In Python:
value = obj.foreignKeys

Reimplemented in db_mysql_Table.

grt::ListRef<db_Index> indices (  )  const

Getter for attribute indices (read-only).

In Python:
value = obj.indices

Reimplemented in db_mysql_Table.

virtual grt::StringRef inserts (  )  [virtual]

Returns:
virtual grt::IntegerRef isDependantTable (  )  [virtual]

Returns:
virtual grt::IntegerRef isForeignKeyColumn ( const db_ColumnRef &  column  )  [virtual]

Parameters:
column 
Returns:
virtual grt::IntegerRef isPrimaryKeyColumn ( const db_ColumnRef &  column  )  [virtual]

Parameters:
column 
Returns:
virtual void isStub ( const grt::IntegerRef &  value  )  [virtual]

Setter for attribute isStub.

whether this table is a stub intended for foreign keys and triggers that refer to tables external to this model

In Python:
obj.isStub = value
grt::IntegerRef isStub (  )  const

Getter for attribute isStub.

whether this table is a stub intended for foreign keys and triggers that refer to tables external to this model

In Python:
value = obj.isStub
grt::IntegerRef isSystem (  )  const

Getter for attribute isSystem.

In Python:
value = obj.isSystem
virtual void isSystem ( const grt::IntegerRef &  value  )  [virtual]

Setter for attribute isSystem.

In Python:
obj.isSystem = value
grt::IntegerRef isTemporary (  )  const

Getter for attribute isTemporary.

In Python:
value = obj.isTemporary
virtual void isTemporary ( const grt::IntegerRef &  value  )  [virtual]

Setter for attribute isTemporary.

In Python:
obj.isTemporary = value
db_IndexRef primaryKey (  )  const

Getter for attribute primaryKey.

In Python:
value = obj.primaryKey

Reimplemented in db_mysql_Table.

virtual void primaryKey ( const db_IndexRef &  value  )  [virtual]

Setter for attribute primaryKey.

In Python:
obj.primaryKey = value
virtual void removeColumn ( const db_ColumnRef &  column  )  [virtual]

Parameters:
column 
Returns:
virtual void removeForeignKey ( const db_ForeignKeyRef &  fk,
long  removeColumns 
) [virtual]

Parameters:
fk 
removeColumns 
Returns:
virtual void removeIndex ( const db_IndexRef &  index  )  [virtual]

Parameters:
index 
Returns:
virtual void removePrimaryKeyColumn ( const db_ColumnRef &  column  )  [virtual]

Parameters:
column 
Returns:
grt::StringRef temporaryScope (  )  const

Getter for attribute temporaryScope.

In Python:
value = obj.temporaryScope
virtual void temporaryScope ( const grt::StringRef &  value  )  [virtual]

Setter for attribute temporaryScope.

In Python:
obj.temporaryScope = value
grt::ListRef<db_Trigger> triggers (  )  const

Getter for attribute triggers (read-only).

In Python:
value = obj.triggers

Reimplemented in db_mysql_Table.