<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> <title>NdbDictionary::Dictionary 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.5 --> <div class="navpath"><a class="el" href="classNdbDictionary.html">NdbDictionary</a>::<a class="el" href="classNdbDictionary_1_1Dictionary.html">Dictionary</a> </div> <div class="contents"> <h1>NdbDictionary::Dictionary Class Reference</h1><!-- doxytag: class="NdbDictionary::Dictionary" --><code>#include <NdbDictionary.hpp></code> <p> <p> <a href="classNdbDictionary_1_1Dictionary-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2> <a class="el" href="classNdbDictionary_1_1Dictionary.html" title="Dictionary for defining and retreiving meta data.">Dictionary</a> for defining and retreiving meta data. <h2>Public Member Functions</h2> <tr><td colspan="2"><div class="groupHeader">General</div></td></tr> <ul> <li>int <a class="el" href="classNdbDictionary_1_1Dictionary.html#0cd350743e4215d448f6d9570f8d5071">listObjects</a> (<a class="el" href="structNdbDictionary_1_1Dictionary_1_1List.html">List</a> &list, <a class="el" href="classNdbDictionary_1_1Object.html#3475c4ad2d1adfc812609223f23a9a3c">Object::Type</a> type=Object::TypeUndefined) <li><a class="anchor" name="a3b2f3d8540219861d19b2f60e3366c2"></a><!-- doxytag: member="NdbDictionary::Dictionary::listObjects" ref="a3b2f3d8540219861d19b2f60e3366c2" args="(List &list, Object::Type type=Object::TypeUndefined) const " --> int <b>listObjects</b> (<a class="el" href="structNdbDictionary_1_1Dictionary_1_1List.html">List</a> &list, <a class="el" href="classNdbDictionary_1_1Object.html#3475c4ad2d1adfc812609223f23a9a3c">Object::Type</a> type=Object::TypeUndefined) const <li>struct <a class="el" href="structNdbError.html">NdbError</a> & <a class="el" href="classNdbDictionary_1_1Dictionary.html#0af68ea9b273172b46528ee1bd806f71">getNdbError</a> () const </ul> <tr><td colspan="2"><div class="groupHeader">Retrieving references to Tables and Indexes</div></td></tr> <ul> <li>const <a class="el" href="classNdbDictionary_1_1Table.html">Table</a> * <a class="el" href="classNdbDictionary_1_1Dictionary.html#1a30b1bb5fa164113cb839eed64eb3b6">getTable</a> (const char *name) const <li>const <a class="el" href="classNdbDictionary_1_1Index.html">Index</a> * <a class="el" href="classNdbDictionary_1_1Dictionary.html#906abbe199490648d092c9096dddbc18">getIndex</a> (const char *indexName, const char *tableName) const <li>const <a class="el" href="classNdbDictionary_1_1Index.html">Index</a> * <a class="el" href="classNdbDictionary_1_1Dictionary.html#bb03a36276d5df5471242ac3ecb20367">getIndex</a> (const char *indexName, const <a class="el" href="classNdbDictionary_1_1Table.html">Table</a> &table) const <li>int <a class="el" href="classNdbDictionary_1_1Dictionary.html#02bfb8516aeb46bb7ec89e1e053c68b3">listIndexes</a> (<a class="el" href="structNdbDictionary_1_1Dictionary_1_1List.html">List</a> &list, const char *tableName) <li><a class="anchor" name="58fc19c0472ad9539bd923228ef549dd"></a><!-- doxytag: member="NdbDictionary::Dictionary::listIndexes" ref="58fc19c0472ad9539bd923228ef549dd" args="(List &list, const char *tableName) const " --> int <b>listIndexes</b> (<a class="el" href="structNdbDictionary_1_1Dictionary_1_1List.html">List</a> &list, const char *tableName) const </ul> <tr><td colspan="2"><div class="groupHeader">Table creation</div></td></tr> <tr><td colspan="2"><div class="groupText">These methods should normally not be used in an application as the result will not be visible from the MySQL Server <br><br></div></td></tr> <ul> <li>int <a class="el" href="classNdbDictionary_1_1Dictionary.html#5c5183d812cae2769964ff6229e93894">createTable</a> (const <a class="el" href="classNdbDictionary_1_1Table.html">Table</a> &table) <li>int <a class="el" href="classNdbDictionary_1_1Dictionary.html#3450efd0acdec09811933934ed2f1ca1">dropTable</a> (<a class="el" href="classNdbDictionary_1_1Table.html">Table</a> &table) <li>int <a class="el" href="classNdbDictionary_1_1Dictionary.html#37b79ccb4c0bcfd5ae550732afd40006">dropTable</a> (const char *name) <li>void <a class="el" href="classNdbDictionary_1_1Dictionary.html#98e292e129397c9d14b9231d67abf4e0">removeCachedTable</a> (const char *table) <li>void <a class="el" href="classNdbDictionary_1_1Dictionary.html#87ed83fba6faa0315f155a3a850ab9c7">removeCachedIndex</a> (const char *index, const char *table) </ul> <tr><td colspan="2"><div class="groupHeader">Index creation</div></td></tr> <tr><td colspan="2"><div class="groupText">These methods should normally not be used in an application as the result will not be visible from the MySQL Server <br><br></div></td></tr> <ul> <li>int <a class="el" href="classNdbDictionary_1_1Dictionary.html#e8f31689d7af3670c2cc1fc91b11919a">createIndex</a> (const <a class="el" href="classNdbDictionary_1_1Index.html">Index</a> &index) <li>int <a class="el" href="classNdbDictionary_1_1Dictionary.html#f7d5e3e63300c26591a024d355d08c3f">dropIndex</a> (const char *indexName, const char *tableName) <li>int <a class="el" href="classNdbDictionary_1_1Dictionary.html#cde218de0f16afee023c9d8c77960bca">dropIndex</a> (const <a class="el" href="classNdbDictionary_1_1Index.html">Index</a> &) </ul> <h2>Classes</h2> <ul> <li>class <a class="el" href="structNdbDictionary_1_1Dictionary_1_1List.html">List</a> <dl class="el"><dd class="mdescRight">Structure for retrieving lists of object names. <a href="structNdbDictionary_1_1Dictionary_1_1List.html#_details">More...</a><br></dl></ul> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="0cd350743e4215d448f6d9570f8d5071"></a><!-- doxytag: member="NdbDictionary::Dictionary::listObjects" ref="0cd350743e4215d448f6d9570f8d5071" args="(List &list, Object::Type type=Object::TypeUndefined)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int NdbDictionary::Dictionary::listObjects </td> <td>(</td> <td class="paramtype"><a class="el" href="structNdbDictionary_1_1Dictionary_1_1List.html">List</a> & </td> <td class="paramname"> <em>list</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="classNdbDictionary_1_1Object.html#3475c4ad2d1adfc812609223f23a9a3c">Object::Type</a> </td> <td class="paramname"> <em>type</em> = <code>Object::TypeUndefined</code></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> Fetch list of all objects, optionally restricted to given type.<p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>list</em> </td><td><a class="el" href="structNdbDictionary_1_1Dictionary_1_1List.html" title="Structure for retrieving lists of object names.">List</a> of objects returned in the dictionary </td></tr> <tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>Restrict returned list to only contain objects of this type</td></tr> </table> </dl> <dl class="return" compact><dt><b>Returns:</b></dt><dd>-1 if error. </dd></dl> </div> </div><p> <a class="anchor" name="0af68ea9b273172b46528ee1bd806f71"></a><!-- doxytag: member="NdbDictionary::Dictionary::getNdbError" ref="0af68ea9b273172b46528ee1bd806f71" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">struct <a class="el" href="structNdbError.html">NdbError</a>& NdbDictionary::Dictionary::getNdbError </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"> const<code> [read]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Get the latest error<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd>Error object. </dd></dl> </div> </div><p> <a class="anchor" name="1a30b1bb5fa164113cb839eed64eb3b6"></a><!-- doxytag: member="NdbDictionary::Dictionary::getTable" ref="1a30b1bb5fa164113cb839eed64eb3b6" args="(const char *name) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const <a class="el" href="classNdbDictionary_1_1Table.html">Table</a>* NdbDictionary::Dictionary::getTable </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"> <em>name</em> </td> <td> ) </td> <td width="100%"> const</td> </tr> </table> </div> <div class="memdoc"> <p> Get table with given name, NULL if undefined <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>Name of table to get </td></tr> </table> </dl> <dl class="return" compact><dt><b>Returns:</b></dt><dd>table if successful otherwise NULL. </dd></dl> </div> </div><p> <a class="anchor" name="906abbe199490648d092c9096dddbc18"></a><!-- doxytag: member="NdbDictionary::Dictionary::getIndex" ref="906abbe199490648d092c9096dddbc18" args="(const char *indexName, const char *tableName) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const <a class="el" href="classNdbDictionary_1_1Index.html">Index</a>* NdbDictionary::Dictionary::getIndex </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"> <em>indexName</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"> <em>tableName</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"> const</td> </tr> </table> </div> <div class="memdoc"> <p> Get index with given name, NULL if undefined <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>indexName</em> </td><td>Name of index to get. </td></tr> <tr><td valign="top"></td><td valign="top"><em>tableName</em> </td><td>Name of table that index belongs to. </td></tr> </table> </dl> <dl class="return" compact><dt><b>Returns:</b></dt><dd>index if successful, otherwise 0. </dd></dl> </div> </div><p> <a class="anchor" name="bb03a36276d5df5471242ac3ecb20367"></a><!-- doxytag: member="NdbDictionary::Dictionary::getIndex" ref="bb03a36276d5df5471242ac3ecb20367" args="(const char *indexName, const Table &table) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const <a class="el" href="classNdbDictionary_1_1Index.html">Index</a>* NdbDictionary::Dictionary::getIndex </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"> <em>indexName</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="classNdbDictionary_1_1Table.html">Table</a> & </td> <td class="paramname"> <em>table</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"> const</td> </tr> </table> </div> <div class="memdoc"> <p> Get index with given name, NULL if undefined <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>indexName</em> </td><td>Name of index to get. </td></tr> <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classNdbDictionary_1_1Table.html" title="Represents a table in NDB Cluster.">Table</a></em> </td><td>instance table that index belongs to. </td></tr> </table> </dl> <dl class="return" compact><dt><b>Returns:</b></dt><dd>index if successful, otherwise 0. </dd></dl> </div> </div><p> <a class="anchor" name="02bfb8516aeb46bb7ec89e1e053c68b3"></a><!-- doxytag: member="NdbDictionary::Dictionary::listIndexes" ref="02bfb8516aeb46bb7ec89e1e053c68b3" args="(List &list, const char *tableName)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int NdbDictionary::Dictionary::listIndexes </td> <td>(</td> <td class="paramtype"><a class="el" href="structNdbDictionary_1_1Dictionary_1_1List.html">List</a> & </td> <td class="paramname"> <em>list</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"> <em>tableName</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> Fetch list of indexes of given table. <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>list</em> </td><td>Reference to list where to store the listed indexes </td></tr> <tr><td valign="top"></td><td valign="top"><em>tableName</em> </td><td>Name of table that index belongs to. </td></tr> </table> </dl> <dl class="return" compact><dt><b>Returns:</b></dt><dd>0 if successful, otherwise -1 </dd></dl> </div> </div><p> <a class="anchor" name="5c5183d812cae2769964ff6229e93894"></a><!-- doxytag: member="NdbDictionary::Dictionary::createTable" ref="5c5183d812cae2769964ff6229e93894" args="(const Table &table)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int NdbDictionary::Dictionary::createTable </td> <td>(</td> <td class="paramtype">const <a class="el" href="classNdbDictionary_1_1Table.html">Table</a> & </td> <td class="paramname"> <em>table</em> </td> <td> ) </td> <td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> Create defined table given defined <a class="el" href="classNdbDictionary_1_1Table.html" title="Represents a table in NDB Cluster.">Table</a> instance <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classNdbDictionary_1_1Table.html" title="Represents a table in NDB Cluster.">Table</a></em> </td><td>instance to create </td></tr> </table> </dl> <dl class="return" compact><dt><b>Returns:</b></dt><dd>0 if successful otherwise -1. </dd></dl> </div> </div><p> <a class="anchor" name="3450efd0acdec09811933934ed2f1ca1"></a><!-- doxytag: member="NdbDictionary::Dictionary::dropTable" ref="3450efd0acdec09811933934ed2f1ca1" args="(Table &table)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int NdbDictionary::Dictionary::dropTable </td> <td>(</td> <td class="paramtype"><a class="el" href="classNdbDictionary_1_1Table.html">Table</a> & </td> <td class="paramname"> <em>table</em> </td> <td> ) </td> <td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> Drop table given retrieved <a class="el" href="classNdbDictionary_1_1Table.html" title="Represents a table in NDB Cluster.">Table</a> instance <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classNdbDictionary_1_1Table.html" title="Represents a table in NDB Cluster.">Table</a></em> </td><td>instance to drop </td></tr> </table> </dl> <dl class="return" compact><dt><b>Returns:</b></dt><dd>0 if successful otherwise -1. </dd></dl> </div> </div><p> <a class="anchor" name="37b79ccb4c0bcfd5ae550732afd40006"></a><!-- doxytag: member="NdbDictionary::Dictionary::dropTable" ref="37b79ccb4c0bcfd5ae550732afd40006" args="(const char *name)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int NdbDictionary::Dictionary::dropTable </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"> <em>name</em> </td> <td> ) </td> <td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> Drop table given table name <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>Name of table to drop </td></tr> </table> </dl> <dl class="return" compact><dt><b>Returns:</b></dt><dd>0 if successful otherwise -1. </dd></dl> </div> </div><p> <a class="anchor" name="98e292e129397c9d14b9231d67abf4e0"></a><!-- doxytag: member="NdbDictionary::Dictionary::removeCachedTable" ref="98e292e129397c9d14b9231d67abf4e0" args="(const char *table)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void NdbDictionary::Dictionary::removeCachedTable </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"> <em>table</em> </td> <td> ) </td> <td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> Remove table from local cache </div> </div><p> <a class="anchor" name="87ed83fba6faa0315f155a3a850ab9c7"></a><!-- doxytag: member="NdbDictionary::Dictionary::removeCachedIndex" ref="87ed83fba6faa0315f155a3a850ab9c7" args="(const char *index, const char *table)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void NdbDictionary::Dictionary::removeCachedIndex </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"> <em>index</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"> <em>table</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> Remove index from local cache </div> </div><p> <a class="anchor" name="e8f31689d7af3670c2cc1fc91b11919a"></a><!-- doxytag: member="NdbDictionary::Dictionary::createIndex" ref="e8f31689d7af3670c2cc1fc91b11919a" args="(const Index &index)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int NdbDictionary::Dictionary::createIndex </td> <td>(</td> <td class="paramtype">const <a class="el" href="classNdbDictionary_1_1Index.html">Index</a> & </td> <td class="paramname"> <em>index</em> </td> <td> ) </td> <td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> Create index given defined <a class="el" href="classNdbDictionary_1_1Index.html" title="Represents an index in an NDB Cluster.">Index</a> instance <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>index</em> </td><td><a class="el" href="classNdbDictionary_1_1Index.html" title="Represents an index in an NDB Cluster.">Index</a> to create </td></tr> </table> </dl> <dl class="return" compact><dt><b>Returns:</b></dt><dd>0 if successful otherwise -1. </dd></dl> </div> </div><p> <a class="anchor" name="f7d5e3e63300c26591a024d355d08c3f"></a><!-- doxytag: member="NdbDictionary::Dictionary::dropIndex" ref="f7d5e3e63300c26591a024d355d08c3f" args="(const char *indexName, const char *tableName)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int NdbDictionary::Dictionary::dropIndex </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"> <em>indexName</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"> <em>tableName</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> Drop index with given name <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>indexName</em> </td><td>Name of index to drop. </td></tr> <tr><td valign="top"></td><td valign="top"><em>tableName</em> </td><td>Name of table that index belongs to. </td></tr> </table> </dl> <dl class="return" compact><dt><b>Returns:</b></dt><dd>0 if successful otherwise -1. </dd></dl> </div> </div><p> <a class="anchor" name="cde218de0f16afee023c9d8c77960bca"></a><!-- doxytag: member="NdbDictionary::Dictionary::dropIndex" ref="cde218de0f16afee023c9d8c77960bca" args="(const Index &)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int NdbDictionary::Dictionary::dropIndex </td> <td>(</td> <td class="paramtype">const <a class="el" href="classNdbDictionary_1_1Index.html">Index</a> & </td> <td class="paramname"> </td> <td> ) </td> <td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> Drop index the defined <a class="el" href="classNdbDictionary_1_1Index.html" title="Represents an index in an NDB Cluster.">Index</a> instance <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classNdbDictionary_1_1Index.html" title="Represents an index in an NDB Cluster.">Index</a></em> </td><td>to drop </td></tr> </table> </dl> <dl class="return" compact><dt><b>Returns:</b></dt><dd>0 if successful otherwise -1. </dd></dl> </div> </div><p> </div> <hr> <address> <small> <center> Documentation generated Sun Apr 20 06:25:31 2008 from mysql source files.<br> © 2003-2004 <a href="http://www.mysql.com">MySQL AB</a> <br> </center> </small></address> </body> </html>