MySQL Lists are EOL. Please join:

List:Commits« Previous MessageNext Message »
From:jon Date:November 1 2007 9:34am
Subject:svn commit - mysqldoc@docsrva: r8455 - trunk/ndbapi
View as plain text  
Author: jstephens
Date: 2007-11-01 10:34:51 +0100 (Thu, 01 Nov 2007)
New Revision: 8455

Log:

Forgot to commit one of the new section files.



Added:
   trunk/ndbapi/interface-ndbrecord.xml


Added: trunk/ndbapi/interface-ndbrecord.xml
===================================================================
--- trunk/ndbapi/interface-ndbrecord.xml	                        (rev 0)
+++ trunk/ndbapi/interface-ndbrecord.xml	2007-11-01 09:34:51 UTC (rev 8455)
Changed blocks: 1, Lines Added: 179, Lines Deleted: 0; 5854 bytes

@@ -0,0 +1,179 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
+[
+  <!ENTITY % all.entities SYSTEM "all-entities.ent">
+  %all.entities;
+]>
+
+<section id="interface-ndbrecord">
+
+    <title>The <literal>NdbRecord</literal> Interface</title>
+  
+  &mccge-warning-section;
+
+  <para>
+      <literal>NdbRecord</literal> is an interface which provides a
+      mapping to a full or a partial record stored in
+      <literal>NDB</literal>. In the latter case, it can be used in
+      conjunction with a bitmap to assist in access.
+      <literal>NdbRecord</literal> is available in &mccge-series;
+      releases beginning with MySQL 5.1.19-ndb-6.2.3.
+    </para>
+
+    <para>
+      <literal>NdbRecord</literal> has no API methods of its own; rather
+      it acts as a handle that can be passed between various method
+      calls for use in many different sorts of operations, including
+      these:
+
+      <itemizedlist>
+
+        <listitem>
+          <para>
+            Unique key reads and primary key reads
+          </para>
+        </listitem>
+
+        <listitem>
+          <para>
+            Table scans and index scans
+          </para>
+        </listitem>
+
+        <listitem>
+          <para>
+            DML operations involving unique keys or primary keys
+          </para>
+        </listitem>
+
+        <listitem>
+          <para>
+            Operations involving index bounds
+          </para>
+        </listitem>
+
+      </itemizedlist>
+
+      The same <literal>NdbRecord</literal> can be used simultaneously
+      in multiple operations, transactions, and threads.
+    </para>
+
+    <para>
+      An <literal>NdbRecord</literal> can be created in
+      <literal>NDB</literal> API programs by calling the
+      <literal>createRecord()</literal> method of the
+      <literal>NdbDictionary</literal> class. In addition, a number of
+      <literal>NDB</literal> API methods have additional declarations in
+      MySQL 5.1.19-ndb-6.2.3 and later &mccge-series; releases that
+      allow the programmer to leverage <literal>NdbRecord</literal>:
+
+      <itemizedlist>
+
+        <listitem>
+          <para>
+            <literal><link linkend="class-ndbscanoperation-nextresult">NdbScanOperation::nextResult()</link></literal>
+          </para>
+        </listitem>
+
+        <listitem>
+          <para>
+            <literal><link linkend="class-ndbscanoperation-lockcurrenttuple">NdbScanOperation::lockCurrentTuple()</link></literal>
+          </para>
+        </listitem>
+
+        <listitem>
+          <para>
+            <literal><link linkend="class-ndbscanoperation-updatecurrenttuple">NdbScanOperation::updateCurrentTuple()</link></literal>
+          </para>
+        </listitem>
+
+        <listitem>
+          <para>
+            <literal><link linkend="class-ndbscanoperation-deletecurrenttuple">NdbScanOperation::deleteCurrentTuple()</link></literal>
+          </para>
+        </listitem>
+
+        <listitem>
+          <para>
+            <literal><link linkend="class-dictionary-createrecord">Dictionary::createRecord()</link></literal>
+          </para>
+        </listitem>
+
+        <listitem>
+          <para>
+            <literal><link linkend="class-dictionary-releaserecord">Dictionary::releaseRecord()</link></literal>
+          </para>
+        </listitem>
+
+        <listitem>
+          <para>
+            <literal><link linkend="class-ndbtransaction-readtuple">NdbTransaction::readTuple()</link></literal>
+          </para>
+        </listitem>
+
+        <listitem>
+          <para>
+            <literal><link linkend="class-ndbtransaction-inserttuple">NdbTransaction::insertTuple()</link></literal>
+          </para>
+        </listitem>
+
+        <listitem>
+          <para>
+            <literal><link linkend="class-ndbtransaction-updatetuple">NdbTransaction::updateTuple()</link></literal>
+          </para>
+        </listitem>
+
+        <listitem>
+          <para>
+            <literal><link linkend="class-ndbtransaction-writetuple">NdbTransaction::writeTuple()</link></literal>
+          </para>
+        </listitem>
+
+        <listitem>
+          <para>
+            <literal><link linkend="class-ndbtransaction-deletetuple">NdbTransaction::deleteTuple()</link></literal>
+          </para>
+        </listitem>
+
+        <listitem>
+          <para>
+            <literal><link linkend="class-ndbtransaction-scantable">NdbTransaction::scanTable()</link></literal>
+          </para>
+        </listitem>
+
+        <listitem>
+          <para>
+            <literal><link linkend="class-ndbtransaction-scanindex">NdbTransaction::scanIndex()</link></literal>
+          </para>
+        </listitem>
+
+      </itemizedlist>
+
+      In addition, new members of
+      <literal>NdbIndexScanOperation</literal> and
+      <literal>NdbDictionary</literal> are introduced in MySQL
+      5.1.19-ndb-6.2.3 for use with <literal>NdbRecord</literal> scans:
+
+      <itemizedlist>
+
+        <listitem>
+          <para>
+            <literal>NdbIndexScanOperation::IndexBound</literal> is a
+            structure used to describe index scan bounds. See
+            <xref linkend="class-ndbindexscanoperation-indexbound"/>.
+          </para>
+        </listitem>
+
+        <listitem>
+          <para>
+            <literal>NdbDictionary::RecordSpecification</literal> is a
+            structure used to specify columns and range offsets. See
+            <xref linkend="class-ndbdictionary-recordspecification"/>.
+          </para>
+        </listitem>
+
+      </itemizedlist>
+    </para>
+
+  </section>
\ No newline at end of file


Thread
svn commit - mysqldoc@docsrva: r8455 - trunk/ndbapijon1 Nov