Author: mhillyer
Date: 2006-02-14 01:09:54 +0100 (Tue, 14 Feb 2006)
New Revision: 1304
Log:
Update table editor documentation for query browser and MySQL Administrator.
Also pushing change to sakila sample DB changelog.
Modified:
trunk/gui-common/chapter-table-editor.xml
trunk/gui-common/images/columneditor.png
trunk/gui-common/images/confirmchanges.png
trunk/gui-common/images/indexeditor.png
trunk/gui-common/images/tableeditor.png
trunk/sample-data/sakila/changelog.xml
Modified: trunk/gui-common/chapter-table-editor.xml
===================================================================
--- trunk/gui-common/chapter-table-editor.xml 2006-02-13 21:27:06 UTC (rev 1303)
+++ trunk/gui-common/chapter-table-editor.xml 2006-02-14 00:09:54 UTC (rev 1304)
@@ -15,8 +15,8 @@
<para>
The &table_editor; is a component of both the &query_browser; and
- &administrator;, and allows for the visual creation and
- modification of tables.
+ &administrator;, enabling the visual creation and modification of
+ tables.
</para>
<para>
@@ -50,8 +50,8 @@
</para>
<para>
- Regardless of the tab you have active, you can always edit the
- table name, the database it belongs to, and the table comment.
+ Regardless of the active tab, you can always edit the table name
+ and the table comment.
</para>
<figure>
@@ -84,17 +84,17 @@
<listitem>
<para>
<emphasis>Table Options:</emphasis>Use the Table Options tab
- to choose the storage engine used by the table and the table's
- default character set.
+ to choose the storage engine and default character set used by
+ the table.
</para>
</listitem>
<listitem>
<para>
<emphasis>Advanced Options:</emphasis> Use the Advanced
- Options tab to configure advanced options such as per-table
- storage directory, MERGE and RAID table options, and table/row
- length options.
+ Options tab to configureoptions such as the per-table storage
+ directory, MERGE and RAID table options, and table/row length
+ options.
</para>
</listitem>
@@ -172,8 +172,8 @@
<para>
The detail area of the <literal>Columns and Indices</literal>
- tab is divided into three tabs and is used for modifying the
- index, foreign key, and miscellaneous information regarding your
+ tab is divided into three tabs used for modifying the index,
+ foreign key, and miscellaneous information regarding your
columns.
</para>
@@ -201,10 +201,10 @@
<para>
To add an index, click the <guibutton>+</guibutton> (plus)
- button below the index list. You will be prompted for an index
- name and then the new index is created. To drop an index,
+ button below the index list. The &query_browser; prompts for
+ an index name and the new index is created. To drop an index,
select the index and click the <guibutton>-</guibutton>
- (minus) button to drop the index from the index list.
+ (minus) button.
</para>
<para>
@@ -232,8 +232,7 @@
Columns</guilabel> box and then click the arrow icon to the
right of the <guilabel>Index Columns</guilabel> box. Select
the <guimenu>Set Index Column Length</guimenu> option from the
- drop-down menu that appears. You can set the desired prefix
- length in the dialog that appears.
+ drop-down menu that appears.
</para>
</sect3>
@@ -252,15 +251,14 @@
<para>
To add a foreign key, click the <guibutton>+</guibutton>
- (plus) button below the foreign key list. You will be prompted
- to name the new foreign key, and it is then be added to the
- list.
+ (plus) button below the foreign key list. The &query_browser;
+ prompts for a foreign key name and the new foreign key is
+ created.
</para>
<para>
To drop a foreign key, select the foreign key and click the
<guibutton>-</guibutton> (minus) button below the foreign key
- list. The foreign key is then dropped from the foreign key
list.
</para>
@@ -272,12 +270,12 @@
</para>
<para>
- To establish a foreign key relationship, choose a table from
- the <guilabel>Ref. Table</guilabel> drop-down list. The
- columns that can be referenced as foreign keys are listed in
- the area below, and you can drag a column from the column
- editor to the <guilabel>Column</guilabel> section to the left
- of the column you wish to reference.
+ To define a foreign key relationship, choose a table from the
+ <guilabel>Ref. Table</guilabel> drop-down list. The columns
+ that can be referenced as foreign keys are listed in the area
+ below, and you can drag a column from the column editor to the
+ <guilabel>Column</guilabel> section to the left of the column
+ you wish to reference.
</para>
</sect3>
@@ -320,9 +318,9 @@
<para>
The <literal>Table Options</literal> tab allows you to change the
- storage engine and character set of your table. The potential
- storage engines are listed, along with a brief summary of each
- storage engine's features and strengths.
+ storage engine and default character set of your table. The
+ potential storage engines are listed, along with a brief summary
+ of each storage engine's features and strengths.
</para>
<para>
@@ -357,6 +355,17 @@
sections of this manual.
</para>
+ <para>
+ Descriptions of most options set using the Advanced Options tab
+ can be found in the
+ <ulink
+ url="http://dev.mysql.com/doc/refman/5.0/en/create-table.html">CREATE
+ TABLE section</ulink> of the
+ <ulink
+ url="http://dev.mysql.com/doc/refman/5.0/en/">MySQL
+ Reference Manual</ulink>.
+ </para>
+
<sect2 id="gui-table-editor-advanced-options-various">
<title>The Various Section</title>
@@ -448,8 +457,8 @@
You can also specify the action the server should take when
users attempt to perform INSERT statements on the merge table.
See
- <ulink url="http://dev.mysql.com/doc/mysql/en/MERGE.html">http://dev.mysql.com/doc/mysql/en/MERGE.html
- for more information on MERGE tables.</ulink>
+ <ulink url="http://dev.mysql.com/doc/mysql/en/MERGE.html">http://dev.mysql.com/doc/mysql/en/MERGE.html</ulink>
+ for more information on MERGE tables.
</para>
</sect2>
@@ -511,7 +520,8 @@
<para>
You can click the <guibutton>Execute</guibutton> button to confirm
the changes and have them applied, or click the
- <guibutton>Cancel</guibutton> button to discard the changes. You
+ <guibutton>Cancel</guibutton> button to cancel the changes (the
+ table editor window is redisplayed with your changes intact). You
can also click the <guibutton>Discard Changes</guibutton> button
in the main &table_editor; window to discard all changes you have
made.
Modified: trunk/gui-common/images/columneditor.png
===================================================================
(Binary files differ)
Modified: trunk/gui-common/images/confirmchanges.png
===================================================================
(Binary files differ)
Modified: trunk/gui-common/images/indexeditor.png
===================================================================
(Binary files differ)
Modified: trunk/gui-common/images/tableeditor.png
===================================================================
(Binary files differ)
Modified: trunk/sample-data/sakila/changelog.xml
===================================================================
--- trunk/sample-data/sakila/changelog.xml 2006-02-13 21:27:06 UTC (rev 1303)
+++ trunk/sample-data/sakila/changelog.xml 2006-02-14 00:09:54 UTC (rev 1304)
@@ -1,276 +1,293 @@
-<?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 sakila "Sakila">
- ]>
-<section id="sakila-news">
-
- <title>Sakila Change History</title>
-
- <section id="sakila-news-0.3">
-
- <title>Version 0.3</title>
-
- <itemizedlist>
-
- <listitem>
- <para>
- Changed address.district to VARCHAR(20)
- </para>
- </listitem>
-
- <listitem>
- <para>
- Changed customer.first_name to VARCHAR(45)
- </para>
- </listitem>
-
- <listitem>
- <para>
- Changed customer.last_name to VARCHAR(45)
- </para>
- </listitem>
-
- <listitem>
- <para>
- Changed customer.email to VARCHAR(50)
- </para>
- </listitem>
-
- <listitem>
- <para>
- payment.rental_id added - NULLable INT column
- </para>
- </listitem>
-
- <listitem>
- <para>
- Foreign key added for payment.rental_id to rental.rental_id
- </para>
- </listitem>
-
- <listitem>
- <para>
- rental.rental_id added, INT Auto_Increment, made into
- surrogate primary key, old primary key changed to UNIQUE key.
- </para>
- </listitem>
- </itemizedlist>
-
- </section>
-
-
- <section id="sakila-news-0.2">
-
- <title>Version 0.2</title>
-
- <itemizedlist>
-
- <listitem>
- <para>
- All tables have a <literal>last_update</literal> TIMESTAMP
- with traditional behavior (DEFAULT CURRENT_TIMESTAMP ON UPDATE
- CURRENT_TIMESTAMP)
- </para>
- </listitem>
-
- <listitem>
- <para>
- <literal>actor_id</literal> is now a SMALLINT
- </para>
- </listitem>
-
- <listitem>
- <para>
- <literal>address_id</literal> is now a SMALLINT
- </para>
- </listitem>
-
- <listitem>
- <para>
- <literal>category_id</literal> is now a TINYINT
- </para>
- </listitem>
-
- <listitem>
- <para>
- <literal>city_id</literal> is now a SMALLINT
- </para>
- </listitem>
-
- <listitem>
- <para>
- <literal>country_id</literal> is now a SMALLINT
- </para>
- </listitem>
-
- <listitem>
- <para>
- <literal>customer_id</literal> is now a SMALLINT
- </para>
- </listitem>
-
- <listitem>
- <para>
- <literal>first_name</literal>, <literal>last_name</literal>
- for customer table are now CHAR instead of VARCHAR
- </para>
- </listitem>
-
- <listitem>
- <para>
- <literal>customer</literal> table now has email CHAR(50)
- </para>
- </listitem>
-
- <listitem>
- <para>
- <literal>create_date</literal> on customer table is now
- DATETIME (to accommodate last_update TIMESTAMP)
- </para>
- </listitem>
-
- <listitem>
- <para>
- <literal>customer</literal> table has a new ON INSERT trigger
- that enforces <literal>create_date</literal> column being set
- to NOW()
- </para>
- </listitem>
-
- <listitem>
- <para>
- <literal>film_id</literal> is now SMALLINT
- </para>
- </listitem>
-
- <listitem>
- <para>
- <literal>film.description</literal> now has DEFAULT NULL
- </para>
- </listitem>
-
- <listitem>
- <para>
- <literal>film.release_year</literal> added with type YEAR
- </para>
- </listitem>
-
- <listitem>
- <para>
- <literal>film.language_id</literal> and
- <literal>film.original_language_id</literal> added along with
- language table. For foreign films that may have been subbed.
- <literal>original_language_id</literal> can be NULL,
- <literal>language_id</literal> is NOT NULL
- </para>
- </listitem>
-
- <listitem>
- <para>
- <literal>film.length</literal> is now SMALLINT
- </para>
- </listitem>
-
- <listitem>
- <para>
- <literal>film.category_id</literal> column removed
- </para>
- </listitem>
-
- <listitem>
- <para>
- New table: <literal>film_category</literal> - allows for
- multiple categories per film
- </para>
- </listitem>
-
- <listitem>
- <para>
- <literal>film_text.category_id</literal> column removed
- </para>
- </listitem>
-
- <listitem>
- <para>
- <literal>inventory_id</literal> is now MEDIUMINT
- </para>
- </listitem>
-
- <listitem>
- <para>
- <literal>payment_id</literal> is now SMALLINT
- </para>
- </listitem>
-
- <listitem>
- <para>
- <literal>payment.payment_date</literal> is now DATETIME
- </para>
- </listitem>
-
- <listitem>
- <para>
- Trigger added to <literal>payment</literal> table to enforce
- that payment_date is set to NOW() upon INSERT
- </para>
- </listitem>
-
- <listitem>
- <para>
- <literal>rental.rent_date</literal> is now rental.rental_date
- and is now DATETIME
- </para>
- </listitem>
-
- <listitem>
- <para>
- Trigger added to <literal>rental</literal> table to enforce
- that rental_date is set to NOW() upon INSERT
- </para>
- </listitem>
-
- <listitem>
- <para>
- <literal>staff_id</literal> is now TINYINT
- </para>
- </listitem>
-
- <listitem>
- <para>
- <literal>staff.email</literal> added (VARCHAR(50))
- </para>
- </listitem>
-
- <listitem>
- <para>
- <literal>staff.username</literal> added (VARCHAR(16))
- </para>
- </listitem>
-
- <listitem>
- <para>
- <literal>store_id</literal> is now TINYINT
- </para>
- </listitem>
-
- <listitem>
- <para>
- VIEW <literal>film_list</literal> updated to handle new
- film_category table
- </para>
- </listitem>
-
- <listitem>
- <para>
- VIEW <literal>nicer_but_slower_film_list</literal> updated to
- handle new film_category table
- </para>
- </listitem>
-
- </itemizedlist>
-
- </section>
-
-</section>
+<?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 sakila "Sakila">
+ ]>
+<section id="sakila-news">
+
+ <title>Sakila Change History</title>
+
+ <section id="sakila-news-0.4">
+
+ <title>Version 0.4</title>
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ Added password column to staff table (VARCHAR(40) BINARY
+ DEFAULT NULL)
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ </section>
+
+ <section id="sakila-news-0.3">
+
+ <title>Version 0.3</title>
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ Changed address.district to VARCHAR(20)
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Changed customer.first_name to VARCHAR(45)
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Changed customer.last_name to VARCHAR(45)
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Changed customer.email to VARCHAR(50)
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ payment.rental_id added - NULLable INT column
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Foreign key added for payment.rental_id to rental.rental_id
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ rental.rental_id added, INT Auto_Increment, made into
+ surrogate primary key, old primary key changed to UNIQUE key.
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ </section>
+
+ <section id="sakila-news-0.2">
+
+ <title>Version 0.2</title>
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ All tables have a <literal>last_update</literal> TIMESTAMP
+ with traditional behavior (DEFAULT CURRENT_TIMESTAMP ON UPDATE
+ CURRENT_TIMESTAMP)
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>actor_id</literal> is now a SMALLINT
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>address_id</literal> is now a SMALLINT
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>category_id</literal> is now a TINYINT
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>city_id</literal> is now a SMALLINT
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>country_id</literal> is now a SMALLINT
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>customer_id</literal> is now a SMALLINT
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>first_name</literal>, <literal>last_name</literal>
+ for customer table are now CHAR instead of VARCHAR
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>customer</literal> table now has email CHAR(50)
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>create_date</literal> on customer table is now
+ DATETIME (to accommodate last_update TIMESTAMP)
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>customer</literal> table has a new ON INSERT trigger
+ that enforces <literal>create_date</literal> column being set
+ to NOW()
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>film_id</literal> is now SMALLINT
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>film.description</literal> now has DEFAULT NULL
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>film.release_year</literal> added with type YEAR
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>film.language_id</literal> and
+ <literal>film.original_language_id</literal> added along with
+ language table. For foreign films that may have been subbed.
+ <literal>original_language_id</literal> can be NULL,
+ <literal>language_id</literal> is NOT NULL
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>film.length</literal> is now SMALLINT
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>film.category_id</literal> column removed
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ New table: <literal>film_category</literal> - allows for
+ multiple categories per film
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>film_text.category_id</literal> column removed
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>inventory_id</literal> is now MEDIUMINT
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>payment_id</literal> is now SMALLINT
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>payment.payment_date</literal> is now DATETIME
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Trigger added to <literal>payment</literal> table to enforce
+ that payment_date is set to NOW() upon INSERT
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>rental.rent_date</literal> is now rental.rental_date
+ and is now DATETIME
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Trigger added to <literal>rental</literal> table to enforce
+ that rental_date is set to NOW() upon INSERT
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>staff_id</literal> is now TINYINT
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>staff.email</literal> added (VARCHAR(50))
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>staff.username</literal> added (VARCHAR(16))
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>store_id</literal> is now TINYINT
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ VIEW <literal>film_list</literal> updated to handle new
+ film_category table
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ VIEW <literal>nicer_but_slower_film_list</literal> updated to
+ handle new film_category table
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ </section>
+
+</section>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r1304 - in trunk: gui-common gui-common/images sample-data/sakila | mhillyer | 14 Feb |
