List:Commits« Previous MessageNext Message »
From:paul Date:January 12 2006 6:18pm
Subject:svn commit - mysqldoc@docsrva: r778 - in trunk: . refman-4.1 refman-5.0 refman-5.1
View as plain text  
Author: paul
Date: 2006-01-12 19:18:57 +0100 (Thu, 12 Jan 2006)
New Revision: 778

Log:
 r6113@frost:  paul | 2006-01-12 11:58:45 -0600
 Make references to TYPE as synonym for ENGINE more consistent.


Modified:
   trunk/
   trunk/refman-4.1/innodb.xml
   trunk/refman-4.1/storage-engines.xml
   trunk/refman-5.0/innodb.xml
   trunk/refman-5.0/storage-engines.xml
   trunk/refman-5.1/innodb.xml
   trunk/refman-5.1/storage-engines.xml


Property changes on: trunk
___________________________________________________________________
Name: svk:merge
   - b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:6112
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:2101
   + b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:6113
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:2101

Modified: trunk/refman-4.1/innodb.xml
===================================================================
--- trunk/refman-4.1/innodb.xml	2006-01-12 18:18:44 UTC (rev 777)
+++ trunk/refman-4.1/innodb.xml	2006-01-12 18:18:57 UTC (rev 778)
@@ -1870,17 +1870,23 @@
 
     <para>
       To create an <literal>InnoDB</literal> table, you must specify an
-      <literal>ENGINE = InnoDB</literal> option (or <literal>TYPE =
-      InnoDB</literal>, but this is deprecated) in the <literal>CREATE
+      <literal>ENGINE = InnoDB</literal> option
+in the <literal>CREATE
       TABLE</literal> statement:
     </para>
 
 <programlisting>
 CREATE TABLE customers (a INT, b CHAR (20), INDEX (a)) ENGINE=InnoDB;
-CREATE TABLE customers (a INT, b CHAR (20), INDEX (a)) TYPE=InnoDB;
 </programlisting>
 
     <para>
+      The older term <literal>TYPE</literal> is supported as a synonym
+      for <literal>ENGINE</literal> for backward compatibility, but
+      <literal>ENGINE</literal> is the preferred term and
+      <literal>TYPE</literal> is deprecated.
+    </para>
+
+    <para>
       The statement creates a table and an index on column
       <literal>a</literal> in the <literal>InnoDB</literal> tablespace
       that consists of the data files that you specified in

Modified: trunk/refman-4.1/storage-engines.xml
===================================================================
--- trunk/refman-4.1/storage-engines.xml	2006-01-12 18:18:44 UTC (rev 777)
+++ trunk/refman-4.1/storage-engines.xml	2006-01-12 18:18:57 UTC (rev 778)
@@ -250,11 +250,20 @@
 CREATE TABLE t (i INT) TYPE = MEMORY;
 </programlisting>
 
+  <remark role="note">
+    A paragraph similar to the following one also appears in sections
+    for individual storage engines, but only for those in existence at
+    the time of the switch from TYPE to ENGINE (MySQL 4.0.18). For newer
+    engines, the paragraph does not appear; there is no reason to give
+    people an encouragement to use TYPE.
+  </remark>
+
   <para>
     <literal>ENGINE</literal> is the preferred term, but cannot be used
     before MySQL 4.0.18. <literal>TYPE</literal> is available beginning
     with MySQL 3.23.0, the first version of MySQL for which multiple
-    storage engines were available.
+    storage engines were available. <literal>TYPE</literal> is supported
+    for backward compatibility but is deprecated.
   </para>
 
   <para>
@@ -463,16 +472,22 @@
 
     <para>
       To specify explicitly that you want a <literal>MyISAM</literal>
-      table, indicate that with an <literal>ENGINE</literal> or
-      <literal>TYPE</literal> table option:
+      table, indicate that with an <literal>ENGINE</literal> table
+      option:
     </para>
 
 <programlisting>
 CREATE TABLE t (i INT) ENGINE = MYISAM;
-CREATE TABLE t (i INT) TYPE = MYISAM;
 </programlisting>
 
     <para>
+      The older term <literal>TYPE</literal> is supported as a synonym
+      for <literal>ENGINE</literal> for backward compatibility, but
+      <literal>ENGINE</literal> is the preferred term from MySQL 4.0.18
+      on and <literal>TYPE</literal> is deprecated.
+    </para>
+
+    <para>
       Normally, the <literal>ENGINE</literal> or <literal>TYPE</literal>
       option is unnecessary; <literal>MyISAM</literal> is the default
       storage engine unless the default has been changed.
@@ -1563,6 +1578,7 @@
     </section>
 
   </section>
+
   <xi:include href="innodb.xml"  xmlns:xi="http://www.w3.org/2001/XInclude"/>
 
   <section id="merge-storage-engine">
@@ -1675,19 +1691,26 @@
 <programlisting>
 mysql&gt; <userinput>CREATE TABLE t1 (</userinput>
     -&gt;    <userinput>a INT NOT NULL AUTO_INCREMENT PRIMARY KEY,</userinput>
-    -&gt;    <userinput>message CHAR(20));</userinput>
+    -&gt;    <userinput>message CHAR(20)) ENGINE=MyISAM;</userinput>
 mysql&gt; <userinput>CREATE TABLE t2 (</userinput>
     -&gt;    <userinput>a INT NOT NULL AUTO_INCREMENT PRIMARY KEY,</userinput>
-    -&gt;    <userinput>message CHAR(20));</userinput>
+    -&gt;    <userinput>message CHAR(20)) ENGINE=MyISAM;</userinput>
 mysql&gt; <userinput>INSERT INTO t1 (message) VALUES ('Testing'),('table'),('t1');</userinput>
 mysql&gt; <userinput>INSERT INTO t2 (message) VALUES ('Testing'),('table'),('t2');</userinput>
 mysql&gt; <userinput>CREATE TABLE total (</userinput>
     -&gt;    <userinput>a INT NOT NULL AUTO_INCREMENT,</userinput>
     -&gt;    <userinput>message CHAR(20), INDEX(a))</userinput>
-    -&gt;    <userinput>TYPE=MERGE UNION=(t1,t2) INSERT_METHOD=LAST;</userinput>
+    -&gt;    <userinput>ENGINE=MERGE UNION=(t1,t2) INSERT_METHOD=LAST;</userinput>
 </programlisting>
 
     <para>
+      The older term <literal>TYPE</literal> is supported as a synonym
+      for <literal>ENGINE</literal> for backward compatibility, but
+      <literal>ENGINE</literal> is the preferred term from MySQL 4.0.18
+      on and <literal>TYPE</literal> is deprecated.
+    </para>
+
+    <para>
       Note that the <literal>a</literal> column is indexed in the
       <literal>MERGE</literal> table, but is not declared as a
       <literal>PRIMARY KEY</literal> as it is in the underlying
@@ -2115,16 +2138,22 @@
 
     <para>
       To specify explicitly that you want a <literal>MEMORY</literal>
-      table, indicate that with an <literal>ENGINE</literal> or
-      <literal>TYPE</literal> table option:
+      table, indicate that with an <literal>ENGINE</literal> table
+      option:
     </para>
 
 <programlisting>
 CREATE TABLE t (i INT) ENGINE = MEMORY;
-CREATE TABLE t (i INT) TYPE = HEAP;
 </programlisting>
 
     <para>
+      The older term <literal>TYPE</literal> is supported as a synonym
+      for <literal>ENGINE</literal> for backward compatibility, but
+      <literal>ENGINE</literal> is the preferred term from MySQL 4.0.18
+      on and <literal>TYPE</literal> is deprecated.
+    </para>
+
+    <para>
       As indicated by their name, <literal>MEMORY</literal> tables are
       stored in memory and use hash indexes by default. This makes them
       very fast, and very useful for creating temporary tables. However,
@@ -2824,19 +2853,25 @@
 
       <para>
         To specify explicitly that you want a <literal>BDB</literal>
-        table, indicate that with an <literal>ENGINE</literal> or
-        <literal>TYPE</literal> table option:
+        table, indicate that with an <literal>ENGINE</literal> table
+        option:
       </para>
 
 <programlisting>
 CREATE TABLE t (i INT) ENGINE = BDB;
-CREATE TABLE t (i INT) TYPE = BDB;
 </programlisting>
 
       <para>
+        The older term <literal>TYPE</literal> is supported as a synonym
+        for <literal>ENGINE</literal> for backward compatibility, but
+        <literal>ENGINE</literal> is the preferred term from MySQL
+        4.0.18 on and <literal>TYPE</literal> is deprecated.
+      </para>
+
+      <para>
         <literal>BerkeleyDB</literal> is a synonym for
-        <literal>BDB</literal> in the <literal>ENGINE</literal> or
-        <literal>TYPE</literal> option.
+        <literal>BDB</literal> in the <literal>ENGINE</literal> table
+        option.
       </para>
 
       <para>

Modified: trunk/refman-5.0/innodb.xml
===================================================================
--- trunk/refman-5.0/innodb.xml	2006-01-12 18:18:44 UTC (rev 777)
+++ trunk/refman-5.0/innodb.xml	2006-01-12 18:18:57 UTC (rev 778)
@@ -1920,17 +1920,23 @@
 
     <para>
       To create an <literal>InnoDB</literal> table, you must specify an
-      <literal>ENGINE = InnoDB</literal> option (or <literal>TYPE =
-      InnoDB</literal>, but this is deprecated) in the <literal>CREATE
+      <literal>ENGINE = InnoDB</literal> option
+in the <literal>CREATE
       TABLE</literal> statement:
     </para>
 
 <programlisting>
 CREATE TABLE customers (a INT, b CHAR (20), INDEX (a)) ENGINE=InnoDB;
-CREATE TABLE customers (a INT, b CHAR (20), INDEX (a)) TYPE=InnoDB;
 </programlisting>
 
     <para>
+      The older term <literal>TYPE</literal> is supported as a synonym
+      for <literal>ENGINE</literal> for backward compatibility, but
+      <literal>ENGINE</literal> is the preferred term and
+      <literal>TYPE</literal> is deprecated.
+    </para>
+
+    <para>
       The statement creates a table and an index on column
       <literal>a</literal> in the <literal>InnoDB</literal> tablespace
       that consists of the data files that you specified in

Modified: trunk/refman-5.0/storage-engines.xml
===================================================================
--- trunk/refman-5.0/storage-engines.xml	2006-01-12 18:18:44 UTC (rev 777)
+++ trunk/refman-5.0/storage-engines.xml	2006-01-12 18:18:57 UTC (rev 778)
@@ -269,10 +269,19 @@
 CREATE TABLE t (i INT) TYPE = MEMORY;
 </programlisting>
 
+  <remark role="note">
+    The following paragraph also appears in sections for individual
+    storage engines, but only for those in existence at the time of the
+    switch from TYPE to ENGINE (MySQL 4.0.18). For newer engines, the
+    paragraph does not appear; there is no reason to give people an
+    encouragement to use TYPE.
+  </remark>
+
   <para>
-    Although <literal>TYPE</literal> is still supported in MySQL
-    &current-series;, <literal>ENGINE</literal> is now the preferred
-    term.
+    The older term <literal>TYPE</literal> is supported as a synonym for
+    <literal>ENGINE</literal> for backward compatibility, but
+    <literal>ENGINE</literal> is the preferred term and
+    <literal>TYPE</literal> is deprecated.
   </para>
 
   <para>
@@ -488,12 +497,10 @@
 </programlisting>
 
     <para>
-      (<emphasis role="bold">Note</emphasis>: Older versions of MySQL
-      used <literal>TYPE</literal> rather than <literal>ENGINE</literal>
-      (for example: <literal>TYPE = MYISAM</literal>). MySQL
-      &current-series; supports this syntax for backward compatibility
-      but <literal>TYPE</literal> is now deprecated and
-      <literal>ENGINE</literal> is the preferred usage.)
+      The older term <literal>TYPE</literal> is supported as a synonym
+      for <literal>ENGINE</literal> for backward compatibility, but
+      <literal>ENGINE</literal> is the preferred term and
+      <literal>TYPE</literal> is deprecated.
     </para>
 
     <para>
@@ -1694,10 +1701,10 @@
 <programlisting>
 mysql&gt; <userinput>CREATE TABLE t1 (</userinput>
     -&gt;    <userinput>a INT NOT NULL AUTO_INCREMENT PRIMARY KEY,</userinput>
-    -&gt;    <userinput>message CHAR(20));</userinput>
+    -&gt;    <userinput>message CHAR(20)) ENGINE=MyISAM;</userinput>
 mysql&gt; <userinput>CREATE TABLE t2 (</userinput>
     -&gt;    <userinput>a INT NOT NULL AUTO_INCREMENT PRIMARY KEY,</userinput>
-    -&gt;    <userinput>message CHAR(20));</userinput>
+    -&gt;    <userinput>message CHAR(20)) ENGINE=MyISAM;</userinput>
 mysql&gt; <userinput>INSERT INTO t1 (message) VALUES ('Testing'),('table'),('t1');</userinput>
 mysql&gt; <userinput>INSERT INTO t2 (message) VALUES ('Testing'),('table'),('t2');</userinput>
 mysql&gt; <userinput>CREATE TABLE total (</userinput>
@@ -1707,6 +1714,13 @@
 </programlisting>
 
     <para>
+      The older term <literal>TYPE</literal> is supported as a synonym
+      for <literal>ENGINE</literal> for backward compatibility, but
+      <literal>ENGINE</literal> is the preferred term and
+      <literal>TYPE</literal> is deprecated.
+    </para>
+
+    <para>
       Note that the <literal>a</literal> column is indexed in the
       <literal>MERGE</literal> table, but is not declared as a
       <literal>PRIMARY KEY</literal> as it is in the underlying
@@ -2118,6 +2132,13 @@
 </programlisting>
 
     <para>
+      The older term <literal>TYPE</literal> is supported as a synonym
+      for <literal>ENGINE</literal> for backward compatibility, but
+      <literal>ENGINE</literal> is the preferred term and
+      <literal>TYPE</literal> is deprecated.
+    </para>
+
+    <para>
       As indicated by their name, <literal>MEMORY</literal> tables are
       stored in memory and use hash indexes by default. This makes them
       very fast, and very useful for creating temporary tables. However,
@@ -2817,19 +2838,25 @@
 
       <para>
         To specify explicitly that you want a <literal>BDB</literal>
-        table, indicate that with an <literal>ENGINE</literal> or
-        <literal>TYPE</literal> table option:
+        table, indicate that with an <literal>ENGINE</literal> table
+        option:
       </para>
 
 <programlisting>
 CREATE TABLE t (i INT) ENGINE = BDB;
-CREATE TABLE t (i INT) TYPE = BDB;
 </programlisting>
 
       <para>
+        The older term <literal>TYPE</literal> is supported as a synonym
+        for <literal>ENGINE</literal> for backward compatibility, but
+        <literal>ENGINE</literal> is the preferred term and
+        <literal>TYPE</literal> is deprecated.
+      </para>
+
+      <para>
         <literal>BerkeleyDB</literal> is a synonym for
-        <literal>BDB</literal> in the <literal>ENGINE</literal> or
-        <literal>TYPE</literal> option.
+        <literal>BDB</literal> in the <literal>ENGINE</literal> table
+        option.
       </para>
 
       <para>

Modified: trunk/refman-5.1/innodb.xml
===================================================================
--- trunk/refman-5.1/innodb.xml	2006-01-12 18:18:44 UTC (rev 777)
+++ trunk/refman-5.1/innodb.xml	2006-01-12 18:18:57 UTC (rev 778)
@@ -1896,17 +1896,23 @@
 
     <para>
       To create an <literal>InnoDB</literal> table, you must specify an
-      <literal>ENGINE = InnoDB</literal> option (or <literal>TYPE =
-      InnoDB</literal>, but this is deprecated) in the <literal>CREATE
+      <literal>ENGINE = InnoDB</literal> option
+in the <literal>CREATE
       TABLE</literal> statement:
     </para>
 
 <programlisting>
 CREATE TABLE customers (a INT, b CHAR (20), INDEX (a)) ENGINE=InnoDB;
-CREATE TABLE customers (a INT, b CHAR (20), INDEX (a)) TYPE=InnoDB;
 </programlisting>
 
     <para>
+      The older term <literal>TYPE</literal> is supported as a synonym
+      for <literal>ENGINE</literal> for backward compatibility, but
+      <literal>ENGINE</literal> is the preferred term and
+      <literal>TYPE</literal> is deprecated.
+    </para>
+
+    <para>
       The statement creates a table and an index on column
       <literal>a</literal> in the <literal>InnoDB</literal> tablespace
       that consists of the data files that you specified in

Modified: trunk/refman-5.1/storage-engines.xml
===================================================================
--- trunk/refman-5.1/storage-engines.xml	2006-01-12 18:18:44 UTC (rev 777)
+++ trunk/refman-5.1/storage-engines.xml	2006-01-12 18:18:57 UTC (rev 778)
@@ -273,10 +273,19 @@
 CREATE TABLE t (i INT) TYPE = MEMORY;
 </programlisting>
 
+  <remark role="note">
+    The following paragraph also appears in sections for individual
+    storage engines, but only for those in existence at the time of the
+    switch from TYPE to ENGINE (MySQL 4.0.18). For newer engines, the
+    paragraph does not appear; there is no reason to give people an
+    encouragement to use TYPE.
+  </remark>
+
   <para>
-    Although <literal>TYPE</literal> is still supported in MySQL
-    &current-series;, <literal>ENGINE</literal> is now the preferred
-    term.
+    The older term <literal>TYPE</literal> is supported as a synonym for
+    <literal>ENGINE</literal> for backward compatibility, but
+    <literal>ENGINE</literal> is the preferred term and
+    <literal>TYPE</literal> is deprecated.
   </para>
 
   <para>
@@ -492,12 +501,10 @@
 </programlisting>
 
     <para>
-      (<emphasis role="bold">Note</emphasis>: Older versions of MySQL
-      used <literal>TYPE</literal> rather than <literal>ENGINE</literal>
-      (for example: <literal>TYPE = MYISAM</literal>). MySQL
-      &current-series; supports this syntax for backward compatibility
-      but <literal>TYPE</literal> is now deprecated and
-      <literal>ENGINE</literal> is the preferred usage.)
+      The older term <literal>TYPE</literal> is supported as a synonym
+      for <literal>ENGINE</literal> for backward compatibility, but
+      <literal>ENGINE</literal> is the preferred term and
+      <literal>TYPE</literal> is deprecated.
     </para>
 
     <para>
@@ -1694,10 +1701,10 @@
 <programlisting>
 mysql&gt; <userinput>CREATE TABLE t1 (</userinput>
     -&gt;    <userinput>a INT NOT NULL AUTO_INCREMENT PRIMARY KEY,</userinput>
-    -&gt;    <userinput>message CHAR(20));</userinput>
+    -&gt;    <userinput>message CHAR(20)) ENGINE=MyISAM;</userinput>
 mysql&gt; <userinput>CREATE TABLE t2 (</userinput>
     -&gt;    <userinput>a INT NOT NULL AUTO_INCREMENT PRIMARY KEY,</userinput>
-    -&gt;    <userinput>message CHAR(20));</userinput>
+    -&gt;    <userinput>message CHAR(20)) ENGINE=MyISAM;</userinput>
 mysql&gt; <userinput>INSERT INTO t1 (message) VALUES ('Testing'),('table'),('t1');</userinput>
 mysql&gt; <userinput>INSERT INTO t2 (message) VALUES ('Testing'),('table'),('t2');</userinput>
 mysql&gt; <userinput>CREATE TABLE total (</userinput>
@@ -1707,6 +1714,13 @@
 </programlisting>
 
     <para>
+      The older term <literal>TYPE</literal> is supported as a synonym
+      for <literal>ENGINE</literal> for backward compatibility, but
+      <literal>ENGINE</literal> is the preferred term and
+      <literal>TYPE</literal> is deprecated.
+    </para>
+
+    <para>
       Note that the <literal>a</literal> column is indexed in the
       <literal>MERGE</literal> table, but is not declared as a
       <literal>PRIMARY KEY</literal> as it is in the underlying
@@ -2118,6 +2132,13 @@
 </programlisting>
 
     <para>
+      The older term <literal>TYPE</literal> is supported as a synonym
+      for <literal>ENGINE</literal> for backward compatibility, but
+      <literal>ENGINE</literal> is the preferred term and
+      <literal>TYPE</literal> is deprecated.
+    </para>
+
+    <para>
       As indicated by their name, <literal>MEMORY</literal> tables are
       stored in memory and use hash indexes by default. This makes them
       very fast, and very useful for creating temporary tables. However,
@@ -2843,19 +2864,25 @@
 
       <para>
         To specify explicitly that you want a <literal>BDB</literal>
-        table, indicate that with an <literal>ENGINE</literal> or
-        <literal>TYPE</literal> table option:
+        table, indicate that with an <literal>ENGINE</literal> table
+        option:
       </para>
 
 <programlisting>
 CREATE TABLE t (i INT) ENGINE = BDB;
-CREATE TABLE t (i INT) TYPE = BDB;
 </programlisting>
 
       <para>
+        The older term <literal>TYPE</literal> is supported as a synonym
+        for <literal>ENGINE</literal> for backward compatibility, but
+        <literal>ENGINE</literal> is the preferred term and
+        <literal>TYPE</literal> is deprecated.
+      </para>
+
+      <para>
         <literal>BerkeleyDB</literal> is a synonym for
-        <literal>BDB</literal> in the <literal>ENGINE</literal> or
-        <literal>TYPE</literal> option.
+        <literal>BDB</literal> in the <literal>ENGINE</literal> table
+        option.
       </para>
 
       <para>

Thread
svn commit - mysqldoc@docsrva: r778 - in trunk: . refman-4.1 refman-5.0 refman-5.1paul12 Jan