From: jon Date: June 16 2006 5:43pm Subject: svn commit - mysqldoc@docsrva: r2403 - trunk/ndbapi List-Archive: http://lists.mysql.com/commits/7777 Message-Id: <200606161743.k5GHh9J5022080@docsrva.mysql.com> Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 @@ Olddecimal - + Signed decimal as used prior to MySQL 5.0 - Signed decimal as used prior to MySQL 5.0 - - - Olddecimalunsigned Unsigned decimal as used prior to MySQL 5.0 @@ -4594,6 +4590,15 @@ + + + Do not confuse Column::Type with + Object::Type, + Table::Type, or + Index::Type. + + + @@ -7542,153 +7547,251 @@ The <literal>Index</literal> Class - + - - This class represents an index on a table column. - + + This section provides a reference to the + Index class and its public members. + - + - + - Description + Description - + + This class represents an index on an NDB + Cluster table column. It is a descandant of the + NdbDictionary class, via the + Object class. For informaiton on these, + see , and + . + - + - + - Public Methods + Public Methods - - The following table lists the public methods of Index and the - purpose or use of each method: + + The following table lists the public methods of + Index and the purpose or use of each + method: - - - - - - - Method - Purpose / Use - - - - - - - - - - - For detailed descriptions, signatures, and examples of use for each - of these methods, see . - - + + + + + + + Method + Purpose / Use + + + + + Index() + Class constructor + + + ~Index() + Destructor + + + getName() + + + + getTable() + + + + getNoOfColumns() + + + + getColumn() + + + + getType() + Gets the index type + + + getLogging() + Checks whether the index is logged to disk + + + getObjectStatus() + Gets the index object status + + + getObjectVersion() + Gets the index object status + + + getObjectId() + Gets the index object ID + + + setName() + Sets the name of the index + + + setTable() + Sets the name of the table to be indexed + + + addColumn() + Adds a Column object to the index + + + addColumnName() + Adds a column by name to the index + + + addColumnNames() + Adds multiple columns by name to the index + + + setType() + Set the index type + + + setLogging() + Enable/disable logging of the index to disk + + + + - + For detailed descriptions, signatures, and examples of use + for each of these methods, see + . + - Public Types + - - Index has one public type, the Type type. For a - discussion of Type, see . - + - + Public Types + + + Index has one public type, the Type type. + For a discussion of Type, see + . + + + + - - - Class Diagram - - This diagram shows all the available methods and enumerated types - of the Index class: + Class Diagram - - - - - - Public methods and types of the - Index class. - - - + + This diagram shows all the available methods and enumerated + types of the Index class: - - -
- <literal>Object::Index::Type</literal> - - - - This type describes the type of column index represented by a - given instance Index. - - - - - - Do not confuse this enumerated type with - Object::Type, which is discussed in - . - - - - - Description - - - - - - - - Enumeration Values - + + + + + + Public methods and types of the + Index class. + + + - - - - - - - Value - Description - - - - - - - - - - - - - - - -
+ -
+
- <literal>Index</literal> Class Members + <literal>Object::Index::Type</literal> + + + Description + + + This is an enumerated type which describes the sort of + column index represented by a given instance of + Index. + + + + + + + Do not confuse this enumerated type with + Object::Type, which is discussed in + , or with + Table::Type or + Column::Type. + + + + + + Enumeration Values + + + + + + + + + Name + Value + Description + + + + + Undefined + 0 + Undefined object type (initial/default value) + + + UniqueHashIndex + 3 + Unique un-ordered hash index (only index type currently supported) + + + [js] is this still the case? + + + + OrderedIndex + 6 + Non-unique, ordered index + + + + + + + + +
+ +
+ + <literal>Index</literal> Class Members + - + -
+ +
The <literal>LogfileGroup</literal> Class @@ -7833,79 +7936,105 @@ getName() - + Gets the table's name getTableId() - + Gets the table's ID getColumn() - + Gets a column (by name) from the table getLogging() - + Checks whether logging to disk is enabled for this table getFragmentType() - + Gets the table's FragmentType getKValue() - + Gets the table's KValue getLinLoadFactor() - + Gets the table's minimum load factor getMaxLoadFactor() - + Gets the table's maximum load factor getNoOfColumns() - + Gets the number of columns in the table getNoOfPrimaryKeys() - + Gets the number of primary keys in the table + + + [js] Do we mean "gets the number of columns in the + PK here...?" + getPrimaryKey() - + Gets the name of the table's primary key equal() - + Compares the table with another table getFrmData() - + Gets the data from the table .FRM file + + + [js] Are these two methods described correctly? + + getFrmLength() + Gets the length of the table's .FRM file + + getFragmentData() - + Gets table fragment data (ID, state, and node group) + getFragmentDataLen() + Gets the length of the table fragment data + + getRangeListData() - + Gets a RANGE or LIST array - getTableSpaceData() - + getRangeListDataLen() + Gets the length of the table RANGE or + LIST array + getTablespaceData() + Gets the ID and version of the tablespace containing the table + + + getTablespaceDataLen() + Gets the length of the table's tablespace data + + getLinearFlag() - + Gets the current setting for the table's linear hashing flag getFragmentCount() - + Gets the number of fragments for this table getTablespace() - + Gets the tablespace containing this table getTablespaceNames() @@ -7913,119 +8042,131 @@ getObjectType() - + Gets the table's object type (Object::Type as opposed + to Table::Type) getObjectStatus() - + Gets the table's object status getObjectVersion() - + Gets the table's object version getObjectId() - + Gets the table's object ID getMaxRows() - + Gets the maximum number of rows that this table may contain getDefaultNoPartitionsFlag() - + Checks whether the default number of partitions is being used getRowGCIIndicator() - + + Not documented in NdbDictionary.hpp + getRowChecksumIndicator() - + + Not documented in NdbDictionary.hpp + setName() - + Sets the table's name addColumn() - + Adds a column to the table setLogging() - + Toggle logging ofthe table to disk setLinearFlag() - + Sets the table's linear hashing flag setFragmentCount() - + Sets the number of fragments for this table setFragmentationType() - + Sets the table's FragmentType setKValue() - + Set the KValue setMinLoadFactor() - + Set the table's minimum load factor (MinLoadFactor) setMaxLoadFactor() - + Set the table's maximum load factor (MaxLoadFactor) setTablespace() - + Set the tablespace to use for this table setStatusInvalid() - + + [js] Purpose not documented...? + setMaxRows() - + Sets the maximum number of rows in the table setNoDefaultPartitionsFlag() - + Toggles whether the default number of partitions should be used for the + table setFrm() - + Sets the .FRM file to be used for this table setFragmentData() - + Sets the fragment ID, node group ID, and fragment state setTablespaceNames() - + Sets the tablespace names for fragments setTablespaceData() - + Sets the tablespace ID and version setRangeListData() - + Sets LIST and RANGE partition data setObjectType() - + Sets the table's object type setRowGCIIndicator() - + + Not documented in NdbDictionary.hpp + setRowChecksumIndicator() - + + Not documented in NdbDictionary.hpp +