46 #ifndef vtkSQLDatabaseSchema_h
47 #define vtkSQLDatabaseSchema_h
49 #include "vtkIOSQLModule.h"
57 #define VTK_SQL_ALLBACKENDS "*" // works for all backends
58 #define VTK_SQL_MYSQL "vtkMySQLDatabase"
59 #define VTK_SQL_POSTGRESQL "vtkPostgreSQLDatabase"
60 #define VTK_SQL_SQLITE "vtkSQLiteDatabase"
62 class vtkSQLDatabaseSchemaInternals;
128 virtual int AddPreamble(
134 virtual int AddTable(
const char* tblName);
142 virtual int AddColumnToTable(
143 int tblHandle,
int colType,
const char* colName,
int colSize,
const char* colOpts);
145 const char* tblName,
int colType,
const char* colName,
int colSize,
const char* colAttribs)
147 return this->AddColumnToTable(
148 this->GetTableHandleFromName(tblName), colType, colName, colSize, colAttribs);
158 virtual int AddIndexToTable(
int tblHandle,
int idxType,
const char* idxName);
161 return this->AddIndexToTable(this->GetTableHandleFromName(tblName), idxType, idxName);
171 virtual int AddColumnToIndex(
int tblHandle,
int idxHandle,
int colHandle);
172 virtual int AddColumnToIndex(
const char* tblName,
const char* idxName,
const char* colName)
174 int tblHandle = this->GetTableHandleFromName(tblName);
175 return this->AddColumnToIndex(tblHandle, this->GetIndexHandleFromName(tblName, idxName),
176 this->GetColumnHandleFromName(tblName, colName));
187 virtual int AddTriggerToTable(
int tblHandle,
int trgType,
const char* trgName,
192 return this->AddTriggerToTable(
193 this->GetTableHandleFromName(tblName), trgType, trgName, trgAction, trgBackend);
209 virtual int AddOptionToTable(
214 return this->AddOptionToTable(this->GetTableHandleFromName(tblName), optStr, optBackend);
221 int GetPreambleHandleFromName(
const char* preName);
226 const char* GetPreambleNameFromHandle(
int preHandle);
231 const char* GetPreambleActionFromHandle(
int preHandle);
236 const char* GetPreambleBackendFromHandle(
int preHandle);
241 int GetTableHandleFromName(
const char* tblName);
246 const char* GetTableNameFromHandle(
int tblHandle);
251 int GetIndexHandleFromName(
const char* tblName,
const char* idxName);
256 const char* GetIndexNameFromHandle(
int tblHandle,
int idxHandle);
261 int GetIndexTypeFromHandle(
int tblHandle,
int idxHandle);
266 const char* GetIndexColumnNameFromHandle(
int tblHandle,
int idxHandle,
int cnmHandle);
271 int GetColumnHandleFromName(
const char* tblName,
const char* colName);
276 const char* GetColumnNameFromHandle(
int tblHandle,
int colHandle);
281 int GetColumnTypeFromHandle(
int tblHandle,
int colHandle);
286 int GetColumnSizeFromHandle(
int tblHandle,
int colHandle);
291 const char* GetColumnAttributesFromHandle(
int tblHandle,
int colHandle);
296 int GetTriggerHandleFromName(
const char* tblName,
const char* trgName);
301 const char* GetTriggerNameFromHandle(
int tblHandle,
int trgHandle);
306 int GetTriggerTypeFromHandle(
int tblHandle,
int trgHandle);
311 const char* GetTriggerActionFromHandle(
int tblHandle,
int trgHandle);
316 const char* GetTriggerBackendFromHandle(
int tblHandle,
int trgHandle);
321 const char* GetOptionTextFromHandle(
int tblHandle,
int optHandle);
326 const char* GetOptionBackendFromHandle(
int tblHandle,
int optHandle);
336 int GetNumberOfPreambles();
341 int GetNumberOfTables();
346 int GetNumberOfColumnsInTable(
int tblHandle);
351 int GetNumberOfIndicesInTable(
int tblHandle);
356 int GetNumberOfColumnNamesInIndex(
int tblHandle,
int idxHandle);
361 int GetNumberOfTriggersInTable(
int tblHandle);
366 int GetNumberOfOptionsInTable(
int tblHandle);
372 vtkSetStringMacro(Name);
373 vtkGetStringMacro(Name);
382 INDEX_COLUMN_TOKEN = 65,
383 END_INDEX_TOKEN = 75,
418 int AddTableMultipleArguments(
const char* tblName, ...);
433 #endif // vtkSQLDatabaseSchema_h
abstract base class for most VTK objects
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
virtual int AddTriggerToTable(const char *tblName, int trgType, const char *trgName, const char *trgAction, const char *trgBackend=VTK_SQL_ALLBACKENDS)
Add a (possibly backend-specific) trigger action to a table.
virtual int AddColumnToTable(const char *tblName, int colType, const char *colName, int colSize, const char *colAttribs)
Add a column to table.
represent an SQL database schema
DatabaseColumnType
Basic data types for database columns.
a simple class to control print indentation
DatabaseTriggerType
Events where database triggers can be registered.
#define VTK_SQL_ALLBACKENDS
DatabaseIndexType
Types of indices that can be generated for database tables.
virtual int AddColumnToIndex(const char *tblName, const char *idxName, const char *colName)
Add a column to a table index.
virtual int AddOptionToTable(const char *tblName, const char *optStr, const char *optBackend=VTK_SQL_ALLBACKENDS)
Add (possibly backend-specific) text to the end of a CREATE TABLE (...) statement.
virtual int AddIndexToTable(const char *tblName, int idxType, const char *idxName)
Add an index to table.
static vtkObject * New()
Create an object with Debug turned off, modified time initialized to zero, and reference counting on...
class vtkSQLDatabaseSchemaInternals * Internals