Author: jstephens
Date: 2006-04-22 15:20:08 +0200 (Sat, 22 Apr 2006)
New Revision: 1899
Log:
Moving ndbapi directory from mysqldoc-internal to mysqldoc (Stefan)
Added:
ndbapi/
ndbapi/ndbapi.xml
Added: ndbapi/ndbapi.xml
===================================================================
--- ndbapi/ndbapi.xml (rev 0)
+++ ndbapi/ndbapi.xml 2006-04-22 13:20:08 UTC (rev 1899)
@@ -0,0 +1,645 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE book SYSTEM "http://www.docbook.org/xml/4.4/docbookx.dtd"
+[
+ <!ENTITY title " MySQL® NDB API DEVELOPERS' GUIDE">
+ <!ENTITY subtitle "VERSION &version; (<?dbtimestamp format='Y-m-d'?>)">
+ <!ENTITY version "2.0">
+]>
+<book id="ndb-api" revision="2.0">
+ <title>&title;</title>
+ <subtitle>&subtitle;</subtitle>
+
+ <bookinfo>
+ <abstract>
+ <title>&title;</title>
+ <para> Provides information for developers wishing to use the
+ low-level C/C++-language NDB API for the MySQL®
+ <literal>NDBCLUSTER</literal> storage engine. Includes
+ concepts, terminology, programming class and structure
+ references, practical examples, common problems, and tips for
+ using the NDB API in applications. </para>
+
+ <para>The NDB and MGM APIs as presented in this guide are current
+ for MySQL 5.1. The definitions of NDB API classes and MGM API
+ functions reflect the state of the MySQL main development tree
+ shortly after MySQL 5.1.9 was branched off for release
+ builds.</para>
+ </abstract>
+
+ <corpauthor>MySQL AB</corpauthor>
+
+ <copyright>
+ <year>2003-2006</year>
+ <holder>MySQL AB</holder>
+ </copyright>
+
+ <legalnotice>
+
+ <para> This manual is NOT distributed under a GPL style license.
+ Use of the manual is subject to the following terms: <itemizedlist>
+
+ <listitem>
+ <para> Conversion to other formats is permitted, but the
+ actual content may not be altered or edited in any way.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para> You may create a printed copy for your own personal
+ use. </para>
+ </listitem>
+
+ <listitem>
+ <para> For all other uses, such as selling printed copies or
+ using this manual or parts thereof in another publication,
+ prior written agreement from MySQL AB is required. </para>
+ </listitem>
+
+ </itemizedlist> Please email <email>docs@stripped</email> for
+ more information or if you are interested in doing a
+ translation. </para>
+
+ <para> MySQL® and the <quote>Sakila</quote> dolphin logo
+ are registered trademarks of MySQL AB in the European Union, the
+ United States of America, and elsewhere. </para>
+
+ </legalnotice>
+
+ </bookinfo>
+
+ <chapter>
+ <title>OVERVIEW AND CONCEPTS</title>
+
+ <abstract>
+ <para>This chapter provides a general overview of essential MySQL
+ Cluster and NDB API concepts, terminology, and programming
+ constructs.</para>
+ </abstract>
+
+ <section>
+ <title>Introduction</title>
+
+ <abstract>
+ <para>Introduces the NDB Transaction and Scanning APIs as well
+ as the NDB Management (MGM) API for use in building
+ applications to run on MySQL Cluster. Discusses the general
+ theory and principles involved in developing such
+ applications.</para>
+ </abstract>
+ </section>
+
+ <section>
+ <title>Terminology</title>
+
+ <abstract>
+ <para>Provides a glossary of terms which are unique to the NDB
+ and MGM APIs, or have a specialised meaning when applied
+ therein.</para>
+ </abstract>
+ </section>
+
+ <section>
+ <title>The <literal>NDB Cluster</literal> Transaction and Scanning
+ API</title>
+
+ <abstract>
+ <para>Defines and discusses the high-level architecture of the
+ NDB API; introduces the NDB classes which are of greatest use
+ and interest to the developer. Also covers most important NDB
+ API concepts, including a review of MySQL Cluster
+ Concepts.</para>
+ </abstract>
+
+ <section>
+ <title>Review of MySQL Cluster Concepts</title>
+
+ <abstract>
+ <para>Covers the NDB Kernel; discusses MySQL Cluster
+ transaction handling, and transaction co-ordinators. Also
+ describes NDB record structures and concurrency
+ issues.</para>
+ </abstract>
+ </section>
+
+ <section>
+ <title>The Adaptive Send Algorithm</title>
+
+ <abstract>
+ <para>Discusses the mechanics of transaction handling and
+ transmission in MySQL Cluster and the NDB API, and the
+ objects used to implement these.</para>
+ </abstract>
+ </section>
+
+ <section>
+ <title>NDB Class Listing</title>
+
+ <abstract>
+ <para>Quick reference of the NDB classes.</para>
+ </abstract>
+ </section>
+
+ <section>
+ <title>NDB Class Members</title>
+
+ <abstract>
+ <para>Quick reference for locating NDB class members.</para>
+ </abstract>
+ </section>
+
+ </section>
+
+ </chapter>
+
+ <chapter>
+ <title>TIPS, TRICKS, AND COMMON PROBLEMS</title>
+
+ <!-- <abstract> -->
+ <para> </para>
+ <!-- </abstract> -->
+
+ <section>
+ <title>Getting Started</title>
+
+ <abstract>
+ <para>Dicusses preparations for writing an NDB API
+ application.</para>
+ </abstract>
+ </section>
+
+ <section>
+ <title>Common Problems</title>
+
+ <abstract>
+ <para>Discusses some of the issues most often encountered when
+ trying to develop new NDB API applications, and offers
+ possible solutions to these.</para>
+ </abstract>
+ </section>
+
+ <section>
+ <title>Tips & Tricks</title>
+
+ <abstract>
+ <para>Performing common tasks using the NDB API classes;
+ optimising NDB API code.</para>
+ </abstract>
+ </section>
+
+ </chapter>
+
+ <chapter>
+ <title>The MySQL Cluster Management (MGM) API</title>
+
+ <abstract>
+ <para> Discusses the MySQL Cluster Management API, a C language
+ API that is used for administrative tasks such as starting and
+ stopping Cluster nodes, backups, and logging. Covers MGM
+ concepts, programming constructs, and event types.</para>
+ </abstract>
+
+ <section>
+ <title>MGM C API Function Listing</title>
+
+ <abstract>
+ <para>Covers the structures and functions used in the MGM API.
+ Listings grouped by purpose or use.</para>
+ </abstract>
+
+ <section>
+ <title>Working with Log Events</title>
+
+ <!-- <abstract> -->
+ <para> </para>
+ <!-- </abstract> -->
+ </section>
+
+ <section>
+ <title>Error-Handling Functions</title>
+
+ <!-- <abstract> -->
+ <para> </para>
+ <!-- </abstract> -->
+ </section>
+
+ <section>
+ <title>Creating & Destroying Management Server Handles</title>
+
+ <!-- <abstract> -->
+ <para> </para>
+ <!-- </abstract> -->
+ </section>
+
+ <section>
+ <title>Management Server Connections & Disconnections</title>
+
+ <!-- <abstract> -->
+ <para> </para>
+ <!-- </abstract> -->
+ </section>
+
+ <section>
+ <title>Cluster Status</title>
+
+ <!-- <abstract> -->
+ <para> </para>
+ <!-- </abstract> -->
+ </section>
+
+ <section>
+ <title>Starting & Stopping Nodes</title>
+
+ <!-- <abstract> -->
+ <para> </para>
+ <!-- </abstract> -->
+ </section>
+
+ <section>
+ <title>Functions for Controlling the Cluster Log</title>
+
+ <!-- <abstract> -->
+ <para> </para>
+ <!-- </abstract> -->
+ </section>
+
+ <section>
+ <title>Backup-Control Functions</title>
+
+ <!-- <abstract> -->
+ <para> </para>
+ <!-- </abstract> -->
+ </section>
+
+ <section>
+ <title>Single-User Mode Functions</title>
+
+ <!-- <abstract> -->
+ <para> </para>
+ <!-- </abstract> -->
+ </section>
+
+ </section>
+
+ <section>
+ <title>MGM Structure List</title>
+
+ <abstract>
+ <para>Covers the C structures available in the MGM API</para>
+ </abstract>
+
+ <section>
+ <title>The <literal>ndb_logevent</literal> Structure</title>
+
+ <abstract>
+ <para>Models a Cluster log event.</para>
+ </abstract>
+ </section>
+
+
+ <section>
+ <title>The <literal>ndb_mgm_node_state</literal> Structure</title>
+
+ <abstract>
+ <para>Provides information on the status of a Cluster
+ node.</para>
+ </abstract>
+ </section>
+
+ <section>
+ <title>The <literal>ndb_mgm_cluster_state</literal> Structure</title>
+
+ <abstract>
+ <para>Provides information on the status of the Cluster as a
+ whole.</para>
+ </abstract>
+ </section>
+
+ <section>
+ <title>The <literal>ndb_mgm_reply</literal> Structure</title>
+
+ <abstract>
+ <para>Contains response information from the management
+ server.</para>
+ </abstract>
+ </section>
+ </section>
+
+ </chapter>
+
+ <chapter>
+ <title>THE NDB CLASS HIERARCHY</title>
+
+ <abstract>
+ <para>This chapter provides a detailed listing of all NDB API
+ classes.</para>
+
+ <para>Each class listing includes: <itemizedlist>
+ <listitem>
+ <para> Description of the class' purpose in the API </para>
+ </listitem>
+
+ <listitem>
+ <para>Listing of all members, including descriptions of all
+ method parameters and enumerated class constants</para>
+ </listitem>
+
+ <listitem>
+ <para> One or more brief examples, showing the use of the
+ most important class members </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+
+ <para> The introductory section of the chapter includes a class
+ relationship diagram. </para>
+
+ </abstract>
+
+ <section>
+ <title>The <literal>Ndb</literal> Class</title>
+
+ <!-- <abstract> -->
+ <para> </para>
+ <!-- </abstract> -->
+
+ <section>
+ <title>The <literal>Ndb_cluster_connection</literal> Class</title>
+
+ <!-- <abstract> -->
+ <para> </para>
+ <!-- </abstract> -->
+ </section>
+
+ <section>
+ <title>The <literal>NdbDictionary</literal> Class</title>
+
+ <!-- <abstract> -->
+ <para> </para>
+ <!-- </abstract> -->
+
+ <section>
+ <title>The <literal>Dictionary</literal> Class</title>
+
+ <!-- <abstract> -->
+ <para> </para>
+ <!-- </abstract> -->
+
+ <section>
+ <title>The <literal>List</literal> Structure</title>
+
+ <!-- <abstract> -->
+ <para> </para>
+ <!-- </abstract> -->
+
+ <section>
+ <title>The <literal>Element</literal> Structure</title>
+
+ <!-- <abstract> -->
+ <para> </para>
+ <!-- </abstract> -->
+ </section>
+ </section>
+ </section>
+
+ <section>
+ <title>The <literal>Column</literal> Class</title>
+
+ <!-- <abstract> -->
+ <para> </para>
+ <!-- </abstract> -->
+ </section>
+
+ <section>
+ <title>The <literal>Datafile</literal> Class</title>
+
+ <!-- <abstract> -->
+ <para> </para>
+ <!-- </abstract> -->
+ </section>
+
+ <section>
+ <title>The <literal>Event</literal> Class</title>
+
+ <!-- <abstract> -->
+ <para> </para>
+ <!-- </abstract> -->
+ </section>
+
+ <section>
+ <title>The <literal>Index</literal> Class</title>
+
+ <!-- <abstract> -->
+ <para> </para>
+ <!-- </abstract> -->
+ </section>
+
+ <section>
+ <title>The <literal>LogfileGroup</literal> Class</title>
+
+ <!-- <abstract> -->
+ <para> </para>
+ <!-- </abstract> -->
+ </section>
+
+ <section>
+ <title>The <literal>Object</literal> Class</title>
+
+ <!-- <abstract> -->
+ <para> </para>
+ <!-- </abstract> -->
+
+ </section>
+
+ <section>
+ <title>The <literal>Table</literal> Class</title>
+
+ <!-- <abstract> -->
+ <para> </para>
+ <!-- </abstract> -->
+ </section>
+ </section>
+
+ <section>
+ <title>The <literal>Tablespace</literal> Class</title>
+
+ <!-- <abstract> -->
+ <para> </para>
+ <!-- </abstract> -->
+ </section>
+
+ <section>
+ <title>The <literal>Undofile</literal> Class</title>
+
+ <!-- <abstract> -->
+ <para> </para>
+ <!-- </abstract> -->
+ </section>
+
+ <section>
+ <title>The <literal>NdbOperation</literal> Class</title>
+
+ <!-- <abstract> -->
+ <para> </para>
+ <!-- </abstract> -->
+
+ <section>
+ <title>The <literal>NdbIndexOperation</literal> Class</title>
+
+ <!-- <abstract> -->
+ <para> </para>
+ <!-- </abstract> -->
+ </section>
+
+ <section>
+ <title>The <literal>NdbScanOperation</literal> Class</title>
+
+ <!-- <abstract> -->
+ <para> </para>
+ <!-- </abstract> -->
+
+ <section>
+ <title>The <literal>NdbIndexScanOperation</literal> Class</title>
+
+ <!-- <abstract> -->
+ <para> </para>
+ <!-- </abstract> -->
+ </section>
+
+ </section>
+
+ <section>
+ <title>The <literal>NdbEventOperation</literal> Class</title>
+
+ <!-- <abstract> -->
+ <para> </para>
+ <!-- </abstract> -->
+ </section>
+ </section>
+
+ <section>
+ <title>The <literal>NdbTransaction</literal> Class</title>
+
+ <!-- <abstract> -->
+ <para> </para>
+ <!-- </abstract> -->
+ </section>
+
+ <section>
+ <title>The <literal>NdbBlob</literal> Class</title>
+
+ <!-- <abstract> -->
+ <para> </para>
+ <!-- </abstract> -->
+ </section>
+
+ <section>
+ <title>The <literal>NdbRecAttr</literal> Class</title>
+
+ <!-- <abstract> -->
+ <para> </para>
+ <!-- </abstract> -->
+ </section>
+
+ <section>
+ <title>The <literal>NdbScanFilter</literal> Class</title>
+
+ <!-- <abstract> -->
+ <para> </para>
+ <!-- </abstract> -->
+ </section>
+
+ </section>
+
+ </chapter>
+
+ <chapter>
+ <title>ERRORS</title>
+
+ <abstract>
+ <para>Discusses reporting and handling of errors potentially
+ generated in NDB API applications.</para>
+ </abstract>
+
+ <section>
+ <title>The <literal>NdbError</literal> Structure</title>
+
+ <abstract>
+ <para>Contains status and other information about errors,
+ including error codes, classificaitons, and messages.</para>
+ </abstract>
+ </section>
+
+ <section>
+ <title>NDB Error Messages</title>
+
+ <abstract>
+ <para> Listing of common NDB error codes and messages, with
+ likely causes for which they might be raised.</para>
+ </abstract>
+ </section>
+
+ </chapter>
+
+ <chapter>
+ <title>PRACTICAL EXAMPLES</title>
+
+ <abstract>
+ <para>This section provides code examples illustrating how to
+ accomplish some basic tasks using the NDB API.</para>
+
+ <para> All of these examples can be compiled and run as provided,
+ and produce sample output to demonstrate their effects. </para>
+ </abstract>
+
+ <section>
+ <title>Using Synchronous Transactions</title>
+
+ <!-- <abstract> -->
+ <para> </para>
+ <!-- </abstract> -->
+ </section>
+
+ <section>
+ <title>Handling Errors and Retrying Transactions</title>
+
+ <!-- <abstract> -->
+ <para> </para>
+ <!-- </abstract> -->
+ </section>
+
+ <section>
+ <title>Basic Scanning Example</title>
+
+ <!-- <abstract> -->
+ <para> </para>
+ <!-- </abstract> -->
+ </section>
+
+ <section>
+ <title>Using Secondary Indexes in Scans</title>
+
+ <!-- <abstract> -->
+ <para> </para>
+ <!-- </abstract> -->
+ </section>
+
+ <section>
+ <title>NDB API Event Handling Example</title>
+
+ <!-- <abstract> -->
+ <para> </para>
+ <!-- </abstract> -->
+ </section>
+
+ </chapter>
+
+ <chapter>
+ <title>INDEX</title>
+
+ <abstract>
+ <para> Alphabetical Index of: terms; class, struct, and member
+ names; concepts. </para>
+ </abstract>
+ </chapter>
+
+</book>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r1899 - / ndbapi | jon | 22 Apr |
