<!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 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="contents"> <h1>NdbDictionary Class Reference</h1><!-- doxytag: class="NdbDictionary" --><code>#include <NdbDictionary.hpp></code> <p> <p> <a href="classNdbDictionary-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2> Data dictionary class. <p> The preferred and supported way to create and drop tables and indexes in ndb is through the MySQL Server (see MySQL reference Manual, section MySQL Cluster).<p> Tables and indexes that are created directly through the <a class="el" href="classNdbDictionary.html" title="Data dictionary class.">NdbDictionary</a> class can not be viewed from the MySQL Server. Dropping indexes directly via the NdbApi will cause inconsistencies if they were originally created from a MySQL Cluster.<p> This class supports schema data enquiries such as:<ol type=1> <li>Enquiries about tables (<a class="el" href="classNdbDictionary_1_1Dictionary.html#1a30b1bb5fa164113cb839eed64eb3b6">Dictionary::getTable</a>, <a class="el" href="classNdbDictionary_1_1Table.html#64041384c75e28c72fd9b03bd7c5c0d3">Table::getNoOfColumns</a>, <a class="el" href="classNdbDictionary_1_1Table.html#10886d1ca08823f4e25fa59b0207fc0a">Table::getPrimaryKey</a>, and <a class="el" href="classNdbDictionary_1_1Table.html#1c9ebfca646cd2d05204dd3d55e75522">Table::getNoOfPrimaryKeys</a>)</li><li>Enquiries about indexes (<a class="el" href="classNdbDictionary_1_1Dictionary.html#906abbe199490648d092c9096dddbc18">Dictionary::getIndex</a>, <a class="el" href="classNdbDictionary_1_1Index.html#91bb0945189b8e26177f32265cc9642a">Index::getNoOfColumns</a>, and <a class="el" href="classNdbDictionary_1_1Index.html#450aa8e480d59f6c8cb6349192d5e04b">Index::getColumn</a>)</li></ol> <p> This class supports schema data definition such as:<ol type=1> <li>Creating tables (<a class="el" href="classNdbDictionary_1_1Dictionary.html#5c5183d812cae2769964ff6229e93894">Dictionary::createTable</a>) and table columns</li><li>Dropping tables (<a class="el" href="classNdbDictionary_1_1Dictionary.html#3450efd0acdec09811933934ed2f1ca1">Dictionary::dropTable</a>)</li><li>Creating secondary indexes (<a class="el" href="classNdbDictionary_1_1Dictionary.html#e8f31689d7af3670c2cc1fc91b11919a">Dictionary::createIndex</a>)</li><li>Dropping secondary indexes (<a class="el" href="classNdbDictionary_1_1Dictionary.html#f7d5e3e63300c26591a024d355d08c3f">Dictionary::dropIndex</a>)</li></ol> <p> <a class="el" href="classNdbDictionary.html" title="Data dictionary class.">NdbDictionary</a> has several help (inner) classes to support this:<ol type=1> <li><a class="el" href="classNdbDictionary_1_1Dictionary.html" title="Dictionary for defining and retreiving meta data.">NdbDictionary::Dictionary</a> the dictionary handling dictionary objects</li><li><a class="el" href="classNdbDictionary_1_1Table.html" title="Represents a table in NDB Cluster.">NdbDictionary::Table</a> for creating tables</li><li><a class="el" href="classNdbDictionary_1_1Column.html" title="Represents a column in an NDB Cluster table.">NdbDictionary::Column</a> for creating table columns</li><li><a class="el" href="classNdbDictionary_1_1Index.html" title="Represents an index in an NDB Cluster.">NdbDictionary::Index</a> for creating secondary indexes</li></ol> <p> See <a class="el" href="ndbapi_simple_index.cpp.html">ndbapi_simple_index.cpp</a> for details of usage. <h2>Classes</h2> <ul> <li>class <a class="el" href="classNdbDictionary_1_1Column.html">Column</a> <dl class="el"><dd class="mdescRight">Represents a column in an NDB Cluster table. <a href="classNdbDictionary_1_1Column.html#_details">More...</a><br></dl><li>class <a class="el" href="classNdbDictionary_1_1Dictionary.html">Dictionary</a> <dl class="el"><dd class="mdescRight"><a class="el" href="classNdbDictionary_1_1Dictionary.html" title="Dictionary for defining and retreiving meta data.">Dictionary</a> for defining and retreiving meta data. <a href="classNdbDictionary_1_1Dictionary.html#_details">More...</a><br></dl><li>class <a class="el" href="classNdbDictionary_1_1Index.html">Index</a> <dl class="el"><dd class="mdescRight">Represents an index in an NDB Cluster. <a href="classNdbDictionary_1_1Index.html#_details">More...</a><br></dl><li>class <a class="el" href="classNdbDictionary_1_1Object.html">Object</a> <dl class="el"><dd class="mdescRight">Meta information about a database object (a table, index, etc). <a href="classNdbDictionary_1_1Object.html#_details">More...</a><br></dl><li>class <a class="el" href="classNdbDictionary_1_1Table.html">Table</a> <dl class="el"><dd class="mdescRight">Represents a table in NDB Cluster. <a href="classNdbDictionary_1_1Table.html#_details">More...</a><br></dl></ul> </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>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-testing
>
by-pkgid
>
91128064e1b251eab84e1c0e3ea0dd7a
>
files
>
108
