Commit 584f68e8 authored by unknown's avatar unknown

changed example names

and updated some docs

parent fcdd5e43
BIN_DIRS := ndbapi_example1 ndbapi_example3 ndbapi_example4 \ BIN_DIRS := ndbapi_simple_example \
ndbapi_example5 ndbapi_scan_example ndbapi_async_example \
ndbapi_async_example1 \
ndbapi_retries_example \
ndbapi_simple_index_example \
ndbapi_event_example \
ndbapi_scan_example
bins: $(patsubst %, _bins_%, $(BIN_DIRS)) bins: $(patsubst %, _bins_%, $(BIN_DIRS))
......
TARGET = ndbapi_example3 TARGET = ndbapi_async1
SRCS = ndbapi_example3.cpp SRCS = ndbapi_async1.cpp
OBJS = ndbapi_example3.o OBJS = ndbapi_async1.o
CXX = g++ CXX = g++
CFLAGS = -c -Wall -fno-rtti -fno-exceptions CFLAGS = -c -Wall -fno-rtti -fno-exceptions
DEBUG = DEBUG =
......
...@@ -15,7 +15,7 @@ ...@@ -15,7 +15,7 @@
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */
// //
// ndbapi_example2.cpp: Using asynchronous transactions in NDB API // ndbapi_async1.cpp: Using asynchronous transactions in NDB API
// //
// Execute ndbapi_example1 to create the table "MYTABLENAME" // Execute ndbapi_example1 to create the table "MYTABLENAME"
// before executing this program. // before executing this program.
......
TARGET = ndbapi_example5 TARGET = ndbapi_event
SRCS = ndbapi_example5.cpp SRCS = ndbapi_event.cpp
OBJS = ndbapi_example5.o OBJS = ndbapi_event.o
CXX = g++ CXX = g++
CFLAGS = -c -Wall -fno-rtti -fno-exceptions CFLAGS = -c -Wall -fno-rtti -fno-exceptions
CXXFLAGS = CXXFLAGS =
......
...@@ -15,7 +15,38 @@ ...@@ -15,7 +15,38 @@
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */
/** /**
* ndbapi_example5.cpp: Using API level events in NDB API * ndbapi_event.cpp: Using API level events in NDB API
*
* Classes and methods used in this example:
*
* Ndb_cluster_connection
* connect()
* wait_until_ready()
*
* Ndb
* init()
* getDictionary()
* createEventOperation()
* dropEventOperation()
* pollEvents()
*
* NdbDictionary
* createEvent()
* dropEvent()
*
* NdbDictionary::Event
* setTable()
* addtableEvent()
* addEventColumn()
*
* NdbEventOperation
* getValue()
* getPreValue()
* execute()
* next()
* isConsistent()
* getEventType()
*
*/ */
#include <NdbApi.hpp> #include <NdbApi.hpp>
......
TARGET = ndbapi_example2 TARGET = ndbapi_retries
SRCS = ndbapi_example2.cpp SRCS = ndbapi_retries.cpp
OBJS = ndbapi_example2.o OBJS = ndbapi_retries.o
CXX = g++ CXX = g++
CFLAGS = -c -Wall -fno-rtti -fno-exceptions CFLAGS = -c -Wall -fno-rtti -fno-exceptions
DEBUG = DEBUG =
......
...@@ -15,9 +15,9 @@ ...@@ -15,9 +15,9 @@
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */
// //
// ndbapi_example3.cpp: Error handling and transaction retries // ndbapi_retries.cpp: Error handling and transaction retries
// //
// Execute ndbapi_example1 to create the table "MYTABLENAME" // Execute ndbapi_simple to create the table "MYTABLENAME"
// before executing this program. // before executing this program.
// //
// There are many ways to program using the NDB API. In this example // There are many ways to program using the NDB API. In this example
......
TARGET = ndbapi_example1 TARGET = ndbapi_simple
SRCS = $(TARGET).cpp SRCS = $(TARGET).cpp
OBJS = $(TARGET).o OBJS = $(TARGET).o
CXX = g++ CXX = g++
......
...@@ -15,7 +15,7 @@ ...@@ -15,7 +15,7 @@
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */
/* /*
* ndbapi_example1.cpp: Using synchronous transactions in NDB API * ndbapi_simple.cpp: Using synchronous transactions in NDB API
* *
* Correct output from this program is: * Correct output from this program is:
* *
......
TARGET = ndbapi_example4 TARGET = ndbapi_simple_index
SRCS = $(TARGET).cpp SRCS = $(TARGET).cpp
OBJS = $(TARGET).o OBJS = $(TARGET).o
CXX = g++ CXX = g++
......
...@@ -15,7 +15,7 @@ ...@@ -15,7 +15,7 @@
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */
// //
// ndbapi_example4.cpp: Using secondary indexes in NDB API // ndbapi_simple_index.cpp: Using secondary indexes in NDB API
// //
// Correct output from this program is: // Correct output from this program is:
// //
......
This diff is collapsed.
...@@ -56,7 +56,7 @@ typedef struct charset_info_st CHARSET_INFO; ...@@ -56,7 +56,7 @@ typedef struct charset_info_st CHARSET_INFO;
* -# NdbDictionary::Column for creating table columns * -# NdbDictionary::Column for creating table columns
* -# NdbDictionary::Index for creating secondary indexes * -# NdbDictionary::Index for creating secondary indexes
* *
* See @ref ndbapi_example4.cpp for details of usage. * See @ref ndbapi_simple_index.cpp for details of usage.
*/ */
class NdbDictionary { class NdbDictionary {
public: public:
......
...@@ -41,7 +41,7 @@ ...@@ -41,7 +41,7 @@
* The <em>error messages</em> and <em>error details</em> may * The <em>error messages</em> and <em>error details</em> may
* change without notice. * change without notice.
* *
* For example of use, see @ref ndbapi_example3.cpp. * For example of use, see @ref ndbapi_retries.cpp.
*/ */
struct NdbError { struct NdbError {
/** /**
......
...@@ -46,7 +46,7 @@ class NdbEventOperationImpl; ...@@ -46,7 +46,7 @@ class NdbEventOperationImpl;
* The instance is removed by Ndb::dropEventOperation * The instance is removed by Ndb::dropEventOperation
* *
* For more info see: * For more info see:
* @ref ndbapi_example5.cpp * @ref ndbapi_event.cpp
* *
* Known limitations: * Known limitations:
* *
......
...@@ -237,10 +237,13 @@ public: ...@@ -237,10 +237,13 @@ public:
* use several equals (then all of them must be satisfied for the * use several equals (then all of them must be satisfied for the
* tuple to be selected). * tuple to be selected).
* *
* @note There are 10 versions of NdbOperation::equal with * @note For insertTuple() it is also allowed to define the
* search key by using setValue().
*
* @note There are 10 versions of equal() with
* slightly different parameters. * slightly different parameters.
* *
* @note When using NdbOperation::equal with a string (char *) as * @note When using equal() with a string (char *) as
* second argument, the string needs to be padded with * second argument, the string needs to be padded with
* zeros in the following sense: * zeros in the following sense:
* @code * @code
...@@ -249,6 +252,8 @@ public: ...@@ -249,6 +252,8 @@ public:
* NdbOperation->equal("Attr1", buf); * NdbOperation->equal("Attr1", buf);
* @endcode * @endcode
* *
*
*
* @param anAttrName Attribute name * @param anAttrName Attribute name
* @param aValue Attribute value. * @param aValue Attribute value.
* @param len Attribute length expressed in bytes. * @param len Attribute length expressed in bytes.
...@@ -328,6 +333,12 @@ public: ...@@ -328,6 +333,12 @@ public:
* then the API will assume that the pointer * then the API will assume that the pointer
* is correct and not bother with checking it. * is correct and not bother with checking it.
* *
* @note For insertTuple() the NDB API will automatically detect that
* it is supposed to use equal() instead.
*
* @note For insertTuple() it is not necessary to use
* setValue() on key attributes before other attributes.
*
* @note There are 14 versions of NdbOperation::setValue with * @note There are 14 versions of NdbOperation::setValue with
* slightly different parameters. * slightly different parameters.
* *
......
...@@ -39,7 +39,7 @@ class NdbOperation; ...@@ -39,7 +39,7 @@ class NdbOperation;
* ndbout << MyRecAttr->u_32_value(); * ndbout << MyRecAttr->u_32_value();
* @endcode * @endcode
* For more examples, see * For more examples, see
* @ref ndbapi_example1.cpp. * @ref ndbapi_simple.cpp.
* *
* @note The NdbRecAttr object is instantiated with its value when * @note The NdbRecAttr object is instantiated with its value when
* NdbTransaction::execute is called. Before this, the value is * NdbTransaction::execute is called. Before this, the value is
......
...@@ -298,7 +298,7 @@ public: ...@@ -298,7 +298,7 @@ public:
* ExecType::Rollback rollbacks the entire transaction. * ExecType::Rollback rollbacks the entire transaction.
* @param callback A callback method. This method gets * @param callback A callback method. This method gets
* called when the transaction has been * called when the transaction has been
* executed. See @ref ndbapi_example2.cpp * executed. See @ref ndbapi_async1.cpp
* for an example on how to specify and use * for an example on how to specify and use
* a callback method. * a callback method.
* @param anyObject A void pointer. This pointer is forwarded to the * @param anyObject A void pointer. This pointer is forwarded to the
...@@ -366,7 +366,13 @@ public: ...@@ -366,7 +366,13 @@ public:
* Once a transaction has been completed successfully * Once a transaction has been completed successfully
* it can be started again wo/ calling closeTransaction/startTransaction * it can be started again wo/ calling closeTransaction/startTransaction
* *
* Note this method also releases completed operations * @note This method also releases completed operations
*
* @note This method does not close open scans,
* c.f. NdbScanOperation::close()
*
* @note This method can only be called _directly_ after commit
* and only if commit is successful
*/ */
int restart(); int restart();
#endif #endif
......
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