Copyright © 2003, 2010, Oracle and/or its affiliates. All rights reserved.
This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.
The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.
If this software or related documentation is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, the following notice is applicable:
U.S. GOVERNMENT RIGHTS Programs, software, databases, and related documentation and technical data delivered to U.S. Government customers are "commercial computer software" or "commercial technical data" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, the use, duplication, disclosure, modification, and adaptation shall be subject to the restrictions and license terms set forth in the applicable Government contract, and, to the extent applicable by the terms of the Government contract, the additional rights set forth in FAR 52.227-19, Commercial Computer Software License (December 2007). Oracle USA, Inc., 500 Oracle Parkway, Redwood City, CA 94065.
This software is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications which may create a risk of personal injury. If you use this software in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure the safe use of this software. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software in dangerous applications.
Oracle is a registered trademark of Oracle Corporation and/or its affiliates. MySQL is a trademark of Oracle Corporation and/or its affiliates, and shall not be used without Oracle's express written authorization. Other names may be trademarks of their respective owners.
This software and documentation may provide access to or information on content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services.
This document in any form, software or printed matter, contains proprietary information that is the exclusive property of Oracle. Your access to and use of this material is subject to the terms and conditions of your Oracle Software License and Service Agreement, which has been executed and with which you agree to comply. This document and information contained herein may not be disclosed, copied, reproduced, or distributed to anyone outside Oracle without prior written consent of Oracle or as specifically provided below. This document is not part of your license agreement nor can it be incorporated into any contractual agreement with Oracle or its subsidiaries or affiliates.
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 Oracle 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 Oracle. Oracle and/or its affiliates 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 visit http://www.mysql.com/company/contact/.
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 and PDF formats, see the MySQL Documentation Library.
The MySQL Cluster API Developer Guide
Document generated on: 2010-11-04 (revision: 23557)
This guide provides information for developers wishing to develop applications against MySQL Cluster. These include:
The low-level C++-language NDB API
for the MySQL NDBCLUSTER
storage engine
the C-language MGM API for communicating with and controlling MySQL Cluster management servers
The MySQL Cluster Connector for Java, which is a a collection of Java APIs introduced in MySQL Cluster NDB 7.1 for writing applications against MySQL Cluster, including JDBC, JPA, and ClusterJ.
This Guide includes concepts, terminology, class and function
references, practical examples, common problems, and tips for
using these APIs in applications. It also contains information
about NDB internals that may be of interest to developers
working with NDBCLUSTER
, such as
communication protocols employed between nodes, filesystems used
by data nodes, and error messages.
The information presented in this guide is current for recent MySQL Cluster NDB 6.2, NDB 6.3, NDB 7.0, and NDB 7.1 releases. You should be aware that there have been significant changes in the NDB API, MGM API, and other particulars in MySQL Cluster versions since MySQL 5.1.12.
Table of Contents
Column
ClassDatafile
ClassDictionary
ClassEvent
ClassIndex
ClassLogfileGroup
ClassList
ClassNdb
ClassNdbBlob
ClassNdbDictionary
ClassNdbEventOperation
ClassNdbIndexOperation
ClassNdbIndexScanOperation
ClassNdbInterpretedCode
ClassNdbOperation
ClassNdbRecAttr
ClassNdbScanFilter
ClassNdbScanOperation
ClassNdbTransaction
ClassObject
ClassTable
ClassTablespace
ClassUndofile
ClassNdb_cluster_connection
ClassNdbRecord
InterfaceAutoGrowSpecification
StructureElement
StructureGetValueSpec
StructureIndexBound
StructureKey_part_ptr
StructureNdbError
StructureOperationOptions
StructurePartitionSpec
StructureRecordSpecification
StructureScanOptions
StructureSetValueSpec
StructureNdbRecord
with Hash IndexesRecAttr
and NdbRecord
BLOB
Handling ExampleBLOB
s Using NdbRecord
DUMP
CommandsDUMP
Codes 1 to 999DUMP
Codes 1000 to 1999DUMP
Codes 2000 to 2999DUMP
Codes 3000 to 3999DUMP
Codes 4000 to 4999DUMP
Codes 5000 to 5999DUMP
Codes 6000 to 6999DUMP
Codes 7000 to 7999DUMP
Codes 8000 to 8999DUMP
Codes 9000 to 9999DUMP
Codes 10000 to 10999DUMP
Codes 11000 to 11999DUMP
Codes 12000 to 12999NDB
Kernel BlocksBACKUP
BlockCMVMI
BlockDBACC
BlockDBDICT
BlockDBDIH
BlockDBLQH
BlockDBTC
BlockDBTUP
BlockDBTUX
BlockDBUTIL
BlockLGMAN
BlockNDBCNTR
BlockNDBFS
BlockPGMAN
BlockQMGR
BlockRESTORE
BlockSUMA
BlockTSMAN
BlockTRIX
BlockSTTOR
Phase -1)STTOR
Phase 0STTOR
Phase 1STTOR
Phase 2NDB_STTOR
Phase 1STTOR
Phase 3NDB_STTOR
Phase 2STTOR
Phase 4NDB_STTOR
Phase 3STTOR
Phase 5NDB_STTOR
Phase 4NDB_STTOR
Phase 5NDB_STTOR
Phase 6STTOR
Phase 6STTOR
Phase 7STTOR
Phase 8NDB_STTOR
Phase 7STTOR
Phase 9STTOR
Phase 101START_MEREQ
HandlingNDB
Internals Glossary