<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>VTK: vtkODBCDatabase Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.6 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>vtkODBCDatabase Class Reference</h1><!-- doxytag: class="vtkODBCDatabase" --><!-- doxytag: inherits="vtkSQLDatabase" --><code>#include <<a class="el" href="a04953.html">vtkODBCDatabase.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for vtkODBCDatabase:</div>
<div class="dynsection">
<p><center><img src="a12409.png" border="0" usemap="#a12410" alt="Inheritance graph"></center>
<map name="a12410">
<area shape="rect" href="a01593.html" title="maintain a connection to an sql database" alt="" coords="11,155,136,181"><area shape="rect" href="a01084.html" title="abstract base class for most VTK objects" alt="" coords="34,80,114,107"><area shape="rect" href="a01085.html" title="abstract base class for most VTK objects" alt="" coords="19,5,128,32"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<div class="dynheader">
Collaboration diagram for vtkODBCDatabase:</div>
<div class="dynsection">
<p><center><img src="a12411.png" border="0" usemap="#a12412" alt="Collaboration graph"></center>
<map name="a12412">
<area shape="rect" href="a01593.html" title="maintain a connection to an sql database" alt="" coords="6,315,131,342"><area shape="rect" href="a01084.html" title="abstract base class for most VTK objects" alt="" coords="58,174,138,200"><area shape="rect" href="a00081.html" title="Abstract superclass for all arrays." alt="" coords="127,366,250,392"><area shape="rect" href="a00872.html" title="Store vtkAlgorithm input/output information." alt="" coords="188,264,298,291"><area shape="rect" href="a01085.html" title="abstract base class for most VTK objects" alt="" coords="188,6,298,32"><area shape="rect" href="a00884.html" title="internal structure for vtkInformation" alt="" coords="162,174,324,200"><area shape="rect" href="a00886.html" title="Superclass for vtkInformation keys." alt="" coords="310,83,440,110"><area shape="rect" href="a01719.html" title="record modification and/or execution time" alt="" coords="86,83,195,110"><area shape="rect" href="a01093.html" title="Simple class to hide ODBC structures." alt="" coords="106,456,236,483"><area shape="rect" href="a01619.html" title="Subclass of vtkAbstractArray that holds vtkStdStrings." alt="" coords="260,456,370,483"><area shape="rect" href="a00891.html" title="Key for pointer to pointer." alt="" coords="348,174,530,200"><area shape="rect" href="a01607.html" title="Wrapper around vtkstd::string to keep symbols short." alt="" coords="274,366,370,392"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="a12413.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
maintain an ODBC connection to a SQL database
<p>
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.<p>
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.<p>
<dl class="warning" compact><dt><b>Warning:</b></dt><dd>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.<p>
Also, <a class="el" href="a01593.html#ecaaaf67b4d08c393d28ffe2766bf317">vtkSQLDatabase::CreateFromURL()</a> will only handle URLs of the following form for ODBC:<p>
odbc://[user@]datsourcename[:port]/[dbname]<p>
Anything more complicated than that needs to be set up manually.<p>
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.</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="a01094.html" title="vtkSQLQuery implementation for ODBC connections to databases">vtkODBCQuery</a></dd></dl>
<dl class="user" compact><dt><b>Tests:</b></dt><dd><a class="el" href="c2_vtk_t_11.html#c2_vtk_t_vtkODBCDatabase">vtkODBCDatabase (Tests)</a> </dd></dl>
<p>Definition at line <a class="el" href="a04953.html#l00084">84</a> of file <a class="el" href="a04953.html">vtkODBCDatabase.h</a>.</p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="a01593.html">vtkSQLDatabase</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a01092.html#fbb68164963efebef376fa33e1d5d814">Superclass</a></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="a01092.html#8472e35d9c01648d3fff4041e8f32659">GetClassName</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="a01092.html#d4225c5502e62d045cd3a77325a8233d">IsA</a> (const char *type)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a01092.html#b3ca785e13303ec1f2bd9a04ddc1cee4">PrintSelf</a> (ostream &os, <a class="el" href="a00869.html">vtkIndent</a> indent)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a01092.html#16668a283bb34d0161f7b25dc9357a34">Open</a> (const char *password)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a01092.html#4123f45757ec17bb9f7f432759785719">Close</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a01092.html#0b1053e16572c3544b3647afac1b1e82">IsOpen</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a01600.html">vtkSQLQuery</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a01092.html#af49354ea39d0fa290f495c536631f61">GetQueryInstance</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="a01092.html#5f9bb392f4eb96598225ad374f4a5af4">GetLastErrorText</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a01619.html">vtkStringArray</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a01092.html#0ea829242b42e408cc99f91588bca006">GetTables</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a01619.html">vtkStringArray</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a01092.html#bb8c76b19c94296b9f725ee6e96931ec">GetRecord</a> (const char *table)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a01092.html#89a159ae37a6461f10d3815648c49ad1">IsSupported</a> (int feature)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a01092.html#ef8d87e151ab87a88d75c9681077c297">SetServerPort</a> (int)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a01092.html#77d224d71b1aee6b71a53b65f75222b7">SetHostName</a> (const char *)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a01092.html#59abcd8b5b080e63fbfb0dabfa9129fa">SetUserName</a> (const char *)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a01092.html#0c1645ee51de74775fd68a3d22b1eb47">SetDatabaseName</a> (const char *)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual char * </td><td class="memItemRight" valign="bottom"><a class="el" href="a01092.html#de731e652acad88a8e102ddc017797f1">GetDatabaseName</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a01092.html#7e9b70a4ba10cacddf349e8bdb142641">SetPassword</a> (const char *)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a01092.html#b85defa7de9a54e63a16984f18236406">HasError</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a01607.html">vtkStdString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a01092.html#e28937ac9d08b5440e1c57e516e41f1d">GetURL</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a01092.html#9fe9d11872e2f22ca261aa80d2c9b271">CreateDatabase</a> (const char *dbName, bool dropExisting)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a01092.html#09273b04b8ba5329de241c3e52e2861d">DropDatabase</a> (const char *dbName)</td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a01092.html#64ea34306b2c650743bbcf983108bc82">SetDataSourceName</a> (const char *)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual char * </td><td class="memItemRight" valign="bottom"><a class="el" href="a01092.html#5dba90af5ac88179692f4c8d6aaad670">GetDataSourceName</a> ()</td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual char * </td><td class="memItemRight" valign="bottom"><a class="el" href="a01092.html#192aa8d237969cf34346ad981615fd75">GetDatabaseType</a> ()</td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="a01607.html">vtkStdString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a01092.html#e4daaccf03ce65840669221e59490a2b">GetColumnSpecification</a> (<a class="el" href="a01595.html">vtkSQLDatabaseSchema</a> *schema, int tblHandle, int colHandle)</td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="a01607.html">vtkStdString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a01092.html#bb9dee31b0e1a215ce5b1d252cd522f4">GetIndexSpecification</a> (<a class="el" href="a01595.html">vtkSQLDatabaseSchema</a> *schema, int tblHandle, int idxHandle, bool &skipped)</td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="a01092.html#50925ecc6a9a4b7a1247d63110c196e5">IsTypeOf</a> (const char *type)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="a01092.html">vtkODBCDatabase</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a01092.html#a693116f4db233784b301e9f7658d69e">SafeDownCast</a> (<a class="el" href="a01084.html">vtkObject</a> *o)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="a01092.html">vtkODBCDatabase</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a01092.html#da91634a1a29d32a384978c99fbadb15">New</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a01092.html#c14f99cecb6bba77068faca3d2db250e">vtkODBCDatabase</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a01092.html#a92745527ff4e09f1c940cc027355fcd">~vtkODBCDatabase</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a01092.html#5290d834d72d3dbc362ee8045094393f">SetLastErrorText</a> (const char *)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a01092.html#05c2c41e4d92ec6e4b936e40e1c1ff28">ParseURL</a> (const char *url)</td></tr>
<tr><td colspan="2"><br><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="a01092.html#cce5f13c5860656d7a93a3dc8303bc3d">vtkODBCQuery</a></td></tr>
</table>
<hr><h2>Member Typedef Documentation</h2>
<a class="anchor" name="fbb68164963efebef376fa33e1d5d814"></a><!-- doxytag: member="vtkODBCDatabase::Superclass" ref="fbb68164963efebef376fa33e1d5d814" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="a01593.html">vtkSQLDatabase</a> <a class="el" href="a01593.html">vtkODBCDatabase::Superclass</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Reimplemented from <a class="el" href="a01593.html#664e020df8ed1ebfdb3c4e198bcbe6ad">vtkSQLDatabase</a>.</p>
<p>Definition at line <a class="el" href="a04953.html#l00091">91</a> of file <a class="el" href="a04953.html">vtkODBCDatabase.h</a>.</p>
</div>
</div><p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="c14f99cecb6bba77068faca3d2db250e"></a><!-- doxytag: member="vtkODBCDatabase::vtkODBCDatabase" ref="c14f99cecb6bba77068faca3d2db250e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vtkODBCDatabase::vtkODBCDatabase </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="a92745527ff4e09f1c940cc027355fcd"></a><!-- doxytag: member="vtkODBCDatabase::~vtkODBCDatabase" ref="a92745527ff4e09f1c940cc027355fcd" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vtkODBCDatabase::~vtkODBCDatabase </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="8472e35d9c01648d3fff4041e8f32659"></a><!-- doxytag: member="vtkODBCDatabase::GetClassName" ref="8472e35d9c01648d3fff4041e8f32659" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* vtkODBCDatabase::GetClassName </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Reimplemented from <a class="el" href="a01593.html#ebab6aec13660a41dba61ca22beabb67">vtkSQLDatabase</a>.</p>
</div>
</div><p>
<a class="anchor" name="50925ecc6a9a4b7a1247d63110c196e5"></a><!-- doxytag: member="vtkODBCDatabase::IsTypeOf" ref="50925ecc6a9a4b7a1247d63110c196e5" args="(const char *type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static int vtkODBCDatabase::IsTypeOf </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em> </td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
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 vtkTypeRevisionMacro found in vtkSetGet.h.
<p>Reimplemented from <a class="el" href="a01593.html#9c3b15b8be3614774caa15b79048c864">vtkSQLDatabase</a>.</p>
</div>
</div><p>
<a class="anchor" name="d4225c5502e62d045cd3a77325a8233d"></a><!-- doxytag: member="vtkODBCDatabase::IsA" ref="d4225c5502e62d045cd3a77325a8233d" args="(const char *type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int vtkODBCDatabase::IsA </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
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 vtkTypeRevisionMacro found in vtkSetGet.h.
<p>Reimplemented from <a class="el" href="a01593.html#8b2cef1c0fdcce3d42550814d17dbc3a">vtkSQLDatabase</a>.</p>
</div>
</div><p>
<a class="anchor" name="a693116f4db233784b301e9f7658d69e"></a><!-- doxytag: member="vtkODBCDatabase::SafeDownCast" ref="a693116f4db233784b301e9f7658d69e" args="(vtkObject *o)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="a01092.html">vtkODBCDatabase</a>* vtkODBCDatabase::SafeDownCast </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a01084.html">vtkObject</a> * </td>
<td class="paramname"> <em>o</em> </td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Reimplemented from <a class="el" href="a01593.html#fbcde15dac76ca1c949656b443d8f2ac">vtkSQLDatabase</a>.</p>
</div>
</div><p>
<a class="anchor" name="b3ca785e13303ec1f2bd9a04ddc1cee4"></a><!-- doxytag: member="vtkODBCDatabase::PrintSelf" ref="b3ca785e13303ec1f2bd9a04ddc1cee4" args="(ostream &os, vtkIndent indent)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void vtkODBCDatabase::PrintSelf </td>
<td>(</td>
<td class="paramtype">ostream & </td>
<td class="paramname"> <em>os</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00869.html">vtkIndent</a> </td>
<td class="paramname"> <em>indent</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use <a class="el" href="a01085.html#edadf6378465fd81c2592ef64262e2a5">Print()</a> instead) but used in the hierarchical print process to combine the output of several classes.
<p>Reimplemented from <a class="el" href="a01593.html#ce7a99b2be0a312ded18f03faec5ef7f">vtkSQLDatabase</a>.</p>
</div>
</div><p>
<a class="anchor" name="da91634a1a29d32a384978c99fbadb15"></a><!-- doxytag: member="vtkODBCDatabase::New" ref="da91634a1a29d32a384978c99fbadb15" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="a01092.html">vtkODBCDatabase</a>* vtkODBCDatabase::New </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
<p>Reimplemented from <a class="el" href="a01084.html#4d5b227267c076d6f9e38483370b6612">vtkObject</a>.</p>
</div>
</div><p>
<a class="anchor" name="16668a283bb34d0161f7b25dc9357a34"></a><!-- doxytag: member="vtkODBCDatabase::Open" ref="16668a283bb34d0161f7b25dc9357a34" args="(const char *password)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool vtkODBCDatabase::Open </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>password</em> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
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.
<p>Implements <a class="el" href="a01593.html#1ad93ce2f8e955dee1b7fbefa29bc601">vtkSQLDatabase</a>.</p>
</div>
</div><p>
<a class="anchor" name="4123f45757ec17bb9f7f432759785719"></a><!-- doxytag: member="vtkODBCDatabase::Close" ref="4123f45757ec17bb9f7f432759785719" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void vtkODBCDatabase::Close </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Close the connection to the database.
<p>Implements <a class="el" href="a01593.html#ca2514f61379a34c483b8495fc587d38">vtkSQLDatabase</a>.</p>
</div>
</div><p>
<a class="anchor" name="0b1053e16572c3544b3647afac1b1e82"></a><!-- doxytag: member="vtkODBCDatabase::IsOpen" ref="0b1053e16572c3544b3647afac1b1e82" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool vtkODBCDatabase::IsOpen </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return whether the database has an open connection
<p>Implements <a class="el" href="a01593.html#e6cbab57ae129acf5cadb26a7091764e">vtkSQLDatabase</a>.</p>
</div>
</div><p>
<a class="anchor" name="af49354ea39d0fa290f495c536631f61"></a><!-- doxytag: member="vtkODBCDatabase::GetQueryInstance" ref="af49354ea39d0fa290f495c536631f61" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a01600.html">vtkSQLQuery</a>* vtkODBCDatabase::GetQueryInstance </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return an empty query on this database.
<p>Implements <a class="el" href="a01593.html#9bb75b01cc942a6c63ba9005afa0e18f">vtkSQLDatabase</a>.</p>
</div>
</div><p>
<a class="anchor" name="5f9bb392f4eb96598225ad374f4a5af4"></a><!-- doxytag: member="vtkODBCDatabase::GetLastErrorText" ref="5f9bb392f4eb96598225ad374f4a5af4" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* vtkODBCDatabase::GetLastErrorText </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the last error text from the database
<p>Implements <a class="el" href="a01593.html#802a9394bb4ae23d1dba134479db1bdc">vtkSQLDatabase</a>.</p>
</div>
</div><p>
<a class="anchor" name="0ea829242b42e408cc99f91588bca006"></a><!-- doxytag: member="vtkODBCDatabase::GetTables" ref="0ea829242b42e408cc99f91588bca006" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a01619.html">vtkStringArray</a>* vtkODBCDatabase::GetTables </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the list of tables from the database
<p>Implements <a class="el" href="a01593.html#fb9f12b4accb814ed2922f454c0fd7ff">vtkSQLDatabase</a>.</p>
</div>
</div><p>
<a class="anchor" name="bb8c76b19c94296b9f725ee6e96931ec"></a><!-- doxytag: member="vtkODBCDatabase::GetRecord" ref="bb8c76b19c94296b9f725ee6e96931ec" args="(const char *table)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a01619.html">vtkStringArray</a>* vtkODBCDatabase::GetRecord </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>table</em> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the list of fields for a particular table
<p>Implements <a class="el" href="a01593.html#7145a148bc6b76820587b6ab8de5ba16">vtkSQLDatabase</a>.</p>
</div>
</div><p>
<a class="anchor" name="89a159ae37a6461f10d3815648c49ad1"></a><!-- doxytag: member="vtkODBCDatabase::IsSupported" ref="89a159ae37a6461f10d3815648c49ad1" args="(int feature)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool vtkODBCDatabase::IsSupported </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>feature</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return whether a feature is supported by the database.
</div>
</div><p>
<a class="anchor" name="64ea34306b2c650743bbcf983108bc82"></a><!-- doxytag: member="vtkODBCDatabase::SetDataSourceName" ref="64ea34306b2c650743bbcf983108bc82" args="(const char *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void vtkODBCDatabase::SetDataSourceName </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
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.
</div>
</div><p>
<a class="anchor" name="5dba90af5ac88179692f4c8d6aaad670"></a><!-- doxytag: member="vtkODBCDatabase::GetDataSourceName" ref="5dba90af5ac88179692f4c8d6aaad670" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual char* vtkODBCDatabase::GetDataSourceName </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
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.
</div>
</div><p>
<a class="anchor" name="ef8d87e151ab87a88d75c9681077c297"></a><!-- doxytag: member="vtkODBCDatabase::SetServerPort" ref="ef8d87e151ab87a88d75c9681077c297" args="(int)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void vtkODBCDatabase::SetServerPort </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="77d224d71b1aee6b71a53b65f75222b7"></a><!-- doxytag: member="vtkODBCDatabase::SetHostName" ref="77d224d71b1aee6b71a53b65f75222b7" args="(const char *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void vtkODBCDatabase::SetHostName </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="59abcd8b5b080e63fbfb0dabfa9129fa"></a><!-- doxytag: member="vtkODBCDatabase::SetUserName" ref="59abcd8b5b080e63fbfb0dabfa9129fa" args="(const char *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void vtkODBCDatabase::SetUserName </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="0c1645ee51de74775fd68a3d22b1eb47"></a><!-- doxytag: member="vtkODBCDatabase::SetDatabaseName" ref="0c1645ee51de74775fd68a3d22b1eb47" args="(const char *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void vtkODBCDatabase::SetDatabaseName </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="de731e652acad88a8e102ddc017797f1"></a><!-- doxytag: member="vtkODBCDatabase::GetDatabaseName" ref="de731e652acad88a8e102ddc017797f1" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual char* vtkODBCDatabase::GetDatabaseName </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="7e9b70a4ba10cacddf349e8bdb142641"></a><!-- doxytag: member="vtkODBCDatabase::SetPassword" ref="7e9b70a4ba10cacddf349e8bdb142641" args="(const char *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void vtkODBCDatabase::SetPassword </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="b85defa7de9a54e63a16984f18236406"></a><!-- doxytag: member="vtkODBCDatabase::HasError" ref="b85defa7de9a54e63a16984f18236406" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool vtkODBCDatabase::HasError </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Did the last operation generate an error
<p>Implements <a class="el" href="a01593.html#b4cd894738c5c0f7e6dfb576aaf44cdd">vtkSQLDatabase</a>.</p>
</div>
</div><p>
<a class="anchor" name="192aa8d237969cf34346ad981615fd75"></a><!-- doxytag: member="vtkODBCDatabase::GetDatabaseType" ref="192aa8d237969cf34346ad981615fd75" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual char* vtkODBCDatabase::GetDatabaseType </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
String representing database type (e.g. "ODBC").
<p>Implements <a class="el" href="a01593.html#61e8951bfa175da2e6a6e9ad1f7a5da0">vtkSQLDatabase</a>.</p>
</div>
</div><p>
<a class="anchor" name="e28937ac9d08b5440e1c57e516e41f1d"></a><!-- doxytag: member="vtkODBCDatabase::GetURL" ref="e28937ac9d08b5440e1c57e516e41f1d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a01607.html">vtkStdString</a> vtkODBCDatabase::GetURL </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the URL of the database.
<p>Implements <a class="el" href="a01593.html#4e9b0199b16525879febe0e1925add23">vtkSQLDatabase</a>.</p>
</div>
</div><p>
<a class="anchor" name="e4daaccf03ce65840669221e59490a2b"></a><!-- doxytag: member="vtkODBCDatabase::GetColumnSpecification" ref="e4daaccf03ce65840669221e59490a2b" args="(vtkSQLDatabaseSchema *schema, int tblHandle, int colHandle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="a01607.html">vtkStdString</a> vtkODBCDatabase::GetColumnSpecification </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a01595.html">vtkSQLDatabaseSchema</a> * </td>
<td class="paramname"> <em>schema</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>tblHandle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>colHandle</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
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.
<p>Reimplemented from <a class="el" href="a01593.html#653487fb98342c539bc884e5d60a09e2">vtkSQLDatabase</a>.</p>
</div>
</div><p>
<a class="anchor" name="bb9dee31b0e1a215ce5b1d252cd522f4"></a><!-- doxytag: member="vtkODBCDatabase::GetIndexSpecification" ref="bb9dee31b0e1a215ce5b1d252cd522f4" args="(vtkSQLDatabaseSchema *schema, int tblHandle, int idxHandle, bool &skipped)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="a01607.html">vtkStdString</a> vtkODBCDatabase::GetIndexSpecification </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a01595.html">vtkSQLDatabaseSchema</a> * </td>
<td class="paramname"> <em>schema</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>tblHandle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>idxHandle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool & </td>
<td class="paramname"> <em>skipped</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the SQL string with the syntax to create an index inside a "CREATE TABLE" SQL statement.
<p>Reimplemented from <a class="el" href="a01593.html#918e2d8245497f5bc652efe86d02ebcb">vtkSQLDatabase</a>.</p>
</div>
</div><p>
<a class="anchor" name="9fe9d11872e2f22ca261aa80d2c9b271"></a><!-- doxytag: member="vtkODBCDatabase::CreateDatabase" ref="9fe9d11872e2f22ca261aa80d2c9b271" args="(const char *dbName, bool dropExisting)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool vtkODBCDatabase::CreateDatabase </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>dbName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>dropExisting</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
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.
</div>
</div><p>
<a class="anchor" name="09273b04b8ba5329de241c3e52e2861d"></a><!-- doxytag: member="vtkODBCDatabase::DropDatabase" ref="09273b04b8ba5329de241c3e52e2861d" args="(const char *dbName)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool vtkODBCDatabase::DropDatabase </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>dbName</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Drop a database if it exists. Returns true on success and false on failure.
</div>
</div><p>
<a class="anchor" name="5290d834d72d3dbc362ee8045094393f"></a><!-- doxytag: member="vtkODBCDatabase::SetLastErrorText" ref="5290d834d72d3dbc362ee8045094393f" args="(const char *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void vtkODBCDatabase::SetLastErrorText </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="05c2c41e4d92ec6e4b936e40e1c1ff28"></a><!-- doxytag: member="vtkODBCDatabase::ParseURL" ref="05c2c41e4d92ec6e4b936e40e1c1ff28" args="(const char *url)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool vtkODBCDatabase::ParseURL </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>url</em> </td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This will only handle URLs of the form odbc://[user@]datsourcename[:port]/[dbname]. Anything more complicated than that needs to be set up manually.
<p>Implements <a class="el" href="a01593.html#72094d9af97ffd1f18ab436d3ca784a6">vtkSQLDatabase</a>.</p>
</div>
</div><p>
<hr><h2>Friends And Related Function Documentation</h2>
<a class="anchor" name="cce5f13c5860656d7a93a3dc8303bc3d"></a><!-- doxytag: member="vtkODBCDatabase::vtkODBCQuery" ref="cce5f13c5860656d7a93a3dc8303bc3d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="a01094.html">vtkODBCQuery</a><code> [friend]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Definition at line <a class="el" href="a04953.html#l00087">87</a> of file <a class="el" href="a04953.html">vtkODBCDatabase.h</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>dox/IO/<a class="el" href="a04953.html">vtkODBCDatabase.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 3 19:19:59 2009 for VTK by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
</body>
</html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
60f1dc962abad0f3b492991a4fbef9be
>
files
>
1095
