Author: mhillyer
Date: 2006-03-02 06:45:18 +0100 (Thu, 02 Mar 2006)
New Revision: 1480
Log:
Begin work on Sakila sample DB documentation.
Added:
trunk/sample-data/sakila/sakila.ent
trunk/sample-data/sakila/sakila.xml
Added: trunk/sample-data/sakila/sakila.ent
===================================================================
--- trunk/sample-data/sakila/sakila.ent 2006-03-02 02:09:28 UTC (rev 1479)
+++ trunk/sample-data/sakila/sakila.ent 2006-03-02 05:45:18 UTC (rev 1480)
@@ -0,0 +1,2 @@
+<?xml version='1.0' encoding='utf-8'?>
+<!ENTITY sampdb "Sakila">
Added: trunk/sample-data/sakila/sakila.xml
===================================================================
--- trunk/sample-data/sakila/sakila.xml 2006-03-02 02:09:28 UTC (rev 1479)
+++ trunk/sample-data/sakila/sakila.xml 2006-03-02 05:45:18 UTC (rev 1480)
@@ -0,0 +1,193 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
+[
+ <!ENTITY % sakila.entities SYSTEM "sakila.ent">
+ %sakila.entities;
+ ]>
+<article id="sakila" lang="en">
+
+ <section id="sakila-introduction">
+
+ <title>Introduction</title>
+
+ <para>
+ This document describes the &sampdb; sample database -- its
+ history, installation, structure and usage.
+ </para>
+
+ <para>
+ The &sampdb; sample database is developed and maintained by Mike
+ Hillyer of the MySQL AB documentation team and is intended to
+ provide a standard schema that can be used for examples in books,
+ tutorials, articles, samples, etc. The &sampdb; sample database
+ also serves to highlight the latest features of MySQL including
+ Views, Stored Procedures, Triggers, etc.
+ </para>
+
+ <para>
+ The &sampdb; sample database is the result of support and feedback
+ from the MySQL user community and feedback and user input is
+ always appreciated. Please direct all feedback to docs@stripped
+ </para>
+
+ <para>Additional information on the &sampdb;ample database and
+ its usage can be found through the <ulink url="http://forums.mysql.com/list.php?121">MySQL forums</ulink>.</para>
+ </section>
+
+ <section id="sakila-history">
+
+ <title>History</title>
+
+ <para>
+ The &sampdb; was designed as a replacement to the
+ <ulink url="http://downloads.mysql.com/docs/world.sql"><literal>World</literal></ulink>
+ sample database, also provided by MySQL AB.
+ </para>
+
+ <para>
+ The World sample database provides a set of tables containing
+ information on the countries and cities of the world and is useful
+ for basic queries, but lacked structures for testing
+ MySQL-specific functionality and new features found in MySQL 5.
+ </para>
+
+ <para>
+ Development of the &sampdb; sample database began in early 2005
+ . Early designs were based on the database used in the Dell
+ Whitepaper
+ <ulink url="http://www.dell.com/downloads/global/solutions/mysql_apps.pdf">Three
+ Approaches to MySQL Applications on Dell PowerEdge
+ Servers</ulink>.
+ </para>
+
+ <para>
+ Where Dell's sample database was designed to represent an online
+ DVD store, the &sampdb; sample database is designed to represent
+ a DVD rental store. The &sampdb; sample database still borrows
+ film and actor names from the Dell sample database.
+ </para>
+
+ <para>
+ Development was accomplished using MySQL Query Browser for
+ schema design with the tables being populated by a combination
+ of MySQL Query Browser and custom scripts, in addition to
+ contributor efforts (see <xref
+ linkend="sakila-acknowledgements"/>).
+ </para>
+
+ <para>After the basic schema was completed, various views, stored
+ routines, and triggers were added to the schema, after which
+ the sample data was populated. After a series of review
+ versions, the first official version of the &sampdb; sample
+ database was released in March 2006.</para>
+ </section>
+
+ <section id="sakila-installation">
+ <title>Installation</title>
+
+ <para>Fill</para>
+ </section>
+
+ <section id="sakila-structure">
+ <title>Structure</title>
+
+ <section id="sakila-structure-tables">
+ <title>Tables</title>
+ </section>
+
+ <section id="sakila-structure-views">
+ <title>Views</title>
+ </section>
+
+ <section id="sakila-structure-procedures">
+ <title>Stored Procedures</title>
+ </section>
+
+ <section id="sakila-structure-functions">
+ <title>Stored Functions</title>
+ </section>
+
+ <section id="sakila-structure-triggers">
+ <title>Triggers</title>
+ </section>
+
+ </section>
+
+ <section id="sakila-usage">
+ <title>Usage Exampled</title>
+ </section>
+
+ <section id="sakila-acknowledgements">
+
+ <title>Acknowledgements</title>
+
+ <para>
+ The following individuals and organizations have contributed to
+ the development of the Sakila sample database.
+ </para>
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <literal>Roland Bouman</literal>,
+ <ulink url="http://rpbouman.blogspot.com/">Author</ulink> -
+ Provided valuable feedback throughout the development process.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>Ronald Bradford</literal>,
+ <ulink
+ url="http://blog.arabx.com.au/">Developer</ulink>
+ - Developed
+ <ulink url="http://sakila.arabx.com.au/index.htm">first sample
+ application</ulink> for use with the &sampdb; sample
+ database.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>Dave Jaffe</literal>, Dell - Provided schema used in
+ Dell whitepaper and secured permission to use parts thereof in
+ &sampdb; sample database.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>Giuseppe Maxia</literal>, CTO of
+ <ulink
+ url="http://www.stardata.it//index_en.html">Stardata</ulink>
+ - Provided valuable feedback throughout the development
+ process, populated some of the sample data, provided some of
+ the sample views and triggers.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>Jay Pipes</literal>,
+ <ulink url="http://www.jpipes.com/">MySQL Community
+ Advocate</ulink> - Provided some of the sample stored
+ procedures.
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ <para>
+ In addition to the individuals mentioned above, there are various
+ individuals in MySQL AB and the community that have provided
+ feedback during the course of development.
+ </para>
+
+ </section>
+
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
+ href="changelog.xml"/>
+
+</article>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r1480 - trunk/sample-data/sakila | mhillyer | 2 Mar |
