<!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: vtkMySQLDatabase 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>vtkMySQLDatabase Class Reference</h1><!-- doxytag: class="vtkMySQLDatabase" --><!-- doxytag: inherits="vtkSQLDatabase" --><code>#include <<a class="el" href="a04949.html">vtkMySQLDatabase.h</a>></code> <p> <div class="dynheader"> Inheritance diagram for vtkMySQLDatabase:</div> <div class="dynsection"> <p><center><img src="a12341.png" border="0" usemap="#a12342" alt="Inheritance graph"></center> <map name="a12342"> <area shape="rect" href="a01593.html" title="maintain a connection to an sql database" alt="" coords="15,155,140,181"><area shape="rect" href="a01084.html" title="abstract base class for most VTK objects" alt="" coords="38,80,118,107"><area shape="rect" href="a01085.html" title="abstract base class for most VTK objects" alt="" coords="23,5,132,32"></map> <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div> <div class="dynheader"> Collaboration diagram for vtkMySQLDatabase:</div> <div class="dynsection"> <p><center><img src="a12343.png" border="0" usemap="#a12344" alt="Collaboration graph"></center> <map name="a12344"> <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="178,366,300,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="a01076.html" title="vtkMySQLDatabasePrivate" alt="" coords="106,456,292,483"><area shape="rect" href="a01619.html" title="Subclass of vtkAbstractArray that holds vtkStdStrings." alt="" coords="316,456,426,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="324,366,420,392"></map> <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div> <p> <a href="a12345.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2> maintain a connection to a MySQL database <p> This class provides a VTK interface to MySQL (<a href="http://www.mysql.com">http://www.mysql.com</a>). Unlike file-based databases like SQLite, you talk to MySQL through a client/server connection. You must specify the hostname, (optional) port to connect to, username, password and database name in order to connect.<p> <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="a01077.html" title="vtkSQLQuery implementation for MySQL databases">vtkMySQLQuery</a></dd></dl> <dl class="user" compact><dt><b>Tests:</b></dt><dd><a class="el" href="c2_vtk_t_10.html#c2_vtk_t_vtkMySQLDatabase">vtkMySQLDatabase (Tests)</a> </dd></dl> <p>Definition at line <a class="el" href="a04949.html#l00048">48</a> of file <a class="el" href="a04949.html">vtkMySQLDatabase.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="a01075.html#16ff160f1f095c57ff1d6cfc6841cb5b">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="a01075.html#025746e1d4421447f4d26084d158c8b7">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="a01075.html#2129c11a1b41f145135af63b67b751eb">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="a01075.html#6d51a569dd30b6c9fa4f2e078c1e481b">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="a01075.html#e1866198b2361ccc2c463fd4c243ed3b">Open</a> (const char *password=0)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a01075.html#2b38f65839e5b7a764ed1b9ae93b4b7a">Close</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a01075.html#57ddbeeb09cbf3cbd09fb025a2544699">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="a01075.html#0eb21faa21cd716e28faf6f628d6b575">GetQueryInstance</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="a01075.html#d9e4366ae71665a4ff3bc3d8b8c9f295">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="a01075.html#de4932a3b60f5f8956f40cde0b8fc715">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="a01075.html#7949c814e86fcde09a29dcea26edc590">IsSupported</a> (int feature)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a01075.html#9bb657aa51ebf2fab86e33add89dcb3b">HasError</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="a01075.html#d0cf32c2c43fd99b338cd931a172ae52">GetLastErrorText</a> ()</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="a01075.html#f4d002dc1fd14dcd1df9451092a97331">GetURL</a> ()</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="a01075.html#76aaf8df91ac98491bab6119c3488c0f">GetTablePreamble</a> (bool b)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a01075.html#5130408f91db7685d7a39d29d8215c43">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="a01075.html#4486a76da6a1ceb20920137080f63e04">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 char * </td><td class="memItemRight" valign="bottom"><a class="el" href="a01075.html#4049446f0a4eb28a5b43746ac55ec4aa">GetDatabaseType</a> ()</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="a01075.html#7b14de2f4349f86e695eb91265a8a451">SetHostName</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="a01075.html#63c11e91811f1f5095952b9ac565a44e">GetHostName</a> ()</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="a01075.html#2c3609dfda67d965c559d947ac26479e">SetUser</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="a01075.html#3a1161b38fb7e45247dd7a0f7a085a0c">GetUser</a> ()</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="a01075.html#ca4c7c646474287103f5e09110d96abd">SetPassword</a> (const char *)</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="a01075.html#f860c3b83fb379d98f396fe5712cba88">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="a01075.html#a67fe1a7eb411f67835f1dc74e024d83">GetDatabaseName</a> ()</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="a01075.html#80093fcaaae15e5b32e0359605ee084d">SetConnectOptions</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="a01075.html#93fc310fad10db1a9cf77f7185c5867d">GetConnectOptions</a> ()</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="a01075.html#50c635cd48eaa57a339202e3addc2898">SetServerPort</a> (int)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="a01075.html#53a7b42dd96ad68546c7171bf24a96d9">GetServerPort</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="a01075.html#e1b04e07c79622b064ec16c7ea2e4384">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="a01075.html#f1012768f02d99eff23c15193e1770d5">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="a01075.html#ff08222e2f91f04b56562870438ee0a3">IsTypeOf</a> (const char *type)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="a01075.html">vtkMySQLDatabase</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a01075.html#ae52bfdec9b12ae776cb216fa10a205a">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="a01075.html">vtkMySQLDatabase</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a01075.html#2146c904282c3e688ae95357337f217a">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="a01075.html#aaf3ac2c7c746cb039d2cd03961246a3">vtkMySQLDatabase</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a01075.html#61293483676f2513dc2fa0d59b8a4e56">~vtkMySQLDatabase</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a01075.html#90439b12777bfc5d28647a4ddfef9976">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="a01075.html#5674e46dc023d269eb78275c111afae4">vtkMySQLQuery</a></td></tr> </table> <hr><h2>Member Typedef Documentation</h2> <a class="anchor" name="16ff160f1f095c57ff1d6cfc6841cb5b"></a><!-- doxytag: member="vtkMySQLDatabase::Superclass" ref="16ff160f1f095c57ff1d6cfc6841cb5b" 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">vtkMySQLDatabase::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="a04949.html#l00055">55</a> of file <a class="el" href="a04949.html">vtkMySQLDatabase.h</a>.</p> </div> </div><p> <hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="aaf3ac2c7c746cb039d2cd03961246a3"></a><!-- doxytag: member="vtkMySQLDatabase::vtkMySQLDatabase" ref="aaf3ac2c7c746cb039d2cd03961246a3" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">vtkMySQLDatabase::vtkMySQLDatabase </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="61293483676f2513dc2fa0d59b8a4e56"></a><!-- doxytag: member="vtkMySQLDatabase::~vtkMySQLDatabase" ref="61293483676f2513dc2fa0d59b8a4e56" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">vtkMySQLDatabase::~vtkMySQLDatabase </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="025746e1d4421447f4d26084d158c8b7"></a><!-- doxytag: member="vtkMySQLDatabase::GetClassName" ref="025746e1d4421447f4d26084d158c8b7" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual const char* vtkMySQLDatabase::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="ff08222e2f91f04b56562870438ee0a3"></a><!-- doxytag: member="vtkMySQLDatabase::IsTypeOf" ref="ff08222e2f91f04b56562870438ee0a3" args="(const char *type)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static int vtkMySQLDatabase::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="2129c11a1b41f145135af63b67b751eb"></a><!-- doxytag: member="vtkMySQLDatabase::IsA" ref="2129c11a1b41f145135af63b67b751eb" args="(const char *type)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual int vtkMySQLDatabase::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="ae52bfdec9b12ae776cb216fa10a205a"></a><!-- doxytag: member="vtkMySQLDatabase::SafeDownCast" ref="ae52bfdec9b12ae776cb216fa10a205a" args="(vtkObject *o)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static <a class="el" href="a01075.html">vtkMySQLDatabase</a>* vtkMySQLDatabase::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="6d51a569dd30b6c9fa4f2e078c1e481b"></a><!-- doxytag: member="vtkMySQLDatabase::PrintSelf" ref="6d51a569dd30b6c9fa4f2e078c1e481b" args="(ostream &os, vtkIndent indent)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void vtkMySQLDatabase::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="2146c904282c3e688ae95357337f217a"></a><!-- doxytag: member="vtkMySQLDatabase::New" ref="2146c904282c3e688ae95357337f217a" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static <a class="el" href="a01075.html">vtkMySQLDatabase</a>* vtkMySQLDatabase::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="e1866198b2361ccc2c463fd4c243ed3b"></a><!-- doxytag: member="vtkMySQLDatabase::Open" ref="e1866198b2361ccc2c463fd4c243ed3b" args="(const char *password=0)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool vtkMySQLDatabase::Open </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"> <em>password</em> = <code>0</code> </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="2b38f65839e5b7a764ed1b9ae93b4b7a"></a><!-- doxytag: member="vtkMySQLDatabase::Close" ref="2b38f65839e5b7a764ed1b9ae93b4b7a" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void vtkMySQLDatabase::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="57ddbeeb09cbf3cbd09fb025a2544699"></a><!-- doxytag: member="vtkMySQLDatabase::IsOpen" ref="57ddbeeb09cbf3cbd09fb025a2544699" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool vtkMySQLDatabase::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="0eb21faa21cd716e28faf6f628d6b575"></a><!-- doxytag: member="vtkMySQLDatabase::GetQueryInstance" ref="0eb21faa21cd716e28faf6f628d6b575" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="a01600.html">vtkSQLQuery</a>* vtkMySQLDatabase::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="d9e4366ae71665a4ff3bc3d8b8c9f295"></a><!-- doxytag: member="vtkMySQLDatabase::GetTables" ref="d9e4366ae71665a4ff3bc3d8b8c9f295" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="a01619.html">vtkStringArray</a>* vtkMySQLDatabase::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="de4932a3b60f5f8956f40cde0b8fc715"></a><!-- doxytag: member="vtkMySQLDatabase::GetRecord" ref="de4932a3b60f5f8956f40cde0b8fc715" 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>* vtkMySQLDatabase::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="7949c814e86fcde09a29dcea26edc590"></a><!-- doxytag: member="vtkMySQLDatabase::IsSupported" ref="7949c814e86fcde09a29dcea26edc590" args="(int feature)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool vtkMySQLDatabase::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="9bb657aa51ebf2fab86e33add89dcb3b"></a><!-- doxytag: member="vtkMySQLDatabase::HasError" ref="9bb657aa51ebf2fab86e33add89dcb3b" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool vtkMySQLDatabase::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="d0cf32c2c43fd99b338cd931a172ae52"></a><!-- doxytag: member="vtkMySQLDatabase::GetLastErrorText" ref="d0cf32c2c43fd99b338cd931a172ae52" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const char* vtkMySQLDatabase::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="4049446f0a4eb28a5b43746ac55ec4aa"></a><!-- doxytag: member="vtkMySQLDatabase::GetDatabaseType" ref="4049446f0a4eb28a5b43746ac55ec4aa" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual char* vtkMySQLDatabase::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. "mysql"). <p>Implements <a class="el" href="a01593.html#61e8951bfa175da2e6a6e9ad1f7a5da0">vtkSQLDatabase</a>.</p> </div> </div><p> <a class="anchor" name="7b14de2f4349f86e695eb91265a8a451"></a><!-- doxytag: member="vtkMySQLDatabase::SetHostName" ref="7b14de2f4349f86e695eb91265a8a451" args="(const char *)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void vtkMySQLDatabase::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> The database server host name. </div> </div><p> <a class="anchor" name="63c11e91811f1f5095952b9ac565a44e"></a><!-- doxytag: member="vtkMySQLDatabase::GetHostName" ref="63c11e91811f1f5095952b9ac565a44e" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual char* vtkMySQLDatabase::GetHostName </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> The database server host name. </div> </div><p> <a class="anchor" name="2c3609dfda67d965c559d947ac26479e"></a><!-- doxytag: member="vtkMySQLDatabase::SetUser" ref="2c3609dfda67d965c559d947ac26479e" args="(const char *)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void vtkMySQLDatabase::SetUser </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> The user name for connecting to the database server. </div> </div><p> <a class="anchor" name="3a1161b38fb7e45247dd7a0f7a085a0c"></a><!-- doxytag: member="vtkMySQLDatabase::GetUser" ref="3a1161b38fb7e45247dd7a0f7a085a0c" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual char* vtkMySQLDatabase::GetUser </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> The user name for connecting to the database server. </div> </div><p> <a class="anchor" name="ca4c7c646474287103f5e09110d96abd"></a><!-- doxytag: member="vtkMySQLDatabase::SetPassword" ref="ca4c7c646474287103f5e09110d96abd" args="(const char *)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void vtkMySQLDatabase::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> The user's password for connecting to the database server. </div> </div><p> <a class="anchor" name="f860c3b83fb379d98f396fe5712cba88"></a><!-- doxytag: member="vtkMySQLDatabase::SetDatabaseName" ref="f860c3b83fb379d98f396fe5712cba88" args="(const char *)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void vtkMySQLDatabase::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> The name of the database to connect to. </div> </div><p> <a class="anchor" name="a67fe1a7eb411f67835f1dc74e024d83"></a><!-- doxytag: member="vtkMySQLDatabase::GetDatabaseName" ref="a67fe1a7eb411f67835f1dc74e024d83" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual char* vtkMySQLDatabase::GetDatabaseName </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> The name of the database to connect to. </div> </div><p> <a class="anchor" name="80093fcaaae15e5b32e0359605ee084d"></a><!-- doxytag: member="vtkMySQLDatabase::SetConnectOptions" ref="80093fcaaae15e5b32e0359605ee084d" args="(const char *)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void vtkMySQLDatabase::SetConnectOptions </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> Additional options for the database. </div> </div><p> <a class="anchor" name="93fc310fad10db1a9cf77f7185c5867d"></a><!-- doxytag: member="vtkMySQLDatabase::GetConnectOptions" ref="93fc310fad10db1a9cf77f7185c5867d" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual char* vtkMySQLDatabase::GetConnectOptions </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Additional options for the database. </div> </div><p> <a class="anchor" name="50c635cd48eaa57a339202e3addc2898"></a><!-- doxytag: member="vtkMySQLDatabase::SetServerPort" ref="50c635cd48eaa57a339202e3addc2898" args="(int)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void vtkMySQLDatabase::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> The port used for connecting to the database. </div> </div><p> <a class="anchor" name="53a7b42dd96ad68546c7171bf24a96d9"></a><!-- doxytag: member="vtkMySQLDatabase::GetServerPort" ref="53a7b42dd96ad68546c7171bf24a96d9" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual int vtkMySQLDatabase::GetServerPort </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> The port used for connecting to the database. </div> </div><p> <a class="anchor" name="f4d002dc1fd14dcd1df9451092a97331"></a><!-- doxytag: member="vtkMySQLDatabase::GetURL" ref="f4d002dc1fd14dcd1df9451092a97331" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual <a class="el" href="a01607.html">vtkStdString</a> vtkMySQLDatabase::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="76aaf8df91ac98491bab6119c3488c0f"></a><!-- doxytag: member="vtkMySQLDatabase::GetTablePreamble" ref="76aaf8df91ac98491bab6119c3488c0f" args="(bool b)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual <a class="el" href="a01607.html">vtkStdString</a> vtkMySQLDatabase::GetTablePreamble </td> <td>(</td> <td class="paramtype">bool </td> <td class="paramname"> <em>b</em> </td> <td> ) </td> <td><code> [inline, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Return the SQL string with the syntax of the preamble following a "CREATE TABLE" SQL statement. NB: this method implements the MySQL-specific IF NOT EXISTS syntax, used when b = false. <p>Reimplemented from <a class="el" href="a01593.html#4db0b2c395ab7518e58f1fcc00c4ef21">vtkSQLDatabase</a>.</p> <p>Definition at line <a class="el" href="a04949.html#l00134">134</a> of file <a class="el" href="a04949.html">vtkMySQLDatabase.h</a>.</p> </div> </div><p> <a class="anchor" name="e1b04e07c79622b064ec16c7ea2e4384"></a><!-- doxytag: member="vtkMySQLDatabase::GetColumnSpecification" ref="e1b04e07c79622b064ec16c7ea2e4384" 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> vtkMySQLDatabase::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. NB1: this method implements the MySQL-specific syntax: <div class="fragment"><pre class="fragment">`<column name>` <column type> <column attributes> </pre></div> NB2: if a column has type SERIAL in the schema, this will be turned into INT NOT NULL AUTO_INCREMENT. 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="f1012768f02d99eff23c15193e1770d5"></a><!-- doxytag: member="vtkMySQLDatabase::GetIndexSpecification" ref="f1012768f02d99eff23c15193e1770d5" 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> vtkMySQLDatabase::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. NB1: this method implements the MySQL-specific syntax: <div class="fragment"><pre class="fragment"><index type> [<index name>] (`<column name 1>`,... ) </pre></div> NB2: since MySQL supports INDEX creation within a CREATE TABLE statement, skipped is always returned false. <p>Reimplemented from <a class="el" href="a01593.html#918e2d8245497f5bc652efe86d02ebcb">vtkSQLDatabase</a>.</p> </div> </div><p> <a class="anchor" name="5130408f91db7685d7a39d29d8215c43"></a><!-- doxytag: member="vtkMySQLDatabase::CreateDatabase" ref="5130408f91db7685d7a39d29d8215c43" args="(const char *dbName, bool dropExisting)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool vtkMySQLDatabase::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="4486a76da6a1ceb20920137080f63e04"></a><!-- doxytag: member="vtkMySQLDatabase::DropDatabase" ref="4486a76da6a1ceb20920137080f63e04" args="(const char *dbName)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool vtkMySQLDatabase::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="90439b12777bfc5d28647a4ddfef9976"></a><!-- doxytag: member="vtkMySQLDatabase::ParseURL" ref="90439b12777bfc5d28647a4ddfef9976" args="(const char *url)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual bool vtkMySQLDatabase::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> Overridden to determine connection paramters given the URL. This is called by <a class="el" href="a01593.html#ecaaaf67b4d08c393d28ffe2766bf317">CreateFromURL()</a> to initialize the instance. Look at <a class="el" href="a01593.html#ecaaaf67b4d08c393d28ffe2766bf317">CreateFromURL()</a> for details about the URL format. <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="5674e46dc023d269eb78275c111afae4"></a><!-- doxytag: member="vtkMySQLDatabase::vtkMySQLQuery" ref="5674e46dc023d269eb78275c111afae4" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">friend class <a class="el" href="a01077.html">vtkMySQLQuery</a><code> [friend]</code> </td> </tr> </table> </div> <div class="memdoc"> <p> <p>Definition at line <a class="el" href="a04949.html#l00051">51</a> of file <a class="el" href="a04949.html">vtkMySQLDatabase.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="a04949.html">vtkMySQLDatabase.h</a></ul> </div> <hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 3 19:19:14 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>