Author: mhillyer
Date: 2005-10-19 20:09:24 +0200 (Wed, 19 Oct 2005)
New Revision: 101
Log:
WIP for eric.
Added:
branches/MikePluggable/trunk/refman-5.1/images/pluggable-storage-overview.png
branches/MikePluggable/trunk/refman-5.1/pluggable-storage.xml
Modified:
branches/MikePluggable/trunk/refman-5.1/
branches/MikePluggable/trunk/refman-5.1/custom-engine.xml
branches/MikePluggable/trunk/refman-5.1/manual.xml
Property changes on: branches/MikePluggable/trunk/refman-5.1
___________________________________________________________________
Name: svn:ignore
+ *.bak
Modified: branches/MikePluggable/trunk/refman-5.1/custom-engine.xml
===================================================================
--- branches/MikePluggable/trunk/refman-5.1/custom-engine.xml 2005-10-19 17:24:47 UTC (rev 100)
+++ branches/MikePluggable/trunk/refman-5.1/custom-engine.xml 2005-10-19 18:09:24 UTC (rev 101)
@@ -10,15 +10,138 @@
%versions.entities;
]>
-<chapter id="writing-storage-engine">
+<chapter id="custom-engine">
<title>Writing a Custom Storage Engine</title>
- <section id="writing-storage-engine-introduction">
+ <section id="custom-engine-introduction">
<title>Introduction</title>
<para/>
</section>
+ <section id="custom-engine-api-reference">
+ <title>API Reference</title>
+
+ <refentry id="custom-engine-api-reference-close">
+ <refmeta>
+ <refentrytitle>close</refentrytitle>
+ </refmeta>
+
+ <refnamediv>
+ <refname>close</refname>
+ <refpurpose>Open the table</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>virtual int <function>close</function></funcdef>
+ <void/>
+ </funcprototype>
+
+ </funcsynopsis>
+ </refsynopsisdiv>
+
+ <refsection>
+ <title>Description</title>
+
+ <para>This is the <function>close</function> method.</para>
+ </refsection>
+
+ <refsection>
+ <title>Parameters</title>
+
+ <para>This function has no parameters.</para>
+ </refsection>
+
+ <refsection>
+ <title>Return Values</title>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ <literal>0</literal> - Table successfully closed.
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ </refsection>
+
+ <refsection>
+ <title>Usage</title>
+
+ <programlisting>
+ Put an example here.
+ </programlisting>
+ </refsection>
+
+ </refentry>
+
+
+ <refentry id="custom-engine-api-reference-open">
+ <refmeta>
+ <refentrytitle>open</refentrytitle>
+ </refmeta>
+
+ <refnamediv>
+ <refname>open</refname>
+ <refpurpose>Open the table</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>virtual int <function>open</function></funcdef>
+ <paramdef>const char <parameter>*name</parameter></paramdef>
+ <paramdef>int <parameter>mode</parameter></paramdef>
+ <paramdef>uint <parameter>test_if_locked</parameter></paramdef>
+ </funcprototype>
+
+ </funcsynopsis>
+ </refsynopsisdiv>
+
+ <refsection>
+ <title>Description</title>
+
+ <para>This is the <function>open</function> method.</para>
+ </refsection>
+
+ <refsection>
+ <title>Parameters</title>
+
+ <itemizedlist>
+ <listitem><para><literal>name</literal> - The name of the
+ table to open.</para></listitem>
+ </itemizedlist>
+
+ </refsection>
+
+ <refsection>
+ <title>Return Values</title>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ <literal>0</literal> - Table successfully opened.
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ </refsection>
+
+ <refsection>
+ <title>Usage</title>
+
+ <programlisting>
+ Put an example here.
+ </programlisting>
+ </refsection>
+
+ </refentry>
+
+ </section>
+
+
</chapter>
<!-- END WRITING A CUSTOM STORAGE ENGINE -->
Added: branches/MikePluggable/trunk/refman-5.1/images/pluggable-storage-overview.png
===================================================================
(Binary files differ)
Property changes on: branches/MikePluggable/trunk/refman-5.1/images/pluggable-storage-overview.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Modified: branches/MikePluggable/trunk/refman-5.1/manual.xml
===================================================================
--- branches/MikePluggable/trunk/refman-5.1/manual.xml 2005-10-19 17:24:47 UTC (rev 100)
+++ branches/MikePluggable/trunk/refman-5.1/manual.xml 2005-10-19 18:09:24 UTC (rev 101)
@@ -41,8 +41,12 @@
<xi:include href="sql-syntax.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+ <xi:include href="pluggable-storage.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+
<xi:include href="storage-engines.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+ <xi:include href="custom-engine.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+
<xi:include href="ndbcluster.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="partitioning.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
Added: branches/MikePluggable/trunk/refman-5.1/pluggable-storage.xml
===================================================================
--- branches/MikePluggable/trunk/refman-5.1/pluggable-storage.xml 2005-10-19 17:24:47 UTC (rev 100)
+++ branches/MikePluggable/trunk/refman-5.1/pluggable-storage.xml 2005-10-19 18:09:24 UTC (rev 101)
@@ -0,0 +1,98 @@
+<?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"
+[
+ <!ENTITY % fixedchars.entities SYSTEM "../refman-common/fixedchars.ent">
+ %fixedchars.entities;
+ <!ENTITY % title.entities SYSTEM "../refman-common/titles.en.ent">
+ %title.entities;
+ <!ENTITY % versions.entities SYSTEM "versions.ent">
+ %versions.entities;
+ ]>
+
+ <chapter id="pluggable-storage">
+ <title>MySQL Pluggable Storage Engine Architecture</title>
+
+ <section id="pluggable-storage-introduction">
+ <title>Introduction</title>
+
+ <para>With MySQL 5.1, MySQL AB has introduced a new pluggable
+ storage engine architecture that allows storage engines to be
+ loaded into a running MySQL server.</para>
+ </section>
+
+ <section id="pluggable-storage-overview">
+ <title>Overview of the MySQL Pluggable Storage Engine Architecture</title>
+
+ <para>The MySQL pluggable storage engine architecture allows a database professional to select a
+ specialized storage engine for a particular application need while being completely shielded from
+ the need to manage any specific application coding requirements. The MySQL server architecture
+ isolates the application programmer and DBA from all of the low-level implementation details
+ at the storage level providing a consistent and easy application model and API. So while there
+ are different capabilities across different storage engines, the application is shielded from these.</para>
+
+ <para>Graphically depicted, the MySQL pluggable storage engine
+ architecture looks like the following:</para>
+
+ <figure>
+ <title>The MySQL pluggable storage engine architecture</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/pluggable-storage-overview.png" format="PNG" lang="en"/>
+ </imageobject>
+ <textobject>
+ <phrase lang="en">The MySQL pluggable storage engine
+ architecture</phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
+
+ <para>The pluggable storage engine architecture provides a standard set of management and support
+ services that are common among all underlying storage engines. The storage engines themselves are
+ the components of the database server that actually perform actions on the underlying data that is
+ maintained at the physical server level.</para>
+
+ <para>This efficient and modular architecture provides huge benefits for those wishing to specifically
+ target a particular application need – such as data warehousing, transaction processing, high availability
+ situations, etc. – while enjoying the advantage of utilizing a set of interfaces and services that are
+ independent of any one storage engine.</para>
+
+ <para>The application programmer and DBA interact with the MySQL database through Connector APIs and
+ service layers that are above the storage engines. If application changes bring about requirements
+ that demand the underlying storage engine change, or that one or more additional storage engines be
+ added to support new needs, no significant coding or process changes are required to make things work.
+ The MySQL server architecture shields the application from the underlying complexity of the storage
+ engine by presenting a consistent and easy to use API that applies across storage engines.
+ </para>
+
+ </section>
+
+ <section id="pluggable-storage-assigning">
+ <title>Assigning Storage Engines to Tables</title>
+
+ <para/>
+ </section>
+
+ <section id="pluggable-storage-transactions">
+ <title>Storage Engines and Transactions</title>
+ <para/>
+ </section>
+
+ <section id="pluggable-storage-plugging">
+ <title>Plugging in a Storage Engine</title>
+ <para/>
+ </section>
+
+ <section id="pluggable-storage-unplugging">
+ <title>Unplugging a Storage Engine</title>
+ <para/>
+ </section>
+
+ <section id="pluggable-storage-security">
+ <title>Security Implications of Pluggable Storage</title>
+ <para/>
+ </section>
+
+ </chapter>
+
+ <!-- END PLUGGABLE STORAGE -->
\ No newline at end of file
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r101 - in branches/MikePluggable/trunk/refman-5.1: . images | mhillyer | 19 Oct |
