cvs: pear /MDB2_Schema/docs xml_schema_documentation.html

From:	Igor Feghali	Date:	Mon, 25 Sep 2006 17:56:34 +0000
Subject:	cvs: pear /MDB2_Schema/docs xml_schema_documentation.html
Groups:	php.pear.cvs
Request:	Send a blank email to pear-cvs+get-42228@lists.php.net to get a copy of this message

ifeghali Mon Sep 25 17:56:34 2006 UTC Modified files: /pear/MDB2_Schema/docs xml_schema_documentation.html Log: - added schema overview data structure section http://cvs.php.net/viewvc.cgi/pear/MDB2_Schema/docs/xml_schema_documentation.html?r1=1.5&r2=1.6&diff_format=u Index: pear/MDB2_Schema/docs/xml_schema_documentation.html diff -u pear/MDB2_Schema/docs/xml_schema_documentation.html:1.5 pear/MDB2_Schema/docs/xml_schema_documentation.html:1.6 --- pear/MDB2_Schema/docs/xml_schema_documentation.html:1.5 Sun Sep 24 04:48:38 2006 +++ pear/MDB2_Schema/docs/xml_schema_documentation.html Mon Sep 25 17:56:34 2006 @@ -5,7 +5,7 @@ <body> <center><h1>MDB2 XML Schema documentation</h1></center> Author: Manuel Lemos (<a href="mailto:mlemos@acm.org">mlemos@acm.org</a>) -Version control: <tt>@(#) $Id: xml_schema_documentation.html,v 1.5 2006/09/24 04:48:38 ifeghali Exp $</tt> +Version control: <tt>@(#) $Id: xml_schema_documentation.html,v 1.6 2006/09/25 17:56:34 ifeghali Exp $</tt> <h2>Contents</h2> <ul> @@ -24,6 +24,13 @@ <li><a href="#3.4.0">variable</a></li> </ul> </li> + <li><a href="#4.0.0">Schema overview data structure</a> + <ul> + <li><a href="#4.1.0">Main structure</a></li> + <li><a href="#4.2.0">Common elements</a></li> + <li><a href="#4.3.0">Legend</a></li> + </ul> + </li> </ul> @@ -108,7 +115,7 @@ </ul> -Example: +<h4>Example</h4> <ul> <tt><table></tt> <ul> @@ -208,7 +215,7 @@ Default: none </ul> -Example: +<h5>Example</h5> <ul> <tt><field></tt> <ul> @@ -259,7 +266,7 @@ Default: none </ul> -Example: +<h5>Example</h5> <ul> <tt><index></tt> <ul> @@ -350,7 +357,8 @@ <h4>sequence <tt>on</tt></h4> The sequence <tt>on</tt> <tt>table</tt> <tt>field</tt> section specifies a table field on which the sequence value should be synchronized. This information is meant to be used only by the database manager class when it is added a sequence later after the database has been installed for the first time. If the sequence <tt>on</tt> is specified, the database manager class will override the sequence <tt>start</tt> value with a value that is higher than the highest value in the specified field table. Therefore, the specified field table type must be integer. -Example: + +<h4>Example</h4> <ul> <tt><sequence></tt> <ul> @@ -373,5 +381,163 @@ For instance, if you have several tables that store user names in text fields with the same length limit, instead of hard coding the length value in all field definitions, you may use a variable reference. The parser will replace variable references found in property definitions by the text values of the respective values passed to the parser. The parser will issue an error if it find a reference for a variable that is not defined. + +<h2><a name="4.0.0">Schema overview data structure</a></h2> +<h3><a name="4.1.0">Main structure</a></h3> +<ul><tt><database></tt> +<ul> + <tt><name/></tt> + <tt><create/>?</tt> + <tt><overwrite/>?</tt> + <tt><description/>?</tt> + <tt><comments/>?</tt> + + <tt><table></tt> + <ul> + <tt><name/></tt> + <tt><was/></tt> + <tt><description/></tt> + <tt><comments/></tt> + + <tt><declaration></tt> + <ul> + <tt><field></tt> + <ul> + <tt><name/></tt> + <tt><was/></tt> + <tt><type/></tt> + <tt><default/></tt> + <tt><notnull/></tt> + <tt><autoincrement/></tt> + <tt><unsigned/></tt> + <tt><description/></tt> + <tt><comments/></tt> + <tt><length/></tt> + </ul> + <tt></field>+</tt> + <tt><index></tt> + <ul> + <tt><name/></tt> + <tt><was/>?</tt> + <tt><unique/>?</tt> + <tt><primary/>?</tt> + <tt><field></tt> + <ul> + <tt><name/></tt> + <tt><sorting/></tt> + </ul> + <tt></field>+</tt> + </ul> + <tt></index>*</tt> + </ul> + <tt></declaration></tt> + + <tt><initialization></tt> + <ul> + <tt><insert></tt> + <ul> + <tt>{field}+</tt> + </ul> + <tt></insert>*</tt> + + <tt><update></tt> + <ul> + <tt>{field}+</tt> + <tt><where></tt> + <ul> + <tt>{expression}</tt> + </ul> + <tt></where>?</tt> + </ul> + <tt></update>*</tt> + + <tt><delete></tt> + <ul> + <tt><where></tt> + <ul> + <tt>{expression}?</tt> + </ul> + <tt></where></tt> + </ul> + <tt></delete>*</tt> + </ul> + <tt></initialization></tt> + </ul> + <tt></table>+</tt> + + + <tt><sequence></tt> + <ul> + <tt><name/></tt> + <tt><was/>?</tt> + <tt><start/>?</tt> + + <tt><on></tt> + <ul> + <tt><table/></tt> + <tt><field/>+</tt> + </ul> + <tt></on></tt> + + <tt><description/>?</tt> + <tt><comments/>?</tt> + </ul> + <tt></sequence>?</tt> + +</ul> +<tt></database></tt> +</ul> + +<h3><a name="4.2.0">Common Elements</a></h3> +<ul> + <li>{field}</li> + <ul> + <tt><field></tt> + <ul> + <tt><name/> + <value/> or <column/> or {function} or {expression}</tt> + </ul> + <tt></field></tt> + </ul> + + <li>{function}</li> + <ul> + <tt><function></tt> + <ul> + <tt><name/> + ( <value/> or <column/> or {function} or {expression} )+</tt></t> + </ul> + <tt></function></tt> + </ul> + + <li>{expression}</li> + + <ul>Some Operators example: + <li>NOT, AND, OR, XOR</li> + <li>EQUAL, LIKE, LESS THAN, GREATER THAN</li> + <li>IS NULL, BETWEEN</li> + <li>etc.</li> + </ul> + + <ul> + <tt><expression></tt> + <ul> + <tt><value/> or <column/> or {function} or {expression} + <operator>OPERATOR</operator> + <value/> or <column/> or {function} or {expression}</tt> + </ul> + <tt></expression></tt> + </ul> + </ul> + +<h3><a name="4.3.0">Legend</a></h3> +<ul> + <li>{tag} common element</li> + <li><tag/> stands for <tag>STRING</tag></li> + <li>? Zero or one</li> + <li>* Zero or more</li> + <li>+ More than one</li> +</ul> + </body> </html>