MySQL Bugs: #57317: Missing descriptions in NDBAPI/MGMAPI

Bug #57317	Missing descriptions in NDBAPI/MGMAPI
Submitted:	7 Oct 2010 15:25	Modified:	10 Feb 2012 7:20
Reporter:	Jon Stephens	Email Updates:
Status:	Closed	Impact on me:	None
Category:	MySQL Server: Documentation	Severity:	S3 (Non-critical)
Version:	ALL	OS:	Any
Assigned to:	Jon Stephens	CPU Architecture:	Any

Description:
The following methods lack even basic descriptions:

getRowGCIIndicator()
getRowChecksumIndicator()
setRowGCIIndicator()
setRowChecksumIndicator()

How to repeat:
See http://dev.mysql.com/doc/ndbapi/en/ndb-table-methods.html

Suggested fix:
Add descriptions for the indicated Table methods.

Mail from JD Duncan, 20101105:

> NdbDictionary has some "convenience methods" that make it much easier to 
> actually do anything with NdbRecords.
> 
> I don't know anything special about these -- I'm just trying to use 
> them.  But as far as I can tell, they are supposed to be in the 
> documentation (in "the NdbRecord interface" section), but they're missing.
> 
> That's:
> 
>   NdbDictionary::getValuePtr()
>   NdbDictionary::isNull()
>   NdbDictionary::setNull()
> 
> etc. up to NdbDictionary::getNullBitOffset()
> 
> all in include/ndbapi/NdbDictionary.hpp

JD has also noted that NdbTransaction::scanIndex() also appears to have changed in NDB-7.1.

Here's another one:

NdbTransaction::executePendingBlobOps(), which is 

#ifndef DOXYGEN_SHOULD_SKIP_INTERNAL ...

Determine whether we actually support it, and if so, document it.

MGM API functions, mentioned in bug reports and in docs derived from code comments, but #ifndef DOXYGEN_SHOULD_SKIP_INTERNAL'ed out:

ndb_mgm_get_configuration()
(and by implication ndb_mgm_destroy_configuration() and the struct ndb_mgm_configuration)

Issues with NdbTransaction::scanIndex(), NdbTransaction::unlock(), NdbTransaction::releaseLockHandle(),
NdbOperation::getLockHandle() fixed by mysqldoc r28603, r28617, r28630, r28632.

Missing NdbDictionary methods (getRecordType(), getRecordTableName(), getRecordIndexName(), getFirstAttrId(), getNextAttrId(), getOffset(), getNullBitOffset(), getValuePtr(), isNull(). setNull(), getRecordRowLength(), and
getEmptyBitmask()) added in mysqldoc r28576 & r28583.

Added documentation for the following missing NDB API methods while working on other issues:

Ndb::getGCIEventOperations()
Ndb::isConsistent()
NdbInterpretedCode::copy()

Bug report status unchanged.

mysqldoc r28705, r28706: Documented the getRowGCIIndicator(), getRowChecksumIndicator(), setRowGCIIndicator(), and setRowChecksumIndicator() methods. Also added the Table::getPartitionId() method that was previously undocumented.

Sent mail to developers asking about the 'internal' MGM functions, which should be the last issue that needs resolution before i can close this bug.

Discussed MGM API configuration functions with Jonas yesterday; there's been no real demand for this, so we'll leave them until there is.

Closed.

Forgot to close earlier.