| CARVIEW |
The world's most popular open source database
Version 2.0 (2009-01-22)
Copyright 2003-2008 MySQL AB, 2008 Sun Microsystems, Inc.
This documentation is NOT distributed under a GPL license. Use of this documentation is subject to the following terms: You may create a printed copy of this documentation solely for your own personal use. Conversion to other formats is allowed as long as the actual content is not altered or edited in any way. You shall not publish or distribute this documentation in any form or on any media, except if you distribute the documentation in a manner similar to how Sun disseminates it (that is, electronically for download on a Web site with the software) or on a CD-ROM or similar medium, provided however that the documentation is disseminated together with the software on the same medium. Any other use, such as any dissemination of printed copies or use of this documentation, in whole or in part, in another publication, requires the prior written consent from an authorized representative of Sun Microsystems, Inc. Sun Microsystems, Inc. and MySQL AB reserve any and all rights to this documentation not expressly granted above.
For more information on the terms of this license, for details on
how the MySQL documentation is built and produced, or if you are
interested in doing a translation, please contact us at
<docs@mysql.com>.
If you want help with using MySQL, please visit either the MySQL Forums or MySQL Mailing Lists where you can discuss your issues with other MySQL users.
For additional documentation on MySQL products, including translations of the documentation into other languages, and downloadable versions in variety of formats, including HTML, CHM and PDF formats, see MySQL Documentation Library.
The MySQL Cluster API Developer Guide
Document generated on: 2009-01-22 (revision: 13339)
Provides information for developers wishing to use the low-level
C/C++-language NDB API for the MySQL®
NDBCLUSTER storage engine. Includes
concepts, terminology, programming class and structure
references, practical examples, common problems, and tips for
using the NDB API in applications.
The NDB and MGM APIs as presented in this guide are current for MySQL 5.1 — note that there have been significant changes in the API as implemented in previous MySQL Cluster versions. The definitions of NDB API classes and MGM API functions reflect the state of the MySQL main development tree as of MySQL 5.1.12 and later.
Table of Contents [+/-]
- 1. Overview and Concepts [+/-]
- 2. Getting Started with the
NDBAPI [+/-] - 3. The
NDBObject Hierarachy - 4.
NDBAPI Classes, Interfaces, and Structures [+/-] - 4.1. The
ColumnClass [+/-] - 4.2. The
DatafileClass [+/-] - 4.3. The
DictionaryClass [+/-] - 4.4. The
EventClass [+/-] - 4.5. The
IndexClass [+/-] - 4.6. The
LogfileGroupClass [+/-] - 4.7. The
ListClass - 4.8. The
NDBClass [+/-] - 4.9. The
NdbBlobClass [+/-] - 4.10. The
NdbDictionaryClass - 4.11. The
NdbEventOperationClass [+/-] - 4.12. The
NdbIndexOperationClass [+/-] - 4.13. The
NdbIndexScanOperationClass [+/-] - 4.14. The
NdbInterpretedCodeClass [+/-] - 4.15. The
NdbOperationClass [+/-] - 4.16. The
NdbRecAttrClass [+/-] - 4.17. The
NdbScanFilterClass [+/-] - 4.18. The
NdbScanOperationClass [+/-] - 4.19. The
NdbTransactionClass [+/-] - 4.20. The
ObjectClass [+/-] - 4.21. The
TableClass [+/-] - 4.22. The
TablespaceClass [+/-] - 4.23. The
UndofileClass [+/-] - 4.24. The
Ndb_cluster_connectionClass [+/-] - 4.25. The
NdbRecordInterface - 4.26. The
AutoGrowSpecificationStructure - 4.27. The
ElementStructure - 4.28. The
IndexBoundStructure - 4.29. The
NdbErrorStructure [+/-] - 4.30. The
RecordSpecificationStructure
- 4.1. The
- 5. MySQL Cluster API Errors [+/-]
- 6. The MGM API [+/-]
- 6.1. General Concepts [+/-]
- 6.2. MGM C API Function Listing [+/-]
- 6.2.1. Log Event Functions
- 6.2.2. MGM API Error Handling Functions
- 6.2.3. Management Server Handle Functions
- 6.2.4. Management Server Connection Functions
- 6.2.5. Cluster Status Functions
- 6.2.6. Functions for Starting & Stopping Nodes
- 6.2.7. Cluster Log Functions
- 6.2.8. Backup Functions
- 6.2.9. Single-User Mode Functions
- 6.3. MGM Datatypes [+/-]
- 6.4. MGM Structures [+/-]
- 7. Practical Examples [+/-]
- 7.1. Using Synchronous Transactions
- 7.2. Using Synchronous Transactions and Multiple Clusters
- 7.3. Handling Errors and Retrying Transactions
- 7.4. Basic Scanning Example
- 7.5. Using Secondary Indexes in Scans
- 7.6. Using
NdbRecordwith Hash Indexes - 7.7.
NDBAPI Event Handling Example - 7.8. Event Handling with Multiple Clusters
- 7.9. Basic
BLOBHandling Example - 7.10. Handling
BLOBs UsingNdbRecord
- 8. MySQL Cluster Internals [+/-]
- 8.1. MySQL Cluster File Systems [+/-]
- 8.2.
DUMPCommands [+/-] - 8.2.1.
DUMPCodes 1 to 999 - 8.2.2.
DUMPCodes 1000 to 1999 - 8.2.3.
DUMPCodes 2000 to 2999 - 8.2.4.
DUMPCodes 3000 to 3999 - 8.2.5.
DUMPCodes 4000 to 4999 - 8.2.6.
DUMPCodes 5000 to 5999 - 8.2.7.
DUMPCodes 6000 to 6999 - 8.2.8.
DUMPCodes 7000 to 7999 - 8.2.9.
DUMPCodes 8000 to 8999 - 8.2.10.
DUMPCodes 9000 to 9999 - 8.2.11.
DUMPCodes 10000 to 10999 - 8.2.12.
DUMPCodes 11000 to 11999 - 8.2.13.
DUMPCodes 12000 to 12999
- 8.2.1.
- 8.3. The NDB Protocol [+/-]
- 8.4.
NDBKernel Blocks [+/-] - 8.4.1. The
BACKUPBlock - 8.4.2. The
CMVMIBlock - 8.4.3. The
DBACCBlock - 8.4.4. The
DBDICTBlock - 8.4.5. The
DBDIHBlock - 8.4.6.
DBLQHBlock - 8.4.7. The
DBTCBlock - 8.4.8. The
DBTUPBlock - 8.4.9.
DBTUXBlock - 8.4.10. The
DBUTILBlock - 8.4.11. The
LGMANBlock - 8.4.12. The
NDBCNTRBlock - 8.4.13. The
NDBFSBlock - 8.4.14. The
PGMANBlock - 8.4.15. The
QMGRBlock - 8.4.16. The
RESTOREBlock - 8.4.17. The
SUMABlock - 8.4.18. The
TSMANBlock - 8.4.19. The
TRIXBlock
- 8.4.1. The
- 8.5. MySQL Cluster Start Phases [+/-]
- 8.5.1. Initialization Phase (Phase -1)
- 8.5.2. Configuration Read Phase (
STTORPhase -1) - 8.5.3.
STTORPhase 0 - 8.5.4.
STTORPhase 1 - 8.5.5.
STTORPhase 2 - 8.5.6.
NDB_STTORPhase 1 - 8.5.7.
STTORPhase 3 - 8.5.8.
NDB_STTORPhase 2 - 8.5.9.
STTORPhase 4 - 8.5.10.
NDB_STTORPhase 3 - 8.5.11.
STTORPhase 5 - 8.5.12.
NDB_STTORPhase 4 - 8.5.13.
NDB_STTORPhase 5 - 8.5.14.
NDB_STTORPhase 6 - 8.5.15.
STTORPhase 6 - 8.5.16.
STTORPhase 7 - 8.5.17.
STTORPhase 8 - 8.5.18.
NDB_STTORPhase 7 - 8.5.19.
STTORPhase 9 - 8.5.20.
STTORPhase 101 - 8.5.21. System Restart Handling in Phase 4
- 8.5.22.
START_MEREQHandling
- 8.6.
NDBInternals Glossary
- Index

