From: jon Date: June 17 2006 5:08am Subject: svn commit - mysqldoc@docsrva: r2404 - trunk/ndbapi List-Archive: http://lists.mysql.com/commits/7799 Message-Id: <200606170508.k5H58uCV023064@docsrva.mysql.com> Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Author: jstephens Date: 2006-06-17 07:08:53 +0200 (Sat, 17 Jun 2006) New Revision: 2404 Log: Index class members + misc. fixes. Tweaks in template file. Modified: trunk/ndbapi/class-member-template.xml trunk/ndbapi/ndb-classes.xml Modified: trunk/ndbapi/class-member-template.xml =================================================================== --- trunk/ndbapi/class-member-template.xml 2006-06-16 17:43:07 UTC (rev 2403) +++ trunk/ndbapi/class-member-template.xml 2006-06-17 05:08:53 UTC (rev 2404) @@ -1,6 +1,6 @@ -
+
<literal></literal> @@ -43,7 +43,7 @@ -[To be written...] +[To be supplied...] Modified: trunk/ndbapi/ndb-classes.xml =================================================================== --- trunk/ndbapi/ndb-classes.xml 2006-06-16 17:43:07 UTC (rev 2403) +++ trunk/ndbapi/ndb-classes.xml 2006-06-17 05:08:53 UTC (rev 2404) @@ -337,7 +337,7 @@ object: -[To be written...] +[To be supplied...] @@ -453,7 +453,7 @@ method to initialise an Ndb object: -[To be written...] +[To be supplied...] @@ -521,7 +521,7 @@ the current database: -[To be written...] +[To be supplied...] @@ -590,7 +590,7 @@ current database: -[To be written...] +[To be supplied...] @@ -658,7 +658,7 @@ name of the current database schema: -[To be written...] +[To be supplied...] @@ -726,7 +726,7 @@ of the current database schema: -[To be written...] +[To be supplied...] @@ -847,7 +847,7 @@ transaction: -[To be written...] +[To be supplied...] @@ -926,7 +926,7 @@ instance of NdbTransaction: -[To be written...] +[To be supplied...] @@ -997,7 +997,7 @@ database event: -[To be written...] +[To be supplied...] @@ -1068,7 +1068,7 @@ subscription to a database event: -[To be written...] +[To be supplied...] @@ -1191,7 +1191,7 @@ waiting in a given subscription queue: -[To be written...] +[To be supplied...] @@ -1263,7 +1263,7 @@ to obtain the next event in a series of database events: -[To be written...] +[To be supplied...] @@ -1362,7 +1362,7 @@ NDB API error: -[To be written...] +[To be supplied...] The next example shows how to retrieve an @@ -1371,7 +1371,7 @@ code: -[To be written...] +[To be supplied...] @@ -1545,7 +1545,7 @@ -[To be written...] +[To be supplied...] @@ -1641,7 +1641,7 @@ -[To be written...] +[To be supplied...] @@ -1740,7 +1740,7 @@ -[To be written...] +[To be supplied...] @@ -2411,7 +2411,7 @@ -[To be written...] +[To be supplied...] @@ -2486,7 +2486,7 @@ -[To be written...] +[To be supplied...] @@ -2561,7 +2561,7 @@ -[To be written...] +[To be supplied...] @@ -2632,7 +2632,7 @@ -[To be written...] +[To be supplied...] @@ -2730,7 +2730,7 @@ -[To be written...] +[To be supplied...] @@ -2818,7 +2818,7 @@ -[To be written...] +[To be supplied...] @@ -2883,7 +2883,7 @@ -[To be written...] +[To be supplied...] @@ -2951,7 +2951,7 @@ -[To be written...] +[To be supplied...] @@ -3020,7 +3020,7 @@ -[To be written...] +[To be supplied...] @@ -3086,7 +3086,7 @@ -[To be written...] +[To be supplied...] @@ -3162,7 +3162,7 @@ -[To be written...] +[To be supplied...] @@ -3231,7 +3231,7 @@ -[To be written...] +[To be supplied...] @@ -3308,7 +3308,7 @@ -[To be written...] +[To be supplied...] @@ -3372,7 +3372,7 @@ -[To be written...] +[To be supplied...] @@ -3438,7 +3438,7 @@ -[To be written...] +[To be supplied...] @@ -3502,7 +3502,7 @@ -[To be written...] +[To be supplied...] @@ -3567,7 +3567,7 @@ -[To be written...] +[To be supplied...] @@ -3667,7 +3667,7 @@ -[To be written...] +[To be supplied...] @@ -3772,7 +3772,7 @@ -[To be written...] +[To be supplied...] @@ -4743,7 +4743,7 @@ -[To be written...] +[To be supplied...] @@ -4807,7 +4807,7 @@ -[To be written...] +[To be supplied...] @@ -4873,7 +4873,7 @@ -[To be written...] +[To be supplied...] @@ -4939,7 +4939,7 @@ -[To be written...] +[To be supplied...] @@ -5003,7 +5003,7 @@ -[To be written...] +[To be supplied...] @@ -5071,7 +5071,7 @@ -[To be written...] +[To be supplied...] @@ -5136,7 +5136,7 @@ -[To be written...] +[To be supplied...] @@ -5210,7 +5210,7 @@ -[To be written...] +[To be supplied...] @@ -5287,7 +5287,7 @@ -[To be written...] +[To be supplied...] @@ -5352,7 +5352,7 @@ -[To be written...] +[To be supplied...] @@ -5428,7 +5428,7 @@ -[To be written...] +[To be supplied...] @@ -5500,7 +5500,7 @@ -[To be written...] +[To be supplied...] @@ -5574,7 +5574,7 @@ -[To be written...] +[To be supplied...] @@ -5639,7 +5639,7 @@ -[To be written...] +[To be supplied...] @@ -5741,7 +5741,7 @@ -[To be written...] +[To be supplied...] @@ -5806,7 +5806,7 @@ -[To be written...] +[To be supplied...] @@ -5871,7 +5871,7 @@ -[To be written...] +[To be supplied...] @@ -5945,7 +5945,7 @@ -[To be written...] +[To be supplied...] @@ -6021,7 +6021,7 @@ -[To be written...] +[To be supplied...] @@ -6095,7 +6095,7 @@ -[To be written...] +[To be supplied...] @@ -6177,7 +6177,7 @@ -[To be written...] +[To be supplied...] @@ -6256,7 +6256,7 @@ -[To be written...] +[To be supplied...] @@ -6336,7 +6336,7 @@ -[To be written...] +[To be supplied...] @@ -6410,7 +6410,7 @@ -[To be written...] +[To be supplied...] @@ -6493,7 +6493,7 @@ -[To be written...] +[To be supplied...] @@ -6572,7 +6572,7 @@ -[To be written...] +[To be supplied...] @@ -6654,7 +6654,7 @@ -[To be written...] +[To be supplied...] @@ -6733,7 +6733,7 @@ -[To be written...] +[To be supplied...] @@ -6815,7 +6815,7 @@ -[To be written...] +[To be supplied...] @@ -7601,19 +7601,19 @@ getName() - + Gets the name of the index getTable() - + Gets the name of the table being indexed getNoOfColumns() - + Gets the number of columns belonging to the index getColumn() - + Gets a column making up (part of) the index getType() @@ -7782,12 +7782,1233 @@ <literal>Index</literal> Class Members - + - + + This section contain descriptions of all public methods of + the Index class. This class has + relatively few methods (compared to, say, + Table), which are fairly + straightforward to use. + - + + + + If you create or change indexes using the + NDB API, these modifications cannot be + seen by MySQL. The only exception to this is renaming the + index using Index::setName(). + + + +
+ + <literal>Index</literal> Class Constructor + + + + Description + + + This is used to create an new instance of + Index. + + + + + + + Indexes created using the NDB API + cannot be seen by the MySQL Server. + + + + + + Signature + + + +Index + ( + const char* name = "" + ) + + + + + + + + Parameters + + + The name of the new index. It is possible to create an + index without a name, and then assign a name to it later + using setName(). See + . + + + + + + + Return Value + + + A new instance of Index. + + + + + + + Destructor + + + The destructor (~Index()) is supplied + as a virtual method. + + + + + + + Example + + + +[To be supplied...] + + + + + +
+ +
+ + <literal>NdbDictionary::Object::Index::getName()</literal> + + + + Description + + + This method is used to obtain the name of an index. + + + + + + + Signature + + + +const char* getName + ( + void + ) const + + + + + + + + Parameters + + + None. + + + + + + + Return Value + + + The name of the index, as a constant character pointer. + + + + + + + Example + + + +[To be supplied...] + + + + + +
+ +
+ + <literal>NdbDictionary::Object::Index::getTable()</literal> + + + + Description + + + This method can be used to obtain the name of the table + to which the index belongs. + + + + + + + Signature + + + +const char* getTable + ( + void + ) const + + + + + + + + Parameters + + + None. + + + + + + + Return Value + + + The name of the table, as a constant character pointer. + + + + + + + Example + + + +[To be supplied...] + + + + + +
+ +
+ + <literal>NdbDictionary::Object::Index::getNoOfColumns()</literal> + + + + Description + + + This method is used to obtain the number of columns + making up the index. + + + + + + + Signature + + + +unsigned getNoOfColumns + ( + void + ) const + + + + + + + + Parameters + + + None. + + + + + + + Return Value + + + An unsigned integer representing the number of columns + in the index. + + + + + + + Example + + + +[To be supplied...] + + + + + +
+ +
+ + <literal>NdbDictionary::Object::Index::getColumn()</literal> + + + + Description + + + This method retrieves the column at the specified + position within the index. + + + + + + + Signature + + + +const Column* getColumn + ( + unsigned no + ) const + + + + + + + + Parameters + + + The ordinal position number + no of the column, as an + unsigned integer. Use the + getNoOfColumns() method to determine + how many columns make up the index — see + , for + details. + + + + + + [js] Do these positions start with 0 or 1? + + + + + Return Value + + + The column having position no + in the index, as a pointer to an instance of + Column. See + . + + + + + + + Example + + + +[To be supplied...] + + + + + +
+ +
+ + <literal>NdbDictionary::Object::Index::getType()</literal> + + + + Description + + + This method can be used to find the type of index. + + + + + + + Signature + + + +Type getType + ( + void + ) const + + + + + + + + Parameters + + + None. + + + + + + + Return Value + + + An index type. See , + for possible values. + + + + + + + Example + + + +[To be supplied...] + + + + + +
+ +
+ + <literal>NdbDictionary::Object::Index::getLogging()</literal> + + + + Description + + + Use this method to determine whether logging to disk has + been enabled for the index. + + + + + + + Indexes which are not logged are rebuilt when the + cluster is started or restarted. + + + + Ordered indexes currently do not support logging to + disk; they are rebuilt each time the cluster is started. + (This includes restarts.) + + + + + + Signature + + + +bool getLogging + ( + void + ) const + + + + + + + + Parameters + + + None. + + + + + + + Return Value + + + A Boolean value: + + + + + + true: The index is being logged + to disk. + + + + + + false: The index is not being + logged. + + + + + + + + + + + Example + + + +[To be supplied...] + + + + + +
+ +
+ + <literal>NdbDictionary::Object::Index::getObjectStatus()</literal> + + + + Description + + + This method gets the object status of the index. + + + + + + + Signature + + + +virtual Object::Status getObjectStatus + ( + void + ) const + + + + + + + + Parameters + + + None. + + + + + + + Return Value + + + A Status value — see + , for more + information. + + + + + + + Example + + + +[To be supplied...] + + + + + +
+ +
+ + <literal>NdbDictionary::Object::Index::getObjectVersion()</literal> + + + + Description + + + This method gets the object version of the index. + + + + + + + Signature + + + +virtual int getObjectVersion + ( + void + ) const + + + + + + + + Parameters + + + None. + + + + + + + Return Value + + + The object version for the index, as an integer. + + + + + + + Example + + + +[To be supplied...] + + + + + +
+ +
+ + <literal>NdbDictionary::Object::Index::getObjectId()</literal> + + + + Description + + + This method is used to obtain the object ID of the + index. + + + + + + + Signature + + + +virtual int getObjectId + ( + void + ) const + + + + + + + + Parameters + + + None. + + + + + + + Return Value + + + The object ID, as an integer. + + + + + + + Example + + + +[To be supplied...] + + + + + +
+ +
+ + <literal>NdbDictionary::Object::Index::setName()</literal> + + + + Description + + + This method sets the name of the index. + + + + + + + This is the only + Index::set*() + method whose result is visible to a MySQL Server. + + + + + + Signature + + + +void setName + ( + const char* name + ) + + + + + + + + Parameters + + + The desired name for the + index, as a constant character pointer. + + + + + + + Return Value + + + None. + + + + + + + Example + + + +[To be supplied...] + + + + + +
+ +
+ + <literal>NdbDictionary::Object::Index::setTable()</literal> + + + + Description + + + This method sets the table that is to be indexed. The + table is referenced by name. + + + + + + + Signature + + + +void setTable + ( + const char* name + ) + + + + + + + + Parameters + + + The name of the table to be + indexed, as a constant character pointer. + + + + + + + Return Value + + + None. + + + + + + + Example + + + +[To be supplied...] + + + + + +
+ +
+ + <literal>NdbDictionary::Object::Index::addColumn()</literal> + + + + Description + + + This method may be used to add a column to an index. + + + + + + + The order of the columns matches the order in which they + are added to the index. However, this matters only with + ordered indexes. + + + + + + Signature + + + +void addColumn + ( + const Column& c + ) + + + + + + + + Parameters + + + A reference c to the column + which is to be added to the index. + + + + + + + Return Value + + + None. + + + + + + + Example + + + +[To be supplied...] + + + + + +
+ +
+ + <literal>NdbDictionary::Object::Index::addColumnName()</literal> + + + + Description + + + This method works in the same way as + addColumn(), except that it takes the + name of the column as a parameter. See + . + + + + + + + Signature + + + +void addColumnName + ( + const char* name + ) + + + + + + + + Parameters + + + The name of the column to be + added to the index, as a constant character pointer. + + + + + + + Return Value + + + None. + + + + + + + Example + + + +[To be supplied...] + + + + + +
+ +
+ + <literal>NdbDictionary::Object::Index::addColumnNames()</literal> + + + + Description + + + This method is used to add several column names to an + index definition at one time. + + + + + + + As with the addColumn() and + addColumnName() methods, the indexes + are numbered in the order in which they were added. + (However, this matters only for ordered indexes.) + + + + + + Signature + + + +void addColumnNames + ( + unsigned noOfNames, + const char** names + ) + + + + + + + + Parameters + + + This method takes two parameters: + + + + + + The number of columns/names + noOfNames to be added + to the index. + + + + + + The names to be added + (as a pointer to a pointer). + + + + + + + + + + + Return Value + + + None. + + + + + + + Example + + + +[To be supplied...] + + + + + +
+ +
+ + <literal>NdbDictionary::Object::Index::setType()</literal> + + + + Description + + + This method is used to set the index type. + + + + + + + Signature + + + +void setType + ( + Type type + ) + + + + + + + + Parameters + + + The type of index. For + possible values, see . + + + + + + + Return Value + + + None. + + + + + + + Example + + + +[To be supplied...] + + + + + +
+ +
+ + <literal></literal> + + + + Description + + + This method is used to enable or disable logging of the + index to disk. + + + + + + + Signature + + + +void setLogging + ( + bool enable + ) + + + + + + + + Parameters + + + setLogging() takes a single Boolean + parameter enable. If + enable is + true, then logging is enabled for the + index; if false, then logging of this index is disabled. + + + + + + + Return Value + + + None. + + + + + + + Example + + + +[To be supplied...] + + + + + +
+
@@ -8320,7 +9541,7 @@ -[To be written...] +[To be supplied...] @@ -8395,7 +9616,7 @@ -[To be written...] +[To be supplied...] @@ -8458,7 +9679,7 @@ -[To be written...] +[To be supplied...] @@ -8538,7 +9759,7 @@ -[To be written...] +[To be supplied...] @@ -8610,7 +9831,7 @@ -[To be written...] +[To be supplied...] @@ -8674,7 +9895,7 @@ -[To be written...] +[To be supplied...] @@ -8740,7 +9961,7 @@ -[To be written...] +[To be supplied...] @@ -8808,7 +10029,7 @@ -[To be written...] +[To be supplied...] @@ -8878,7 +10099,7 @@ -[To be written...] +[To be supplied...] @@ -8942,7 +10163,7 @@ -[To be written...] +[To be supplied...] @@ -9006,7 +10227,7 @@ -[To be written...] +[To be supplied...] @@ -9071,7 +10292,7 @@ -[To be written...] +[To be supplied...] @@ -9137,7 +10358,7 @@ -[To be written...] +[To be supplied...] @@ -9201,7 +10422,7 @@ -[To be written...] +[To be supplied...] @@ -9266,7 +10487,7 @@ -[To be written...] +[To be supplied...] @@ -9330,7 +10551,7 @@ -[To be written...] +[To be supplied...] @@ -9395,7 +10616,7 @@ -[To be written...] +[To be supplied...] @@ -9459,7 +10680,7 @@ -[To be written...] +[To be supplied...] @@ -9523,7 +10744,7 @@ -[To be written...] +[To be supplied...] @@ -9587,7 +10808,7 @@ -[To be written...] +[To be supplied...] @@ -9651,7 +10872,7 @@ -[To be written...] +[To be supplied...] @@ -9720,7 +10941,7 @@ -[To be written...] +[To be supplied...] @@ -9784,7 +11005,7 @@ -[To be written...] +[To be supplied...] @@ -9940,7 +11161,7 @@ -[To be written...] +[To be supplied...] @@ -10005,7 +11226,7 @@ -[To be written...] +[To be supplied...] @@ -10070,7 +11291,7 @@ -[To be written...] +[To be supplied...] @@ -10133,7 +11354,7 @@ -[To be written...] +[To be supplied...] @@ -10199,7 +11420,7 @@ -[To be written...] +[To be supplied...] @@ -10267,7 +11488,7 @@ -[To be written...] +[To be supplied...] @@ -10330,7 +11551,7 @@ -[To be written...] +[To be supplied...] @@ -10398,7 +11619,7 @@ -[To be written...] +[To be supplied...] @@ -10464,7 +11685,7 @@ -[To be written...] +[To be supplied...] @@ -10530,7 +11751,7 @@ -[To be written...] +[To be supplied...] @@ -10596,7 +11817,7 @@ -[To be written...] +[To be supplied...] @@ -10669,7 +11890,7 @@ -[To be written...] +[To be supplied...] @@ -10731,7 +11952,7 @@ -[To be written...] +[To be supplied...] @@ -10798,7 +12019,7 @@ -[To be written...] +[To be supplied...] @@ -10860,7 +12081,7 @@ -[To be written...] +[To be supplied...] @@ -10924,7 +12145,7 @@ -[To be written...] +[To be supplied...] @@ -10990,7 +12211,7 @@ -[To be written...] +[To be supplied...] @@ -11064,7 +12285,7 @@ -[To be written...] +[To be supplied...] @@ -11139,7 +12360,7 @@ -[To be written...] +[To be supplied...] @@ -11215,7 +12436,7 @@ -[To be written...] +[To be supplied...] @@ -11310,7 +12531,7 @@ -[To be written...] +[To be supplied...] @@ -11376,7 +12597,7 @@ -[To be written...] +[To be supplied...] @@ -11446,7 +12667,7 @@ -[To be written...] +[To be supplied...] @@ -11535,7 +12756,7 @@ -[To be written...] +[To be supplied...] @@ -11640,7 +12861,7 @@ -[To be written...] +[To be supplied...] @@ -11727,7 +12948,7 @@ -[To be written...] +[To be supplied...] @@ -11811,7 +13032,7 @@ -[To be written...] +[To be supplied...] @@ -11900,7 +13121,7 @@ -[To be written...] +[To be supplied...] @@ -11965,7 +13186,7 @@ -[To be written...] +[To be supplied...] @@ -12031,7 +13252,7 @@ -[To be written...] +[To be supplied...] @@ -12097,7 +13318,7 @@ -[To be written...] +[To be supplied...]