vtkODBCDatabase Class Reference
#include <vtkODBCDatabase.h>
Detailed Description
maintain an ODBC connection to a SQL databaseODBC 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.
- Warning:
- The password supplied as an argument to the Open call will override whatever password is set (if any) in the DSN definition. To use the password from the DSN definition, pass in NULL for the password argument.
Also, vtkSQLDatabase::CreateFromURL() will only handle URLs of the following form for ODBC:
odbc://[user@]datsourcename[:port]/[dbname]
Anything more complicated than that needs to be set up manually.
Finally, this class does not yet support the schema API present in the SQLite, MySQL and PostgreSQL drivers. Those functions will be added once the bare-bones driver has been successfully integrated into VTK.
- See also:
- vtkODBCQuery
- Tests:
- vtkODBCDatabase (Tests)
Definition at line 84 of file vtkODBCDatabase.h.
Public Types | |
| typedef vtkSQLDatabase | Superclass |
Public Member Functions | |
| virtual const char * | GetClassName () |
| virtual int | IsA (const char *type) |
| 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) |
| 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) |
Static Public Member Functions | |
| static int | IsTypeOf (const char *type) |
| static vtkODBCDatabase * | SafeDownCast (vtkObject *o) |
| static vtkODBCDatabase * | New () |
Protected Member Functions | |
| vtkODBCDatabase () | |
| ~vtkODBCDatabase () | |
| virtual void | SetLastErrorText (const char *) |
| bool | ParseURL (const char *url) |
Friends | |
| class | vtkODBCQuery |
Member Typedef Documentation
Constructor & Destructor Documentation
| vtkODBCDatabase::vtkODBCDatabase | ( | ) | [protected] |
| vtkODBCDatabase::~vtkODBCDatabase | ( | ) | [protected] |
Member Function Documentation
| virtual const char* vtkODBCDatabase::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkSQLDatabase.
| static int vtkODBCDatabase::IsTypeOf | ( | const char * | name | ) | [static] |
Return 1 if this class type 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.
| virtual int vtkODBCDatabase::IsA | ( | const char * | name | ) | [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 vtkODBCDatabase* vtkODBCDatabase::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Reimplemented from vtkSQLDatabase.
| void vtkODBCDatabase::PrintSelf | ( | ostream & | os, | |
| vtkIndent | indent | |||
| ) | [virtual] |
Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.
Reimplemented from vtkSQLDatabase.
| static vtkODBCDatabase* vtkODBCDatabase::New | ( | ) | [static] |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
Reimplemented from vtkObject.
| bool vtkODBCDatabase::Open | ( | const char * | password | ) | [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.
| void vtkODBCDatabase::Close | ( | ) | [virtual] |
Close the connection to the database.
Implements vtkSQLDatabase.
| bool vtkODBCDatabase::IsOpen | ( | ) | [virtual] |
Return whether the database has an open connection
Implements vtkSQLDatabase.
| vtkSQLQuery* vtkODBCDatabase::GetQueryInstance | ( | ) | [virtual] |
Return an empty query on this database.
Implements vtkSQLDatabase.
| const char* vtkODBCDatabase::GetLastErrorText | ( | ) | [virtual] |
Get the last error text from the database
Implements vtkSQLDatabase.
| vtkStringArray* vtkODBCDatabase::GetTables | ( | ) | [virtual] |
Get the list of tables from the database
Implements vtkSQLDatabase.
| vtkStringArray* vtkODBCDatabase::GetRecord | ( | const char * | table | ) | [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 void vtkODBCDatabase::SetDataSourceName | ( | const char * | ) | [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 char* vtkODBCDatabase::GetDataSourceName | ( | ) | [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 void vtkODBCDatabase::SetServerPort | ( | int | ) | [virtual] |
| virtual void vtkODBCDatabase::SetHostName | ( | const char * | ) | [virtual] |
| virtual void vtkODBCDatabase::SetUserName | ( | const char * | ) | [virtual] |
| virtual void vtkODBCDatabase::SetDatabaseName | ( | const char * | ) | [virtual] |
| virtual char* vtkODBCDatabase::GetDatabaseName | ( | ) | [virtual] |
| virtual void vtkODBCDatabase::SetPassword | ( | const char * | ) | [virtual] |
| bool vtkODBCDatabase::HasError | ( | ) | [virtual] |
Did the last operation generate an error
Implements vtkSQLDatabase.
| virtual char* vtkODBCDatabase::GetDatabaseType | ( | ) | [virtual] |
String representing database type (e.g. "ODBC").
Implements vtkSQLDatabase.
| vtkStdString vtkODBCDatabase::GetURL | ( | ) | [virtual] |
Get the URL of the database.
Implements vtkSQLDatabase.
| virtual vtkStdString vtkODBCDatabase::GetColumnSpecification | ( | vtkSQLDatabaseSchema * | schema, | |
| int | tblHandle, | |||
| int | colHandle | |||
| ) | [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 vtkStdString vtkODBCDatabase::GetIndexSpecification | ( | vtkSQLDatabaseSchema * | schema, | |
| int | tblHandle, | |||
| int | idxHandle, | |||
| bool & | skipped | |||
| ) | [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 void vtkODBCDatabase::SetLastErrorText | ( | const char * | ) | [protected, virtual] |
| bool vtkODBCDatabase::ParseURL | ( | const char * | url | ) | [protected, 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.
Friends And Related Function Documentation
friend class vtkODBCQuery [friend] |
Definition at line 87 of file vtkODBCDatabase.h.
The documentation for this class was generated from the following file:
- dox/IO/vtkODBCDatabase.h
