| List: | Commits | « Previous MessageNext Message » | |
| From: | jon | Date: | April 24 2006 2:00pm |
| Subject: | svn commit - mysqldoc@docsrva: r1912 - trunk/ndbapi | ||
| View as plain text | |||
Author: jstephens Date: 2006-04-24 14:00:15 +0200 (Mon, 24 Apr 2006) New Revision: 1912 Log: Split off chapters into files. Updated Makefile. Added: trunk/ndbapi/errors.xml trunk/ndbapi/examples.xml trunk/ndbapi/mgm-api.xml trunk/ndbapi/ndb-classes.xml trunk/ndbapi/overview.xml trunk/ndbapi/tips-tricks-problems.xml Modified: trunk/ndbapi/Makefile trunk/ndbapi/ndbapi.xml Modified: trunk/ndbapi/Makefile =================================================================== --- trunk/ndbapi/Makefile 2006-04-24 11:09:34 UTC (rev 1911) +++ trunk/ndbapi/Makefile 2006-04-24 12:00:15 UTC (rev 1912) @@ -39,7 +39,7 @@ # Dependency list for MySQL User Guide document # This variable is updated by "make depend" -NDBAPI_SRCS = $(NDBAPI_SRCS_EXTRA) ndbapi.xml +NDBAPI_SRCS = $(NDBAPI_SRCS_EXTRA) ndbapi.xml overview.xml tips-tricks-problems.xml mgm-api.xml ndb-classes.xml errors.xml examples.xml ndbapi-prepped.xml: $(NDBAPI_SRCS) Added: trunk/ndbapi/errors.xml =================================================================== --- trunk/ndbapi/errors.xml (rev 0) +++ trunk/ndbapi/errors.xml 2006-04-24 12:00:15 UTC (rev 1912) @@ -0,0 +1,30 @@ +<?xml version="1.0" encoding="utf-8"?> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" +"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"> +<chapter id="errors"> + <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> \ No newline at end of file Added: trunk/ndbapi/examples.xml =================================================================== --- trunk/ndbapi/examples.xml (rev 0) +++ trunk/ndbapi/examples.xml 2006-04-24 12:00:15 UTC (rev 1912) @@ -0,0 +1,55 @@ +<?xml version="1.0" encoding="utf-8"?> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" +"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"> +<chapter id="examples"> + <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> \ No newline at end of file Added: trunk/ndbapi/mgm-api.xml =================================================================== --- trunk/ndbapi/mgm-api.xml (rev 0) +++ trunk/ndbapi/mgm-api.xml 2006-04-24 12:00:15 UTC (rev 1912) @@ -0,0 +1,140 @@ +<?xml version="1.0" encoding="utf-8"?> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" +"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"> +<chapter id="mgm-api"> + <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> \ No newline at end of file Added: trunk/ndbapi/ndb-classes.xml =================================================================== --- trunk/ndbapi/ndb-classes.xml (rev 0) +++ trunk/ndbapi/ndb-classes.xml 2006-04-24 12:00:15 UTC (rev 1912) @@ -0,0 +1,228 @@ +<?xml version="1.0" encoding="utf-8"?> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" +"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"> +<chapter id="ndb-classes"> + <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> \ No newline at end of file Modified: trunk/ndbapi/ndbapi.xml =================================================================== --- trunk/ndbapi/ndbapi.xml 2006-04-24 11:09:34 UTC (rev 1911) +++ trunk/ndbapi/ndbapi.xml 2006-04-24 12:00:15 UTC (rev 1912) @@ -5,6 +5,9 @@ <!ENTITY title " MySQL® NDB API DEVELOPERS' GUIDE"> <!ENTITY subtitle "VERSION &version; (<?dbtimestamp format='Y-m-d'?>)"> <!ENTITY version "2.0"> + + <!ENTITY copy "©"> + <!ENTITY reg "®"> ]> <book id="ndb-api" revision="2.0"> <title>&title;</title> @@ -68,579 +71,18 @@ </bookinfo> - <chapter> - <title>OVERVIEW AND CONCEPTS</title> + <xi:include href="overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> - <abstract> - <para>This chapter provides a general overview of essential MySQL - Cluster and NDB API concepts, terminology, and programming - constructs.</para> - </abstract> + <xi:include href="tips-tricks-problems.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> - <section> - <title>Introduction</title> + <xi:include href="mgm-api.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> - <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> + <xi:include href="ndb-classes.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> - <section> - <title>Terminology</title> + <xi:include href="errors.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> - <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> + <xi:include href="examples.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> + + <index/> - <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> Added: trunk/ndbapi/overview.xml =================================================================== --- trunk/ndbapi/overview.xml (rev 0) +++ trunk/ndbapi/overview.xml 2006-04-24 12:00:15 UTC (rev 1912) @@ -0,0 +1,86 @@ +<?xml version="1.0" encoding="utf-8"?> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" +"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"> +<chapter id="overview"> + <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> \ No newline at end of file Added: trunk/ndbapi/tips-tricks-problems.xml =================================================================== --- trunk/ndbapi/tips-tricks-problems.xml (rev 0) +++ trunk/ndbapi/tips-tricks-problems.xml 2006-04-24 12:00:15 UTC (rev 1912) @@ -0,0 +1,39 @@ +<?xml version="1.0" encoding="utf-8"?> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" +"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"> +<chapter id="tips-tricks-problems"> + <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> \ No newline at end of file
| Thread | ||
|---|---|---|
| • svn commit - mysqldoc@docsrva: r1912 - trunk/ndbapi | jon | 24 Apr |
© 1995-2008 MySQL AB, 2008-2009 Sun Microsystems, Inc.
Page generated in 0.915 sec. using MySQL 5.1.14-beta-log