| List: | Commits | « Previous MessageNext Message » | |
| From: | jon | Date: | June 16 2006 7:43pm |
| Subject: | svn commit - mysqldoc@docsrva: r2403 - trunk/ndbapi | ||
| View as plain text | |||
Author: jstephens Date: 2006-06-16 19:43:07 +0200 (Fri, 16 Jun 2006) New Revision: 2403 Log: Added missing short method descriptions for Table class. Short method desciptions for Index, Index::Type section. Modified: trunk/ndbapi/ndb-classes.xml Modified: trunk/ndbapi/ndb-classes.xml =================================================================== --- trunk/ndbapi/ndb-classes.xml 2006-06-16 17:38:01 UTC (rev 2402) +++ trunk/ndbapi/ndb-classes.xml 2006-06-16 17:43:07 UTC (rev 2403) @@ -4509,13 +4509,9 @@ </row> <row> <entry><literal>Olddecimal</literal></entry> - <entry></entry> + <entry>Signed decimal as used prior to MySQL 5.0</entry> </row> <row> - <entry><literal>Signed decimal as used prior to MySQL 5.0</literal></entry> - <entry></entry> - </row> - <row> <entry><literal>Olddecimalunsigned</literal></entry> <entry>Unsigned decimal as used prior to MySQL 5.0</entry> </row> @@ -4594,6 +4590,15 @@ </formalpara> + <caution> + <para> + Do not confuse <literal>Column::Type</literal> with + <literal>Object::Type</literal>, + <literal>Table::Type</literal>, or + <literal>Index::Type</literal>. + </para> + </caution> + </section> </section> @@ -7542,153 +7547,251 @@ <title>The <literal>Index</literal> Class</title> - <abstract> + <abstract> - <para> - This class represents an index on a table column. - </para> + <para> + This section provides a reference to the + <literal>Index</literal> class and its public members. + </para> - </abstract> + </abstract> - <formalpara> + <formalpara> - <title>Description</title> + <title>Description</title> - <para></para> + <para> + This class represents an index on an <literal>NDB + Cluster</literal> table column. It is a descandant of the + <literal>NdbDictionary</literal> class, via the + <literal>Object</literal> class. For informaiton on these, + see <xref linkend="class-ndbdictionary"/>, and + <xref linkend="class-object"/>. + </para> - </formalpara> + </formalpara> - <formalpara> + <formalpara> - <title>Public Methods</title> + <title>Public Methods</title> - <para> - The following table lists the public methods of <literal>Index</literal> and the - purpose or use of each method: + <para> + The following table lists the public methods of + <literal>Index</literal> and the purpose or use of each + method: - <informaltable> - <tgroup cols="2"> - <colspec colwidth="35*"/> - <colspec colwidth="65*"/> - <thead> - <row> - <entry>Method</entry> - <entry>Purpose / Use</entry> - </row> - </thead> - <tbody> - <row> - <entry><literal></literal></entry> - <entry></entry> - </row> - </tbody> - </tgroup> - </informaltable> - For detailed descriptions, signatures, and examples of use for each - of these methods, see <xref linkend="class-index-members"/>. - </para> - </formalpara> + <informaltable> + <tgroup cols="2"> + <colspec colwidth="35*"/> + <colspec colwidth="65*"/> + <thead> + <row> + <entry>Method</entry> + <entry>Purpose / Use</entry> + </row> + </thead> + <tbody> + <row> + <entry><literal>Index()</literal></entry> + <entry>Class constructor</entry> + </row> + <row> + <entry><literal>~Index()</literal></entry> + <entry>Destructor</entry> + </row> + <row> + <entry><literal>getName()</literal></entry> + <entry></entry> + </row> + <row> + <entry><literal>getTable()</literal></entry> + <entry></entry> + </row> + <row> + <entry><literal>getNoOfColumns()</literal></entry> + <entry></entry> + </row> + <row> + <entry><literal>getColumn()</literal></entry> + <entry></entry> + </row> + <row> + <entry><literal>getType()</literal></entry> + <entry>Gets the index type</entry> + </row> + <row> + <entry><literal>getLogging()</literal></entry> + <entry>Checks whether the index is logged to disk</entry> + </row> + <row> + <entry><literal>getObjectStatus()</literal></entry> + <entry>Gets the index object status</entry> + </row> + <row> + <entry><literal>getObjectVersion()</literal></entry> + <entry>Gets the index object status</entry> + </row> + <row> + <entry><literal>getObjectId()</literal></entry> + <entry>Gets the index object ID</entry> + </row> + <row> + <entry><literal>setName()</literal></entry> + <entry>Sets the name of the index</entry> + </row> + <row> + <entry><literal>setTable()</literal></entry> + <entry>Sets the name of the table to be indexed</entry> + </row> + <row> + <entry><literal>addColumn()</literal></entry> + <entry>Adds a <literal>Column</literal> object to the index</entry> + </row> + <row> + <entry><literal>addColumnName()</literal></entry> + <entry>Adds a column by name to the index</entry> + </row> + <row> + <entry><literal>addColumnNames()</literal></entry> + <entry>Adds multiple columns by name to the index</entry> + </row> + <row> + <entry><literal>setType()</literal></entry> + <entry>Set the index type</entry> + </row> + <row> + <entry><literal>setLogging()</literal></entry> + <entry>Enable/disable logging of the index to disk</entry> + </row> + </tbody> + </tgroup> + </informaltable> - <formalpara> + For detailed descriptions, signatures, and examples of use + for each of these methods, see + <xref linkend="class-index-members"/>. + </para> - <title>Public Types</title> + </formalpara> - <para> - Index has one public type, the <literal>Type</literal> type. For a - discussion of Type, see <xref linkend="class-index-type"/>. - </para> + <formalpara> - </formalpara> + <title>Public Types</title> + + <para> + Index has one public type, the <literal>Type</literal> type. + For a discussion of Type, see + <xref linkend="class-index-type"/>. + </para> + + </formalpara> + <formalpara> - - - <title>Class Diagram</title> - <para> - This diagram shows all the available methods and enumerated types - of the <literal>Index</literal> class: + <title>Class Diagram</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/NdbDictionary-Object-Index-class.png" format="PNG"/> - </imageobject> - <textobject> - <phrase lang="en">Public methods and types of the - <literal>Index</literal> class.</phrase> - </textobject> - </mediaobject> - </para> + <para> + This diagram shows all the available methods and enumerated + types of the <literal>Index</literal> class: - </formalpara> - - <section id="class-index-type"> - <title><literal>Object::Index::Type</literal></title> - - <abstract> - <para> - This type describes the type of column index represented by a - given instance <literal>Index</literal>. - </para> - </abstract> - - <caution> - <para> - Do not confuse this enumerated type with - <literal>Object::Type</literal>, which is discussed in - <xref linkend="class-object-type"/>. - </para> - </caution> - - <formalpara> - <title>Description</title> - - <para> - - </para> - </formalpara> - - <formalpara> - <title>Enumeration Values</title> - <para> + <mediaobject> + <imageobject> + <imagedata fileref="images/NdbDictionary-Object-Index-class.png" format="PNG"/> + </imageobject> + <textobject> + <phrase lang="en">Public methods and types of the + <literal>Index</literal> class.</phrase> + </textobject> + </mediaobject> + </para> - <informaltable> - <tgroup cols="2"> - <colspec colwidth="35*"/> - <colspec colwidth="65*"/> - <thead> - <row> - <entry>Value</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry><literal></literal></entry> - <entry></entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - </formalpara> - - - - </section> + </formalpara> - <section id="class-index-members"> + <section id="class-index-type"> - <title><literal>Index</literal> Class Members</title> + <title><literal>Object::Index::Type</literal></title> + <formalpara> + + <title>Description</title> + + <para> + This is an enumerated type which describes the sort of + column index represented by a given instance of + <literal>Index</literal>. + </para> + + </formalpara> + + <caution> + <para> + Do not confuse this enumerated type with + <literal>Object::Type</literal>, which is discussed in + <xref linkend="class-object-type"/>, or with + <literal>Table::Type</literal> or + <literal>Column::Type</literal>. + </para> + </caution> + + <formalpara> + + <title>Enumeration Values</title> + + <para> + <informaltable> + <tgroup cols="2"> + <colspec colwidth="35*"/> + <colspec colwidth="65*"/> + <thead> + <row> + <entry>Name</entry> + <entry>Value</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry><literal>Undefined</literal></entry> + <entry>0</entry> + <entry>Undefined object type (initial/default value)</entry> + </row> + <row> + <entry><literal>UniqueHashIndex</literal></entry> + <entry>3</entry> + <entry>Unique un-ordered hash index (only index type currently supported) + + <remark role="todo"> + [js] is this still the case? + </remark></entry> + </row> + <row> + <entry><literal>OrderedIndex</literal></entry> + <entry>6</entry> + <entry>Non-unique, ordered index</entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + + </formalpara> + + </section> + + <section id="class-index-members"> + + <title><literal>Index</literal> Class Members</title> + <!-- <abstract> --> - <para/> + <para/> <!-- </abstract> --> - </section> </section> + </section> + <section id="class-logfilegroup"> <title>The <literal>LogfileGroup</literal> Class</title> @@ -7833,79 +7936,105 @@ </row> <row> <entry><literal>getName()</literal></entry> - <entry></entry> + <entry>Gets the table's name</entry> </row> <row> <entry><literal>getTableId()</literal></entry> - <entry></entry> + <entry>Gets the table's ID</entry> </row> <row> <entry><literal>getColumn()</literal></entry> - <entry></entry> + <entry>Gets a column (by name) from the table</entry> </row> <row> <entry><literal>getLogging()</literal></entry> - <entry></entry> + <entry>Checks whether logging to disk is enabled for this table</entry> </row> <row> <entry><literal>getFragmentType()</literal></entry> - <entry></entry> + <entry>Gets the table's <literal>FragmentType</literal></entry> </row> <row> <entry><literal>getKValue()</literal></entry> - <entry></entry> + <entry>Gets the table's <literal>KValue</literal></entry> </row> <row> <entry><literal>getLinLoadFactor()</literal></entry> - <entry></entry> + <entry>Gets the table's minimum load factor</entry> </row> <row> <entry><literal>getMaxLoadFactor()</literal></entry> - <entry></entry> + <entry>Gets the table's maximum load factor</entry> </row> <row> <entry><literal>getNoOfColumns()</literal></entry> - <entry></entry> + <entry>Gets the number of columns in the table</entry> </row> <row> <entry><literal>getNoOfPrimaryKeys()</literal></entry> - <entry></entry> + <entry>Gets the number of primary keys in the table + + <remark role="todo"> + [js] Do we mean "gets the number of columns in the + PK here...?" + </remark></entry> </row> <row> <entry><literal>getPrimaryKey()</literal></entry> - <entry></entry> + <entry>Gets the name of the table's primary key</entry> </row> <row> <entry><literal>equal()</literal></entry> - <entry></entry> + <entry>Compares the table with another table</entry> </row> <row> <entry><literal>getFrmData()</literal></entry> - <entry></entry> + <entry>Gets the data from the table <filename>.FRM</filename> file + + <remark role="todo"> + [js] Are these two methods described correctly? + </remark></entry> </row> <row> + <entry><literal>getFrmLength()</literal></entry> + <entry>Gets the length of the table's <filename>.FRM</filename> file</entry> + </row> + <row> <entry><literal>getFragmentData()</literal></entry> - <entry></entry> + <entry>Gets table fragment data (ID, state, and node group)</entry> </row> <row> + <entry><literal>getFragmentDataLen()</literal></entry> + <entry>Gets the length of the table fragment data</entry> + </row> + <row> <entry><literal>getRangeListData()</literal></entry> - <entry></entry> + <entry>Gets a <literal>RANGE</literal> or <literal>LIST</literal> array</entry> </row> <row> - <entry><literal>getTableSpaceData()</literal></entry> - <entry></entry> + <entry><literal>getRangeListDataLen()</literal></entry> + <entry>Gets the length of the table <literal>RANGE</literal> or + <literal>LIST</literal> array</entry> </row> <row> + <entry><literal>getTablespaceData()</literal></entry> + <entry>Gets the ID and version of the tablespace containing the table</entry> + </row> + <row> + <entry><literal>getTablespaceDataLen()</literal></entry> + <entry>Gets the length of the table's tablespace data</entry> + </row> + <row> <entry><literal>getLinearFlag()</literal></entry> - <entry></entry> + <entry>Gets the current setting for the table's linear hashing flag</entry> </row> <row> <entry><literal>getFragmentCount()</literal></entry> - <entry></entry> + <entry>Gets the number of fragments for this table</entry> </row> <row> <entry><literal>getTablespace()</literal></entry> - <entry></entry> + <entry>Gets the tablespace containing this table</entry> </row> <row> <entry><literal>getTablespaceNames()</literal></entry> @@ -7913,119 +8042,131 @@ </row> <row> <entry><literal>getObjectType()</literal></entry> - <entry></entry> + <entry>Gets the table's object type (<literal>Object::Type</literal> as opposed + to <literal>Table::Type</literal>)</entry> </row> <row> <entry><literal>getObjectStatus()</literal></entry> - <entry></entry> + <entry>Gets the table's object status</entry> </row> <row> <entry><literal>getObjectVersion()</literal></entry> - <entry></entry> + <entry>Gets the table's object version</entry> </row> <row> <entry><literal>getObjectId()</literal></entry> - <entry></entry> + <entry>Gets the table's object ID</entry> </row> <row> <entry><literal>getMaxRows()</literal></entry> - <entry></entry> + <entry>Gets the maximum number of rows that this table may contain</entry> </row> <row> <entry><literal>getDefaultNoPartitionsFlag()</literal></entry> - <entry></entry> + <entry>Checks whether the default number of partitions is being used</entry> </row> <row> <entry><literal>getRowGCIIndicator()</literal></entry> - <entry></entry> + <entry><remark role="todo"> + Not documented in NdbDictionary.hpp + </remark></entry> </row> <row> <entry><literal>getRowChecksumIndicator()</literal></entry> - <entry></entry> + <entry><remark role="todo"> + Not documented in NdbDictionary.hpp + </remark></entry> </row> <row> <entry><literal>setName()</literal></entry> - <entry></entry> + <entry>Sets the table's name</entry> </row> <row> <entry><literal>addColumn()</literal></entry> - <entry></entry> + <entry>Adds a column to the table</entry> </row> <row> <entry><literal>setLogging()</literal></entry> - <entry></entry> + <entry>Toggle logging ofthe table to disk</entry> </row> <row> <entry><literal>setLinearFlag()</literal></entry> - <entry></entry> + <entry>Sets the table's linear hashing flag</entry> </row> <row> <entry><literal>setFragmentCount()</literal></entry> - <entry></entry> + <entry>Sets the number of fragments for this table</entry> </row> <row> <entry><literal>setFragmentationType()</literal></entry> - <entry></entry> + <entry>Sets the table's <literal>FragmentType</literal></entry> </row> <row> <entry><literal>setKValue()</literal></entry> - <entry></entry> + <entry>Set the <literal>KValue</literal></entry> </row> <row> <entry><literal>setMinLoadFactor()</literal></entry> - <entry></entry> + <entry>Set the table's minimum load factor (<literal>MinLoadFactor</literal>)</entry> </row> <row> <entry><literal>setMaxLoadFactor()</literal></entry> - <entry></entry> + <entry>Set the table's maximum load factor (<literal>MaxLoadFactor</literal>)</entry> </row> <row> <entry><literal>setTablespace()</literal></entry> - <entry></entry> + <entry>Set the tablespace to use for this table</entry> </row> <row> <entry><literal>setStatusInvalid()</literal></entry> - <entry></entry> + <entry><remark role="todo"> + [js] Purpose not documented...? + </remark></entry> </row> <row> <entry><literal>setMaxRows()</literal></entry> - <entry></entry> + <entry>Sets the maximum number of rows in the table</entry> </row> <row> <entry><literal>setNoDefaultPartitionsFlag()</literal></entry> - <entry></entry> + <entry>Toggles whether the default number of partitions should be used for the + table</entry> </row> <row> <entry><literal>setFrm()</literal></entry> - <entry></entry> + <entry>Sets the <filename>.FRM</filename> file to be used for this table</entry> </row> <row> <entry><literal>setFragmentData()</literal></entry> - <entry></entry> + <entry>Sets the fragment ID, node group ID, and fragment state</entry> </row> <row> <entry><literal>setTablespaceNames()</literal></entry> - <entry></entry> + <entry>Sets the tablespace names for fragments</entry> </row> <row> <entry><literal>setTablespaceData()</literal></entry> - <entry></entry> + <entry>Sets the tablespace ID and version</entry> </row> <row> <entry><literal>setRangeListData()</literal></entry> - <entry></entry> + <entry>Sets <literal>LIST</literal> and <literal>RANGE</literal> partition data</entry> </row> <row> <entry><literal>setObjectType()</literal></entry> - <entry></entry> + <entry>Sets the table's object type</entry> </row> <row> <entry><literal>setRowGCIIndicator()</literal></entry> - <entry></entry> + <entry><remark role="todo"> + Not documented in NdbDictionary.hpp + </remark></entry> </row> <row> <entry><literal>setRowChecksumIndicator()</literal></entry> - <entry></entry> + <entry><remark role="todo"> + Not documented in NdbDictionary.hpp + </remark></entry> </row> </tbody> </tgroup>
| Thread | ||
|---|---|---|
| • svn commit - mysqldoc@docsrva: r2403 - trunk/ndbapi | jon | 16 Jun |
© 1995-2008 MySQL AB, 2008-2009 Sun Microsystems, Inc.
Page generated in 0.686 sec. using MySQL 5.1.14-beta-log