mirror/mariadb
1
0
Fork 0
mirror of https://github.com/MariaDB/server.git synced 2026-05-06 15:15:34 +02:00
Code Issues Projects Releases Packages Wiki Activity

ndb - Update documentation wrt scans

Browse source 
ndb/include/ndbapi/Ndb.hpp:
  Update documentation wrt scans
ndb/include/ndbapi/NdbIndexScanOperation.hpp:
  Update documentation wrt scans
ndb/include/ndbapi/NdbOperation.hpp:
  Update documentation wrt scans
ndb/include/ndbapi/NdbRecAttr.hpp:
  Update documentation wrt scans
ndb/include/ndbapi/NdbScanOperation.hpp:
  Update documentation wrt scans
ndb/include/ndbapi/NdbTransaction.hpp:
  Update documentation wrt scans
ndb/src/ndbapi/NdbOperationSearch.cpp:
  Update documentation wrt scans
This commit is contained in:
unknown 2004-12-28 11:59:33 +01:00
commit badf354985
7 changed files with 471 additions and 515 deletions
Download patch file Download diff file Expand all files Collapse all files

30
ndb/include/ndbapi/NdbIndexScanOperation.hpp
View file

@ -34,16 +34,15 @@ class NdbIndexScanOperation : public NdbScanOperation {
public:
/**
* readTuples returns a NdbResultSet where tuples are stored.
* Tuples are not stored in NdbResultSet until execute(NoCommit)
* has been executed and nextResult has been called.
* readTuples using ordered index
*
* @param parallel Scan parallelism
* @param lock_mode Lock mode
* @param batch No of rows to fetch from each fragment at a time
* @param LockMode Scan lock handling
* @param parallel No of fragments to scan in parallel
* @param order_by Order result set in index order
* @param order_desc Order descending, ignored unless order_by
* @returns NdbResultSet.
* @param order_desc Order descending, ignored unless order_by
* @param read_range_no Enable reading of range no using @ref get_range_no
* @returns 0 for success and -1 for failure
* @see NdbScanOperation::readTuples
*/
int readTuples(LockMode = LM_Read,
@ -53,16 +52,6 @@ public:
bool order_desc = false,
bool read_range_no = false);
#ifndef DOXYGEN_SHOULD_SKIP_DEPRECATED
inline int readTuples(int parallell){
return readTuples(LM_Read, 0, parallell, false);
}
inline int readTuplesExclusive(int parallell = 0){
return readTuples(LM_Exclusive, 0, parallell, false);
}
#endif
/**
* Type of ordered index key bound. The values (0-4) will not change
* and can be used explicitly (e.g. they could be computed).
@ -134,7 +123,14 @@ public:
*/
int get_range_no();
/**
* Is current scan sorted
*/
bool getSorted() const { return m_ordered; }
/**
* Is current scan sorted descending
*/
bool getDescending() const { return m_descending; }
private:
NdbIndexScanOperation(Ndb* aNdb);