Commit b58224a5 authored by unknown's avatar unknown

Updated docs

parent de5ce111
This diff is collapsed.
...@@ -31,6 +31,8 @@ class Ndb; ...@@ -31,6 +31,8 @@ class Ndb;
class NdbBlob; class NdbBlob;
#ifndef DOXYGEN_SHOULD_SKIP_INTERNAL
// to be documented later
/** /**
* NdbAsynchCallback functions are used when executing asynchronous * NdbAsynchCallback functions are used when executing asynchronous
* transactions (using NdbConnection::executeAsynchPrepare, or * transactions (using NdbConnection::executeAsynchPrepare, or
...@@ -39,6 +41,7 @@ class NdbBlob; ...@@ -39,6 +41,7 @@ class NdbBlob;
* See @ref secAsync for more information. * See @ref secAsync for more information.
*/ */
typedef void (* NdbAsynchCallback)(int, NdbConnection*, void*); typedef void (* NdbAsynchCallback)(int, NdbConnection*, void*);
#endif
/** /**
* Commit type of transaction * Commit type of transaction
...@@ -184,7 +187,8 @@ public: ...@@ -184,7 +187,8 @@ public:
* @note All operations within the same transaction need to * @note All operations within the same transaction need to
* be initialized with this method. * be initialized with this method.
* *
* @param aTable A table object (fetched by NdbDictionary::Dictionary::getTable) * @param aTable
* A table object (fetched by NdbDictionary::Dictionary::getTable)
* @return Pointer to an NdbOperation object if successful, otherwise NULL. * @return Pointer to an NdbOperation object if successful, otherwise NULL.
*/ */
NdbOperation* getNdbOperation(const NdbDictionary::Table * aTable); NdbOperation* getNdbOperation(const NdbDictionary::Table * aTable);
...@@ -204,7 +208,8 @@ public: ...@@ -204,7 +208,8 @@ public:
* get the NdbConnection object which * get the NdbConnection object which
* was fetched by startTransaction pointing to this operation. * was fetched by startTransaction pointing to this operation.
* *
* @param aTable A table object (fetched by NdbDictionary::Dictionary::getTable) * @param aTable
* A table object (fetched by NdbDictionary::Dictionary::getTable)
* @return pointer to an NdbOperation object if successful, otherwise NULL * @return pointer to an NdbOperation object if successful, otherwise NULL
*/ */
NdbScanOperation* getNdbScanOperation(const NdbDictionary::Table * aTable); NdbScanOperation* getNdbScanOperation(const NdbDictionary::Table * aTable);
...@@ -226,11 +231,14 @@ public: ...@@ -226,11 +231,14 @@ public:
* get the NdbConnection object which * get the NdbConnection object which
* was fetched by startTransaction pointing to this operation. * was fetched by startTransaction pointing to this operation.
* *
* @param anIndex An index object (fetched by NdbDictionary::Dictionary::getIndex). * @param anIndex
* @param aTable A table object (fetched by NdbDictionary::Dictionary::getTable). An index object (fetched by NdbDictionary::Dictionary::getIndex).
* @param aTable
A table object (fetched by NdbDictionary::Dictionary::getTable).
* @return pointer to an NdbOperation object if successful, otherwise NULL * @return pointer to an NdbOperation object if successful, otherwise NULL
*/ */
NdbIndexScanOperation* getNdbIndexScanOperation(const NdbDictionary::Index * anIndex, NdbIndexScanOperation* getNdbIndexScanOperation
(const NdbDictionary::Index * anIndex,
const NdbDictionary::Table * aTable); const NdbDictionary::Table * aTable);
/** /**
...@@ -251,8 +259,10 @@ public: ...@@ -251,8 +259,10 @@ public:
* get the NdbConnection object that * get the NdbConnection object that
* was fetched by startTransaction pointing to this operation. * was fetched by startTransaction pointing to this operation.
* *
* @param anIndex An index object (fetched by NdbDictionary::Dictionary::getIndex). * @param anIndex
* @param aTable A table object (fetched by NdbDictionary::Dictionary::getTable). * An index object (fetched by NdbDictionary::Dictionary::getIndex).
* @param aTable
* A table object (fetched by NdbDictionary::Dictionary::getTable).
* @return Pointer to an NdbIndexOperation object if * @return Pointer to an NdbIndexOperation object if
* successful, otherwise NULL * successful, otherwise NULL
*/ */
...@@ -289,6 +299,8 @@ public: ...@@ -289,6 +299,8 @@ public:
AbortOption abortOption = AbortOnError, AbortOption abortOption = AbortOnError,
int force = 0 ); int force = 0 );
#ifndef DOXYGEN_SHOULD_SKIP_INTERNAL
// to be documented later
/** /**
* Prepare an asynchronous transaction. * Prepare an asynchronous transaction.
* *
...@@ -334,7 +346,7 @@ public: ...@@ -334,7 +346,7 @@ public:
NdbAsynchCallback aCallback, NdbAsynchCallback aCallback,
void* anyObject, void* anyObject,
AbortOption abortOption = AbortOnError); AbortOption abortOption = AbortOnError);
#endif
/** /**
* Refresh * Refresh
* Update timeout counter of this transaction * Update timeout counter of this transaction
......
...@@ -166,7 +166,7 @@ public: ...@@ -166,7 +166,7 @@ public:
* The builtin column types * The builtin column types
*/ */
enum Type { enum Type {
Undefined=0,///< Undefined Undefined=0, ///< Undefined
Tinyint, ///< 8 bit. 1 byte signed integer, can be used in array Tinyint, ///< 8 bit. 1 byte signed integer, can be used in array
Tinyunsigned, ///< 8 bit. 1 byte unsigned integer, can be used in array Tinyunsigned, ///< 8 bit. 1 byte unsigned integer, can be used in array
Smallint, ///< 16 bit. 2 byte signed integer, can be used in array Smallint, ///< 16 bit. 2 byte signed integer, can be used in array
...@@ -373,16 +373,11 @@ public: ...@@ -373,16 +373,11 @@ public:
#ifndef DOXYGEN_SHOULD_SKIP_INTERNAL #ifndef DOXYGEN_SHOULD_SKIP_INTERNAL
const Table * getBlobTable() const; const Table * getBlobTable() const;
/**
* @name ODBC Specific methods
* @{
*/
void setAutoIncrement(bool); void setAutoIncrement(bool);
bool getAutoIncrement() const; bool getAutoIncrement() const;
void setAutoIncrementInitialValue(Uint64 val); void setAutoIncrementInitialValue(Uint64 val);
void setDefaultValue(const char*); void setDefaultValue(const char*);
const char* getDefaultValue() const; const char* getDefaultValue() const;
/** @} *******************************************************************/
static const Column * FRAGMENT; static const Column * FRAGMENT;
static const Column * ROW_COUNT; static const Column * ROW_COUNT;
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment