VTK
|
maintain an ODBC connection to a SQL database More...
#include <vtkODBCDatabase.h>
Public Types | |
typedef vtkSQLDatabase | Superclass |
Public Types inherited from vtkSQLDatabase | |
typedef vtkObject | Superclass |
typedef vtkSQLDatabase *(* | CreateFunction) (const char *URL) |
Public Types inherited from vtkObject | |
typedef vtkObjectBase | Superclass |
Public Member Functions | |
virtual int | IsA (const char *type) |
vtkODBCDatabase * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) |
bool | Open (const char *password) |
void | Close () |
bool | IsOpen () |
vtkSQLQuery * | GetQueryInstance () |
const char * | GetLastErrorText () |
vtkStringArray * | GetTables () |
vtkStringArray * | GetRecord (const char *table) |
bool | IsSupported (int feature) |
virtual void | SetServerPort (int) |
virtual void | SetHostName (const char *) |
virtual void | SetUserName (const char *) |
virtual void | SetDatabaseName (const char *) |
virtual char * | GetDatabaseName () |
virtual void | SetPassword (const char *) |
bool | HasError () |
vtkStdString | GetURL () |
bool | CreateDatabase (const char *dbName, bool dropExisting) |
bool | DropDatabase (const char *dbName) |
bool | ParseURL (const char *url) |
virtual void | SetDataSourceName (const char *) |
virtual char * | GetDataSourceName () |
virtual char * | GetDatabaseType () |
virtual vtkStdString | GetColumnSpecification (vtkSQLDatabaseSchema *schema, int tblHandle, int colHandle) |
virtual vtkStdString | GetIndexSpecification (vtkSQLDatabaseSchema *schema, int tblHandle, int idxHandle, bool &skipped) |
Public Member Functions inherited from vtkSQLDatabase | |
vtkSQLDatabase * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) |
virtual bool | IsSupported (int vtkNotUsed(feature)) |
virtual vtkStdString | GetTablePreamble (bool) |
virtual bool | EffectSchema (vtkSQLDatabaseSchema *, bool dropIfExists=false) |
virtual vtkStdString | GetTriggerSpecification (vtkSQLDatabaseSchema *schema, int tblHandle, int trgHandle) |
Public Member Functions inherited from vtkObject | |
vtkObject * | NewInstance () const |
virtual void | DebugOn () |
virtual void | DebugOff () |
bool | GetDebug () |
void | SetDebug (bool debugFlag) |
virtual void | Modified () |
virtual unsigned long | GetMTime () |
unsigned long | AddObserver (unsigned long event, vtkCommand *, float priority=0.0f) |
unsigned long | AddObserver (const char *event, vtkCommand *, float priority=0.0f) |
vtkCommand * | GetCommand (unsigned long tag) |
void | RemoveObserver (vtkCommand *) |
void | RemoveObservers (unsigned long event, vtkCommand *) |
void | RemoveObservers (const char *event, vtkCommand *) |
int | HasObserver (unsigned long event, vtkCommand *) |
int | HasObserver (const char *event, vtkCommand *) |
void | RemoveObserver (unsigned long tag) |
void | RemoveObservers (unsigned long event) |
void | RemoveObservers (const char *event) |
void | RemoveAllObservers () |
int | HasObserver (unsigned long event) |
int | HasObserver (const char *event) |
template<class U , class T > | |
unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f) |
template<class U , class T > | |
unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
template<class U , class T > | |
unsigned long | AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
int | InvokeEvent (unsigned long event, void *callData) |
int | InvokeEvent (const char *event, void *callData) |
int | InvokeEvent (unsigned long event) |
int | InvokeEvent (const char *event) |
Public Member Functions inherited from vtkObjectBase | |
const char * | GetClassName () const |
virtual void | Delete () |
virtual void | FastDelete () |
void | Print (ostream &os) |
virtual void | Register (vtkObjectBase *o) |
virtual void | UnRegister (vtkObjectBase *o) |
void | SetReferenceCount (int) |
void | PrintRevisions (ostream &) |
virtual void | PrintHeader (ostream &os, vtkIndent indent) |
virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
int | GetReferenceCount () |
Static Public Member Functions | |
static int | IsTypeOf (const char *type) |
static vtkODBCDatabase * | SafeDownCast (vtkObjectBase *o) |
static vtkODBCDatabase * | New () |
Static Public Member Functions inherited from vtkSQLDatabase | |
static int | IsTypeOf (const char *type) |
static vtkSQLDatabase * | SafeDownCast (vtkObjectBase *o) |
static vtkSQLDatabase * | CreateFromURL (const char *URL) |
static vtkInformationObjectBaseKey * | DATABASE () |
static void | RegisterCreateFromURLCallback (CreateFunction callback) |
static void | UnRegisterCreateFromURLCallback (CreateFunction callback) |
static void | UnRegisterAllCreateFromURLCallbacks () |
Static Public Member Functions inherited from vtkObject | |
static int | IsTypeOf (const char *type) |
static vtkObject * | SafeDownCast (vtkObjectBase *o) |
static vtkObject * | New () |
static void | BreakOnError () |
static void | SetGlobalWarningDisplay (int val) |
static void | GlobalWarningDisplayOn () |
static void | GlobalWarningDisplayOff () |
static int | GetGlobalWarningDisplay () |
Static Public Member Functions inherited from vtkObjectBase | |
static int | IsTypeOf (const char *name) |
static vtkObjectBase * | New () |
Protected Member Functions | |
virtual vtkObjectBase * | NewInstanceInternal () const |
vtkODBCDatabase () | |
~vtkODBCDatabase () | |
virtual void | SetLastErrorText (const char *) |
Protected Member Functions inherited from vtkSQLDatabase | |
vtkSQLDatabase () | |
~vtkSQLDatabase () | |
Protected Member Functions inherited from vtkObject | |
vtkObject () | |
virtual | ~vtkObject () |
virtual void | RegisterInternal (vtkObjectBase *, int check) |
virtual void | UnRegisterInternal (vtkObjectBase *, int check) |
void | InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL) |
void | InternalReleaseFocus () |
Protected Member Functions inherited from vtkObjectBase | |
vtkObjectBase () | |
virtual | ~vtkObjectBase () |
virtual void | CollectRevisions (ostream &) |
virtual void | ReportReferences (vtkGarbageCollector *) |
vtkObjectBase (const vtkObjectBase &) | |
void | operator= (const vtkObjectBase &) |
Friends | |
class | vtkODBCQuery |
Additional Inherited Members | |
Protected Attributes inherited from vtkObject | |
bool | Debug |
vtkTimeStamp | MTime |
vtkSubjectHelper * | SubjectHelper |
Protected Attributes inherited from vtkObjectBase | |
vtkAtomicInt32 | ReferenceCount |
vtkWeakPointerBase ** | WeakPointers |
maintain an ODBC connection to a SQL database
ODBC is a standard for connecting to an SQL database regardless of vendor or implementation. In order to make it work you need two separate pices of software: a driver manager and then a database-specific driver. On Windows, the driver manager is built into the OS. On Unix platforms, the open-source packages iODBC and unixODBC will do the job. Mac OS X has its own driver manager and can also use the open-source packages. Database-specific drivers must be obtained from the entity that makes the database(s) you use.
Unlike the other VTK database drivers, ODBC can read its parameters from a configuration file (odbc.ini). That file can define an entire set of connection parameters and give it a single name called a data source name (DSN). Writing and maintaining odbc.ini files is beyond the scope of this header file.
Definition at line 85 of file vtkODBCDatabase.h.
Definition at line 92 of file vtkODBCDatabase.h.
|
protected |
|
protected |
|
static |
|
virtual |
Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.
Reimplemented from vtkSQLDatabase.
|
static |
|
protectedvirtual |
Reimplemented from vtkSQLDatabase.
vtkODBCDatabase* vtkODBCDatabase::NewInstance | ( | ) | const |
|
virtual |
|
static |
|
virtual |
Open a new connection to the database. You need to set the filename before calling this function. Returns true if the database was opened successfully; false otherwise.
Implements vtkSQLDatabase.
|
virtual |
Close the connection to the database.
Implements vtkSQLDatabase.
|
virtual |
Return whether the database has an open connection
Implements vtkSQLDatabase.
|
virtual |
Return an empty query on this database.
Implements vtkSQLDatabase.
|
virtual |
Get the last error text from the database
Implements vtkSQLDatabase.
|
virtual |
Get the list of tables from the database
Implements vtkSQLDatabase.
|
virtual |
Get the list of fields for a particular table
Implements vtkSQLDatabase.
bool vtkODBCDatabase::IsSupported | ( | int | feature | ) |
Return whether a feature is supported by the database.
|
virtual |
Set the data source name. For ODBC connections this will be something listed in odbc.ini. The location of that file varies wildly based on system, ODBC library, and installation. Good luck.
|
virtual |
Set the data source name. For ODBC connections this will be something listed in odbc.ini. The location of that file varies wildly based on system, ODBC library, and installation. Good luck.
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
Did the last operation generate an error
Implements vtkSQLDatabase.
|
virtual |
String representing database type (e.g. "ODBC").
Implements vtkSQLDatabase.
|
virtual |
Get the URL of the database.
Implements vtkSQLDatabase.
|
virtual |
Return the SQL string with the syntax to create a column inside a "CREATE TABLE" SQL statement. NB2: if a column has type SERIAL in the schema, this will be turned into INT NOT NULL. Therefore, one should not pass NOT NULL as an attribute of a column whose type is SERIAL.
Reimplemented from vtkSQLDatabase.
|
virtual |
Return the SQL string with the syntax to create an index inside a "CREATE TABLE" SQL statement.
Reimplemented from vtkSQLDatabase.
bool vtkODBCDatabase::CreateDatabase | ( | const char * | dbName, |
bool | dropExisting | ||
) |
Create a new database, optionally dropping any existing database of the same name. Returns true when the database is properly created and false on failure.
bool vtkODBCDatabase::DropDatabase | ( | const char * | dbName | ) |
Drop a database if it exists. Returns true on success and false on failure.
|
virtual |
This will only handle URLs of the form odbc://[user@]datsourcename[:port]/[dbname]. Anything more complicated than that needs to be set up manually.
Implements vtkSQLDatabase.
|
protectedvirtual |
|
friend |
Definition at line 88 of file vtkODBCDatabase.h.